heroku-go: github.com/heroku/heroku-go/v5 Index | Files

package v5

import "github.com/heroku/heroku-go/v5"

Generated service client for heroku API.

To be able to interact with this API, you have to create a new service:

s := heroku.NewService(nil)

The Service struct has all the methods you need to interact with heroku API.

Index

Package Files

heroku.go round_trip_with_retry_backoff.go transport.go

Constants

const (
    Version          = "v5"
    DefaultUserAgent = "heroku/" + Version + " (" + runtime.GOOS + "; " + runtime.GOARCH + ")"
    DefaultURL       = "https://api.heroku.com"
)

Variables

var DefaultClient = &http.Client{
    Transport: DefaultTransport,
}
var DefaultTransport = &Transport{}

func Bool Uses

func Bool(v bool) *bool

Bool allocates a new int value returns a pointer to it.

func Float64 Uses

func Float64(v float64) *float64

Float64 allocates a new float64 value returns a pointer to it.

func Int Uses

func Int(v int) *int

Int allocates a new int value returns a pointer to it.

func String Uses

func String(v string) *string

String allocates a new string value returns a pointer to it.

type Account Uses

type Account struct {
    AllowTracking       bool      `json:"allow_tracking" url:"allow_tracking,key"` // whether to allow third party web activity tracking
    Beta                bool      `json:"beta" url:"beta,key"`                     // whether allowed to utilize beta Heroku features
    CreatedAt           time.Time `json:"created_at" url:"created_at,key"`         // when account was created
    DefaultOrganization *struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of team
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"default_organization" url:"default_organization,key"` // team selected by default
    DefaultTeam *struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of team
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"default_team" url:"default_team,key"` // team selected by default
    DelinquentAt     *time.Time `json:"delinquent_at" url:"delinquent_at,key"` // when account became delinquent
    Email            string     `json:"email" url:"email,key"`                 // unique email address of account
    Federated        bool       `json:"federated" url:"federated,key"`         // whether the user is federated and belongs to an Identity Provider
    ID               string     `json:"id" url:"id,key"`                       // unique identifier of an account
    IdentityProvider *struct {
        ID           string `json:"id" url:"id,key"` // unique identifier of this identity provider
        Organization struct {
            Name string `json:"name" url:"name,key"` // unique name of team
        }   `json:"organization" url:"organization,key"`
        Owner struct {
            ID   string `json:"id" url:"id,key"`     // unique identifier of the owner
            Name string `json:"name" url:"name,key"` // name of the owner
            Type string `json:"type" url:"type,key"` // type of the owner
        }   `json:"owner" url:"owner,key"` // entity that owns this identity provider
        Team struct {
            Name string `json:"name" url:"name,key"` // unique name of team
        }   `json:"team" url:"team,key"`
    }   `json:"identity_provider" url:"identity_provider,key"` // Identity Provider details for federated users.
    LastLogin               *time.Time `json:"last_login" url:"last_login,key"`                               // when account last authorized with Heroku
    Name                    *string    `json:"name" url:"name,key"`                                           // full name of the account owner
    SmsNumber               *string    `json:"sms_number" url:"sms_number,key"`                               // SMS number of account
    SuspendedAt             *time.Time `json:"suspended_at" url:"suspended_at,key"`                           // when account was suspended
    TwoFactorAuthentication bool       `json:"two_factor_authentication" url:"two_factor_authentication,key"` // whether two-factor auth is enabled on the account
    UpdatedAt               time.Time  `json:"updated_at" url:"updated_at,key"`                               // when account was updated
    Verified                bool       `json:"verified" url:"verified,key"`                                   // whether account has been verified with billing information
}

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

type AccountFeature Uses

type AccountFeature struct {
    CreatedAt     time.Time `json:"created_at" url:"created_at,key"`         // when account feature was created
    Description   string    `json:"description" url:"description,key"`       // description of account feature
    DisplayName   string    `json:"display_name" url:"display_name,key"`     // user readable feature name
    DocURL        string    `json:"doc_url" url:"doc_url,key"`               // documentation URL of account feature
    Enabled       bool      `json:"enabled" url:"enabled,key"`               // whether or not account feature has been enabled
    FeedbackEmail string    `json:"feedback_email" url:"feedback_email,key"` // e-mail to send feedback about the feature
    ID            string    `json:"id" url:"id,key"`                         // unique identifier of account feature
    Name          string    `json:"name" url:"name,key"`                     // unique name of account feature
    State         string    `json:"state" url:"state,key"`                   // state of account feature
    UpdatedAt     time.Time `json:"updated_at" url:"updated_at,key"`         // when account feature was updated
}

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

type AccountFeatureListResult Uses

type AccountFeatureListResult []AccountFeature

type AccountFeatureUpdateOpts Uses

type AccountFeatureUpdateOpts struct {
    Enabled bool `json:"enabled" url:"enabled,key"` // whether or not account feature has been enabled
}

type AccountUpdateByUserOpts Uses

type AccountUpdateByUserOpts struct {
    AllowTracking *bool   `json:"allow_tracking,omitempty" url:"allow_tracking,omitempty,key"` // whether to allow third party web activity tracking
    Beta          *bool   `json:"beta,omitempty" url:"beta,omitempty,key"`                     // whether allowed to utilize beta Heroku features
    Name          *string `json:"name,omitempty" url:"name,omitempty,key"`                     // full name of the account owner
}

type AccountUpdateOpts Uses

type AccountUpdateOpts struct {
    AllowTracking *bool   `json:"allow_tracking,omitempty" url:"allow_tracking,omitempty,key"` // whether to allow third party web activity tracking
    Beta          *bool   `json:"beta,omitempty" url:"beta,omitempty,key"`                     // whether allowed to utilize beta Heroku features
    Name          *string `json:"name,omitempty" url:"name,omitempty,key"`                     // full name of the account owner
}

type AddOn Uses

type AddOn struct {
    Actions      []struct{} `json:"actions" url:"actions,key"` // provider actions for this specific add-on
    AddonService struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this add-on-service
        Name string `json:"name" url:"name,key"` // unique name of this add-on-service
    }   `json:"addon_service" url:"addon_service,key"` // identity of add-on service
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // billing application associated with this add-on
    BilledPrice *struct {
        Cents    int    `json:"cents" url:"cents,key"`       // price in cents per unit of plan
        Contract bool   `json:"contract" url:"contract,key"` // price is negotiated in a contract outside of monthly add-on billing
        Unit     string `json:"unit" url:"unit,key"`         // unit of price for plan
    }   `json:"billed_price" url:"billed_price,key"` // billed price
    BillingEntity struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of the billing entity
        Name string `json:"name" url:"name,key"` // name of the billing entity
        Type string `json:"type" url:"type,key"` // type of Object of the billing entity; new types allowed at any time.
    }   `json:"billing_entity" url:"billing_entity,key"` // billing entity associated with this add-on
    ConfigVars []string  `json:"config_vars" url:"config_vars,key"` // config vars exposed to the owning app by this add-on
    CreatedAt  time.Time `json:"created_at" url:"created_at,key"`   // when add-on was created
    ID         string    `json:"id" url:"id,key"`                   // unique identifier of add-on
    Name       string    `json:"name" url:"name,key"`               // globally unique name of the add-on
    Plan       struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this plan
        Name string `json:"name" url:"name,key"` // unique name of this plan
    }   `json:"plan" url:"plan,key"` // identity of add-on plan
    ProviderID string    `json:"provider_id" url:"provider_id,key"` // id of this add-on with its provider
    State      string    `json:"state" url:"state,key"`             // state in the add-on's lifecycle
    UpdatedAt  time.Time `json:"updated_at" url:"updated_at,key"`   // when add-on was updated
    WebURL     *string   `json:"web_url" url:"web_url,key"`         // URL for logging into web interface of add-on (e.g. a dashboard)
}

Add-ons represent add-ons that have been provisioned and attached to one or more apps.

type AddOnAction Uses

type AddOnAction struct{}

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.

type AddOnActionDeprovisionResult Uses

type AddOnActionDeprovisionResult struct {
    Actions      []struct{} `json:"actions" url:"actions,key"` // provider actions for this specific add-on
    AddonService struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this add-on-service
        Name string `json:"name" url:"name,key"` // unique name of this add-on-service
    }   `json:"addon_service" url:"addon_service,key"` // identity of add-on service
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // billing application associated with this add-on
    BilledPrice *struct {
        Cents    int    `json:"cents" url:"cents,key"`       // price in cents per unit of plan
        Contract bool   `json:"contract" url:"contract,key"` // price is negotiated in a contract outside of monthly add-on billing
        Unit     string `json:"unit" url:"unit,key"`         // unit of price for plan
    }   `json:"billed_price" url:"billed_price,key"` // billed price
    BillingEntity struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of the billing entity
        Name string `json:"name" url:"name,key"` // name of the billing entity
        Type string `json:"type" url:"type,key"` // type of Object of the billing entity; new types allowed at any time.
    }   `json:"billing_entity" url:"billing_entity,key"` // billing entity associated with this add-on
    ConfigVars []string  `json:"config_vars" url:"config_vars,key"` // config vars exposed to the owning app by this add-on
    CreatedAt  time.Time `json:"created_at" url:"created_at,key"`   // when add-on was created
    ID         string    `json:"id" url:"id,key"`                   // unique identifier of add-on
    Name       string    `json:"name" url:"name,key"`               // globally unique name of the add-on
    Plan       struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this plan
        Name string `json:"name" url:"name,key"` // unique name of this plan
    }   `json:"plan" url:"plan,key"` // identity of add-on plan
    ProviderID string    `json:"provider_id" url:"provider_id,key"` // id of this add-on with its provider
    State      string    `json:"state" url:"state,key"`             // state in the add-on's lifecycle
    UpdatedAt  time.Time `json:"updated_at" url:"updated_at,key"`   // when add-on was updated
    WebURL     *string   `json:"web_url" url:"web_url,key"`         // URL for logging into web interface of add-on (e.g. a dashboard)
}

type AddOnActionProvisionResult Uses

type AddOnActionProvisionResult struct {
    Actions      []struct{} `json:"actions" url:"actions,key"` // provider actions for this specific add-on
    AddonService struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this add-on-service
        Name string `json:"name" url:"name,key"` // unique name of this add-on-service
    }   `json:"addon_service" url:"addon_service,key"` // identity of add-on service
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // billing application associated with this add-on
    BilledPrice *struct {
        Cents    int    `json:"cents" url:"cents,key"`       // price in cents per unit of plan
        Contract bool   `json:"contract" url:"contract,key"` // price is negotiated in a contract outside of monthly add-on billing
        Unit     string `json:"unit" url:"unit,key"`         // unit of price for plan
    }   `json:"billed_price" url:"billed_price,key"` // billed price
    BillingEntity struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of the billing entity
        Name string `json:"name" url:"name,key"` // name of the billing entity
        Type string `json:"type" url:"type,key"` // type of Object of the billing entity; new types allowed at any time.
    }   `json:"billing_entity" url:"billing_entity,key"` // billing entity associated with this add-on
    ConfigVars []string  `json:"config_vars" url:"config_vars,key"` // config vars exposed to the owning app by this add-on
    CreatedAt  time.Time `json:"created_at" url:"created_at,key"`   // when add-on was created
    ID         string    `json:"id" url:"id,key"`                   // unique identifier of add-on
    Name       string    `json:"name" url:"name,key"`               // globally unique name of the add-on
    Plan       struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this plan
        Name string `json:"name" url:"name,key"` // unique name of this plan
    }   `json:"plan" url:"plan,key"` // identity of add-on plan
    ProviderID string    `json:"provider_id" url:"provider_id,key"` // id of this add-on with its provider
    State      string    `json:"state" url:"state,key"`             // state in the add-on's lifecycle
    UpdatedAt  time.Time `json:"updated_at" url:"updated_at,key"`   // when add-on was updated
    WebURL     *string   `json:"web_url" url:"web_url,key"`         // URL for logging into web interface of add-on (e.g. a dashboard)
}

type AddOnAttachment Uses

type AddOnAttachment struct {
    Addon struct {
        App struct {
            ID   string `json:"id" url:"id,key"`     // unique identifier of app
            Name string `json:"name" url:"name,key"` // unique name of app
        }   `json:"app" url:"app,key"` // billing application associated with this add-on
        ID   string `json:"id" url:"id,key"`     // unique identifier of add-on
        Name string `json:"name" url:"name,key"` // globally unique name of the add-on
    }   `json:"addon" url:"addon,key"` // identity of add-on
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // application that is attached to add-on
    CreatedAt   time.Time `json:"created_at" url:"created_at,key"`       // when add-on attachment was created
    ID          string    `json:"id" url:"id,key"`                       // unique identifier of this add-on attachment
    LogInputURL *string   `json:"log_input_url" url:"log_input_url,key"` // URL for add-on partners to write to an add-on's logs
    Name        string    `json:"name" url:"name,key"`                   // unique name for this add-on attachment to this app
    Namespace   *string   `json:"namespace" url:"namespace,key"`         // attachment namespace
    UpdatedAt   time.Time `json:"updated_at" url:"updated_at,key"`       // when add-on attachment was updated
    WebURL      *string   `json:"web_url" url:"web_url,key"`             // URL for logging into web interface of add-on in attached app context
}

An add-on attachment represents a connection between an app and an add-on that it has been given access to.

type AddOnAttachmentCreateOpts Uses

type AddOnAttachmentCreateOpts struct {
    Addon     string  `json:"addon" url:"addon,key"`                             // unique identifier of add-on
    App       string  `json:"app" url:"app,key"`                                 // unique identifier of app
    Confirm   *string `json:"confirm,omitempty" url:"confirm,omitempty,key"`     // name of owning app for confirmation
    Name      *string `json:"name,omitempty" url:"name,omitempty,key"`           // unique name for this add-on attachment to this app
    Namespace *string `json:"namespace,omitempty" url:"namespace,omitempty,key"` // attachment namespace
}

type AddOnAttachmentListByAddOnResult Uses

type AddOnAttachmentListByAddOnResult []AddOnAttachment

type AddOnAttachmentListByAppResult Uses

type AddOnAttachmentListByAppResult []AddOnAttachment

type AddOnAttachmentListResult Uses

type AddOnAttachmentListResult []AddOnAttachment

type AddOnAttachmentResolutionOpts Uses

type AddOnAttachmentResolutionOpts struct {
    AddonAttachment string  `json:"addon_attachment" url:"addon_attachment,key"`               // unique name for this add-on attachment to this app
    AddonService    *string `json:"addon_service,omitempty" url:"addon_service,omitempty,key"` // unique name of this add-on-service
    App             *string `json:"app,omitempty" url:"app,omitempty,key"`                     // unique name of app
}

type AddOnAttachmentResolutionResult Uses

type AddOnAttachmentResolutionResult []AddOnAttachment

type AddOnConfig Uses

type AddOnConfig struct {
    Name  string  `json:"name" url:"name,key"`   // unique name of the config
    Value *string `json:"value" url:"value,key"` // value of the config
}

Configuration of an Add-on

type AddOnConfigListResult Uses

type AddOnConfigListResult []AddOnConfig

type AddOnConfigUpdateOpts Uses

type AddOnConfigUpdateOpts struct {
    Config []*struct {
        Name  *string `json:"name,omitempty" url:"name,omitempty,key"`   // unique name of the config
        Value *string `json:"value,omitempty" url:"value,omitempty,key"` // value of the config
    } `json:"config,omitempty" url:"config,omitempty,key"`
}

type AddOnConfigUpdateResult Uses

type AddOnConfigUpdateResult []AddOnConfig

type AddOnCreateOpts Uses

type AddOnCreateOpts struct {
    Attachment *struct {
        Name *string `json:"name,omitempty" url:"name,omitempty,key"` // unique name for this add-on attachment to this app
    }   `json:"attachment,omitempty" url:"attachment,omitempty,key"` // name for add-on's initial attachment
    Config  map[string]string `json:"config,omitempty" url:"config,omitempty,key"`   // custom add-on provisioning options
    Confirm *string           `json:"confirm,omitempty" url:"confirm,omitempty,key"` // name of billing entity for confirmation
    Name    *string           `json:"name,omitempty" url:"name,omitempty,key"`       // globally unique name of the add-on
    Plan    string            `json:"plan" url:"plan,key"`                           // unique identifier of this plan
}

type AddOnListByAppResult Uses

type AddOnListByAppResult []AddOn

type AddOnListByTeamResult Uses

type AddOnListByTeamResult []AddOn

type AddOnListByUserResult Uses

type AddOnListByUserResult []AddOn

type AddOnListResult Uses

type AddOnListResult []AddOn

type AddOnPlanAction Uses

type AddOnPlanAction struct {
    Action        string `json:"action" url:"action,key"`                 // identifier of the action to take that is sent via SSO
    ID            string `json:"id" url:"id,key"`                         // a unique identifier
    Label         string `json:"label" url:"label,key"`                   // the display text shown in Dashboard
    RequiresOwner bool   `json:"requires_owner" url:"requires_owner,key"` // if the action requires the user to own the app
    URL           string `json:"url" url:"url,key"`                       // absolute URL to use instead of an action
}

Add-on Plan Actions are Provider functionality for specific add-on installations

type AddOnRegionCapability Uses

type AddOnRegionCapability struct {
    AddonService struct {
        CliPluginName                 *string   `json:"cli_plugin_name" url:"cli_plugin_name,key"`                                 // npm package name of the add-on service's Heroku CLI plugin
        CreatedAt                     time.Time `json:"created_at" url:"created_at,key"`                                           // when add-on-service was created
        HumanName                     string    `json:"human_name" url:"human_name,key"`                                           // human-readable name of the add-on service provider
        ID                            string    `json:"id" url:"id,key"`                                                           // unique identifier of this add-on-service
        Name                          string    `json:"name" url:"name,key"`                                                       // unique name of this add-on-service
        State                         string    `json:"state" url:"state,key"`                                                     // release status for add-on service
        SupportsMultipleInstallations bool      `json:"supports_multiple_installations" url:"supports_multiple_installations,key"` // whether or not apps can have access to more than one instance of this
        // add-on at the same time
        SupportsSharing bool `json:"supports_sharing" url:"supports_sharing,key"` // whether or not apps can have access to add-ons billed to a different
        // app
        UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when add-on-service was updated
    }   `json:"addon_service" url:"addon_service,key"` // Add-on services represent add-ons that may be provisioned for apps.
    // Endpoints under add-on services can be accessed without
    // authentication.
    ID     string `json:"id" url:"id,key"` // unique identifier of this add-on-region-capability
    Region struct {
        Country        string    `json:"country" url:"country,key"`                 // country where the region exists
        CreatedAt      time.Time `json:"created_at" url:"created_at,key"`           // when region was created
        Description    string    `json:"description" url:"description,key"`         // description of region
        ID             string    `json:"id" url:"id,key"`                           // unique identifier of region
        Locale         string    `json:"locale" url:"locale,key"`                   // area in the country where the region exists
        Name           string    `json:"name" url:"name,key"`                       // unique name of region
        PrivateCapable bool      `json:"private_capable" url:"private_capable,key"` // whether or not region is available for creating a Private Space
        Provider       struct {
            Name   string `json:"name" url:"name,key"`     // name of provider
            Region string `json:"region" url:"region,key"` // region name used by provider
        }   `json:"provider" url:"provider,key"` // provider of underlying substrate
        UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when region was updated
    }   `json:"region" url:"region,key"` // A region represents a geographic location in which your application
    // may run.
    SupportsPrivateNetworking bool `json:"supports_private_networking" url:"supports_private_networking,key"` // whether the add-on can be installed to a Space
}

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.

type AddOnRegionCapabilityListByAddOnServiceResult Uses

type AddOnRegionCapabilityListByAddOnServiceResult []AddOnRegionCapability

type AddOnRegionCapabilityListByRegionResult Uses

type AddOnRegionCapabilityListByRegionResult []AddOnRegionCapability

type AddOnRegionCapabilityListResult Uses

type AddOnRegionCapabilityListResult []AddOnRegionCapability

type AddOnResolutionOpts Uses

type AddOnResolutionOpts struct {
    Addon        string  `json:"addon" url:"addon,key"`                                     // globally unique name of the add-on
    AddonService *string `json:"addon_service,omitempty" url:"addon_service,omitempty,key"` // unique name of this add-on-service
    App          *string `json:"app,omitempty" url:"app,omitempty,key"`                     // unique name of app
}

type AddOnResolutionResult Uses

type AddOnResolutionResult []AddOn

type AddOnService Uses

type AddOnService struct {
    CliPluginName                 *string   `json:"cli_plugin_name" url:"cli_plugin_name,key"`                                 // npm package name of the add-on service's Heroku CLI plugin
    CreatedAt                     time.Time `json:"created_at" url:"created_at,key"`                                           // when add-on-service was created
    HumanName                     string    `json:"human_name" url:"human_name,key"`                                           // human-readable name of the add-on service provider
    ID                            string    `json:"id" url:"id,key"`                                                           // unique identifier of this add-on-service
    Name                          string    `json:"name" url:"name,key"`                                                       // unique name of this add-on-service
    State                         string    `json:"state" url:"state,key"`                                                     // release status for add-on service
    SupportsMultipleInstallations bool      `json:"supports_multiple_installations" url:"supports_multiple_installations,key"` // whether or not apps can have access to more than one instance of this
    // add-on at the same time
    SupportsSharing bool `json:"supports_sharing" url:"supports_sharing,key"` // whether or not apps can have access to add-ons billed to a different
    // app
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when add-on-service was updated
}

Add-on services represent add-ons that may be provisioned for apps. Endpoints under add-on services can be accessed without authentication.

type AddOnServiceListResult Uses

type AddOnServiceListResult []AddOnService

type AddOnUpdateOpts Uses

type AddOnUpdateOpts struct {
    Name *string `json:"name,omitempty" url:"name,omitempty,key"` // globally unique name of the add-on
    Plan string  `json:"plan" url:"plan,key"`                     // unique identifier of this plan
}

type AddOnWebhook Uses

type AddOnWebhook struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

Represents the details of a webhook subscription

type AddOnWebhookCreateOpts Uses

type AddOnWebhookCreateOpts struct {
    Authorization *string `json:"authorization,omitempty" url:"authorization,omitempty,key"` // a custom `Authorization` header that Heroku will include with all
    // webhook notifications
    Include []string `json:"include" url:"include,key"` // the entities that the subscription provides notifications for
    Level   string   `json:"level" url:"level,key"`     // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    Secret *string `json:"secret,omitempty" url:"secret,omitempty,key"` // a value that Heroku will use to sign all webhook notification
    // requests (the signature is included in the request’s
    // `Heroku-Webhook-Hmac-SHA256` header)
    URL string `json:"url" url:"url,key"` // the URL where the webhook's notification requests are sent
}

type AddOnWebhookCreateResult Uses

type AddOnWebhookCreateResult struct {
    Addon struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of add-on
        Name string `json:"name" url:"name,key"` // globally unique name of the add-on
    }   `json:"addon" url:"addon,key"` // identity of add-on. Only used for add-on partner webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type AddOnWebhookDeleteResult Uses

type AddOnWebhookDeleteResult struct {
    Addon struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of add-on
        Name string `json:"name" url:"name,key"` // globally unique name of the add-on
    }   `json:"addon" url:"addon,key"` // identity of add-on. Only used for add-on partner webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type AddOnWebhookDelivery Uses

type AddOnWebhookDelivery struct{}

Represents the delivery of a webhook notification, including its current status.

type AddOnWebhookDeliveryInfoResult Uses

type AddOnWebhookDeliveryInfoResult struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the delivery was created
    Event     struct {
        ID      string `json:"id" url:"id,key"`           // the event's unique identifier
        Include string `json:"include" url:"include,key"` // the type of entity that the event is related to
    }   `json:"event" url:"event,key"` // identity of event
    ID          string `json:"id" url:"id,key"` // the delivery's unique identifier
    LastAttempt *struct {
        Code       *int      `json:"code" url:"code,key"`               // http response code received during attempt
        CreatedAt  time.Time `json:"created_at" url:"created_at,key"`   // when attempt was created
        ErrorClass *string   `json:"error_class" url:"error_class,key"` // error class encountered during attempt
        ID         string    `json:"id" url:"id,key"`                   // unique identifier of attempt
        Status     string    `json:"status" url:"status,key"`           // status of an attempt
        UpdatedAt  time.Time `json:"updated_at" url:"updated_at,key"`   // when attempt was updated
    }   `json:"last_attempt" url:"last_attempt,key"` // last attempt of a delivery
    NextAttemptAt *time.Time `json:"next_attempt_at" url:"next_attempt_at,key"` // when delivery will be attempted again
    NumAttempts   int        `json:"num_attempts" url:"num_attempts,key"`       // number of times a delivery has been attempted
    Status        string     `json:"status" url:"status,key"`                   // the delivery's status
    UpdatedAt     time.Time  `json:"updated_at" url:"updated_at,key"`           // when the delivery was last updated
    Webhook       struct {
        ID    string `json:"id" url:"id,key"`       // the webhook's unique identifier
        Level string `json:"level" url:"level,key"` // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.

    }   `json:"webhook" url:"webhook,key"` // identity of webhook
}

type AddOnWebhookDeliveryListResult Uses

type AddOnWebhookDeliveryListResult []struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the delivery was created
    Event     struct {
        ID      string `json:"id" url:"id,key"`           // the event's unique identifier
        Include string `json:"include" url:"include,key"` // the type of entity that the event is related to
    }   `json:"event" url:"event,key"` // identity of event
    ID          string `json:"id" url:"id,key"` // the delivery's unique identifier
    LastAttempt *struct {
        Code       *int      `json:"code" url:"code,key"`               // http response code received during attempt
        CreatedAt  time.Time `json:"created_at" url:"created_at,key"`   // when attempt was created
        ErrorClass *string   `json:"error_class" url:"error_class,key"` // error class encountered during attempt
        ID         string    `json:"id" url:"id,key"`                   // unique identifier of attempt
        Status     string    `json:"status" url:"status,key"`           // status of an attempt
        UpdatedAt  time.Time `json:"updated_at" url:"updated_at,key"`   // when attempt was updated
    }   `json:"last_attempt" url:"last_attempt,key"` // last attempt of a delivery
    NextAttemptAt *time.Time `json:"next_attempt_at" url:"next_attempt_at,key"` // when delivery will be attempted again
    NumAttempts   int        `json:"num_attempts" url:"num_attempts,key"`       // number of times a delivery has been attempted
    Status        string     `json:"status" url:"status,key"`                   // the delivery's status
    UpdatedAt     time.Time  `json:"updated_at" url:"updated_at,key"`           // when the delivery was last updated
    Webhook       struct {
        ID    string `json:"id" url:"id,key"`       // the webhook's unique identifier
        Level string `json:"level" url:"level,key"` // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.

    }   `json:"webhook" url:"webhook,key"` // identity of webhook
}

type AddOnWebhookEvent Uses

type AddOnWebhookEvent struct{}

Represents a webhook event that occurred.

type AddOnWebhookEventInfoResult Uses

type AddOnWebhookEventInfoResult struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when event was created
    ID        string    `json:"id" url:"id,key"`                 // the event's unique identifier
    Include   string    `json:"include" url:"include,key"`       // the type of entity that the event is related to
    Payload   struct {
        Action string `json:"action" url:"action,key"` // the type of event that occurred
        Actor  struct {
            Email string `json:"email" url:"email,key"` // unique email address of account
            ID    string `json:"id" url:"id,key"`       // unique identifier of an account
        }   `json:"actor" url:"actor,key"` // user that caused event
        Data         struct{} `json:"data" url:"data,key"`                   // the current details of the event
        PreviousData struct{} `json:"previous_data" url:"previous_data,key"` // previous details of the event (if any)
        Resource     string   `json:"resource" url:"resource,key"`           // the type of resource associated with the event
        Version      string   `json:"version" url:"version,key"`             // the version of the details provided for the event
    }   `json:"payload" url:"payload,key"` // payload of event
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the event was last updated
}

type AddOnWebhookEventListResult Uses

type AddOnWebhookEventListResult []struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when event was created
    ID        string    `json:"id" url:"id,key"`                 // the event's unique identifier
    Include   string    `json:"include" url:"include,key"`       // the type of entity that the event is related to
    Payload   struct {
        Action string `json:"action" url:"action,key"` // the type of event that occurred
        Actor  struct {
            Email string `json:"email" url:"email,key"` // unique email address of account
            ID    string `json:"id" url:"id,key"`       // unique identifier of an account
        }   `json:"actor" url:"actor,key"` // user that caused event
        Data         struct{} `json:"data" url:"data,key"`                   // the current details of the event
        PreviousData struct{} `json:"previous_data" url:"previous_data,key"` // previous details of the event (if any)
        Resource     string   `json:"resource" url:"resource,key"`           // the type of resource associated with the event
        Version      string   `json:"version" url:"version,key"`             // the version of the details provided for the event
    }   `json:"payload" url:"payload,key"` // payload of event
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the event was last updated
}

type AddOnWebhookInfoResult Uses

type AddOnWebhookInfoResult struct {
    Addon struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of add-on
        Name string `json:"name" url:"name,key"` // globally unique name of the add-on
    }   `json:"addon" url:"addon,key"` // identity of add-on. Only used for add-on partner webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type AddOnWebhookListResult Uses

type AddOnWebhookListResult []struct {
    Addon struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of add-on
        Name string `json:"name" url:"name,key"` // globally unique name of the add-on
    }   `json:"addon" url:"addon,key"` // identity of add-on. Only used for add-on partner webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type AddOnWebhookUpdateOpts Uses

type AddOnWebhookUpdateOpts struct {
    Authorization *string `json:"authorization,omitempty" url:"authorization,omitempty,key"` // a custom `Authorization` header that Heroku will include with all
    // webhook notifications
    Include []*string `json:"include,omitempty" url:"include,omitempty,key"` // the entities that the subscription provides notifications for
    Level   *string   `json:"level,omitempty" url:"level,omitempty,key"`     // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    Secret *string `json:"secret,omitempty" url:"secret,omitempty,key"` // a value that Heroku will use to sign all webhook notification
    // requests (the signature is included in the request’s
    // `Heroku-Webhook-Hmac-SHA256` header)
    URL *string `json:"url,omitempty" url:"url,omitempty,key"` // the URL where the webhook's notification requests are sent
}

type AddOnWebhookUpdateResult Uses

type AddOnWebhookUpdateResult struct {
    Addon struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of add-on
        Name string `json:"name" url:"name,key"` // globally unique name of the add-on
    }   `json:"addon" url:"addon,key"` // identity of add-on. Only used for add-on partner webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type App Uses

type App struct {
    Acm        bool       `json:"acm" url:"acm,key"`                 // ACM status of this app
    ArchivedAt *time.Time `json:"archived_at" url:"archived_at,key"` // when app was archived
    BuildStack struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"build_stack" url:"build_stack,key"` // identity of the stack that will be used for new builds
    BuildpackProvidedDescription *string   `json:"buildpack_provided_description" url:"buildpack_provided_description,key"` // description from buildpack of app
    CreatedAt                    time.Time `json:"created_at" url:"created_at,key"`                                         // when app was created
    GitURL                       string    `json:"git_url" url:"git_url,key"`                                               // git repo URL of app
    ID                           string    `json:"id" url:"id,key"`                                                         // unique identifier of app
    InternalRouting              *bool     `json:"internal_routing" url:"internal_routing,key"`                             // describes whether a Private Spaces app is externally routable or not
    Maintenance                  bool      `json:"maintenance" url:"maintenance,key"`                                       // maintenance status of app
    Name                         string    `json:"name" url:"name,key"`                                                     // unique name of app
    Organization                 *struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of team
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"organization" url:"organization,key"` // identity of team
    Owner struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"owner" url:"owner,key"` // identity of app owner
    Region struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of region
        Name string `json:"name" url:"name,key"` // unique name of region
    }   `json:"region" url:"region,key"` // identity of app region
    ReleasedAt *time.Time `json:"released_at" url:"released_at,key"` // when app was released
    RepoSize   *int       `json:"repo_size" url:"repo_size,key"`     // git repo size in bytes of app
    SlugSize   *int       `json:"slug_size" url:"slug_size,key"`     // slug size in bytes of app
    Space      *struct {
        ID     string `json:"id" url:"id,key"`         // unique identifier of space
        Name   string `json:"name" url:"name,key"`     // unique name of space
        Shield bool   `json:"shield" url:"shield,key"` // true if this space has shield enabled
    }   `json:"space" url:"space,key"` // identity of space
    Stack struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"stack" url:"stack,key"` // identity of app stack
    Team *struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of team
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"team" url:"team,key"` // identity of team
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when app was updated
    WebURL    string    `json:"web_url" url:"web_url,key"`       // web URL of app
}

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

type AppCreateOpts Uses

type AppCreateOpts struct {
    Name   *string `json:"name,omitempty" url:"name,omitempty,key"`     // unique name of app
    Region *string `json:"region,omitempty" url:"region,omitempty,key"` // unique identifier of region
    Stack  *string `json:"stack,omitempty" url:"stack,omitempty,key"`   // unique name of stack
}

type AppFeature Uses

type AppFeature struct {
    CreatedAt     time.Time `json:"created_at" url:"created_at,key"`         // when app feature was created
    Description   string    `json:"description" url:"description,key"`       // description of app feature
    DisplayName   string    `json:"display_name" url:"display_name,key"`     // user readable feature name
    DocURL        string    `json:"doc_url" url:"doc_url,key"`               // documentation URL of app feature
    Enabled       bool      `json:"enabled" url:"enabled,key"`               // whether or not app feature has been enabled
    FeedbackEmail string    `json:"feedback_email" url:"feedback_email,key"` // e-mail to send feedback about the feature
    ID            string    `json:"id" url:"id,key"`                         // unique identifier of app feature
    Name          string    `json:"name" url:"name,key"`                     // unique name of app feature
    State         string    `json:"state" url:"state,key"`                   // state of app feature
    UpdatedAt     time.Time `json:"updated_at" url:"updated_at,key"`         // when app feature was updated
}

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

type AppFeatureListResult Uses

type AppFeatureListResult []AppFeature

type AppFeatureUpdateOpts Uses

type AppFeatureUpdateOpts struct {
    Enabled bool `json:"enabled" url:"enabled,key"` // whether or not app feature has been enabled
}

type AppFormationSet Uses

type AppFormationSet struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // app being described by the formation-set
    Description string    `json:"description" url:"description,key"`   // a string representation of the formation set
    ProcessTier string    `json:"process_tier" url:"process_tier,key"` // application process tier
    UpdatedAt   time.Time `json:"updated_at" url:"updated_at,key"`     // last time fomation-set was updated
}

App formation set describes the combination of process types with their quantities and sizes as well as application process tier

type AppListOwnedAndCollaboratedResult Uses

type AppListOwnedAndCollaboratedResult []App

type AppListResult Uses

type AppListResult []App

type AppSetup Uses

type AppSetup struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // identity of app
    Build *struct {
        ID              string `json:"id" url:"id,key"`                               // unique identifier of build
        OutputStreamURL string `json:"output_stream_url" url:"output_stream_url,key"` // Build process output will be available from this URL as a stream. The
        // stream is available as either `text/plain` or `text/event-stream`.
        // Clients should be prepared to handle disconnects and can resume the
        // stream by sending a `Range` header (for `text/plain`) or a
        // `Last-Event-Id` header (for `text/event-stream`).
        Status string `json:"status" url:"status,key"` // status of build
    }   `json:"build" url:"build,key"` // identity and status of build
    CreatedAt      time.Time `json:"created_at" url:"created_at,key"`           // when app setup was created
    FailureMessage *string   `json:"failure_message" url:"failure_message,key"` // reason that app setup has failed
    ID             string    `json:"id" url:"id,key"`                           // unique identifier of app setup
    ManifestErrors []string  `json:"manifest_errors" url:"manifest_errors,key"` // errors associated with invalid app.json manifest file
    Postdeploy     *struct {
        ExitCode int    `json:"exit_code" url:"exit_code,key"` // The exit code of the postdeploy script
        Output   string `json:"output" url:"output,key"`       // output of the postdeploy script
    }   `json:"postdeploy" url:"postdeploy,key"` // result of postdeploy script
    ResolvedSuccessURL *string   `json:"resolved_success_url" url:"resolved_success_url,key"` // fully qualified success url
    Status             string    `json:"status" url:"status,key"`                             // the overall status of app setup
    UpdatedAt          time.Time `json:"updated_at" url:"updated_at,key"`                     // when app setup was updated
}

An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.

type AppSetupCreateOpts Uses

type AppSetupCreateOpts struct {
    App *struct {
        Locked       *bool   `json:"locked,omitempty" url:"locked,omitempty,key"`             // are other team members forbidden from joining this app.
        Name         *string `json:"name,omitempty" url:"name,omitempty,key"`                 // unique name of app
        Organization *string `json:"organization,omitempty" url:"organization,omitempty,key"` // unique name of team
        Personal     *bool   `json:"personal,omitempty" url:"personal,omitempty,key"`         // force creation of the app in the user account even if a default team
        // is set.
        Region *string `json:"region,omitempty" url:"region,omitempty,key"` // unique name of region
        Space  *string `json:"space,omitempty" url:"space,omitempty,key"`   // unique name of space
        Stack  *string `json:"stack,omitempty" url:"stack,omitempty,key"`   // unique name of stack
    }   `json:"app,omitempty" url:"app,omitempty,key"` // optional parameters for created app
    Overrides *struct {
        Buildpacks []*struct {
            URL *string `json:"url,omitempty" url:"url,omitempty,key"` // location of the buildpack
        }   `json:"buildpacks,omitempty" url:"buildpacks,omitempty,key"` // overrides the buildpacks specified in the app.json manifest file
        Env map[string]string `json:"env,omitempty" url:"env,omitempty,key"` // overrides of the env specified in the app.json manifest file
    }   `json:"overrides,omitempty" url:"overrides,omitempty,key"` // overrides of keys in the app.json manifest file
    SourceBlob struct {
        Checksum *string `json:"checksum,omitempty" url:"checksum,omitempty,key"` // an optional checksum of the gzipped tarball for verifying its
        // integrity
        URL *string `json:"url,omitempty" url:"url,omitempty,key"` // URL of gzipped tarball of source code containing app.json manifest
        // file
        Version *string `json:"version,omitempty" url:"version,omitempty,key"` // Version of the gzipped tarball.
    }   `json:"source_blob" url:"source_blob,key"` // gzipped tarball of source code containing app.json manifest file
}

type AppTransfer Uses

type AppTransfer struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // app involved in the transfer
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when app transfer was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of app transfer
    Owner     struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"owner" url:"owner,key"` // identity of the owner of the transfer
    Recipient struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"recipient" url:"recipient,key"` // identity of the recipient of the transfer
    State     string    `json:"state" url:"state,key"`           // the current state of an app transfer
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when app transfer was updated
}

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

type AppTransferCreateOpts Uses

type AppTransferCreateOpts struct {
    App       string `json:"app" url:"app,key"`                           // unique identifier of app
    Recipient string `json:"recipient" url:"recipient,key"`               // unique email address of account
    Silent    *bool  `json:"silent,omitempty" url:"silent,omitempty,key"` // whether to suppress email notification when transferring apps
}

type AppTransferListResult Uses

type AppTransferListResult []AppTransfer

type AppTransferUpdateOpts Uses

type AppTransferUpdateOpts struct {
    State string `json:"state" url:"state,key"` // the current state of an app transfer
}

type AppUpdateOpts Uses

type AppUpdateOpts struct {
    BuildStack  *string `json:"build_stack,omitempty" url:"build_stack,omitempty,key"` // unique name of stack
    Maintenance *bool   `json:"maintenance,omitempty" url:"maintenance,omitempty,key"` // maintenance status of app
    Name        *string `json:"name,omitempty" url:"name,omitempty,key"`               // unique name of app
}

type AppWebhook Uses

type AppWebhook struct{}

Represents the details of a webhook subscription

type AppWebhookCreateOpts Uses

type AppWebhookCreateOpts struct {
    Authorization *string `json:"authorization,omitempty" url:"authorization,omitempty,key"` // a custom `Authorization` header that Heroku will include with all
    // webhook notifications
    Include []string `json:"include" url:"include,key"` // the entities that the subscription provides notifications for
    Level   string   `json:"level" url:"level,key"`     // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    Secret *string `json:"secret,omitempty" url:"secret,omitempty,key"` // a value that Heroku will use to sign all webhook notification
    // requests (the signature is included in the request’s
    // `Heroku-Webhook-Hmac-SHA256` header)
    URL string `json:"url" url:"url,key"` // the URL where the webhook's notification requests are sent
}

type AppWebhookCreateResult Uses

type AppWebhookCreateResult struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // identity of app. Only used for customer webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type AppWebhookDeleteResult Uses

type AppWebhookDeleteResult struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // identity of app. Only used for customer webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type AppWebhookDelivery Uses

type AppWebhookDelivery struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the delivery was created
    Event     struct {
        ID      string `json:"id" url:"id,key"`           // the event's unique identifier
        Include string `json:"include" url:"include,key"` // the type of entity that the event is related to
    }   `json:"event" url:"event,key"` // identity of event
    ID          string `json:"id" url:"id,key"` // the delivery's unique identifier
    LastAttempt *struct {
        Code       *int      `json:"code" url:"code,key"`               // http response code received during attempt
        CreatedAt  time.Time `json:"created_at" url:"created_at,key"`   // when attempt was created
        ErrorClass *string   `json:"error_class" url:"error_class,key"` // error class encountered during attempt
        ID         string    `json:"id" url:"id,key"`                   // unique identifier of attempt
        Status     string    `json:"status" url:"status,key"`           // status of an attempt
        UpdatedAt  time.Time `json:"updated_at" url:"updated_at,key"`   // when attempt was updated
    }   `json:"last_attempt" url:"last_attempt,key"` // last attempt of a delivery
    NextAttemptAt *time.Time `json:"next_attempt_at" url:"next_attempt_at,key"` // when delivery will be attempted again
    NumAttempts   int        `json:"num_attempts" url:"num_attempts,key"`       // number of times a delivery has been attempted
    Status        string     `json:"status" url:"status,key"`                   // the delivery's status
    UpdatedAt     time.Time  `json:"updated_at" url:"updated_at,key"`           // when the delivery was last updated
    Webhook       struct {
        ID    string `json:"id" url:"id,key"`       // the webhook's unique identifier
        Level string `json:"level" url:"level,key"` // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.

    }   `json:"webhook" url:"webhook,key"` // identity of webhook
}

Represents the delivery of a webhook notification, including its current status.

type AppWebhookDeliveryListResult Uses

type AppWebhookDeliveryListResult []AppWebhookDelivery

type AppWebhookEvent Uses

type AppWebhookEvent struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when event was created
    ID        string    `json:"id" url:"id,key"`                 // the event's unique identifier
    Include   string    `json:"include" url:"include,key"`       // the type of entity that the event is related to
    Payload   struct {
        Action string `json:"action" url:"action,key"` // the type of event that occurred
        Actor  struct {
            Email string `json:"email" url:"email,key"` // unique email address of account
            ID    string `json:"id" url:"id,key"`       // unique identifier of an account
        }   `json:"actor" url:"actor,key"` // user that caused event
        Data         struct{} `json:"data" url:"data,key"`                   // the current details of the event
        PreviousData struct{} `json:"previous_data" url:"previous_data,key"` // previous details of the event (if any)
        Resource     string   `json:"resource" url:"resource,key"`           // the type of resource associated with the event
        Version      string   `json:"version" url:"version,key"`             // the version of the details provided for the event
    }   `json:"payload" url:"payload,key"` // payload of event
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the event was last updated
}

Represents a webhook event that occurred.

type AppWebhookEventListResult Uses

type AppWebhookEventListResult []AppWebhookEvent

type AppWebhookInfoResult Uses

type AppWebhookInfoResult struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // identity of app. Only used for customer webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type AppWebhookListResult Uses

type AppWebhookListResult []struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // identity of app. Only used for customer webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type AppWebhookUpdateOpts Uses

type AppWebhookUpdateOpts struct {
    Authorization *string `json:"authorization,omitempty" url:"authorization,omitempty,key"` // a custom `Authorization` header that Heroku will include with all
    // webhook notifications
    Include []*string `json:"include,omitempty" url:"include,omitempty,key"` // the entities that the subscription provides notifications for
    Level   *string   `json:"level,omitempty" url:"level,omitempty,key"`     // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    Secret *string `json:"secret,omitempty" url:"secret,omitempty,key"` // a value that Heroku will use to sign all webhook notification
    // requests (the signature is included in the request’s
    // `Heroku-Webhook-Hmac-SHA256` header)
    URL *string `json:"url,omitempty" url:"url,omitempty,key"` // the URL where the webhook's notification requests are sent
}

type AppWebhookUpdateResult Uses

type AppWebhookUpdateResult struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // identity of app. Only used for customer webhooks.
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when the webhook was created
    ID        string    `json:"id" url:"id,key"`                 // the webhook's unique identifier
    Include   []string  `json:"include" url:"include,key"`       // the entities that the subscription provides notifications for
    Level     string    `json:"level" url:"level,key"`           // if `notify`, Heroku makes a single, fire-and-forget delivery attempt.
    // If `sync`, Heroku attempts multiple deliveries until the request is
    // successful or a limit is reached
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the webhook was updated
    URL       string    `json:"url" url:"url,key"`               // the URL where the webhook's notification requests are sent
}

type Build Uses

type Build struct {
    App struct {
        ID string `json:"id" url:"id,key"` // unique identifier of app
    }   `json:"app" url:"app,key"` // app that the build belongs to
    Buildpacks []struct {
        Name string `json:"name" url:"name,key"` // Buildpack Registry name of the buildpack for the app
        URL  string `json:"url" url:"url,key"`   // the URL of the buildpack for the app
    }   `json:"buildpacks" url:"buildpacks,key"` // buildpacks executed for this build, in order
    CreatedAt       time.Time `json:"created_at" url:"created_at,key"`               // when build was created
    ID              string    `json:"id" url:"id,key"`                               // unique identifier of build
    OutputStreamURL string    `json:"output_stream_url" url:"output_stream_url,key"` // Build process output will be available from this URL as a stream. The
    // stream is available as either `text/plain` or `text/event-stream`.
    // Clients should be prepared to handle disconnects and can resume the
    // stream by sending a `Range` header (for `text/plain`) or a
    // `Last-Event-Id` header (for `text/event-stream`).
    Release *struct {
        ID string `json:"id" url:"id,key"` // unique identifier of release
    }   `json:"release" url:"release,key"` // release resulting from the build
    Slug *struct {
        ID string `json:"id" url:"id,key"` // unique identifier of slug
    }   `json:"slug" url:"slug,key"` // slug created by this build
    SourceBlob struct {
        Checksum *string `json:"checksum" url:"checksum,key"` // an optional checksum of the gzipped tarball for verifying its
        // integrity
        URL string `json:"url" url:"url,key"` // URL where gzipped tar archive of source code for build was
        // downloaded.
        Version *string `json:"version" url:"version,key"` // Version of the gzipped tarball.
    }   `json:"source_blob" url:"source_blob,key"` // location of gzipped tarball of source code used to create build
    Stack     string    `json:"stack" url:"stack,key"`           // stack of build
    Status    string    `json:"status" url:"status,key"`         // status of build
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when build was updated
    User      struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"user" url:"user,key"` // user that started the build
}

A build represents the process of transforming a code tarball into a slug

type BuildCreateOpts Uses

type BuildCreateOpts struct {
    Buildpacks []*struct {
        Name *string `json:"name,omitempty" url:"name,omitempty,key"` // Buildpack Registry name of the buildpack for the app
        URL  *string `json:"url,omitempty" url:"url,omitempty,key"`   // the URL of the buildpack for the app
    }   `json:"buildpacks,omitempty" url:"buildpacks,omitempty,key"` // buildpacks executed for this build, in order
    SourceBlob struct {
        Checksum *string `json:"checksum,omitempty" url:"checksum,omitempty,key"` // an optional checksum of the gzipped tarball for verifying its
        // integrity
        URL *string `json:"url,omitempty" url:"url,omitempty,key"` // URL where gzipped tar archive of source code for build was
        // downloaded.
        Version *string `json:"version,omitempty" url:"version,omitempty,key"` // Version of the gzipped tarball.
    }   `json:"source_blob" url:"source_blob,key"` // location of gzipped tarball of source code used to create build
}

type BuildListResult Uses

type BuildListResult []Build

type BuildpackInstallation Uses

type BuildpackInstallation struct {
    Buildpack struct {
        Name string `json:"name" url:"name,key"` // either the Buildpack Registry name or a URL of the buildpack for the
        // app
        URL string `json:"url" url:"url,key"` // location of the buildpack for the app. Either a url (unofficial

    }   `json:"buildpack" url:"buildpack,key"` // buildpack
    Ordinal int `json:"ordinal" url:"ordinal,key"` // determines the order in which the buildpacks will execute
}

A buildpack installation represents a buildpack that will be run against an app.

type BuildpackInstallationListResult Uses

type BuildpackInstallationListResult []BuildpackInstallation

type BuildpackInstallationUpdateOpts Uses

type BuildpackInstallationUpdateOpts struct {
    Updates []struct {
        Buildpack string `json:"buildpack" url:"buildpack,key"` // location of the buildpack for the app. Either a url (unofficial

    } `json:"updates" url:"updates,key"` // The buildpack attribute can accept a name, a url, or a urn.
}

type BuildpackInstallationUpdateResult Uses

type BuildpackInstallationUpdateResult []BuildpackInstallation

type Collaborator Uses

type Collaborator struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // app collaborator belongs to
    CreatedAt   time.Time `json:"created_at" url:"created_at,key"` // when collaborator was created
    ID          string    `json:"id" url:"id,key"`                 // unique identifier of collaborator
    Permissions []struct {
        Description string `json:"description" url:"description,key"` // A description of what the app permission allows.
        Name        string `json:"name" url:"name,key"`               // The name of the app permission.
    }   `json:"permissions" url:"permissions,key"`
    Role      *string   `json:"role" url:"role,key"`             // role in the team
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when collaborator was updated
    User      struct {
        Email     string `json:"email" url:"email,key"`         // unique email address of account
        Federated bool   `json:"federated" url:"federated,key"` // whether the user is federated and belongs to an Identity Provider
        ID        string `json:"id" url:"id,key"`               // unique identifier of an account
    }   `json:"user" url:"user,key"` // identity of collaborated account
}

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

type CollaboratorCreateOpts Uses

type CollaboratorCreateOpts struct {
    Silent *bool  `json:"silent,omitempty" url:"silent,omitempty,key"` // whether to suppress email invitation when creating collaborator
    User   string `json:"user" url:"user,key"`                         // unique email address of account
}

type CollaboratorListResult Uses

type CollaboratorListResult []Collaborator

type ConfigVar Uses

type ConfigVar map[string]string

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

type ConfigVarInfoForAppReleaseResult Uses

type ConfigVarInfoForAppReleaseResult map[string]*string

type ConfigVarInfoForAppResult Uses

type ConfigVarInfoForAppResult map[string]*string

type ConfigVarUpdateResult Uses

type ConfigVarUpdateResult map[string]*string

type Credit Uses

type Credit struct {
    Amount    float64   `json:"amount" url:"amount,key"`         // total value of credit in cents
    Balance   float64   `json:"balance" url:"balance,key"`       // remaining value of credit in cents
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when credit was created
    ExpiresAt time.Time `json:"expires_at" url:"expires_at,key"` // when credit will expire
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of credit
    Title     string    `json:"title" url:"title,key"`           // a name for credit
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when credit was updated
}

A credit represents value that will be used up before further charges are assigned to an account.

type CreditCreateOpts Uses

type CreditCreateOpts struct {
    Code1 *string `json:"code1,omitempty" url:"code1,omitempty,key"` // first code from a discount card
    Code2 *string `json:"code2,omitempty" url:"code2,omitempty,key"` // second code from a discount card
}

type CreditListResult Uses

type CreditListResult []Credit

type Domain Uses

type Domain struct {
    AcmStatus       *string `json:"acm_status" url:"acm_status,key"`               // status of this record's ACM
    AcmStatusReason *string `json:"acm_status_reason" url:"acm_status_reason,key"` // reason for the status of this record's ACM
    App             struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // app that owns the domain
    CName     *string   `json:"cname" url:"cname,key"`           // canonical name record, the address to point a domain at
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when domain was created
    Hostname  string    `json:"hostname" url:"hostname,key"`     // full hostname
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of this domain
    Kind      string    `json:"kind" url:"kind,key"`             // type of domain name
    Status    string    `json:"status" url:"status,key"`         // status of this record's cname
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when domain was updated
}

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

type DomainCreateOpts Uses

type DomainCreateOpts struct {
    Hostname string `json:"hostname" url:"hostname,key"` // full hostname
}

type DomainListResult Uses

type DomainListResult []Domain

type Dyno Uses

type Dyno struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // app formation belongs to
    AttachURL *string `json:"attach_url" url:"attach_url,key"` // a URL to stream output from for attached processes or null for
    // non-attached processes
    Command   string    `json:"command" url:"command,key"`       // command used to start this process
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when dyno was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of this dyno
    Name      string    `json:"name" url:"name,key"`             // the name of this process on this dyno
    Release   struct {
        ID      string `json:"id" url:"id,key"`           // unique identifier of release
        Version int    `json:"version" url:"version,key"` // unique version assigned to the release
    }   `json:"release" url:"release,key"` // app release of the dyno
    Size  string `json:"size" url:"size,key"`   // dyno size (default: "standard-1X")
    State string `json:"state" url:"state,key"` // current status of process (either: crashed, down, idle, starting, or
    // up)
    Type      string    `json:"type" url:"type,key"`             // type of process
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when process last changed state
}

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](https://devcenter.h eroku.com/articles/dyno-types).

type DynoCreateOpts Uses

type DynoCreateOpts struct {
    Attach     *bool             `json:"attach,omitempty" url:"attach,omitempty,key"`             // whether to stream output or not
    Command    string            `json:"command" url:"command,key"`                               // command used to start this process
    Env        map[string]string `json:"env,omitempty" url:"env,omitempty,key"`                   // custom environment to add to the dyno config vars
    ForceNoTty *bool             `json:"force_no_tty,omitempty" url:"force_no_tty,omitempty,key"` // force an attached one-off dyno to not run in a tty
    Size       *string           `json:"size,omitempty" url:"size,omitempty,key"`                 // dyno size (default: "standard-1X")
    TimeToLive *int              `json:"time_to_live,omitempty" url:"time_to_live,omitempty,key"` // seconds until dyno expires, after which it will soon be killed, max
    // 86400 seconds (24 hours)
    Type *string `json:"type,omitempty" url:"type,omitempty,key"` // type of process
}

type DynoListResult Uses

type DynoListResult []Dyno

type DynoRestartAllResult Uses

type DynoRestartAllResult struct{}

type DynoRestartResult Uses

type DynoRestartResult struct{}

type DynoSize Uses

type DynoSize struct {
    Compute          int       `json:"compute" url:"compute,key"`                       // minimum vCPUs, non-dedicated may get more depending on load
    Cost             *struct{} `json:"cost" url:"cost,key"`                             // price information for this dyno size
    Dedicated        bool      `json:"dedicated" url:"dedicated,key"`                   // whether this dyno will be dedicated to one user
    DynoUnits        int       `json:"dyno_units" url:"dyno_units,key"`                 // unit of consumption for Heroku Enterprise customers
    ID               string    `json:"id" url:"id,key"`                                 // unique identifier of this dyno size
    Memory           float64   `json:"memory" url:"memory,key"`                         // amount of RAM in GB
    Name             string    `json:"name" url:"name,key"`                             // the name of this dyno-size
    PrivateSpaceOnly bool      `json:"private_space_only" url:"private_space_only,key"` // whether this dyno can only be provisioned in a private space
}

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](https://devcenter.h eroku.com/articles/dyno-types).

type DynoSizeListResult Uses

type DynoSizeListResult []DynoSize

type DynoStopResult Uses

type DynoStopResult struct{}

type Error Uses

type Error struct {
    ID  string
    URL string
    // StatusCode is the HTTP status code returned from the remote server.
    StatusCode int
    // contains filtered or unexported fields
}

type FilterApps Uses

type FilterApps struct{}

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.

type FilterAppsAppsOpts Uses

type FilterAppsAppsOpts struct {
    In *struct {
        ID []*string `json:"id,omitempty" url:"id,omitempty,key"`
    } `json:"in,omitempty" url:"in,omitempty,key"`
}

type FilterAppsAppsResult Uses

type FilterAppsAppsResult []struct {
    ArchivedAt *time.Time `json:"archived_at" url:"archived_at,key"` // when app was archived
    BuildStack struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"build_stack" url:"build_stack,key"` // identity of the stack that will be used for new builds
    BuildpackProvidedDescription *string   `json:"buildpack_provided_description" url:"buildpack_provided_description,key"` // description from buildpack of app
    CreatedAt                    time.Time `json:"created_at" url:"created_at,key"`                                         // when app was created
    GitURL                       string    `json:"git_url" url:"git_url,key"`                                               // git repo URL of app
    ID                           string    `json:"id" url:"id,key"`                                                         // unique identifier of app
    InternalRouting              *bool     `json:"internal_routing" url:"internal_routing,key"`                             // describes whether a Private Spaces app is externally routable or not
    Joined                       bool      `json:"joined" url:"joined,key"`                                                 // is the current member a collaborator on this app.
    Locked                       bool      `json:"locked" url:"locked,key"`                                                 // are other team members forbidden from joining this app.
    Maintenance                  bool      `json:"maintenance" url:"maintenance,key"`                                       // maintenance status of app
    Name                         string    `json:"name" url:"name,key"`                                                     // unique name of app
    Owner                        *struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"owner" url:"owner,key"` // identity of app owner
    Region struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of region
        Name string `json:"name" url:"name,key"` // unique name of region
    }   `json:"region" url:"region,key"` // identity of app region
    ReleasedAt *time.Time `json:"released_at" url:"released_at,key"` // when app was released
    RepoSize   *int       `json:"repo_size" url:"repo_size,key"`     // git repo size in bytes of app
    SlugSize   *int       `json:"slug_size" url:"slug_size,key"`     // slug size in bytes of app
    Space      *struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of space
        Name string `json:"name" url:"name,key"` // unique name of space
    }   `json:"space" url:"space,key"` // identity of space
    Stack struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"stack" url:"stack,key"` // identity of app stack
    Team *struct {
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"team" url:"team,key"` // team that owns this app
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when app was updated
    WebURL    string    `json:"web_url" url:"web_url,key"`       // web URL of app
}

type Formation Uses

type Formation struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // app formation belongs to
    Command   string    `json:"command" url:"command,key"`       // command to use to launch this process
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when process type was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of this process type
    Quantity  int       `json:"quantity" url:"quantity,key"`     // number of processes to maintain
    Size      string    `json:"size" url:"size,key"`             // dyno size (default: "standard-1X")
    Type      string    `json:"type" url:"type,key"`             // type of process to maintain
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when dyno type was updated
}

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](#slug) currently released on an app.

type FormationBatchUpdateOpts Uses

type FormationBatchUpdateOpts struct {
    Updates []struct {
        Quantity *int    `json:"quantity,omitempty" url:"quantity,omitempty,key"` // number of processes to maintain
        Size     *string `json:"size,omitempty" url:"size,omitempty,key"`         // dyno size (default: "standard-1X")
        Type     string  `json:"type" url:"type,key"`                             // type of process to maintain
    } `json:"updates" url:"updates,key"` // Array with formation updates. Each element must have "type", the id

}

type FormationBatchUpdateResult Uses

type FormationBatchUpdateResult []Formation

type FormationListResult Uses

type FormationListResult []Formation

type FormationUpdateOpts Uses

type FormationUpdateOpts struct {
    Quantity *int    `json:"quantity,omitempty" url:"quantity,omitempty,key"` // number of processes to maintain
    Size     *string `json:"size,omitempty" url:"size,omitempty,key"`         // dyno size (default: "standard-1X")
}

type IdentityProvider Uses

type IdentityProvider struct {
    Certificate  string    `json:"certificate" url:"certificate,key"` // raw contents of the public certificate (eg: .crt or .pem file)
    CreatedAt    time.Time `json:"created_at" url:"created_at,key"`   // when provider record was created
    EntityID     string    `json:"entity_id" url:"entity_id,key"`     // URL identifier provided by the identity provider
    ID           string    `json:"id" url:"id,key"`                   // unique identifier of this identity provider
    Organization *struct {
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"organization" url:"organization,key"` // team associated with this identity provider
    Owner struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of the owner
        Name string `json:"name" url:"name,key"` // name of the owner
        Type string `json:"type" url:"type,key"` // type of the owner
    }   `json:"owner" url:"owner,key"` // entity that owns this identity provider
    SloTargetURL string    `json:"slo_target_url" url:"slo_target_url,key"` // single log out URL for this identity provider
    SsoTargetURL string    `json:"sso_target_url" url:"sso_target_url,key"` // single sign on URL for this identity provider
    UpdatedAt    time.Time `json:"updated_at" url:"updated_at,key"`         // when the identity provider record was updated
}

Identity Providers represent the SAML configuration of an Team.

type IdentityProviderCreateByTeamOpts Uses

type IdentityProviderCreateByTeamOpts struct {
    Certificate  string  `json:"certificate" url:"certificate,key"`                           // raw contents of the public certificate (eg: .crt or .pem file)
    EntityID     string  `json:"entity_id" url:"entity_id,key"`                               // URL identifier provided by the identity provider
    SloTargetURL *string `json:"slo_target_url,omitempty" url:"slo_target_url,omitempty,key"` // single log out URL for this identity provider
    SsoTargetURL string  `json:"sso_target_url" url:"sso_target_url,key"`                     // single sign on URL for this identity provider
}

type IdentityProviderListByTeamResult Uses

type IdentityProviderListByTeamResult []IdentityProvider

type IdentityProviderUpdateByTeamOpts Uses

type IdentityProviderUpdateByTeamOpts struct {
    Certificate  *string `json:"certificate,omitempty" url:"certificate,omitempty,key"`       // raw contents of the public certificate (eg: .crt or .pem file)
    EntityID     *string `json:"entity_id,omitempty" url:"entity_id,omitempty,key"`           // URL identifier provided by the identity provider
    SloTargetURL *string `json:"slo_target_url,omitempty" url:"slo_target_url,omitempty,key"` // single log out URL for this identity provider
    SsoTargetURL *string `json:"sso_target_url,omitempty" url:"sso_target_url,omitempty,key"` // single sign on URL for this identity provider
}

type InboundRuleset Uses

type InboundRuleset struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when inbound-ruleset was created
    CreatedBy string    `json:"created_by" url:"created_by,key"` // unique email address of account
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of an inbound-ruleset
    Rules     []struct {
        Action string `json:"action" url:"action,key"` // states whether the connection is allowed or denied
        Source string `json:"source" url:"source,key"` // is the request’s source in CIDR notation
    }   `json:"rules" url:"rules,key"`
    Space struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of space
        Name string `json:"name" url:"name,key"` // unique name of space
    }   `json:"space" url:"space,key"` // identity of space
}

An inbound-ruleset is a collection of rules that specify what hosts can or cannot connect to an application.

type InboundRulesetCreateOpts Uses

type InboundRulesetCreateOpts struct {
    Rules []*struct {
        Action string `json:"action" url:"action,key"` // states whether the connection is allowed or denied
        Source string `json:"source" url:"source,key"` // is the request’s source in CIDR notation
    } `json:"rules,omitempty" url:"rules,omitempty,key"`
}

type InboundRulesetListResult Uses

type InboundRulesetListResult []InboundRuleset

type Invoice Uses

type Invoice struct {
    ChargesTotal float64   `json:"charges_total" url:"charges_total,key"` // total charges on this invoice
    CreatedAt    time.Time `json:"created_at" url:"created_at,key"`       // when invoice was created
    CreditsTotal float64   `json:"credits_total" url:"credits_total,key"` // total credits on this invoice
    ID           string    `json:"id" url:"id,key"`                       // unique identifier of this invoice
    Number       int       `json:"number" url:"number,key"`               // human readable invoice number
    PeriodEnd    string    `json:"period_end" url:"period_end,key"`       // the ending date that the invoice covers
    PeriodStart  string    `json:"period_start" url:"period_start,key"`   // the starting date that this invoice covers
    State        int       `json:"state" url:"state,key"`                 // payment status for this invoice (pending, successful, failed)
    Total        float64   `json:"total" url:"total,key"`                 // combined total of charges and credits on this invoice
    UpdatedAt    time.Time `json:"updated_at" url:"updated_at,key"`       // when invoice was updated
}

An invoice is an itemized bill of goods for an account which includes pricing and charges.

type InvoiceAddress Uses

type InvoiceAddress struct {
    Address1          string `json:"address_1" url:"address_1,key"`                     // invoice street address line 1
    Address2          string `json:"address_2" url:"address_2,key"`                     // invoice street address line 2
    City              string `json:"city" url:"city,key"`                               // invoice city
    Country           string `json:"country" url:"country,key"`                         // country
    HerokuID          string `json:"heroku_id" url:"heroku_id,key"`                     // heroku_id identifier reference
    Other             string `json:"other" url:"other,key"`                             // metadata / additional information to go on invoice
    PostalCode        string `json:"postal_code" url:"postal_code,key"`                 // invoice zip code
    State             string `json:"state" url:"state,key"`                             // invoice state
    UseInvoiceAddress bool   `json:"use_invoice_address" url:"use_invoice_address,key"` // flag to use the invoice address for an account or not
}

An invoice address represents the address that should be listed on an invoice.

type InvoiceAddressUpdateOpts Uses

type InvoiceAddressUpdateOpts struct {
    Address1          *string `json:"address_1,omitempty" url:"address_1,omitempty,key"`                     // invoice street address line 1
    Address2          *string `json:"address_2,omitempty" url:"address_2,omitempty,key"`                     // invoice street address line 2
    City              *string `json:"city,omitempty" url:"city,omitempty,key"`                               // invoice city
    Country           *string `json:"country,omitempty" url:"country,omitempty,key"`                         // country
    Other             *string `json:"other,omitempty" url:"other,omitempty,key"`                             // metadata / additional information to go on invoice
    PostalCode        *string `json:"postal_code,omitempty" url:"postal_code,omitempty,key"`                 // invoice zip code
    State             *string `json:"state,omitempty" url:"state,omitempty,key"`                             // invoice state
    UseInvoiceAddress *bool   `json:"use_invoice_address,omitempty" url:"use_invoice_address,omitempty,key"` // flag to use the invoice address for an account or not
}

type InvoiceListResult Uses

type InvoiceListResult []Invoice

type Key Uses

type Key struct {
    Comment     string    `json:"comment" url:"comment,key"`         // comment on the key
    CreatedAt   time.Time `json:"created_at" url:"created_at,key"`   // when key was created
    Email       string    `json:"email" url:"email,key"`             // deprecated. Please refer to 'comment' instead
    Fingerprint string    `json:"fingerprint" url:"fingerprint,key"` // a unique identifying string based on contents
    ID          string    `json:"id" url:"id,key"`                   // unique identifier of this key
    PublicKey   string    `json:"public_key" url:"public_key,key"`   // full public_key as uploaded
    UpdatedAt   time.Time `json:"updated_at" url:"updated_at,key"`   // when key was updated
}

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

type KeyListResult Uses

type KeyListResult []Key

type ListRange Uses

type ListRange struct {
    Field      string
    Max        int
    Descending bool
    FirstID    string
    LastID     string
}

ListRange describes a range.

func (*ListRange) SetHeader Uses

func (lr *ListRange) SetHeader(req *http.Request)

SetHeader set headers on the given Request.

type LogDrain Uses

type LogDrain struct {
    Addon *struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of add-on
        Name string `json:"name" url:"name,key"` // globally unique name of the add-on
    }   `json:"addon" url:"addon,key"` // add-on that created the drain
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when log drain was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of this log drain
    Token     string    `json:"token" url:"token,key"`           // token associated with the log drain
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when log drain was updated
    URL       string    `json:"url" url:"url,key"`               // url associated with the log drain
}

[Log drains](https://devcenter.heroku.com/articles/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.

type LogDrainCreateOpts Uses

type LogDrainCreateOpts struct {
    URL string `json:"url" url:"url,key"` // url associated with the log drain
}

type LogDrainListByAddOnResult Uses

type LogDrainListByAddOnResult []LogDrain

type LogDrainListResult Uses

type LogDrainListResult []LogDrain

type LogDrainUpdateOpts Uses

type LogDrainUpdateOpts struct {
    URL string `json:"url" url:"url,key"` // url associated with the log drain
}

type LogSession Uses

type LogSession struct {
    CreatedAt  time.Time `json:"created_at" url:"created_at,key"`   // when log connection was created
    ID         string    `json:"id" url:"id,key"`                   // unique identifier of this log session
    LogplexURL string    `json:"logplex_url" url:"logplex_url,key"` // URL for log streaming session
    UpdatedAt  time.Time `json:"updated_at" url:"updated_at,key"`   // when log session was updated
}

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

type LogSessionCreateOpts Uses

type LogSessionCreateOpts struct {
    Dyno   *string `json:"dyno,omitempty" url:"dyno,omitempty,key"`     // dyno to limit results to
    Lines  *int    `json:"lines,omitempty" url:"lines,omitempty,key"`   // number of log lines to stream at once
    Source *string `json:"source,omitempty" url:"source,omitempty,key"` // log source to limit results to
    Tail   *bool   `json:"tail,omitempty" url:"tail,omitempty,key"`     // whether to stream ongoing logs
}

type OAuthAuthorization Uses

type OAuthAuthorization struct {
    AccessToken *struct {
        ExpiresIn *int `json:"expires_in" url:"expires_in,key"` // seconds until OAuth token expires; may be `null` for tokens with
        // indefinite lifetime
        ID    string `json:"id" url:"id,key"`       // unique identifier of OAuth token
        Token string `json:"token" url:"token,key"` // contents of the token to be used for authorization
    }   `json:"access_token" url:"access_token,key"` // access token for this authorization
    Client *struct {
        ID          string `json:"id" url:"id,key"`                     // unique identifier of this OAuth client
        Name        string `json:"name" url:"name,key"`                 // OAuth client name
        RedirectURI string `json:"redirect_uri" url:"redirect_uri,key"` // endpoint for redirection after authorization with OAuth client
    }   `json:"client" url:"client,key"` // identifier of the client that obtained this authorization, if any
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when OAuth authorization was created
    Grant     *struct {
        Code      string `json:"code" url:"code,key"`             // grant code received from OAuth web application authorization
        ExpiresIn int    `json:"expires_in" url:"expires_in,key"` // seconds until OAuth grant expires
        ID        string `json:"id" url:"id,key"`                 // unique identifier of OAuth grant
    }   `json:"grant" url:"grant,key"` // this authorization's grant
    ID           string `json:"id" url:"id,key"` // unique identifier of OAuth authorization
    RefreshToken *struct {
        ExpiresIn *int `json:"expires_in" url:"expires_in,key"` // seconds until OAuth token expires; may be `null` for tokens with
        // indefinite lifetime
        ID    string `json:"id" url:"id,key"`       // unique identifier of OAuth token
        Token string `json:"token" url:"token,key"` // contents of the token to be used for authorization
    }   `json:"refresh_token" url:"refresh_token,key"` // refresh token for this authorization
    Scope     []string  `json:"scope" url:"scope,key"`           // The scope of access OAuth authorization allows
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when OAuth authorization was updated
    User      struct {
        Email    string  `json:"email" url:"email,key"`         // unique email address of account
        FullName *string `json:"full_name" url:"full_name,key"` // full name of the account owner
        ID       string  `json:"id" url:"id,key"`               // unique identifier of an account
    }   `json:"user" url:"user,key"` // authenticated user associated with this authorization
}

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](https://devcenter.heroku.com/articles/oauth)

type OAuthAuthorizationCreateOpts Uses

type OAuthAuthorizationCreateOpts struct {
    Client      *string `json:"client,omitempty" url:"client,omitempty,key"`           // unique identifier of this OAuth client
    Description *string `json:"description,omitempty" url:"description,omitempty,key"` // human-friendly description of this OAuth authorization
    ExpiresIn   *int    `json:"expires_in,omitempty" url:"expires_in,omitempty,key"`   // seconds until OAuth token expires; may be `null` for tokens with
    // indefinite lifetime
    Scope []string `json:"scope" url:"scope,key"` // The scope of access OAuth authorization allows
}

type OAuthAuthorizationListResult Uses

type OAuthAuthorizationListResult []OAuthAuthorization

type OAuthClient Uses

type OAuthClient struct {
    CreatedAt         time.Time `json:"created_at" url:"created_at,key"`                 // when OAuth client was created
    ID                string    `json:"id" url:"id,key"`                                 // unique identifier of this OAuth client
    IgnoresDelinquent *bool     `json:"ignores_delinquent" url:"ignores_delinquent,key"` // whether the client is still operable given a delinquent account
    Name              string    `json:"name" url:"name,key"`                             // OAuth client name
    RedirectURI       string    `json:"redirect_uri" url:"redirect_uri,key"`             // endpoint for redirection after authorization with OAuth client
    Secret            string    `json:"secret" url:"secret,key"`                         // secret used to obtain OAuth authorizations under this client
    UpdatedAt         time.Time `json:"updated_at" url:"updated_at,key"`                 // when OAuth client was updated
}

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](https://devcenter.heroku.com/articles/oauth).

type OAuthClientCreateOpts Uses

type OAuthClientCreateOpts struct {
    Name        string `json:"name" url:"name,key"`                 // OAuth client name
    RedirectURI string `json:"redirect_uri" url:"redirect_uri,key"` // endpoint for redirection after authorization with OAuth client
}

type OAuthClientListResult Uses

type OAuthClientListResult []OAuthClient

type OAuthClientUpdateOpts Uses

type OAuthClientUpdateOpts struct {
    Name        *string `json:"name,omitempty" url:"name,omitempty,key"`                 // OAuth client name
    RedirectURI *string `json:"redirect_uri,omitempty" url:"redirect_uri,omitempty,key"` // endpoint for redirection after authorization with OAuth client
}

type OAuthGrant Uses

type OAuthGrant struct{}

OAuth grants are used to obtain authorizations on behalf of a user. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)

type OAuthToken Uses

type OAuthToken struct {
    AccessToken struct {
        ExpiresIn *int `json:"expires_in" url:"expires_in,key"` // seconds until OAuth token expires; may be `null` for tokens with
        // indefinite lifetime
        ID    string `json:"id" url:"id,key"`       // unique identifier of OAuth token
        Token string `json:"token" url:"token,key"` // contents of the token to be used for authorization
    }   `json:"access_token" url:"access_token,key"` // current access token
    Authorization struct {
        ID string `json:"id" url:"id,key"` // unique identifier of OAuth authorization
    }   `json:"authorization" url:"authorization,key"` // authorization for this set of tokens
    Client *struct {
        Secret string `json:"secret" url:"secret,key"` // secret used to obtain OAuth authorizations under this client
    }   `json:"client" url:"client,key"` // OAuth client secret used to obtain token
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when OAuth token was created
    Grant     struct {
        Code string `json:"code" url:"code,key"` // grant code received from OAuth web application authorization
        Type string `json:"type" url:"type,key"` // type of grant requested, one of `authorization_code` or

    }   `json:"grant" url:"grant,key"` // grant used on the underlying authorization
    ID           string `json:"id" url:"id,key"` // unique identifier of OAuth token
    RefreshToken struct {
        ExpiresIn *int `json:"expires_in" url:"expires_in,key"` // seconds until OAuth token expires; may be `null` for tokens with
        // indefinite lifetime
        ID    string `json:"id" url:"id,key"`       // unique identifier of OAuth token
        Token string `json:"token" url:"token,key"` // contents of the token to be used for authorization
    }   `json:"refresh_token" url:"refresh_token,key"` // refresh token for this authorization
    Session struct {
        ID string `json:"id" url:"id,key"` // unique identifier of OAuth token
    }   `json:"session" url:"session,key"` // OAuth session using this token
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when OAuth token was updated
    User      struct {
        ID string `json:"id" url:"id,key"` // unique identifier of an account
    }   `json:"user" url:"user,key"` // Reference to the user associated with this token
}

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](https://devcenter.heroku.com/articles/oauth)

type OAuthTokenCreateOpts Uses

type OAuthTokenCreateOpts struct {
    Client struct {
        Secret *string `json:"secret,omitempty" url:"secret,omitempty,key"` // secret used to obtain OAuth authorizations under this client
    }   `json:"client" url:"client,key"`
    Grant struct {
        Code *string `json:"code,omitempty" url:"code,omitempty,key"` // grant code received from OAuth web application authorization
        Type *string `json:"type,omitempty" url:"type,omitempty,key"` // type of grant requested, one of `authorization_code` or

    }   `json:"grant" url:"grant,key"`
    RefreshToken struct {
        Token *string `json:"token,omitempty" url:"token,omitempty,key"` // contents of the token to be used for authorization
    }   `json:"refresh_token" url:"refresh_token,key"`
}

type OutboundRuleset Uses

type OutboundRuleset struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when outbound-ruleset was created
    CreatedBy string    `json:"created_by" url:"created_by,key"` // unique email address of account
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of an outbound-ruleset
    Rules     []struct {
        FromPort int    `json:"from_port" url:"from_port,key"` // an endpoint of communication in an operating system.
        Protocol string `json:"protocol" url:"protocol,key"`   // formal standards and policies comprised of rules, procedures and
        // formats that define communication between two or more devices over a
        // network
        Target string `json:"target" url:"target,key"`   // is the target destination in CIDR notation
        ToPort int    `json:"to_port" url:"to_port,key"` // an endpoint of communication in an operating system.
    }   `json:"rules" url:"rules,key"`
    Space struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of space
        Name string `json:"name" url:"name,key"` // unique name of space
    }   `json:"space" url:"space,key"` // identity of space
}

An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with.

type OutboundRulesetCreateOpts Uses

type OutboundRulesetCreateOpts struct {
    Rules []*struct {
        FromPort int    `json:"from_port" url:"from_port,key"` // an endpoint of communication in an operating system.
        Protocol string `json:"protocol" url:"protocol,key"`   // formal standards and policies comprised of rules, procedures and
        // formats that define communication between two or more devices over a
        // network
        Target string `json:"target" url:"target,key"`   // is the target destination in CIDR notation
        ToPort int    `json:"to_port" url:"to_port,key"` // an endpoint of communication in an operating system.
    } `json:"rules,omitempty" url:"rules,omitempty,key"`
}

type OutboundRulesetListResult Uses

type OutboundRulesetListResult []OutboundRuleset

type PasswordReset Uses

type PasswordReset struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when password reset was created
    User      struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"user" url:"user,key"`
}

A password reset represents a in-process password reset attempt.

type PasswordResetCompleteResetPasswordOpts Uses

type PasswordResetCompleteResetPasswordOpts struct {
    Password             *string `json:"password,omitempty" url:"password,omitempty,key"`                           // current password on the account
    PasswordConfirmation *string `json:"password_confirmation,omitempty" url:"password_confirmation,omitempty,key"` // confirmation of the new password
}

type PasswordResetResetPasswordOpts Uses

type PasswordResetResetPasswordOpts struct {
    Email *string `json:"email,omitempty" url:"email,omitempty,key"` // unique email address of account
}

type Peering Uses

type Peering struct {
    AwsAccountID string    `json:"aws_account_id" url:"aws_account_id,key"` // The AWS account ID of your Private Space.
    AwsRegion    string    `json:"aws_region" url:"aws_region,key"`         // The AWS region of the peer connection.
    AwsVpcID     string    `json:"aws_vpc_id" url:"aws_vpc_id,key"`         // The AWS VPC ID of the peer.
    CIDRBlocks   []string  `json:"cidr_blocks" url:"cidr_blocks,key"`       // The CIDR blocks of the peer.
    Expires      time.Time `json:"expires" url:"expires,key"`               // When a peering connection will expire.
    PcxID        string    `json:"pcx_id" url:"pcx_id,key"`                 // The AWS VPC Peering Connection ID of the peering.
    Status       string    `json:"status" url:"status,key"`                 // The status of the peering connection.
    Type         string    `json:"type" url:"type,key"`                     // The type of peering connection.
}

[Peering](https://devcenter.heroku.com/articles/private-space-peering)

provides a way to peer your Private Space VPC to another AWS VPC.

type PeeringInfo Uses

type PeeringInfo struct {
    AwsAccountID          string   `json:"aws_account_id" url:"aws_account_id,key"`                   // The AWS account ID of your Private Space.
    AwsRegion             string   `json:"aws_region" url:"aws_region,key"`                           // region name used by provider
    DynoCIDRBlocks        []string `json:"dyno_cidr_blocks" url:"dyno_cidr_blocks,key"`               // The CIDR ranges that should be routed to the Private Space VPC.
    SpaceCIDRBlocks       []string `json:"space_cidr_blocks" url:"space_cidr_blocks,key"`             // The CIDR ranges that should be routed to the Private Space VPC.
    UnavailableCIDRBlocks []string `json:"unavailable_cidr_blocks" url:"unavailable_cidr_blocks,key"` // The CIDR ranges that you must not conflict with.
    VpcCIDR               string   `json:"vpc_cidr" url:"vpc_cidr,key"`                               // An IP address and the number of significant bits that make up the
    // routing or networking portion.
    VpcID string `json:"vpc_id" url:"vpc_id,key"` // The AWS VPC ID of the peer.
}

[Peering Info](https://devcenter.heroku.com/articles/private-space-peering) gives you the information necessary to peer an AWS VPC to a Private Space.

type PeeringListResult Uses

type PeeringListResult []Peering

type Pipeline Uses

type Pipeline struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when pipeline was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of pipeline
    Name      string    `json:"name" url:"name,key"`             // name of pipeline
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when pipeline was updated
}

A pipeline allows grouping of apps into different stages.

type PipelineCoupling Uses

type PipelineCoupling struct {
    App struct {
        ID string `json:"id" url:"id,key"` // unique identifier of app
    }   `json:"app" url:"app,key"` // app involved in the pipeline coupling
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when pipeline coupling was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of pipeline coupling
    Pipeline  struct {
        ID string `json:"id" url:"id,key"` // unique identifier of pipeline
    }   `json:"pipeline" url:"pipeline,key"` // pipeline involved in the coupling
    Stage     string    `json:"stage" url:"stage,key"`           // target pipeline stage
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when pipeline coupling was updated
}

Information about an app's coupling to a pipeline

type PipelineCouplingCreateOpts Uses

type PipelineCouplingCreateOpts struct {
    App      string `json:"app" url:"app,key"`           // unique identifier of app
    Pipeline string `json:"pipeline" url:"pipeline,key"` // unique identifier of pipeline
    Stage    string `json:"stage" url:"stage,key"`       // target pipeline stage
}

type PipelineCouplingListByPipelineResult Uses

type PipelineCouplingListByPipelineResult []PipelineCoupling

type PipelineCouplingListForCurrentUserResult Uses

type PipelineCouplingListForCurrentUserResult []PipelineCoupling

type PipelineCouplingListResult Uses

type PipelineCouplingListResult []PipelineCoupling

type PipelineCouplingUpdateOpts Uses

type PipelineCouplingUpdateOpts struct {
    Stage *string `json:"stage,omitempty" url:"stage,omitempty,key"` // target pipeline stage
}

type PipelineCreateOpts Uses

type PipelineCreateOpts struct {
    Name string `json:"name" url:"name,key"` // name of pipeline
}

type PipelineListResult Uses

type PipelineListResult []Pipeline

type PipelinePromotion Uses

type PipelinePromotion struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when promotion was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of promotion
    Pipeline  struct {
        ID string `json:"id" url:"id,key"` // unique identifier of pipeline
    }   `json:"pipeline" url:"pipeline,key"` // the pipeline which the promotion belongs to
    Source struct {
        App struct {
            ID string `json:"id" url:"id,key"` // unique identifier of app
        }   `json:"app" url:"app,key"` // the app which was promoted from
        Release struct {
            ID string `json:"id" url:"id,key"` // unique identifier of release
        }   `json:"release" url:"release,key"` // the release used to promoted from
    }   `json:"source" url:"source,key"` // the app being promoted from
    Status    string     `json:"status" url:"status,key"`         // status of promotion
    UpdatedAt *time.Time `json:"updated_at" url:"updated_at,key"` // when promotion was updated
}

Promotions allow you to move code from an app in a pipeline to all targets

type PipelinePromotionCreateOpts Uses

type PipelinePromotionCreateOpts struct {
    Pipeline struct {
        ID string `json:"id" url:"id,key"` // unique identifier of pipeline
    }   `json:"pipeline" url:"pipeline,key"` // pipeline involved in the promotion
    Source struct {
        App *struct {
            ID *string `json:"id,omitempty" url:"id,omitempty,key"` // unique identifier of app
        } `json:"app,omitempty" url:"app,omitempty,key"` // the app which was promoted from
    }   `json:"source" url:"source,key"` // the app being promoted from
    Targets []struct {
        App *struct {
            ID *string `json:"id,omitempty" url:"id,omitempty,key"` // unique identifier of app
        } `json:"app,omitempty" url:"app,omitempty,key"` // the app is being promoted to
    }   `json:"targets" url:"targets,key"`
}

type PipelinePromotionTarget Uses

type PipelinePromotionTarget struct {
    App struct {
        ID string `json:"id" url:"id,key"` // unique identifier of app
    }   `json:"app" url:"app,key"` // the app which was promoted to
    ErrorMessage      *string `json:"error_message" url:"error_message,key"` // an error message for why the promotion failed
    ID                string  `json:"id" url:"id,key"`                       // unique identifier of promotion target
    PipelinePromotion struct {
        ID string `json:"id" url:"id,key"` // unique identifier of promotion
    }   `json:"pipeline_promotion" url:"pipeline_promotion,key"` // the promotion which the target belongs to
    Release *struct {
        ID string `json:"id" url:"id,key"` // unique identifier of release
    }   `json:"release" url:"release,key"` // the release which was created on the target app
    Status string `json:"status" url:"status,key"` // status of promotion
}

Promotion targets represent an individual app being promoted to

type PipelinePromotionTargetListResult Uses

type PipelinePromotionTargetListResult []PipelinePromotionTarget

type PipelineUpdateOpts Uses

type PipelineUpdateOpts struct {
    Name *string `json:"name,omitempty" url:"name,omitempty,key"` // name of pipeline
}

type Plan Uses

type Plan struct {
    AddonService struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this add-on-service
        Name string `json:"name" url:"name,key"` // unique name of this add-on-service
    }   `json:"addon_service" url:"addon_service,key"` // identity of add-on service
    Compliance                       []string  `json:"compliance" url:"compliance,key"`                                                   // the compliance regimes applied to an add-on plan
    CreatedAt                        time.Time `json:"created_at" url:"created_at,key"`                                                   // when plan was created
    Default                          bool      `json:"default" url:"default,key"`                                                         // whether this plan is the default for its add-on service
    Description                      string    `json:"description" url:"description,key"`                                                 // description of plan
    HumanName                        string    `json:"human_name" url:"human_name,key"`                                                   // human readable name of the add-on plan
    ID                               string    `json:"id" url:"id,key"`                                                                   // unique identifier of this plan
    InstallableInsidePrivateNetwork  bool      `json:"installable_inside_private_network" url:"installable_inside_private_network,key"`   // whether this plan is installable to a Private Spaces app
    InstallableOutsidePrivateNetwork bool      `json:"installable_outside_private_network" url:"installable_outside_private_network,key"` // whether this plan is installable to a Common Runtime app
    Name                             string    `json:"name" url:"name,key"`                                                               // unique name of this plan
    Price                            struct {
        Cents    int    `json:"cents" url:"cents,key"`       // price in cents per unit of plan
        Contract bool   `json:"contract" url:"contract,key"` // price is negotiated in a contract outside of monthly add-on billing
        Unit     string `json:"unit" url:"unit,key"`         // unit of price for plan
    }   `json:"price" url:"price,key"` // price
    SpaceDefault bool      `json:"space_default" url:"space_default,key"` // whether this plan is the default for apps in Private Spaces
    State        string    `json:"state" url:"state,key"`                 // release status for plan
    UpdatedAt    time.Time `json:"updated_at" url:"updated_at,key"`       // when plan was updated
    Visible      bool      `json:"visible" url:"visible,key"`             // whether this plan is publicly visible
}

Plans represent different configurations of add-ons that may be added to apps. Endpoints under add-on services can be accessed without authentication.

type PlanListByAddOnResult Uses

type PlanListByAddOnResult []Plan

type RateLimit Uses

type RateLimit struct {
    Remaining int `json:"remaining" url:"remaining,key"` // allowed requests remaining in current interval
}

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

type Region Uses

type Region struct {
    Country        string    `json:"country" url:"country,key"`                 // country where the region exists
    CreatedAt      time.Time `json:"created_at" url:"created_at,key"`           // when region was created
    Description    string    `json:"description" url:"description,key"`         // description of region
    ID             string    `json:"id" url:"id,key"`                           // unique identifier of region
    Locale         string    `json:"locale" url:"locale,key"`                   // area in the country where the region exists
    Name           string    `json:"name" url:"name,key"`                       // unique name of region
    PrivateCapable bool      `json:"private_capable" url:"private_capable,key"` // whether or not region is available for creating a Private Space
    Provider       struct {
        Name   string `json:"name" url:"name,key"`     // name of provider
        Region string `json:"region" url:"region,key"` // region name used by provider
    }   `json:"provider" url:"provider,key"` // provider of underlying substrate
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when region was updated
}

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

type RegionListResult Uses

type RegionListResult []Region

type Release Uses

type Release struct {
    AddonPlanNames []string `json:"addon_plan_names" url:"addon_plan_names,key"` // add-on plans installed on the app for this release
    App            struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // app involved in the release
    CreatedAt       time.Time `json:"created_at" url:"created_at,key"`               // when release was created
    Current         bool      `json:"current" url:"current,key"`                     // indicates this release as being the current one for the app
    Description     string    `json:"description" url:"description,key"`             // description of changes in this release
    ID              string    `json:"id" url:"id,key"`                               // unique identifier of release
    OutputStreamURL *string   `json:"output_stream_url" url:"output_stream_url,key"` // Release command output will be available from this URL as a stream.
    // The stream is available as either `text/plain` or
    // `text/event-stream`. Clients should be prepared to handle disconnects
    // and can resume the stream by sending a `Range` header (for
    // `text/plain`) or a `Last-Event-Id` header (for `text/event-stream`).
    Slug *struct {
        ID string `json:"id" url:"id,key"` // unique identifier of slug
    }   `json:"slug" url:"slug,key"` // slug running in this release
    Status    string    `json:"status" url:"status,key"`         // current status of the release
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when release was updated
    User      struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"user" url:"user,key"` // user that created the release
    Version int `json:"version" url:"version,key"` // unique version assigned to the release
}

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

type ReleaseCreateOpts Uses

type ReleaseCreateOpts struct {
    Description *string `json:"description,omitempty" url:"description,omitempty,key"` // description of changes in this release
    Slug        string  `json:"slug" url:"slug,key"`                                   // unique identifier of slug
}

type ReleaseListResult Uses

type ReleaseListResult []Release

type ReleaseRollbackOpts Uses

type ReleaseRollbackOpts struct {
    Release string `json:"release" url:"release,key"` // unique identifier of release
}

type RoundTripWithRetryBackoff Uses

type RoundTripWithRetryBackoff struct {
    // Configuration fields for backoff.ExponentialBackOff
    InitialIntervalSeconds int64
    RandomizationFactor    float64
    Multiplier             float64
    MaxIntervalSeconds     int64
    // After MaxElapsedTime the ExponentialBackOff stops.
    // It never stops if MaxElapsedTime == 0.
    MaxElapsedTimeSeconds int64
}

net/http RoundTripper interface, a.k.a. Transport https://godoc.org/net/http#RoundTripper

func (RoundTripWithRetryBackoff) RoundTrip Uses

func (r RoundTripWithRetryBackoff) RoundTrip(req *http.Request) (*http.Response, error)

type SSLEndpoint Uses

type SSLEndpoint struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // application associated with this ssl-endpoint
    CertificateChain string    `json:"certificate_chain" url:"certificate_chain,key"` // raw contents of the public certificate chain (eg: .crt or .pem file)
    CName            string    `json:"cname" url:"cname,key"`                         // canonical name record, the address to point a domain at
    CreatedAt        time.Time `json:"created_at" url:"created_at,key"`               // when endpoint was created
    ID               string    `json:"id" url:"id,key"`                               // unique identifier of this SSL endpoint
    Name             string    `json:"name" url:"name,key"`                           // unique name for SSL endpoint
    UpdatedAt        time.Time `json:"updated_at" url:"updated_at,key"`               // when endpoint was updated
}

[SSL Endpoint](https://devcenter.heroku.com/articles/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.

type SSLEndpointCreateOpts Uses

type SSLEndpointCreateOpts struct {
    CertificateChain string `json:"certificate_chain" url:"certificate_chain,key"`       // raw contents of the public certificate chain (eg: .crt or .pem file)
    Preprocess       *bool  `json:"preprocess,omitempty" url:"preprocess,omitempty,key"` // allow Heroku to modify an uploaded public certificate chain if deemed
    // advantageous by adding missing intermediaries, stripping unnecessary
    // ones, etc.
    PrivateKey string `json:"private_key" url:"private_key,key"` // contents of the private key (eg .key file)
}

type SSLEndpointListResult Uses

type SSLEndpointListResult []SSLEndpoint

type SSLEndpointUpdateOpts Uses

type SSLEndpointUpdateOpts struct {
    CertificateChain *string `json:"certificate_chain,omitempty" url:"certificate_chain,omitempty,key"` // raw contents of the public certificate chain (eg: .crt or .pem file)
    Preprocess       *bool   `json:"preprocess,omitempty" url:"preprocess,omitempty,key"`               // allow Heroku to modify an uploaded public certificate chain if deemed
    // advantageous by adding missing intermediaries, stripping unnecessary
    // ones, etc.
    PrivateKey *string `json:"private_key,omitempty" url:"private_key,omitempty,key"` // contents of the private key (eg .key file)
    Rollback   *bool   `json:"rollback,omitempty" url:"rollback,omitempty,key"`       // indicates that a rollback should be performed
}

type Service Uses

type Service struct {
    URL string
    // contains filtered or unexported fields
}

Service represents your API.

func NewService Uses

func NewService(c *http.Client) *Service

NewService creates a Service using the given, if none is provided it uses http.DefaultClient.

func (*Service) AccountDelete Uses

func (s *Service) AccountDelete(ctx context.Context) (*Account, error)

Delete account. Note that this action cannot be undone.

func (*Service) AccountDeleteByUser Uses

func (s *Service) AccountDeleteByUser(ctx context.Context, accountIdentity string) (*Account, error)

Delete account. Note that this action cannot be undone.

func (*Service) AccountFeatureInfo Uses

func (s *Service) AccountFeatureInfo(ctx context.Context, accountFeatureIdentity string) (*AccountFeature, error)

Info for an existing account feature.

func (*Service) AccountFeatureList Uses

func (s *Service) AccountFeatureList(ctx context.Context, lr *ListRange) (AccountFeatureListResult, error)

List existing account features.

func (*Service) AccountFeatureUpdate Uses

func (s *Service) AccountFeatureUpdate(ctx context.Context, accountFeatureIdentity string, o AccountFeatureUpdateOpts) (*AccountFeature, error)

Update an existing account feature.

func (*Service) AccountInfo Uses

func (s *Service) AccountInfo(ctx context.Context) (*Account, error)

Info for account.

func (*Service) AccountInfoByUser Uses

func (s *Service) AccountInfoByUser(ctx context.Context, accountIdentity string) (*Account, error)

Info for account.

func (*Service) AccountUpdate Uses

func (s *Service) AccountUpdate(ctx context.Context, o AccountUpdateOpts) (*Account, error)

Update account.

func (*Service) AccountUpdateByUser Uses

func (s *Service) AccountUpdateByUser(ctx context.Context, accountIdentity string, o AccountUpdateByUserOpts) (*Account, error)

Update account.

func (*Service) AddOnActionDeprovision Uses

func (s *Service) AddOnActionDeprovision(ctx context.Context, addOnIdentity string) (*AddOnActionDeprovisionResult, error)

Mark an add-on as deprovisioned.

func (*Service) AddOnActionProvision Uses

func (s *Service) AddOnActionProvision(ctx context.Context, addOnIdentity string) (*AddOnActionProvisionResult, error)

Mark an add-on as provisioned for use.

func (*Service) AddOnAttachmentCreate Uses

func (s *Service) AddOnAttachmentCreate(ctx context.Context, o AddOnAttachmentCreateOpts) (*AddOnAttachment, error)

Create a new add-on attachment.

func (*Service) AddOnAttachmentDelete Uses

func (s *Service) AddOnAttachmentDelete(ctx context.Context, addOnAttachmentIdentity string) (*AddOnAttachment, error)

Delete an existing add-on attachment.

func (*Service) AddOnAttachmentInfo Uses

func (s *Service) AddOnAttachmentInfo(ctx context.Context, addOnAttachmentIdentity string) (*AddOnAttachment, error)

Info for existing add-on attachment.

func (*Service) AddOnAttachmentInfoByApp Uses

func (s *Service) AddOnAttachmentInfoByApp(ctx context.Context, appIdentity string, addOnAttachmentScopedIdentity string) (*AddOnAttachment, error)

Info for existing add-on attachment for an app.

func (*Service) AddOnAttachmentList Uses

func (s *Service) AddOnAttachmentList(ctx context.Context, lr *ListRange) (AddOnAttachmentListResult, error)

List existing add-on attachments.

func (*Service) AddOnAttachmentListByAddOn Uses

func (s *Service) AddOnAttachmentListByAddOn(ctx context.Context, addOnIdentity string, lr *ListRange) (AddOnAttachmentListByAddOnResult, error)

List existing add-on attachments for an add-on.

func (*Service) AddOnAttachmentListByApp Uses

func (s *Service) AddOnAttachmentListByApp(ctx context.Context, appIdentity string, lr *ListRange) (AddOnAttachmentListByAppResult, error)

List existing add-on attachments for an app.

func (*Service) AddOnAttachmentResolution Uses

func (s *Service) AddOnAttachmentResolution(ctx context.Context, o AddOnAttachmentResolutionOpts) (AddOnAttachmentResolutionResult, error)

Resolve an add-on attachment from a name, optionally passing an app name. If there are matches it returns at least one add-on attachment (exact match) or many.

func (*Service) AddOnConfigList Uses

func (s *Service) AddOnConfigList(ctx context.Context, addOnIdentity string, lr *ListRange) (AddOnConfigListResult, error)

Get an add-on's config. Accessible by customers with access and by the add-on partner providing this add-on.

func (*Service) AddOnConfigUpdate Uses

func (s *Service) AddOnConfigUpdate(ctx context.Context, addOnIdentity string, o AddOnConfigUpdateOpts) (AddOnConfigUpdateResult, error)

Update an add-on's config. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnCreate Uses

func (s *Service) AddOnCreate(ctx context.Context, appIdentity string, o AddOnCreateOpts) (*AddOn, error)

Create a new add-on.

func (*Service) AddOnDelete Uses

func (s *Service) AddOnDelete(ctx context.Context, appIdentity string, addOnIdentity string) (*AddOn, error)

Delete an existing add-on.

func (*Service) AddOnInfo Uses

func (s *Service) AddOnInfo(ctx context.Context, addOnIdentity string) (*AddOn, error)

Info for an existing add-on.

func (*Service) AddOnInfoByApp Uses

func (s *Service) AddOnInfoByApp(ctx context.Context, appIdentity string, addOnIdentity string) (*AddOn, error)

Info for an existing add-on.

func (*Service) AddOnList Uses

func (s *Service) AddOnList(ctx context.Context, lr *ListRange) (AddOnListResult, error)

List all existing add-ons.

func (*Service) AddOnListByApp Uses

func (s *Service) AddOnListByApp(ctx context.Context, appIdentity string, lr *ListRange) (AddOnListByAppResult, error)

List existing add-ons for an app.

func (*Service) AddOnListByTeam Uses

func (s *Service) AddOnListByTeam(ctx context.Context, teamIdentity string, lr *ListRange) (AddOnListByTeamResult, error)

List add-ons used across all Team apps

func (*Service) AddOnListByUser Uses

func (s *Service) AddOnListByUser(ctx context.Context, accountIdentity string, lr *ListRange) (AddOnListByUserResult, error)

List all existing add-ons a user has access to

func (*Service) AddOnRegionCapabilityList Uses

func (s *Service) AddOnRegionCapabilityList(ctx context.Context, lr *ListRange) (AddOnRegionCapabilityListResult, error)

List all existing add-on region capabilities.

func (*Service) AddOnRegionCapabilityListByAddOnService Uses

func (s *Service) AddOnRegionCapabilityListByAddOnService(ctx context.Context, addOnServiceIdentity string, lr *ListRange) (AddOnRegionCapabilityListByAddOnServiceResult, error)

List existing add-on region capabilities for an add-on-service

func (*Service) AddOnRegionCapabilityListByRegion Uses

func (s *Service) AddOnRegionCapabilityListByRegion(ctx context.Context, regionIdentity string, lr *ListRange) (AddOnRegionCapabilityListByRegionResult, error)

List existing add-on region capabilities for a region.

func (*Service) AddOnResolution Uses

func (s *Service) AddOnResolution(ctx context.Context, o AddOnResolutionOpts) (AddOnResolutionResult, error)

Resolve an add-on from a name, optionally passing an app name. If there are matches it returns at least one add-on (exact match) or many.

func (*Service) AddOnServiceInfo Uses

func (s *Service) AddOnServiceInfo(ctx context.Context, addOnServiceIdentity string) (*AddOnService, error)

Info for existing add-on-service.

func (*Service) AddOnServiceList Uses

func (s *Service) AddOnServiceList(ctx context.Context, lr *ListRange) (AddOnServiceListResult, error)

List existing add-on-services.

func (*Service) AddOnUpdate Uses

func (s *Service) AddOnUpdate(ctx context.Context, appIdentity string, addOnIdentity string, o AddOnUpdateOpts) (*AddOn, error)

Change add-on plan. Some add-ons may not support changing plans. In that case, an error will be returned.

func (*Service) AddOnWebhookCreate Uses

func (s *Service) AddOnWebhookCreate(ctx context.Context, addOnIdentity string, o AddOnWebhookCreateOpts) (*AddOnWebhookCreateResult, error)

Create an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnWebhookDelete Uses

func (s *Service) AddOnWebhookDelete(ctx context.Context, addOnIdentity string, appWebhookIdentity string) (*AddOnWebhookDeleteResult, error)

Removes an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnWebhookDeliveryInfo Uses

func (s *Service) AddOnWebhookDeliveryInfo(ctx context.Context, addOnIdentity string, appWebhookDeliveryIdentity string) (*AddOnWebhookDeliveryInfoResult, error)

Returns the info for an existing delivery. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnWebhookDeliveryList Uses

func (s *Service) AddOnWebhookDeliveryList(ctx context.Context, addOnIdentity string, lr *ListRange) (AddOnWebhookDeliveryListResult, error)

Lists existing deliveries for an add-on. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnWebhookEventInfo Uses

func (s *Service) AddOnWebhookEventInfo(ctx context.Context, addOnIdentity string, appWebhookEventIdentity string) (*AddOnWebhookEventInfoResult, error)

Returns the info for a specified webhook event. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnWebhookEventList Uses

func (s *Service) AddOnWebhookEventList(ctx context.Context, addOnIdentity string, lr *ListRange) (AddOnWebhookEventListResult, error)

Lists existing webhook events for an add-on. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnWebhookInfo Uses

func (s *Service) AddOnWebhookInfo(ctx context.Context, addOnIdentity string, appWebhookIdentity string) (*AddOnWebhookInfoResult, error)

Returns the info for an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnWebhookList Uses

func (s *Service) AddOnWebhookList(ctx context.Context, addOnIdentity string, lr *ListRange) (AddOnWebhookListResult, error)

List all webhook subscriptions for a particular add-on. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AddOnWebhookUpdate Uses

func (s *Service) AddOnWebhookUpdate(ctx context.Context, addOnIdentity string, appWebhookIdentity string, o AddOnWebhookUpdateOpts) (*AddOnWebhookUpdateResult, error)

Updates the details of an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.

func (*Service) AppCreate Uses

func (s *Service) AppCreate(ctx context.Context, o AppCreateOpts) (*App, error)

Create a new app.

func (*Service) AppDelete Uses

func (s *Service) AppDelete(ctx context.Context, appIdentity string) (*App, error)

Delete an existing app.

func (*Service) AppDisableACM Uses

func (s *Service) AppDisableACM(ctx context.Context, appIdentity string) (*App, error)

Disable ACM flag for an app

func (*Service) AppEnableACM Uses

func (s *Service) AppEnableACM(ctx context.Context, appIdentity string) (*App, error)

Enable ACM flag for an app

func (*Service) AppFeatureInfo Uses

func (s *Service) AppFeatureInfo(ctx context.Context, appIdentity string, appFeatureIdentity string) (*AppFeature, error)

Info for an existing app feature.

func (*Service) AppFeatureList Uses

func (s *Service) AppFeatureList(ctx context.Context, appIdentity string, lr *ListRange) (AppFeatureListResult, error)

List existing app features.

func (*Service) AppFeatureUpdate Uses

func (s *Service) AppFeatureUpdate(ctx context.Context, appIdentity string, appFeatureIdentity string, o AppFeatureUpdateOpts) (*AppFeature, error)

Update an existing app feature.

func (*Service) AppInfo Uses

func (s *Service) AppInfo(ctx context.Context, appIdentity string) (*App, error)

Info for existing app.

func (*Service) AppList Uses

func (s *Service) AppList(ctx context.Context, lr *ListRange) (AppListResult, error)

List existing apps.

func (*Service) AppListOwnedAndCollaborated Uses

func (s *Service) AppListOwnedAndCollaborated(ctx context.Context, accountIdentity string, lr *ListRange) (AppListOwnedAndCollaboratedResult, error)

List owned and collaborated apps (excludes team apps).

func (*Service) AppRefreshACM Uses

func (s *Service) AppRefreshACM(ctx context.Context, appIdentity string) (*App, error)

Refresh ACM for an app

func (*Service) AppSetupCreate Uses

func (s *Service) AppSetupCreate(ctx context.Context, o AppSetupCreateOpts) (*AppSetup, error)

Create a new app setup from a gzipped tar archive containing an app.json manifest file.

func (*Service) AppSetupInfo Uses

func (s *Service) AppSetupInfo(ctx context.Context, appSetupIdentity string) (*AppSetup, error)

Get the status of an app setup.

func (*Service) AppTransferCreate Uses

func (s *Service) AppTransferCreate(ctx context.Context, o AppTransferCreateOpts) (*AppTransfer, error)

Create a new app transfer.

func (*Service) AppTransferDelete Uses

func (s *Service) AppTransferDelete(ctx context.Context, appTransferIdentity string) (*AppTransfer, error)

Delete an existing app transfer

func (*Service) AppTransferInfo Uses

func (s *Service) AppTransferInfo(ctx context.Context, appTransferIdentity string) (*AppTransfer, error)

Info for existing app transfer.

func (*Service) AppTransferList Uses

func (s *Service) AppTransferList(ctx context.Context, lr *ListRange) (AppTransferListResult, error)

List existing apps transfers.

func (*Service) AppTransferUpdate Uses

func (s *Service) AppTransferUpdate(ctx context.Context, appTransferIdentity string, o AppTransferUpdateOpts) (*AppTransfer, error)

Update an existing app transfer.

func (*Service) AppUpdate Uses

func (s *Service) AppUpdate(ctx context.Context, appIdentity string, o AppUpdateOpts) (*App, error)

Update an existing app.

func (*Service) AppWebhookCreate Uses

func (s *Service) AppWebhookCreate(ctx context.Context, appIdentity string, o AppWebhookCreateOpts) (*AppWebhookCreateResult, error)

Create an app webhook subscription.

func (*Service) AppWebhookDelete Uses

func (s *Service) AppWebhookDelete(ctx context.Context, appIdentity string, appWebhookIdentity string) (*AppWebhookDeleteResult, error)

Removes an app webhook subscription.

func (*Service) AppWebhookDeliveryInfo Uses

func (s *Service) AppWebhookDeliveryInfo(ctx context.Context, appIdentity string, appWebhookDeliveryIdentity string) (*AppWebhookDelivery, error)

Returns the info for an existing delivery.

func (*Service) AppWebhookDeliveryList Uses

func (s *Service) AppWebhookDeliveryList(ctx context.Context, appIdentity string, lr *ListRange) (AppWebhookDeliveryListResult, error)

Lists existing deliveries for an app.

func (*Service) AppWebhookEventInfo Uses

func (s *Service) AppWebhookEventInfo(ctx context.Context, appIdentity string, appWebhookEventIdentity string) (*AppWebhookEvent, error)

Returns the info for a specified webhook event.

func (*Service) AppWebhookEventList Uses

func (s *Service) AppWebhookEventList(ctx context.Context, appIdentity string, lr *ListRange) (AppWebhookEventListResult, error)

Lists existing webhook events for an app.

func (*Service) AppWebhookInfo Uses

func (s *Service) AppWebhookInfo(ctx context.Context, appIdentity string, appWebhookIdentity string) (*AppWebhookInfoResult, error)

Returns the info for an app webhook subscription.

func (*Service) AppWebhookList Uses

func (s *Service) AppWebhookList(ctx context.Context, appIdentity string, lr *ListRange) (AppWebhookListResult, error)

List all webhook subscriptions for a particular app.

func (*Service) AppWebhookUpdate Uses

func (s *Service) AppWebhookUpdate(ctx context.Context, appIdentity string, appWebhookIdentity string, o AppWebhookUpdateOpts) (*AppWebhookUpdateResult, error)

Updates the details of an app webhook subscription.

func (*Service) BuildCreate Uses

func (s *Service) BuildCreate(ctx context.Context, appIdentity string, o BuildCreateOpts) (*Build, error)

Create a new build.

func (*Service) BuildDeleteCache Uses

func (s *Service) BuildDeleteCache(ctx context.Context, appIdentity string) (*Build, error)

Destroy a build cache.

func (*Service) BuildInfo Uses

func (s *Service) BuildInfo(ctx context.Context, appIdentity string, buildIdentity string) (*Build, error)

Info for existing build.

func (*Service) BuildList Uses

func (s *Service) BuildList(ctx context.Context, appIdentity string, lr *ListRange) (BuildListResult, error)

List existing build.

func (*Service) BuildpackInstallationList Uses

func (s *Service) BuildpackInstallationList(ctx context.Context, appIdentity string, lr *ListRange) (BuildpackInstallationListResult, error)

List an app's existing buildpack installations.

func (*Service) BuildpackInstallationUpdate Uses

func (s *Service) BuildpackInstallationUpdate(ctx context.Context, appIdentity string, o BuildpackInstallationUpdateOpts) (BuildpackInstallationUpdateResult, error)

Update an app's buildpack installations.

func (*Service) CollaboratorCreate Uses

func (s *Service) CollaboratorCreate(ctx context.Context, appIdentity string, o CollaboratorCreateOpts) (*Collaborator, error)

Create a new collaborator.

func (*Service) CollaboratorDelete Uses

func (s *Service) CollaboratorDelete(ctx context.Context, appIdentity string, collaboratorIdentity string) (*Collaborator, error)

Delete an existing collaborator.

func (*Service) CollaboratorInfo Uses

func (s *Service) CollaboratorInfo(ctx context.Context, appIdentity string, collaboratorIdentity string) (*Collaborator, error)

Info for existing collaborator.

func (*Service) CollaboratorList Uses

func (s *Service) CollaboratorList(ctx context.Context, appIdentity string, lr *ListRange) (CollaboratorListResult, error)

List existing collaborators.

func (*Service) ConfigVarInfoForApp Uses

func (s *Service) ConfigVarInfoForApp(ctx context.Context, appIdentity string) (ConfigVarInfoForAppResult, error)

Get config-vars for app.

func (*Service) ConfigVarInfoForAppRelease Uses

func (s *Service) ConfigVarInfoForAppRelease(ctx context.Context, appIdentity string, releaseIdentity string) (ConfigVarInfoForAppReleaseResult, error)

Get config-vars for a release.

func (*Service) ConfigVarUpdate Uses

func (s *Service) ConfigVarUpdate(ctx context.Context, appIdentity string, o map[string]*string) (ConfigVarUpdateResult, error)

Update config-vars for app. You can update existing config-vars by setting them again, and remove by setting it to `null`.

func (*Service) CreditCreate Uses

func (s *Service) CreditCreate(ctx context.Context, o CreditCreateOpts) (*Credit, error)

Create a new credit.

func (*Service) CreditInfo Uses

func (s *Service) CreditInfo(ctx context.Context, creditIdentity string) (*Credit, error)

Info for existing credit.

func (*Service) CreditList Uses

func (s *Service) CreditList(ctx context.Context, lr *ListRange) (CreditListResult, error)

List existing credits.

func (*Service) Delete Uses

func (s *Service) Delete(ctx context.Context, v interface{}, path string) error

Delete sends a DELETE request.

func (*Service) Do Uses

func (s *Service) Do(ctx context.Context, v interface{}, method, path string, body interface{}, q interface{}, lr *ListRange) error

Do sends a request and decodes the response into v.

func (*Service) DomainCreate Uses

func (s *Service) DomainCreate(ctx context.Context, appIdentity string, o DomainCreateOpts) (*Domain, error)

Create a new domain.

func (*Service) DomainDelete Uses

func (s *Service) DomainDelete(ctx context.Context, appIdentity string, domainIdentity string) (*Domain, error)

Delete an existing domain

func (*Service) DomainInfo Uses

func (s *Service) DomainInfo(ctx context.Context, appIdentity string, domainIdentity string) (*Domain, error)

Info for existing domain.

func (*Service) DomainList Uses

func (s *Service) DomainList(ctx context.Context, appIdentity string, lr *ListRange) (DomainListResult, error)

List existing domains.

func (*Service) DynoCreate Uses

func (s *Service) DynoCreate(ctx context.Context, appIdentity string, o DynoCreateOpts) (*Dyno, error)

Create a new dyno.

func (*Service) DynoInfo Uses

func (s *Service) DynoInfo(ctx context.Context, appIdentity string, dynoIdentity string) (*Dyno, error)

Info for existing dyno.

func (*Service) DynoList Uses

func (s *Service) DynoList(ctx context.Context, appIdentity string, lr *ListRange) (DynoListResult, error)

List existing dynos.

func (*Service) DynoRestart Uses

func (s *Service) DynoRestart(ctx context.Context, appIdentity string, dynoIdentity string) (DynoRestartResult, error)

Restart dyno.

func (*Service) DynoRestartAll Uses

func (s *Service) DynoRestartAll(ctx context.Context, appIdentity string) (DynoRestartAllResult, error)

Restart all dynos.

func (*Service) DynoSizeInfo Uses

func (s *Service) DynoSizeInfo(ctx context.Context, dynoSizeIdentity string) (*DynoSize, error)

Info for existing dyno size.

func (*Service) DynoSizeList Uses

func (s *Service) DynoSizeList(ctx context.Context, lr *ListRange) (DynoSizeListResult, error)

List existing dyno sizes.

func (*Service) DynoStop Uses

func (s *Service) DynoStop(ctx context.Context, appIdentity string, dynoIdentity string) (DynoStopResult, error)

Stop dyno.

func (*Service) FilterAppsApps Uses

func (s *Service) FilterAppsApps(ctx context.Context, o FilterAppsAppsOpts) (FilterAppsAppsResult, error)

Request an apps list filtered by app id.

func (*Service) FormationBatchUpdate Uses

func (s *Service) FormationBatchUpdate(ctx context.Context, appIdentity string, o FormationBatchUpdateOpts) (FormationBatchUpdateResult, error)

Batch update process types

func (*Service) FormationInfo Uses

func (s *Service) FormationInfo(ctx context.Context, appIdentity string, formationIdentity string) (*Formation, error)

Info for a process type

func (*Service) FormationList Uses

func (s *Service) FormationList(ctx context.Context, appIdentity string, lr *ListRange) (FormationListResult, error)

List process type formation

func (*Service) FormationUpdate Uses

func (s *Service) FormationUpdate(ctx context.Context, appIdentity string, formationIdentity string, o FormationUpdateOpts) (*Formation, error)

Update process type

func (*Service) Get Uses

func (s *Service) Get(ctx context.Context, v interface{}, path string, query interface{}, lr *ListRange) error

Get sends a GET request and decodes the response into v.

func (*Service) IdentityProviderCreateByTeam Uses

func (s *Service) IdentityProviderCreateByTeam(ctx context.Context, teamName string, o IdentityProviderCreateByTeamOpts) (*IdentityProvider, error)

Create an Identity Provider for a team

func (*Service) IdentityProviderDeleteByTeam Uses

func (s *Service) IdentityProviderDeleteByTeam(ctx context.Context, teamName string, identityProviderID string) (*IdentityProvider, error)

Delete a team's Identity Provider

func (*Service) IdentityProviderListByTeam Uses

func (s *Service) IdentityProviderListByTeam(ctx context.Context, teamName string, lr *ListRange) (IdentityProviderListByTeamResult, error)

Get a list of a team's Identity Providers

func (*Service) IdentityProviderUpdateByTeam Uses

func (s *Service) IdentityProviderUpdateByTeam(ctx context.Context, teamName string, identityProviderID string, o IdentityProviderUpdateByTeamOpts) (*IdentityProvider, error)

Update a team's Identity Provider

func (*Service) InboundRulesetCreate Uses

func (s *Service) InboundRulesetCreate(ctx context.Context, spaceIdentity string, o InboundRulesetCreateOpts) (*InboundRuleset, error)

Create a new inbound ruleset

func (*Service) InboundRulesetCurrent Uses

func (s *Service) InboundRulesetCurrent(ctx context.Context, spaceIdentity string) (*InboundRuleset, error)

Current inbound ruleset for a space

func (*Service) InboundRulesetInfo Uses

func (s *Service) InboundRulesetInfo(ctx context.Context, spaceIdentity string, inboundRulesetIdentity string) (*InboundRuleset, error)

Info on an existing Inbound Ruleset

func (*Service) InboundRulesetList Uses

func (s *Service) InboundRulesetList(ctx context.Context, spaceIdentity string, lr *ListRange) (InboundRulesetListResult, error)

List all inbound rulesets for a space

func (*Service) InvoiceAddressInfo Uses

func (s *Service) InvoiceAddressInfo(ctx context.Context) (*InvoiceAddress, error)

Retrieve existing invoice address.

func (*Service) InvoiceAddressUpdate Uses

func (s *Service) InvoiceAddressUpdate(ctx context.Context, o InvoiceAddressUpdateOpts) (*InvoiceAddress, error)

Update invoice address for an account.

func (*Service) InvoiceInfo Uses

func (s *Service) InvoiceInfo(ctx context.Context, invoiceIdentity int) (*Invoice, error)

Info for existing invoice.

func (*Service) InvoiceList Uses

func (s *Service) InvoiceList(ctx context.Context, lr *ListRange) (InvoiceListResult, error)

List existing invoices.

func (*Service) KeyInfo Uses

func (s *Service) KeyInfo(ctx context.Context, keyIdentity string) (*Key, error)

Info for existing key.

func (*Service) KeyList Uses

func (s *Service) KeyList(ctx context.Context, lr *ListRange) (KeyListResult, error)

List existing keys.

func (*Service) LogDrainCreate Uses

func (s *Service) LogDrainCreate(ctx context.Context, appIdentity string, o LogDrainCreateOpts) (*LogDrain, error)

Create a new log drain.

func (*Service) LogDrainDelete Uses

func (s *Service) LogDrainDelete(ctx context.Context, appIdentity string, logDrainQueryIdentity string) (*LogDrain, error)

Delete an existing log drain. Log drains added by add-ons can only be removed by removing the add-on.

func (*Service) LogDrainInfo Uses

func (s *Service) LogDrainInfo(ctx context.Context, appIdentity string, logDrainQueryIdentity string) (*LogDrain, error)

Info for existing log drain.

func (*Service) LogDrainList Uses

func (s *Service) LogDrainList(ctx context.Context, appIdentity string, lr *ListRange) (LogDrainListResult, error)

List existing log drains.

func (*Service) LogDrainListByAddOn Uses

func (s *Service) LogDrainListByAddOn(ctx context.Context, addOnIdentity string, lr *ListRange) (LogDrainListByAddOnResult, error)

List existing log drains for an add-on.

func (*Service) LogDrainUpdate Uses

func (s *Service) LogDrainUpdate(ctx context.Context, addOnIdentity string, logDrainQueryIdentity string, o LogDrainUpdateOpts) (*LogDrain, error)

Update an add-on owned log drain.

func (*Service) LogSessionCreate Uses

func (s *Service) LogSessionCreate(ctx context.Context, appIdentity string, o LogSessionCreateOpts) (*LogSession, error)

Create a new log session.

func (*Service) NewRequest Uses

func (s *Service) NewRequest(ctx context.Context, method, path string, body interface{}, q interface{}) (*http.Request, error)

NewRequest generates an HTTP request, but does not perform the request.

func (*Service) OAuthAuthorizationCreate Uses

func (s *Service) OAuthAuthorizationCreate(ctx context.Context, o OAuthAuthorizationCreateOpts) (*OAuthAuthorization, error)

Create a new OAuth authorization.

func (*Service) OAuthAuthorizationDelete Uses

func (s *Service) OAuthAuthorizationDelete(ctx context.Context, oauthAuthorizationIdentity string) (*OAuthAuthorization, error)

Delete OAuth authorization.

func (*Service) OAuthAuthorizationInfo Uses

func (s *Service) OAuthAuthorizationInfo(ctx context.Context, oauthAuthorizationIdentity string) (*OAuthAuthorization, error)

Info for an OAuth authorization.

func (*Service) OAuthAuthorizationList Uses

func (s *Service) OAuthAuthorizationList(ctx context.Context, lr *ListRange) (OAuthAuthorizationListResult, error)

List OAuth authorizations.

func (*Service) OAuthAuthorizationRegenerate Uses

func (s *Service) OAuthAuthorizationRegenerate(ctx context.Context, oauthAuthorizationIdentity string) (*OAuthAuthorization, error)

Regenerate OAuth tokens. This endpoint is only available to direct authorizations or privileged OAuth clients.

func (*Service) OAuthClientCreate Uses

func (s *Service) OAuthClientCreate(ctx context.Context, o OAuthClientCreateOpts) (*OAuthClient, error)

Create a new OAuth client.

func (*Service) OAuthClientDelete Uses

func (s *Service) OAuthClientDelete(ctx context.Context, oauthClientIdentity string) (*OAuthClient, error)

Delete OAuth client.

func (*Service) OAuthClientInfo Uses

func (s *Service) OAuthClientInfo(ctx context.Context, oauthClientIdentity string) (*OAuthClient, error)

Info for an OAuth client

func (*Service) OAuthClientList Uses

func (s *Service) OAuthClientList(ctx context.Context, lr *ListRange) (OAuthClientListResult, error)

List OAuth clients

func (*Service) OAuthClientRotateCredentials Uses

func (s *Service) OAuthClientRotateCredentials(ctx context.Context, oauthClientIdentity string) (*OAuthClient, error)

Rotate credentials for an OAuth client

func (*Service) OAuthClientUpdate Uses

func (s *Service) OAuthClientUpdate(ctx context.Context, oauthClientIdentity string, o OAuthClientUpdateOpts) (*OAuthClient, error)

Update OAuth client

func (*Service) OAuthTokenCreate Uses

func (s *Service) OAuthTokenCreate(ctx context.Context, o OAuthTokenCreateOpts) (*OAuthToken, error)

Create a new OAuth token.

func (*Service) OAuthTokenDelete Uses

func (s *Service) OAuthTokenDelete(ctx context.Context, oauthTokenIdentity string) (*OAuthToken, error)

Revoke OAuth access token.

func (*Service) OutboundRulesetCreate Uses

func (s *Service) OutboundRulesetCreate(ctx context.Context, spaceIdentity string, o OutboundRulesetCreateOpts) (*OutboundRuleset, error)

Create a new outbound ruleset

func (*Service) OutboundRulesetCurrent Uses

func (s *Service) OutboundRulesetCurrent(ctx context.Context, spaceIdentity string) (*OutboundRuleset, error)

Current outbound ruleset for a space

func (*Service) OutboundRulesetInfo Uses

func (s *Service) OutboundRulesetInfo(ctx context.Context, spaceIdentity string, outboundRulesetIdentity string) (*OutboundRuleset, error)

Info on an existing Outbound Ruleset

func (*Service) OutboundRulesetList Uses

func (s *Service) OutboundRulesetList(ctx context.Context, spaceIdentity string, lr *ListRange) (OutboundRulesetListResult, error)

List all Outbound Rulesets for a space

func (*Service) PasswordResetCompleteResetPassword Uses

func (s *Service) PasswordResetCompleteResetPassword(ctx context.Context, passwordResetResetPasswordToken string, o PasswordResetCompleteResetPasswordOpts) (*PasswordReset, error)

Complete password reset.

func (*Service) PasswordResetResetPassword Uses

func (s *Service) PasswordResetResetPassword(ctx context.Context, o PasswordResetResetPasswordOpts) (*PasswordReset, error)

Reset account's password. This will send a reset password link to the user's email address.

func (*Service) Patch Uses

func (s *Service) Patch(ctx context.Context, v interface{}, path string, body interface{}) error

Patch sends a Path request and decodes the response into v.

func (*Service) PeeringAccept Uses

func (s *Service) PeeringAccept(ctx context.Context, spaceIdentity string, peeringPcxID string) (*Peering, error)

Accept a pending peering connection with a private space.

func (*Service) PeeringDestroy Uses

func (s *Service) PeeringDestroy(ctx context.Context, spaceIdentity string, peeringPcxID string) (*Peering, error)

Destroy an active peering connection with a private space.

func (*Service) PeeringInfo Uses

func (s *Service) PeeringInfo(ctx context.Context, spaceIdentity string, peeringPcxID string) (*Peering, error)

Fetch information for existing peering connection

func (*Service) PeeringInfoInfo Uses

func (s *Service) PeeringInfoInfo(ctx context.Context, spaceIdentity string) (*PeeringInfo, error)

Provides the necessary information to establish an AWS VPC Peering with your private space.

func (*Service) PeeringList Uses

func (s *Service) PeeringList(ctx context.Context, spaceIdentity string, lr *ListRange) (PeeringListResult, error)

List peering connections of a private space.

func (*Service) PipelineCouplingCreate Uses

func (s *Service) PipelineCouplingCreate(ctx context.Context, o PipelineCouplingCreateOpts) (*PipelineCoupling, error)

Create a new pipeline coupling.

func (*Service) PipelineCouplingDelete Uses

func (s *Service) PipelineCouplingDelete(ctx context.Context, pipelineCouplingIdentity string) (*PipelineCoupling, error)

Delete an existing pipeline coupling.

func (*Service) PipelineCouplingInfo Uses

func (s *Service) PipelineCouplingInfo(ctx context.Context, pipelineCouplingIdentity string) (*PipelineCoupling, error)

Info for an existing pipeline coupling.

func (*Service) PipelineCouplingInfoByApp Uses

func (s *Service) PipelineCouplingInfoByApp(ctx context.Context, appIdentity string) (*PipelineCoupling, error)

Info for an existing app pipeline coupling.

func (*Service) PipelineCouplingList Uses

func (s *Service) PipelineCouplingList(ctx context.Context, lr *ListRange) (PipelineCouplingListResult, error)

List pipeline couplings.

func (*Service) PipelineCouplingListByPipeline Uses

func (s *Service) PipelineCouplingListByPipeline(ctx context.Context, pipelineID string, lr *ListRange) (PipelineCouplingListByPipelineResult, error)

List couplings for a pipeline

func (*Service) PipelineCouplingListForCurrentUser Uses

func (s *Service) PipelineCouplingListForCurrentUser(ctx context.Context, lr *ListRange) (PipelineCouplingListForCurrentUserResult, error)

List pipeline couplings for the current user.

func (*Service) PipelineCouplingUpdate Uses

func (s *Service) PipelineCouplingUpdate(ctx context.Context, pipelineCouplingIdentity string, o PipelineCouplingUpdateOpts) (*PipelineCoupling, error)

Update an existing pipeline coupling.

func (*Service) PipelineCreate Uses

func (s *Service) PipelineCreate(ctx context.Context, o PipelineCreateOpts) (*Pipeline, error)

Create a new pipeline.

func (*Service) PipelineDelete Uses

func (s *Service) PipelineDelete(ctx context.Context, pipelineID string) (*Pipeline, error)

Delete an existing pipeline.

func (*Service) PipelineInfo Uses

func (s *Service) PipelineInfo(ctx context.Context, pipelineIdentity string) (*Pipeline, error)

Info for existing pipeline.

func (*Service) PipelineList Uses

func (s *Service) PipelineList(ctx context.Context, lr *ListRange) (PipelineListResult, error)

List existing pipelines.

func (*Service) PipelinePromotionCreate Uses

func (s *Service) PipelinePromotionCreate(ctx context.Context, o PipelinePromotionCreateOpts) (*PipelinePromotion, error)

Create a new promotion.

func (*Service) PipelinePromotionInfo Uses

func (s *Service) PipelinePromotionInfo(ctx context.Context, pipelinePromotionIdentity string) (*PipelinePromotion, error)

Info for existing pipeline promotion.

func (*Service) PipelinePromotionTargetList Uses

func (s *Service) PipelinePromotionTargetList(ctx context.Context, pipelinePromotionID string, lr *ListRange) (PipelinePromotionTargetListResult, error)

List promotion targets belonging to an existing promotion.

func (*Service) PipelineUpdate Uses

func (s *Service) PipelineUpdate(ctx context.Context, pipelineID string, o PipelineUpdateOpts) (*Pipeline, error)

Update an existing pipeline.

func (*Service) PlanInfo Uses

func (s *Service) PlanInfo(ctx context.Context, planIdentity string) (*Plan, error)

Info for existing plan.

func (*Service) PlanInfoByAddOn Uses

func (s *Service) PlanInfoByAddOn(ctx context.Context, addOnServiceIdentity string, planIdentity string) (*Plan, error)

Info for existing plan by Add-on.

func (*Service) PlanListByAddOn Uses

func (s *Service) PlanListByAddOn(ctx context.Context, addOnServiceIdentity string, lr *ListRange) (PlanListByAddOnResult, error)

List existing plans by Add-on.

func (*Service) Post Uses

func (s *Service) Post(ctx context.Context, v interface{}, path string, body interface{}) error

Post sends a POST request and decodes the response into v.

func (*Service) Put Uses

func (s *Service) Put(ctx context.Context, v interface{}, path string, body interface{}) error

Put sends a PUT request and decodes the response into v.

func (*Service) RateLimitInfo Uses

func (s *Service) RateLimitInfo(ctx context.Context) (*RateLimit, error)

Info for rate limits.

func (*Service) RegionInfo Uses

func (s *Service) RegionInfo(ctx context.Context, regionIdentity string) (*Region, error)

Info for existing region.

func (*Service) RegionList Uses

func (s *Service) RegionList(ctx context.Context, lr *ListRange) (RegionListResult, error)

List existing regions.

func (*Service) ReleaseCreate Uses

func (s *Service) ReleaseCreate(ctx context.Context, appIdentity string, o ReleaseCreateOpts) (*Release, error)

Create new release.

func (*Service) ReleaseInfo Uses

func (s *Service) ReleaseInfo(ctx context.Context, appIdentity string, releaseIdentity string) (*Release, error)

Info for existing release.

func (*Service) ReleaseList Uses

func (s *Service) ReleaseList(ctx context.Context, appIdentity string, lr *ListRange) (ReleaseListResult, error)

List existing releases.

func (*Service) ReleaseRollback Uses

func (s *Service) ReleaseRollback(ctx context.Context, appIdentity string, o ReleaseRollbackOpts) (*Release, error)

Rollback to an existing release.

func (*Service) SSLEndpointCreate Uses

func (s *Service) SSLEndpointCreate(ctx context.Context, appIdentity string, o SSLEndpointCreateOpts) (*SSLEndpoint, error)

Create a new SSL endpoint.

func (*Service) SSLEndpointDelete Uses

func (s *Service) SSLEndpointDelete(ctx context.Context, appIdentity string, sslEndpointIdentity string) (*SSLEndpoint, error)

Delete existing SSL endpoint.

func (*Service) SSLEndpointInfo Uses

func (s *Service) SSLEndpointInfo(ctx context.Context, appIdentity string, sslEndpointIdentity string) (*SSLEndpoint, error)

Info for existing SSL endpoint.

func (*Service) SSLEndpointList Uses

func (s *Service) SSLEndpointList(ctx context.Context, appIdentity string, lr *ListRange) (SSLEndpointListResult, error)

List existing SSL endpoints.

func (*Service) SSLEndpointUpdate Uses

func (s *Service) SSLEndpointUpdate(ctx context.Context, appIdentity string, sslEndpointIdentity string, o SSLEndpointUpdateOpts) (*SSLEndpoint, error)

Update an existing SSL endpoint.

func (*Service) SlugCreate Uses

func (s *Service) SlugCreate(ctx context.Context, appIdentity string, o SlugCreateOpts) (*Slug, error)

Create a new slug. For more information please refer to [Deploying Slugs using the Platform API](https://devcenter.heroku.com/articles/platform-api-deploying-slug s).

func (*Service) SlugInfo Uses

func (s *Service) SlugInfo(ctx context.Context, appIdentity string, slugIdentity string) (*Slug, error)

Info for existing slug.

func (*Service) SmsNumberConfirm Uses

func (s *Service) SmsNumberConfirm(ctx context.Context, accountIdentity string) (*SmsNumber, error)

Confirm an SMS number change with a confirmation code

func (*Service) SmsNumberRecover Uses

func (s *Service) SmsNumberRecover(ctx context.Context, accountIdentity string) (*SmsNumber, error)

Recover an account using an SMS recovery code

func (*Service) SmsNumberSMSNumber Uses

func (s *Service) SmsNumberSMSNumber(ctx context.Context, accountIdentity string) (*SmsNumber, error)

Recover an account using an SMS recovery code

func (*Service) SniEndpointCreate Uses

func (s *Service) SniEndpointCreate(ctx context.Context, appIdentity string, o SniEndpointCreateOpts) (*SniEndpoint, error)

Create a new SNI endpoint.

func (*Service) SniEndpointDelete Uses

func (s *Service) SniEndpointDelete(ctx context.Context, appIdentity string, sniEndpointIdentity string) (*SniEndpoint, error)

Delete existing SNI endpoint.

func (*Service) SniEndpointInfo Uses

func (s *Service) SniEndpointInfo(ctx context.Context, appIdentity string, sniEndpointIdentity string) (*SniEndpoint, error)

Info for existing SNI endpoint.

func (*Service) SniEndpointList Uses

func (s *Service) SniEndpointList(ctx context.Context, appIdentity string, lr *ListRange) (SniEndpointListResult, error)

List existing SNI endpoints.

func (*Service) SniEndpointUpdate Uses

func (s *Service) SniEndpointUpdate(ctx context.Context, appIdentity string, sniEndpointIdentity string, o SniEndpointUpdateOpts) (*SniEndpoint, error)

Update an existing SNI endpoint.

func (*Service) SourceCreate Uses

func (s *Service) SourceCreate(ctx context.Context) (*Source, error)

Create URLs for uploading and downloading source.

func (*Service) SourceCreateDeprecated Uses

func (s *Service) SourceCreateDeprecated(ctx context.Context, appIdentity string) (*Source, error)

Create URLs for uploading and downloading source. Deprecated in favor of `POST /sources`

func (*Service) SpaceAppAccessInfo Uses

func (s *Service) SpaceAppAccessInfo(ctx context.Context, spaceIdentity string, accountIdentity string) (*SpaceAppAccess, error)

List permissions for a given user on a given space.

func (*Service) SpaceAppAccessList Uses

func (s *Service) SpaceAppAccessList(ctx context.Context, spaceIdentity string, lr *ListRange) (SpaceAppAccessListResult, error)

List all users and their permissions on a space.

func (*Service) SpaceAppAccessUpdate Uses

func (s *Service) SpaceAppAccessUpdate(ctx context.Context, spaceIdentity string, accountIdentity string, o SpaceAppAccessUpdateOpts) (*SpaceAppAccess, error)

Update an existing user's set of permissions on a space.

func (*Service) SpaceCreate Uses

func (s *Service) SpaceCreate(ctx context.Context, o SpaceCreateOpts) (*Space, error)

Create a new space.

func (*Service) SpaceDelete Uses

func (s *Service) SpaceDelete(ctx context.Context, spaceIdentity string) (*Space, error)

Delete an existing space.

func (*Service) SpaceInfo Uses

func (s *Service) SpaceInfo(ctx context.Context, spaceIdentity string) (*Space, error)

Info for existing space.

func (*Service) SpaceList Uses

func (s *Service) SpaceList(ctx context.Context, lr *ListRange) (SpaceListResult, error)

List existing spaces.

func (*Service) SpaceNATInfo Uses

func (s *Service) SpaceNATInfo(ctx context.Context, spaceIdentity string) (*SpaceNAT, error)

Current state of network address translation for a space.

func (*Service) SpaceUpdate Uses

func (s *Service) SpaceUpdate(ctx context.Context, spaceIdentity string, o SpaceUpdateOpts) (*Space, error)

Update an existing space.

func (*Service) StackInfo Uses

func (s *Service) StackInfo(ctx context.Context, stackIdentity string) (*Stack, error)

Stack info.

func (*Service) StackList Uses

func (s *Service) StackList(ctx context.Context, lr *ListRange) (StackListResult, error)

List available stacks.

func (*Service) TeamAddOnListForTeam Uses

func (s *Service) TeamAddOnListForTeam(ctx context.Context, teamIdentity string, lr *ListRange) (TeamAddOnListForTeamResult, error)

List add-ons used across all Team apps

func (*Service) TeamAppCollaboratorCreate Uses

func (s *Service) TeamAppCollaboratorCreate(ctx context.Context, appIdentity string, o TeamAppCollaboratorCreateOpts) (*TeamAppCollaborator, error)

Create a new collaborator on a team app. Use this endpoint instead of the `/apps/{app_id_or_name}/collaborator` endpoint when you want the collaborator to be granted [permissions] (https://devcenter.heroku.com/articles/org-users-access#roles-and-app- permissions) according to their role in the team.

func (*Service) TeamAppCollaboratorDelete Uses

func (s *Service) TeamAppCollaboratorDelete(ctx context.Context, teamAppIdentity string, teamAppCollaboratorIdentity string) (*TeamAppCollaborator, error)

Delete an existing collaborator from a team app.

func (*Service) TeamAppCollaboratorInfo Uses

func (s *Service) TeamAppCollaboratorInfo(ctx context.Context, teamAppIdentity string, teamAppCollaboratorIdentity string) (*TeamAppCollaborator, error)

Info for a collaborator on a team app.

func (*Service) TeamAppCollaboratorList Uses

func (s *Service) TeamAppCollaboratorList(ctx context.Context, teamAppIdentity string, lr *ListRange) (TeamAppCollaboratorListResult, error)

List collaborators on a team app.

func (*Service) TeamAppCollaboratorUpdate Uses

func (s *Service) TeamAppCollaboratorUpdate(ctx context.Context, teamAppIdentity string, teamAppCollaboratorIdentity string, o TeamAppCollaboratorUpdateOpts) (*TeamAppCollaborator, error)

Update an existing collaborator from a team app.

func (*Service) TeamAppCreate Uses

func (s *Service) TeamAppCreate(ctx context.Context, o TeamAppCreateOpts) (*TeamApp, error)

Create a new app in the specified team, in the default team if unspecified, or in personal account, if default team is not set.

func (*Service) TeamAppInfo Uses

func (s *Service) TeamAppInfo(ctx context.Context, teamAppIdentity string) (*TeamApp, error)

Info for a team app.

func (*Service) TeamAppListByTeam Uses

func (s *Service) TeamAppListByTeam(ctx context.Context, teamIdentity string, lr *ListRange) (TeamAppListByTeamResult, error)

List team apps.

func (*Service) TeamAppPermissionList Uses

func (s *Service) TeamAppPermissionList(ctx context.Context, lr *ListRange) (TeamAppPermissionListResult, error)

Lists permissions available to teams.

func (*Service) TeamAppTransferToAccount Uses

func (s *Service) TeamAppTransferToAccount(ctx context.Context, teamAppIdentity string, o TeamAppTransferToAccountOpts) (*TeamApp, error)

Transfer an existing team app to another Heroku account.

func (*Service) TeamAppTransferToTeam Uses

func (s *Service) TeamAppTransferToTeam(ctx context.Context, teamAppIdentity string, o TeamAppTransferToTeamOpts) (*TeamApp, error)

Transfer an existing team app to another team.

func (*Service) TeamAppUpdateLocked Uses

func (s *Service) TeamAppUpdateLocked(ctx context.Context, teamAppIdentity string, o TeamAppUpdateLockedOpts) (*TeamApp, error)

Lock or unlock a team app.

func (*Service) TeamCreate Uses

func (s *Service) TeamCreate(ctx context.Context, o TeamCreateOpts) (*Team, error)

Create a new team.

func (*Service) TeamDelete Uses

func (s *Service) TeamDelete(ctx context.Context, teamIdentity string) (*Team, error)

Delete an existing team.

func (*Service) TeamFeatureInfo Uses

func (s *Service) TeamFeatureInfo(ctx context.Context, teamIdentity string, teamFeatureIdentity string) (*TeamFeature, error)

Info for an existing team feature.

func (*Service) TeamFeatureList Uses

func (s *Service) TeamFeatureList(ctx context.Context, teamIdentity string, lr *ListRange) (TeamFeatureListResult, error)

List existing team features.

func (*Service) TeamInfo Uses

func (s *Service) TeamInfo(ctx context.Context, teamIdentity string) (*Team, error)

Info for a team.

func (*Service) TeamInvitationAccept Uses

func (s *Service) TeamInvitationAccept(ctx context.Context, teamInvitationToken string) (*TeamInvitationAcceptResult, error)

Accept Team Invitation

func (*Service) TeamInvitationCreate Uses

func (s *Service) TeamInvitationCreate(ctx context.Context, teamIdentity string, o TeamInvitationCreateOpts) (*TeamInvitation, error)

Create Team Invitation

func (*Service) TeamInvitationGet Uses

func (s *Service) TeamInvitationGet(ctx context.Context, teamInvitationToken string, lr *ListRange) (*TeamInvitation, error)

Get an invitation by its token

func (*Service) TeamInvitationList Uses

func (s *Service) TeamInvitationList(ctx context.Context, teamName string, lr *ListRange) (TeamInvitationListResult, error)

Get a list of a team's Identity Providers

func (*Service) TeamInvitationRevoke Uses

func (s *Service) TeamInvitationRevoke(ctx context.Context, teamIdentity string, teamInvitationIdentity string) (*TeamInvitation, error)

Revoke a team invitation.

func (*Service) TeamInvoiceInfo Uses

func (s *Service) TeamInvoiceInfo(ctx context.Context, teamIdentity string, teamInvoiceIdentity int) (*TeamInvoice, error)

Info for existing invoice.

func (*Service) TeamInvoiceList Uses

func (s *Service) TeamInvoiceList(ctx context.Context, teamIdentity string, lr *ListRange) (TeamInvoiceListResult, error)

List existing invoices.

func (*Service) TeamList Uses

func (s *Service) TeamList(ctx context.Context, lr *ListRange) (TeamListResult, error)

List teams in which you are a member.

func (*Service) TeamMemberCreate Uses

func (s *Service) TeamMemberCreate(ctx context.Context, teamIdentity string, o TeamMemberCreateOpts) (*TeamMember, error)

Create a new team member.

func (*Service) TeamMemberCreateOrUpdate Uses

func (s *Service) TeamMemberCreateOrUpdate(ctx context.Context, teamIdentity string, o TeamMemberCreateOrUpdateOpts) (*TeamMember, error)

Create a new team member, or update their role.

func (*Service) TeamMemberDelete Uses

func (s *Service) TeamMemberDelete(ctx context.Context, teamIdentity string, teamMemberIdentity string) (*TeamMember, error)

Remove a member from the team.

func (*Service) TeamMemberList Uses

func (s *Service) TeamMemberList(ctx context.Context, teamIdentity string, lr *ListRange) (TeamMemberListResult, error)

List members of the team.

func (*Service) TeamMemberListByMember Uses

func (s *Service) TeamMemberListByMember(ctx context.Context, teamIdentity string, teamMemberIdentity string, lr *ListRange) (TeamMemberListByMemberResult, error)

List the apps of a team member.

func (*Service) TeamMemberUpdate Uses

func (s *Service) TeamMemberUpdate(ctx context.Context, teamIdentity string, o TeamMemberUpdateOpts) (*TeamMember, error)

Update a team member.

func (*Service) TeamPreferencesList Uses

func (s *Service) TeamPreferencesList(ctx context.Context, teamPreferencesIdentity string) (*TeamPreferences, error)

Retrieve Team Preferences

func (*Service) TeamPreferencesUpdate Uses

func (s *Service) TeamPreferencesUpdate(ctx context.Context, teamPreferencesIdentity string, o TeamPreferencesUpdateOpts) (*TeamPreferences, error)

Update Team Preferences

func (*Service) TeamSpaceList Uses

func (s *Service) TeamSpaceList(ctx context.Context, teamIdentity string, lr *ListRange) (TeamSpaceListResult, error)

List spaces owned by the team

func (*Service) TeamUpdate Uses

func (s *Service) TeamUpdate(ctx context.Context, teamIdentity string, o TeamUpdateOpts) (*Team, error)

Update team properties.

func (*Service) TestCaseList Uses

func (s *Service) TestCaseList(ctx context.Context, testRunID string, lr *ListRange) error

List test cases

func (*Service) TestNodeList Uses

func (s *Service) TestNodeList(ctx context.Context, testRunIdentity string, lr *ListRange) error

List test nodes

func (*Service) TestRunCreate Uses

func (s *Service) TestRunCreate(ctx context.Context, o TestRunCreateOpts) (*TestRun, error)

Create a new test-run.

func (*Service) TestRunInfo Uses

func (s *Service) TestRunInfo(ctx context.Context, testRunID string) (*TestRun, error)

Info for existing test-run.

func (*Service) TestRunInfoByPipeline Uses

func (s *Service) TestRunInfoByPipeline(ctx context.Context, pipelineID string, testRunNumber int) (*TestRun, error)

Info for existing test-run by Pipeline

func (*Service) TestRunList Uses

func (s *Service) TestRunList(ctx context.Context, pipelineID string, lr *ListRange) error

List existing test-runs for a pipeline.

func (*Service) TestRunUpdate Uses

func (s *Service) TestRunUpdate(ctx context.Context, testRunNumber int, o TestRunUpdateOpts) (*TestRun, error)

Update a test-run's status.

func (*Service) UserPreferencesList Uses

func (s *Service) UserPreferencesList(ctx context.Context, userPreferencesIdentity string) (*UserPreferences, error)

Retrieve User Preferences

func (*Service) UserPreferencesUpdate Uses

func (s *Service) UserPreferencesUpdate(ctx context.Context, userPreferencesIdentity string, o UserPreferencesUpdateOpts) (*UserPreferences, error)

Update User Preferences

func (*Service) VPNConnectionCreate Uses

func (s *Service) VPNConnectionCreate(ctx context.Context, spaceIdentity string, o VPNConnectionCreateOpts) (*VPNConnection, error)

Create a new VPN connection in a private space.

func (*Service) VPNConnectionDestroy Uses

func (s *Service) VPNConnectionDestroy(ctx context.Context, spaceIdentity string, vpnConnectionIdentity string) (*VPNConnection, error)

Destroy existing VPN Connection

func (*Service) VPNConnectionInfo Uses

func (s *Service) VPNConnectionInfo(ctx context.Context, spaceIdentity string, vpnConnectionIdentity string) (*VPNConnection, error)

Info for an existing vpn-connection.

func (*Service) VPNConnectionList Uses

func (s *Service) VPNConnectionList(ctx context.Context, spaceIdentity string, lr *ListRange) (VPNConnectionListResult, error)

List VPN connections for a space.

func (*Service) WhitelistedAddOnServiceCreateByTeam Uses

func (s *Service) WhitelistedAddOnServiceCreateByTeam(ctx context.Context, teamIdentity string, o WhitelistedAddOnServiceCreateByTeamOpts) (WhitelistedAddOnServiceCreateByTeamResult, error)

Whitelist an Add-on Service

func (*Service) WhitelistedAddOnServiceDeleteByTeam Uses

func (s *Service) WhitelistedAddOnServiceDeleteByTeam(ctx context.Context, teamIdentity string, whitelistedAddOnServiceIdentity string) (*WhitelistedAddOnService, error)

Remove a whitelisted entity

func (*Service) WhitelistedAddOnServiceListByTeam Uses

func (s *Service) WhitelistedAddOnServiceListByTeam(ctx context.Context, teamIdentity string, lr *ListRange) (WhitelistedAddOnServiceListByTeamResult, error)

List all whitelisted Add-on Services for an Team

type Slug Uses

type Slug struct {
    Blob struct {
        Method string `json:"method" url:"method,key"` // method to be used to interact with the slug blob
        URL    string `json:"url" url:"url,key"`       // URL to interact with the slug blob
    }   `json:"blob" url:"blob,key"` // pointer to the url where clients can fetch or store the actual
    // release binary
    BuildpackProvidedDescription *string `json:"buildpack_provided_description" url:"buildpack_provided_description,key"` // description from buildpack of slug
    Checksum                     *string `json:"checksum" url:"checksum,key"`                                             // an optional checksum of the slug for verifying its integrity
    Commit                       *string `json:"commit" url:"commit,key"`                                                 // identification of the code with your version control system (eg: SHA
    // of the git HEAD)
    CommitDescription *string           `json:"commit_description" url:"commit_description,key"` // an optional description of the provided commit
    CreatedAt         time.Time         `json:"created_at" url:"created_at,key"`                 // when slug was created
    ID                string            `json:"id" url:"id,key"`                                 // unique identifier of slug
    ProcessTypes      map[string]string `json:"process_types" url:"process_types,key"`           // hash mapping process type names to their respective command
    Size              *int              `json:"size" url:"size,key"`                             // size of slug, in bytes
    Stack             struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"stack" url:"stack,key"` // identity of slug stack
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when slug was updated
}

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

type SlugCreateOpts Uses

type SlugCreateOpts struct {
    BuildpackProvidedDescription *string `json:"buildpack_provided_description,omitempty" url:"buildpack_provided_description,omitempty,key"` // description from buildpack of slug
    Checksum                     *string `json:"checksum,omitempty" url:"checksum,omitempty,key"`                                             // an optional checksum of the slug for verifying its integrity
    Commit                       *string `json:"commit,omitempty" url:"commit,omitempty,key"`                                                 // identification of the code with your version control system (eg: SHA
    // of the git HEAD)
    CommitDescription *string           `json:"commit_description,omitempty" url:"commit_description,omitempty,key"` // an optional description of the provided commit
    ProcessTypes      map[string]string `json:"process_types" url:"process_types,key"`                               // hash mapping process type names to their respective command
    Stack             *string           `json:"stack,omitempty" url:"stack,omitempty,key"`                           // unique name of stack
}

type SmsNumber Uses

type SmsNumber struct {
    SmsNumber *string `json:"sms_number" url:"sms_number,key"` // SMS number of account
}

SMS numbers are used for recovery on accounts with two-factor authentication enabled.

type SniEndpoint Uses

type SniEndpoint struct {
    CertificateChain string `json:"certificate_chain" url:"certificate_chain,key"` // raw contents of the public certificate chain (eg: .crt or .pem file)
    CName            string `json:"cname" url:"cname,key"`                         // deprecated; refer to GET /apps/:id/domains for valid CNAMEs for this
    // app
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when endpoint was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of this SNI endpoint
    Name      string    `json:"name" url:"name,key"`             // unique name for SNI endpoint
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when SNI endpoint was updated
}

SNI Endpoint is a public address serving a custom SSL cert for HTTPS traffic, using the SNI TLS extension, to a Heroku app.

type SniEndpointCreateOpts Uses

type SniEndpointCreateOpts struct {
    CertificateChain string `json:"certificate_chain" url:"certificate_chain,key"` // raw contents of the public certificate chain (eg: .crt or .pem file)
    PrivateKey       string `json:"private_key" url:"private_key,key"`             // contents of the private key (eg .key file)
}

type SniEndpointListResult Uses

type SniEndpointListResult []SniEndpoint

type SniEndpointUpdateOpts Uses

type SniEndpointUpdateOpts struct {
    CertificateChain string `json:"certificate_chain" url:"certificate_chain,key"` // raw contents of the public certificate chain (eg: .crt or .pem file)
    PrivateKey       string `json:"private_key" url:"private_key,key"`             // contents of the private key (eg .key file)
}

type Source Uses

type Source struct {
    SourceBlob struct {
        GetURL string `json:"get_url" url:"get_url,key"` // URL to download the source
        PutURL string `json:"put_url" url:"put_url,key"` // URL to upload the source
    } `json:"source_blob" url:"source_blob,key"` // pointer to the URL where clients can fetch or store the source
}

A source is a location for uploading and downloading an application's source code.

type Space Uses

type Space struct {
    CIDR string `json:"cidr" url:"cidr,key"` // The RFC-1918 CIDR the Private Space will use. It must be a /16 in
    // 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when space was created
    DataCIDR  string    `json:"data_cidr" url:"data_cidr,key"`   // The RFC-1918 CIDR that the Private Space will use for the
    // Heroku-managed peering connection that's automatically created when
    // using Heroku Data add-ons. It must be between a /16 and a /20
    ID           string `json:"id" url:"id,key"`     // unique identifier of space
    Name         string `json:"name" url:"name,key"` // unique name of space
    Organization struct {
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"organization" url:"organization,key"` // organization that owns this space
    Region struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of region
        Name string `json:"name" url:"name,key"` // unique name of region
    }   `json:"region" url:"region,key"` // identity of space region
    Shield bool   `json:"shield" url:"shield,key"` // true if this space has shield enabled
    State  string `json:"state" url:"state,key"`   // availability of this space
    Team   struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of team
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"team" url:"team,key"` // team that owns this space
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when space was updated
}

A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.

type SpaceAppAccess Uses

type SpaceAppAccess struct {
    CreatedAt   time.Time `json:"created_at" url:"created_at,key"` // when space was created
    ID          string    `json:"id" url:"id,key"`                 // unique identifier of space
    Permissions []struct {
        Description string `json:"description" url:"description,key"`
        Name        string `json:"name" url:"name,key"`
    }   `json:"permissions" url:"permissions,key"` // user space permissions
    Space struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"space" url:"space,key"` // space user belongs to
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when space was updated
    User      struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"user" url:"user,key"` // identity of user account
}

Space access represents the permissions a particular user has on a particular space.

type SpaceAppAccessListResult Uses

type SpaceAppAccessListResult []SpaceAppAccess

type SpaceAppAccessUpdateOpts Uses

type SpaceAppAccessUpdateOpts struct {
    Permissions []struct {
        Name *string `json:"name,omitempty" url:"name,omitempty,key"`
    } `json:"permissions" url:"permissions,key"`
}

type SpaceCreateOpts Uses

type SpaceCreateOpts struct {
    CIDR *string `json:"cidr,omitempty" url:"cidr,omitempty,key"` // The RFC-1918 CIDR the Private Space will use. It must be a /16 in
    // 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    DataCIDR *string `json:"data_cidr,omitempty" url:"data_cidr,omitempty,key"` // The RFC-1918 CIDR that the Private Space will use for the
    // Heroku-managed peering connection that's automatically created when
    // using Heroku Data add-ons. It must be between a /16 and a /20
    Name   string  `json:"name" url:"name,key"`                         // unique name of space
    Region *string `json:"region,omitempty" url:"region,omitempty,key"` // unique identifier of region
    Shield *bool   `json:"shield,omitempty" url:"shield,omitempty,key"` // true if this space has shield enabled
    Team   string  `json:"team" url:"team,key"`                         // unique name of team
}

type SpaceListResult Uses

type SpaceListResult []Space

type SpaceNAT Uses

type SpaceNAT struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when network address translation for a space was created
    Sources   []string  `json:"sources" url:"sources,key"`       // potential IPs from which outbound network traffic will originate
    State     string    `json:"state" url:"state,key"`           // availability of network address translation for a space
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when network address translation for a space was updated
}

Network address translation (NAT) for stable outbound IP addresses from a space

type SpaceUpdateOpts Uses

type SpaceUpdateOpts struct {
    Name *string `json:"name,omitempty" url:"name,omitempty,key"` // unique name of space
}

type Stack Uses

type Stack struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when stack was introduced
    Default   bool      `json:"default" url:"default,key"`       // indicates this stack is the default for new apps
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of stack
    Name      string    `json:"name" url:"name,key"`             // unique name of stack
    State     string    `json:"state" url:"state,key"`           // availability of this stack: beta, deprecated or public
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when stack was last modified
}

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

type StackListResult Uses

type StackListResult []Stack

type Team Uses

type Team struct {
    CreatedAt             time.Time `json:"created_at" url:"created_at,key"`                           // when the team was created
    CreditCardCollections bool      `json:"credit_card_collections" url:"credit_card_collections,key"` // whether charges incurred by the team are paid by credit card.
    Default               bool      `json:"default" url:"default,key"`                                 // whether to use this team when none is specified
    ID                    string    `json:"id" url:"id,key"`                                           // unique identifier of team
    MembershipLimit       *float64  `json:"membership_limit" url:"membership_limit,key"`               // upper limit of members allowed in a team.
    Name                  string    `json:"name" url:"name,key"`                                       // unique name of team
    ProvisionedLicenses   bool      `json:"provisioned_licenses" url:"provisioned_licenses,key"`       // whether the team is provisioned licenses by salesforce.
    Role                  *string   `json:"role" url:"role,key"`                                       // role in the team
    Type                  string    `json:"type" url:"type,key"`                                       // type of team.
    UpdatedAt             time.Time `json:"updated_at" url:"updated_at,key"`                           // when the team was updated
}

Teams allow you to manage access to a shared group of applications and other resources.

type TeamAddOn Uses

type TeamAddOn struct{}

type TeamAddOnListForTeamResult Uses

type TeamAddOnListForTeamResult []struct {
    Actions      []struct{} `json:"actions" url:"actions,key"` // provider actions for this specific add-on
    AddonService struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this add-on-service
        Name string `json:"name" url:"name,key"` // unique name of this add-on-service
    }   `json:"addon_service" url:"addon_service,key"` // identity of add-on service
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // billing application associated with this add-on
    BilledPrice *struct {
        Cents    int    `json:"cents" url:"cents,key"`       // price in cents per unit of plan
        Contract bool   `json:"contract" url:"contract,key"` // price is negotiated in a contract outside of monthly add-on billing
        Unit     string `json:"unit" url:"unit,key"`         // unit of price for plan
    }   `json:"billed_price" url:"billed_price,key"` // billed price
    BillingEntity struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of the billing entity
        Name string `json:"name" url:"name,key"` // name of the billing entity
        Type string `json:"type" url:"type,key"` // type of Object of the billing entity; new types allowed at any time.
    }   `json:"billing_entity" url:"billing_entity,key"` // billing entity associated with this add-on
    ConfigVars []string  `json:"config_vars" url:"config_vars,key"` // config vars exposed to the owning app by this add-on
    CreatedAt  time.Time `json:"created_at" url:"created_at,key"`   // when add-on was created
    ID         string    `json:"id" url:"id,key"`                   // unique identifier of add-on
    Name       string    `json:"name" url:"name,key"`               // globally unique name of the add-on
    Plan       struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of this plan
        Name string `json:"name" url:"name,key"` // unique name of this plan
    }   `json:"plan" url:"plan,key"` // identity of add-on plan
    ProviderID string    `json:"provider_id" url:"provider_id,key"` // id of this add-on with its provider
    State      string    `json:"state" url:"state,key"`             // state in the add-on's lifecycle
    UpdatedAt  time.Time `json:"updated_at" url:"updated_at,key"`   // when add-on was updated
    WebURL     *string   `json:"web_url" url:"web_url,key"`         // URL for logging into web interface of add-on (e.g. a dashboard)
}

type TeamApp Uses

type TeamApp struct {
    ArchivedAt *time.Time `json:"archived_at" url:"archived_at,key"` // when app was archived
    BuildStack struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"build_stack" url:"build_stack,key"` // identity of the stack that will be used for new builds
    BuildpackProvidedDescription *string   `json:"buildpack_provided_description" url:"buildpack_provided_description,key"` // description from buildpack of app
    CreatedAt                    time.Time `json:"created_at" url:"created_at,key"`                                         // when app was created
    GitURL                       string    `json:"git_url" url:"git_url,key"`                                               // git repo URL of app
    ID                           string    `json:"id" url:"id,key"`                                                         // unique identifier of app
    InternalRouting              *bool     `json:"internal_routing" url:"internal_routing,key"`                             // describes whether a Private Spaces app is externally routable or not
    Joined                       bool      `json:"joined" url:"joined,key"`                                                 // is the current member a collaborator on this app.
    Locked                       bool      `json:"locked" url:"locked,key"`                                                 // are other team members forbidden from joining this app.
    Maintenance                  bool      `json:"maintenance" url:"maintenance,key"`                                       // maintenance status of app
    Name                         string    `json:"name" url:"name,key"`                                                     // unique name of app
    Owner                        *struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"owner" url:"owner,key"` // identity of app owner
    Region struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of region
        Name string `json:"name" url:"name,key"` // unique name of region
    }   `json:"region" url:"region,key"` // identity of app region
    ReleasedAt *time.Time `json:"released_at" url:"released_at,key"` // when app was released
    RepoSize   *int       `json:"repo_size" url:"repo_size,key"`     // git repo size in bytes of app
    SlugSize   *int       `json:"slug_size" url:"slug_size,key"`     // slug size in bytes of app
    Space      *struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of space
        Name string `json:"name" url:"name,key"` // unique name of space
    }   `json:"space" url:"space,key"` // identity of space
    Stack struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"stack" url:"stack,key"` // identity of app stack
    Team *struct {
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"team" url:"team,key"` // team that owns this app
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when app was updated
    WebURL    string    `json:"web_url" url:"web_url,key"`       // web URL of app
}

A team app encapsulates the team specific functionality of Heroku apps.

type TeamAppCollaborator Uses

type TeamAppCollaborator struct {
    App struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of app
        Name string `json:"name" url:"name,key"` // unique name of app
    }   `json:"app" url:"app,key"` // app collaborator belongs to
    CreatedAt   time.Time `json:"created_at" url:"created_at,key"` // when collaborator was created
    ID          string    `json:"id" url:"id,key"`                 // unique identifier of collaborator
    Permissions []struct {
        Description string `json:"description" url:"description,key"` // A description of what the app permission allows.
        Name        string `json:"name" url:"name,key"`               // The name of the app permission.
    }   `json:"permissions" url:"permissions,key"` // array of permissions for the collaborator (only applicable if the app
    // is on a team)
    Role      *string   `json:"role" url:"role,key"`             // role in the team
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when collaborator was updated
    User      struct {
        Email     string `json:"email" url:"email,key"`         // unique email address of account
        Federated bool   `json:"federated" url:"federated,key"` // whether the user is federated and belongs to an Identity Provider
        ID        string `json:"id" url:"id,key"`               // unique identifier of an account
    }   `json:"user" url:"user,key"` // identity of collaborated account
}

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

type TeamAppCollaboratorCreateOpts Uses

type TeamAppCollaboratorCreateOpts struct {
    Permissions []*string `json:"permissions,omitempty" url:"permissions,omitempty,key"` // An array of permissions to give to the collaborator.
    Silent      *bool     `json:"silent,omitempty" url:"silent,omitempty,key"`           // whether to suppress email invitation when creating collaborator
    User        string    `json:"user" url:"user,key"`                                   // unique email address of account
}

type TeamAppCollaboratorListResult Uses

type TeamAppCollaboratorListResult []TeamAppCollaborator

type TeamAppCollaboratorUpdateOpts Uses

type TeamAppCollaboratorUpdateOpts struct {
    Permissions []string `json:"permissions" url:"permissions,key"` // An array of permissions to give to the collaborator.
}

type TeamAppCreateOpts Uses

type TeamAppCreateOpts struct {
    InternalRouting *bool   `json:"internal_routing,omitempty" url:"internal_routing,omitempty,key"` // describes whether a Private Spaces app is externally routable or not
    Locked          *bool   `json:"locked,omitempty" url:"locked,omitempty,key"`                     // are other team members forbidden from joining this app.
    Name            *string `json:"name,omitempty" url:"name,omitempty,key"`                         // unique name of app
    Personal        *bool   `json:"personal,omitempty" url:"personal,omitempty,key"`                 // force creation of the app in the user account even if a default team
    // is set.
    Region *string `json:"region,omitempty" url:"region,omitempty,key"` // unique name of region
    Space  *string `json:"space,omitempty" url:"space,omitempty,key"`   // unique name of space
    Stack  *string `json:"stack,omitempty" url:"stack,omitempty,key"`   // unique name of stack
    Team   *string `json:"team,omitempty" url:"team,omitempty,key"`     // unique name of team
}

type TeamAppListByTeamResult Uses

type TeamAppListByTeamResult []TeamApp

type TeamAppPermission Uses

type TeamAppPermission struct {
    Description string `json:"description" url:"description,key"` // A description of what the app permission allows.
    Name        string `json:"name" url:"name,key"`               // The name of the app permission.
}

A team app permission is a behavior that is assigned to a user in a team app.

type TeamAppPermissionListResult Uses

type TeamAppPermissionListResult []TeamAppPermission

type TeamAppTransferToAccountOpts Uses

type TeamAppTransferToAccountOpts struct {
    Owner string `json:"owner" url:"owner,key"` // unique email address of account
}

type TeamAppTransferToTeamOpts Uses

type TeamAppTransferToTeamOpts struct {
    Owner string `json:"owner" url:"owner,key"` // unique name of team
}

type TeamAppUpdateLockedOpts Uses

type TeamAppUpdateLockedOpts struct {
    Locked bool `json:"locked" url:"locked,key"` // are other team members forbidden from joining this app.
}

type TeamCreateOpts Uses

type TeamCreateOpts struct {
    Address1        *string `json:"address_1,omitempty" url:"address_1,omitempty,key"`               // street address line 1
    Address2        *string `json:"address_2,omitempty" url:"address_2,omitempty,key"`               // street address line 2
    CardNumber      *string `json:"card_number,omitempty" url:"card_number,omitempty,key"`           // encrypted card number of payment method
    City            *string `json:"city,omitempty" url:"city,omitempty,key"`                         // city
    Country         *string `json:"country,omitempty" url:"country,omitempty,key"`                   // country
    Cvv             *string `json:"cvv,omitempty" url:"cvv,omitempty,key"`                           // card verification value
    DeviceData      *string `json:"device_data,omitempty" url:"device_data,omitempty,key"`           // Device data string generated by the client
    ExpirationMonth *string `json:"expiration_month,omitempty" url:"expiration_month,omitempty,key"` // expiration month
    ExpirationYear  *string `json:"expiration_year,omitempty" url:"expiration_year,omitempty,key"`   // expiration year
    FirstName       *string `json:"first_name,omitempty" url:"first_name,omitempty,key"`             // the first name for payment method
    LastName        *string `json:"last_name,omitempty" url:"last_name,omitempty,key"`               // the last name for payment method
    Name            string  `json:"name" url:"name,key"`                                             // unique name of team
    Nonce           *string `json:"nonce,omitempty" url:"nonce,omitempty,key"`                       // Nonce generated by Braintree hosted fields form
    Other           *string `json:"other,omitempty" url:"other,omitempty,key"`                       // metadata
    PostalCode      *string `json:"postal_code,omitempty" url:"postal_code,omitempty,key"`           // postal code
    State           *string `json:"state,omitempty" url:"state,omitempty,key"`                       // state
}

type TeamFeature Uses

type TeamFeature struct {
    CreatedAt     time.Time `json:"created_at" url:"created_at,key"`         // when team feature was created
    Description   string    `json:"description" url:"description,key"`       // description of team feature
    DisplayName   string    `json:"display_name" url:"display_name,key"`     // user readable feature name
    DocURL        string    `json:"doc_url" url:"doc_url,key"`               // documentation URL of team feature
    Enabled       bool      `json:"enabled" url:"enabled,key"`               // whether or not team feature has been enabled
    FeedbackEmail string    `json:"feedback_email" url:"feedback_email,key"` // e-mail to send feedback about the feature
    ID            string    `json:"id" url:"id,key"`                         // unique identifier of team feature
    Name          string    `json:"name" url:"name,key"`                     // unique name of team feature
    State         string    `json:"state" url:"state,key"`                   // state of team feature
    UpdatedAt     time.Time `json:"updated_at" url:"updated_at,key"`         // when team feature was updated
}

A team feature represents a feature enabled on a team account.

type TeamFeatureListResult Uses

type TeamFeatureListResult []TeamFeature

type TeamInvitation Uses

type TeamInvitation struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when invitation was created
    ID        string    `json:"id" url:"id,key"`                 // unique identifier of an invitation
    InvitedBy struct {
        Email string  `json:"email" url:"email,key"` // unique email address of account
        ID    string  `json:"id" url:"id,key"`       // unique identifier of an account
        Name  *string `json:"name" url:"name,key"`   // full name of the account owner
    }   `json:"invited_by" url:"invited_by,key"`
    Role *string `json:"role" url:"role,key"` // role in the team
    Team struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of team
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"team" url:"team,key"`
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when invitation was updated
    User      struct {
        Email string  `json:"email" url:"email,key"` // unique email address of account
        ID    string  `json:"id" url:"id,key"`       // unique identifier of an account
        Name  *string `json:"name" url:"name,key"`   // full name of the account owner
    }   `json:"user" url:"user,key"`
}

A team invitation represents an invite to a team.

type TeamInvitationAcceptResult Uses

type TeamInvitationAcceptResult struct {
    CreatedAt               time.Time `json:"created_at" url:"created_at,key"`                               // when the membership record was created
    Email                   string    `json:"email" url:"email,key"`                                         // email address of the team member
    Federated               bool      `json:"federated" url:"federated,key"`                                 // whether the user is federated and belongs to an Identity Provider
    ID                      string    `json:"id" url:"id,key"`                                               // unique identifier of the team member
    Role                    *string   `json:"role" url:"role,key"`                                           // role in the team
    TwoFactorAuthentication bool      `json:"two_factor_authentication" url:"two_factor_authentication,key"` // whether the Enterprise team member has two factor authentication
    // enabled
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the membership record was updated
    User      struct {
        Email string  `json:"email" url:"email,key"` // unique email address of account
        ID    string  `json:"id" url:"id,key"`       // unique identifier of an account
        Name  *string `json:"name" url:"name,key"`   // full name of the account owner
    }   `json:"user" url:"user,key"` // user information for the membership
}

type TeamInvitationCreateOpts Uses

type TeamInvitationCreateOpts struct {
    Email string  `json:"email" url:"email,key"` // unique email address of account
    Role  *string `json:"role" url:"role,key"`   // role in the team
}

type TeamInvitationListResult Uses

type TeamInvitationListResult []TeamInvitation

type TeamInvoice Uses

type TeamInvoice struct {
    AddonsTotal       int       `json:"addons_total" url:"addons_total,key"`               // total add-ons charges in on this invoice
    ChargesTotal      int       `json:"charges_total" url:"charges_total,key"`             // total charges on this invoice
    CreatedAt         time.Time `json:"created_at" url:"created_at,key"`                   // when invoice was created
    CreditsTotal      int       `json:"credits_total" url:"credits_total,key"`             // total credits on this invoice
    DatabaseTotal     int       `json:"database_total" url:"database_total,key"`           // total database charges on this invoice
    DynoUnits         float64   `json:"dyno_units" url:"dyno_units,key"`                   // total amount of dyno units consumed across dyno types.
    ID                string    `json:"id" url:"id,key"`                                   // unique identifier of this invoice
    Number            int       `json:"number" url:"number,key"`                           // human readable invoice number
    PaymentStatus     string    `json:"payment_status" url:"payment_status,key"`           // status of the invoice payment
    PeriodEnd         string    `json:"period_end" url:"period_end,key"`                   // the ending date that the invoice covers
    PeriodStart       string    `json:"period_start" url:"period_start,key"`               // the starting date that this invoice covers
    PlatformTotal     int       `json:"platform_total" url:"platform_total,key"`           // total platform charges on this invoice
    State             int       `json:"state" url:"state,key"`                             // payment status for this invoice (pending, successful, failed)
    Total             int       `json:"total" url:"total,key"`                             // combined total of charges and credits on this invoice
    UpdatedAt         time.Time `json:"updated_at" url:"updated_at,key"`                   // when invoice was updated
    WeightedDynoHours float64   `json:"weighted_dyno_hours" url:"weighted_dyno_hours,key"` // The total amount of hours consumed across dyno types.
}

A Team Invoice is an itemized bill of goods for a team which includes pricing and charges.

type TeamInvoiceListResult Uses

type TeamInvoiceListResult []TeamInvoice

type TeamListResult Uses

type TeamListResult []Team

type TeamMember Uses

type TeamMember struct {
    CreatedAt               time.Time `json:"created_at" url:"created_at,key"`                               // when the membership record was created
    Email                   string    `json:"email" url:"email,key"`                                         // email address of the team member
    Federated               bool      `json:"federated" url:"federated,key"`                                 // whether the user is federated and belongs to an Identity Provider
    ID                      string    `json:"id" url:"id,key"`                                               // unique identifier of the team member
    Role                    *string   `json:"role" url:"role,key"`                                           // role in the team
    TwoFactorAuthentication bool      `json:"two_factor_authentication" url:"two_factor_authentication,key"` // whether the Enterprise team member has two factor authentication
    // enabled
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when the membership record was updated
    User      struct {
        Email string  `json:"email" url:"email,key"` // unique email address of account
        ID    string  `json:"id" url:"id,key"`       // unique identifier of an account
        Name  *string `json:"name" url:"name,key"`   // full name of the account owner
    }   `json:"user" url:"user,key"` // user information for the membership
}

A team member is an individual with access to a team.

type TeamMemberCreateOpts Uses

type TeamMemberCreateOpts struct {
    Email     string `json:"email" url:"email,key"`                             // email address of the team member
    Federated *bool  `json:"federated,omitempty" url:"federated,omitempty,key"` // whether the user is federated and belongs to an Identity Provider
    Role      string `json:"role" url:"role,key"`                               // role in the team
}

type TeamMemberCreateOrUpdateOpts Uses

type TeamMemberCreateOrUpdateOpts struct {
    Email     string `json:"email" url:"email,key"`                             // email address of the team member
    Federated *bool  `json:"federated,omitempty" url:"federated,omitempty,key"` // whether the user is federated and belongs to an Identity Provider
    Role      string `json:"role" url:"role,key"`                               // role in the team
}

type TeamMemberListByMemberResult Uses

type TeamMemberListByMemberResult []struct {
    ArchivedAt *time.Time `json:"archived_at" url:"archived_at,key"` // when app was archived
    BuildStack struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"build_stack" url:"build_stack,key"` // identity of the stack that will be used for new builds
    BuildpackProvidedDescription *string   `json:"buildpack_provided_description" url:"buildpack_provided_description,key"` // description from buildpack of app
    CreatedAt                    time.Time `json:"created_at" url:"created_at,key"`                                         // when app was created
    GitURL                       string    `json:"git_url" url:"git_url,key"`                                               // git repo URL of app
    ID                           string    `json:"id" url:"id,key"`                                                         // unique identifier of app
    InternalRouting              *bool     `json:"internal_routing" url:"internal_routing,key"`                             // describes whether a Private Spaces app is externally routable or not
    Joined                       bool      `json:"joined" url:"joined,key"`                                                 // is the current member a collaborator on this app.
    Locked                       bool      `json:"locked" url:"locked,key"`                                                 // are other team members forbidden from joining this app.
    Maintenance                  bool      `json:"maintenance" url:"maintenance,key"`                                       // maintenance status of app
    Name                         string    `json:"name" url:"name,key"`                                                     // unique name of app
    Owner                        *struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"owner" url:"owner,key"` // identity of app owner
    Region struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of region
        Name string `json:"name" url:"name,key"` // unique name of region
    }   `json:"region" url:"region,key"` // identity of app region
    ReleasedAt *time.Time `json:"released_at" url:"released_at,key"` // when app was released
    RepoSize   *int       `json:"repo_size" url:"repo_size,key"`     // git repo size in bytes of app
    SlugSize   *int       `json:"slug_size" url:"slug_size,key"`     // slug size in bytes of app
    Space      *struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of space
        Name string `json:"name" url:"name,key"` // unique name of space
    }   `json:"space" url:"space,key"` // identity of space
    Stack struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of stack
        Name string `json:"name" url:"name,key"` // unique name of stack
    }   `json:"stack" url:"stack,key"` // identity of app stack
    Team *struct {
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"team" url:"team,key"` // team that owns this app
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when app was updated
    WebURL    string    `json:"web_url" url:"web_url,key"`       // web URL of app
}

type TeamMemberListResult Uses

type TeamMemberListResult []TeamMember

type TeamMemberUpdateOpts Uses

type TeamMemberUpdateOpts struct {
    Email     string `json:"email" url:"email,key"`                             // email address of the team member
    Federated *bool  `json:"federated,omitempty" url:"federated,omitempty,key"` // whether the user is federated and belongs to an Identity Provider
    Role      string `json:"role" url:"role,key"`                               // role in the team
}

type TeamPreferences Uses

type TeamPreferences struct {
    DefaultPermission   *string `json:"default-permission" url:"default-permission,key"`     // The default permission used when adding new members to the team
    WhitelistingEnabled *bool   `json:"whitelisting-enabled" url:"whitelisting-enabled,key"` // Whether whitelisting rules should be applied to add-on installations
}

Tracks a Team's Preferences

type TeamPreferencesUpdateOpts Uses

type TeamPreferencesUpdateOpts struct {
    WhitelistingEnabled *bool `json:"whitelisting-enabled,omitempty" url:"whitelisting-enabled,omitempty,key"` // Whether whitelisting rules should be applied to add-on installations
}

type TeamSpace Uses

type TeamSpace struct{}

A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.

type TeamSpaceListResult Uses

type TeamSpaceListResult []struct {
    CIDR string `json:"cidr" url:"cidr,key"` // The RFC-1918 CIDR the Private Space will use. It must be a /16 in
    // 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when space was created
    DataCIDR  string    `json:"data_cidr" url:"data_cidr,key"`   // The RFC-1918 CIDR that the Private Space will use for the
    // Heroku-managed peering connection that's automatically created when
    // using Heroku Data add-ons. It must be between a /16 and a /20
    ID           string `json:"id" url:"id,key"`     // unique identifier of space
    Name         string `json:"name" url:"name,key"` // unique name of space
    Organization struct {
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"organization" url:"organization,key"` // organization that owns this space
    Region struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of region
        Name string `json:"name" url:"name,key"` // unique name of region
    }   `json:"region" url:"region,key"` // identity of space region
    Shield bool   `json:"shield" url:"shield,key"` // true if this space has shield enabled
    State  string `json:"state" url:"state,key"`   // availability of this space
    Team   struct {
        ID   string `json:"id" url:"id,key"`     // unique identifier of team
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"team" url:"team,key"` // team that owns this space
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when space was updated
}

type TeamUpdateOpts Uses

type TeamUpdateOpts struct {
    Default *bool   `json:"default,omitempty" url:"default,omitempty,key"` // whether to use this team when none is specified
    Name    *string `json:"name,omitempty" url:"name,omitempty,key"`       // unique name of team
}

type TestCase Uses

type TestCase struct {
    CreatedAt   time.Time `json:"created_at" url:"created_at,key"`   // when test case was created
    Description string    `json:"description" url:"description,key"` // description of the test case
    Diagnostic  string    `json:"diagnostic" url:"diagnostic,key"`   // meta information about the test case
    Directive   string    `json:"directive" url:"directive,key"`     // special note about the test case e.g. skipped, todo
    ID          string    `json:"id" url:"id,key"`                   // unique identifier of a test case
    Number      int       `json:"number" url:"number,key"`           // the test number
    Passed      bool      `json:"passed" url:"passed,key"`           // whether the test case was successful
    TestNode    struct {
        ID string `json:"id" url:"id,key"` // unique identifier of a test node
    }   `json:"test_node" url:"test_node,key"` // the test node which executed this test case
    TestRun struct {
        ID string `json:"id" url:"id,key"` // unique identifier of a test run
    }   `json:"test_run" url:"test_run,key"` // the test run which owns this test case
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when test case was updated
}

A single test case belonging to a test run

type TestCaseListResult Uses

type TestCaseListResult []TestCase

type TestNode Uses

type TestNode struct {
    CreatedAt time.Time `json:"created_at" url:"created_at,key"` // when test node was created
    Dyno      *struct {
        AttachURL *string `json:"attach_url" url:"attach_url,key"` // a URL to stream output from for debug runs or null for non-debug runs
        ID        string  `json:"id" url:"id,key"`                 // unique identifier of this dyno
    }   `json:"dyno" url:"dyno,key"` // the dyno which belongs to this test node
    ErrorStatus     *string `json:"error_status" url:"error_status,key"`           // the status of the test run when the error occured
    ExitCode        *int    `json:"exit_code" url:"exit_code,key"`                 // the exit code of the test script
    ID              string  `json:"id" url:"id,key"`                               // unique identifier of a test node
    Index           int     `json:"index" url:"index,key"`                         // The index of the test node
    Message         *string `json:"message" url:"message,key"`                     // human friendly message indicating reason for an error
    OutputStreamURL string  `json:"output_stream_url" url:"output_stream_url,key"` // the streaming output for the test node
    Pipeline        struct {
        ID string `json:"id" url:"id,key"` // unique identifier of pipeline
    }   `json:"pipeline" url:"pipeline,key"` // the pipeline which owns this test node
    SetupStreamURL string `json:"setup_stream_url" url:"setup_stream_url,key"` // the streaming test setup output for the test node
    Status         string `json:"status" url:"status,key"`                     // current state of the test run
    TestRun        struct {
        ID string `json:"id" url:"id,key"` // unique identifier of a test run
    }   `json:"test_run" url:"test_run,key"` // the test run which owns this test node
    UpdatedAt time.Time `json:"updated_at" url:"updated_at,key"` // when test node was updated
}

A single test node belonging to a test run

type TestNodeListResult Uses

type TestNodeListResult []TestNode

type TestRun Uses

type TestRun struct {
    ActorEmail    string    `json:"actor_email" url:"actor_email,key"`       // the email of the actor triggering the test run
    AppSetup      *struct{} `json:"app_setup" url:"app_setup,key"`           // the app setup for the test run
    ClearCache    *bool     `json:"clear_cache" url:"clear_cache,key"`       // whether the test was run with an empty cache
    CommitBranch  string    `json:"commit_branch" url:"commit_branch,key"`   // the branch of the repository that the test run concerns
    CommitMessage string    `json:"commit_message" url:"commit_message,key"` // the message for the commit under test
    CommitSha     string    `json:"commit_sha" url:"commit_sha,key"`         // the SHA hash of the commit under test
    CreatedAt     time.Time `json:"created_at" url:"created_at,key"`         // when test run was created
    Debug         bool      `json:"debug" url:"debug,key"`                   // whether the test run was started for interactive debugging
    Dyno          *struct {
        Size string `json:"size" url:"size,key"` // dyno size (default: "standard-1X")
    }   `json:"dyno" url:"dyno,key"` // the type of dynos used for this test-run
    ID           string  `json:"id" url:"id,key"`           // unique identifier of a test run
    Message      *string `json:"message" url:"message,key"` // human friendly message indicating reason for an error
    Number       int     `json:"number" url:"number,key"`   // the auto incrementing test run number
    Organization *struct {
        Name string `json:"name" url:"name,key"` // unique name of team
    }   `json:"organization" url:"organization,key"` // the team that owns this test-run
    Pipeline struct {
        ID string `json:"id" url:"id,key"` // unique identifier of pipeline
    }   `json:"pipeline" url:"pipeline,key"` // the pipeline which owns this test-run
    SourceBlobURL string    `json:"source_blob_url" url:"source_blob_url,key"` // The download location for the source code to be tested
    Status        string    `json:"status" url:"status,key"`                   // current state of the test run
    UpdatedAt     time.Time `json:"updated_at" url:"updated_at,key"`           // when test-run was updated
    User          struct {
        AllowTracking       bool      `json:"allow_tracking" url:"allow_tracking,key"` // whether to allow third party web activity tracking
        Beta                bool      `json:"beta" url:"beta,key"`                     // whether allowed to utilize beta Heroku features
        CreatedAt           time.Time `json:"created_at" url:"created_at,key"`         // when account was created
        DefaultOrganization *struct {
            ID   string `json:"id" url:"id,key"`     // unique identifier of team
            Name string `json:"name" url:"name,key"` // unique name of team
        }   `json:"default_organization" url:"default_organization,key"` // team selected by default
        DefaultTeam *struct {
            ID   string `json:"id" url:"id,key"`     // unique identifier of team
            Name string `json:"name" url:"name,key"` // unique name of team
        }   `json:"default_team" url:"default_team,key"` // team selected by default
        DelinquentAt     *time.Time `json:"delinquent_at" url:"delinquent_at,key"` // when account became delinquent
        Email            string     `json:"email" url:"email,key"`                 // unique email address of account
        Federated        bool       `json:"federated" url:"federated,key"`         // whether the user is federated and belongs to an Identity Provider
        ID               string     `json:"id" url:"id,key"`                       // unique identifier of an account
        IdentityProvider *struct {
            ID           string `json:"id" url:"id,key"` // unique identifier of this identity provider
            Organization struct {
                Name string `json:"name" url:"name,key"` // unique name of team
            }   `json:"organization" url:"organization,key"`
            Owner struct {
                ID   string `json:"id" url:"id,key"`     // unique identifier of the owner
                Name string `json:"name" url:"name,key"` // name of the owner
                Type string `json:"type" url:"type,key"` // type of the owner
            }   `json:"owner" url:"owner,key"` // entity that owns this identity provider
            Team struct {
                Name string `json:"name" url:"name,key"` // unique name of team
            }   `json:"team" url:"team,key"`
        }   `json:"identity_provider" url:"identity_provider,key"` // Identity Provider details for federated users.
        LastLogin               *time.Time `json:"last_login" url:"last_login,key"`                               // when account last authorized with Heroku
        Name                    *string    `json:"name" url:"name,key"`                                           // full name of the account owner
        SmsNumber               *string    `json:"sms_number" url:"sms_number,key"`                               // SMS number of account
        SuspendedAt             *time.Time `json:"suspended_at" url:"suspended_at,key"`                           // when account was suspended
        TwoFactorAuthentication bool       `json:"two_factor_authentication" url:"two_factor_authentication,key"` // whether two-factor auth is enabled on the account
        UpdatedAt               time.Time  `json:"updated_at" url:"updated_at,key"`                               // when account was updated
        Verified                bool       `json:"verified" url:"verified,key"`                                   // whether account has been verified with billing information
    }   `json:"user" url:"user,key"` // An account represents an individual signed up to use the Heroku
    // platform.
    WarningMessage *string `json:"warning_message" url:"warning_message,key"` // human friently warning emitted during the test run
}

An execution or trial of one or more tests

type TestRunCreateOpts Uses

type TestRunCreateOpts struct {
    CommitBranch  string  `json:"commit_branch" url:"commit_branch,key"`                   // the branch of the repository that the test run concerns
    CommitMessage string  `json:"commit_message" url:"commit_message,key"`                 // the message for the commit under test
    CommitSha     string  `json:"commit_sha" url:"commit_sha,key"`                         // the SHA hash of the commit under test
    Debug         *bool   `json:"debug,omitempty" url:"debug,omitempty,key"`               // whether the test run was started for interactive debugging
    Organization  *string `json:"organization,omitempty" url:"organization,omitempty,key"` // unique name of team
    Pipeline      string  `json:"pipeline" url:"pipeline,key"`                             // unique identifier of pipeline
    SourceBlobURL string  `json:"source_blob_url" url:"source_blob_url,key"`               // The download location for the source code to be tested
}

type TestRunListResult Uses

type TestRunListResult []TestRun

type TestRunUpdateOpts Uses

type TestRunUpdateOpts struct {
    Message *string `json:"message" url:"message,key"` // human friendly message indicating reason for an error
    Status  string  `json:"status" url:"status,key"`   // current state of the test run
}

type Transport Uses

type Transport struct {
    // Username is the HTTP basic auth username for API calls made by this Client.
    Username string

    // Password is the HTTP basic auth password for API calls made by this Client.
    Password string

    // BearerToken is a bearer token to authorize the request with. If this is
    // set, the basic auth credentials will be ignored.
    BearerToken string

    // UserAgent to be provided in API requests. Set to DefaultUserAgent if not
    // specified.
    UserAgent string

    // Debug mode can be used to dump the full request and response to stdout.
    Debug bool

    // AdditionalHeaders are extra headers to add to each HTTP request sent by
    // this Client.
    AdditionalHeaders http.Header

    // Transport is the HTTP transport to use when making requests.
    // It will default to http.DefaultTransport if nil.
    Transport http.RoundTripper
}

func (*Transport) CancelRequest Uses

func (t *Transport) CancelRequest(req *http.Request)

Forward CancelRequest to underlying Transport

func (*Transport) RoundTrip Uses

func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error)

type UserPreferences Uses

type UserPreferences struct {
    DefaultOrganization        *string `json:"default-organization" url:"default-organization,key"`                   // User's default team
    DismissedGettingStarted    *bool   `json:"dismissed-getting-started" url:"dismissed-getting-started,key"`         // Whether the user has dismissed the getting started banner
    DismissedGithubBanner      *bool   `json:"dismissed-github-banner" url:"dismissed-github-banner,key"`             // Whether the user has dismissed the GitHub link banner
    DismissedOrgAccessControls *bool   `json:"dismissed-org-access-controls" url:"dismissed-org-access-controls,key"` // Whether the user has dismissed the Organization Access Controls
    // banner
    DismissedOrgWizardNotification *bool `json:"dismissed-org-wizard-notification" url:"dismissed-org-wizard-notification,key"` // Whether the user has dismissed the Organization Wizard
    DismissedPipelinesBanner       *bool `json:"dismissed-pipelines-banner" url:"dismissed-pipelines-banner,key"`               // Whether the user has dismissed the Pipelines banner
    DismissedPipelinesGithubBanner *bool `json:"dismissed-pipelines-github-banner" url:"dismissed-pipelines-github-banner,key"` // Whether the user has dismissed the GitHub banner on a pipeline
    // overview
    DismissedPipelinesGithubBanners []string `json:"dismissed-pipelines-github-banners" url:"dismissed-pipelines-github-banners,key"` // Which pipeline uuids the user has dismissed the GitHub banner for
    DismissedSmsBanner              *bool    `json:"dismissed-sms-banner" url:"dismissed-sms-banner,key"`                             // Whether the user has dismissed the 2FA SMS banner
    Timezone                        *string  `json:"timezone" url:"timezone,key"`                                                     // User's default timezone
}

Tracks a user's preferences and message dismissals

type UserPreferencesUpdateOpts Uses

type UserPreferencesUpdateOpts struct {
    DefaultOrganization        *string `json:"default-organization,omitempty" url:"default-organization,omitempty,key"`                   // User's default team
    DismissedGettingStarted    *bool   `json:"dismissed-getting-started,omitempty" url:"dismissed-getting-started,omitempty,key"`         // Whether the user has dismissed the getting started banner
    DismissedGithubBanner      *bool   `json:"dismissed-github-banner,omitempty" url:"dismissed-github-banner,omitempty,key"`             // Whether the user has dismissed the GitHub link banner
    DismissedOrgAccessControls *bool   `json:"dismissed-org-access-controls,omitempty" url:"dismissed-org-access-controls,omitempty,key"` // Whether the user has dismissed the Organization Access Controls
    // banner
    DismissedOrgWizardNotification *bool `json:"dismissed-org-wizard-notification,omitempty" url:"dismissed-org-wizard-notification,omitempty,key"` // Whether the user has dismissed the Organization Wizard
    DismissedPipelinesBanner       *bool `json:"dismissed-pipelines-banner,omitempty" url:"dismissed-pipelines-banner,omitempty,key"`               // Whether the user has dismissed the Pipelines banner
    DismissedPipelinesGithubBanner *bool `json:"dismissed-pipelines-github-banner,omitempty" url:"dismissed-pipelines-github-banner,omitempty,key"` // Whether the user has dismissed the GitHub banner on a pipeline
    // overview
    DismissedPipelinesGithubBanners []*string `json:"dismissed-pipelines-github-banners,omitempty" url:"dismissed-pipelines-github-banners,omitempty,key"` // Which pipeline uuids the user has dismissed the GitHub banner for
    DismissedSmsBanner              *bool     `json:"dismissed-sms-banner,omitempty" url:"dismissed-sms-banner,omitempty,key"`                             // Whether the user has dismissed the 2FA SMS banner
    Timezone                        *string   `json:"timezone,omitempty" url:"timezone,omitempty,key"`                                                     // User's default timezone
}

type VPNConnection Uses

type VPNConnection struct {
    ID             string   `json:"id" url:"id,key"`                             // VPN ID
    IKEVersion     int      `json:"ike_version" url:"ike_version,key"`           // IKE Version
    Name           string   `json:"name" url:"name,key"`                         // VPN Name
    PublicIP       string   `json:"public_ip" url:"public_ip,key"`               // Public IP of VPN customer gateway
    RoutableCidrs  []string `json:"routable_cidrs" url:"routable_cidrs,key"`     // Routable CIDRs of VPN
    SpaceCIDRBlock string   `json:"space_cidr_block" url:"space_cidr_block,key"` // CIDR Block of the Private Space
    Status         string   `json:"status" url:"status,key"`                     // Status of the VPN
    StatusMessage  string   `json:"status_message" url:"status_message,key"`     // Details of the status
    Tunnels        []struct {
        CustomerIP       string `json:"customer_ip" url:"customer_ip,key"`               // Public IP address for the customer side of the tunnel
        IP               string `json:"ip" url:"ip,key"`                                 // Public IP address for the tunnel
        LastStatusChange string `json:"last_status_change" url:"last_status_change,key"` // Timestamp of last status changed
        PreSharedKey     string `json:"pre_shared_key" url:"pre_shared_key,key"`         // Pre-shared key
        Status           string `json:"status" url:"status,key"`                         // Status of the tunnel
        StatusMessage    string `json:"status_message" url:"status_message,key"`         // Details of the status
    }   `json:"tunnels" url:"tunnels,key"`
}

[VPN](https://devcenter.heroku.com/articles/private-space-vpn-connecti on) provides a way to connect your Private Spaces to your network via VPN.

type VPNConnectionCreateOpts Uses

type VPNConnectionCreateOpts struct {
    Name          string   `json:"name" url:"name,key"`                     // VPN Name
    PublicIP      string   `json:"public_ip" url:"public_ip,key"`           // Public IP of VPN customer gateway
    RoutableCidrs []string `json:"routable_cidrs" url:"routable_cidrs,key"` // Routable CIDRs of VPN
}

type VPNConnectionListResult Uses

type VPNConnectionListResult []VPNConnection

type WhitelistedAddOnService Uses

type WhitelistedAddOnService struct {
    AddedAt time.Time `json:"added_at" url:"added_at,key"` // when the add-on service was whitelisted
    AddedBy struct {
        Email string `json:"email" url:"email,key"` // unique email address of account
        ID    string `json:"id" url:"id,key"`       // unique identifier of an account
    }   `json:"added_by" url:"added_by,key"` // the user which whitelisted the Add-on Service
    AddonService struct {
        HumanName string `json:"human_name" url:"human_name,key"` // human-readable name of the add-on service provider
        ID        string `json:"id" url:"id,key"`                 // unique identifier of this add-on-service
        Name      string `json:"name" url:"name,key"`             // unique name of this add-on-service
    }   `json:"addon_service" url:"addon_service,key"` // the Add-on Service whitelisted for use
    ID  string `json:"id" url:"id,key"` // unique identifier for this whitelisting entity
}

Entities that have been whitelisted to be used by an Team

type WhitelistedAddOnServiceCreateByTeamOpts Uses

type WhitelistedAddOnServiceCreateByTeamOpts struct {
    AddonService *string `json:"addon_service,omitempty" url:"addon_service,omitempty,key"` // name of the Add-on to whitelist
}

type WhitelistedAddOnServiceCreateByTeamResult Uses

type WhitelistedAddOnServiceCreateByTeamResult []WhitelistedAddOnService

type WhitelistedAddOnServiceListByTeamResult Uses

type WhitelistedAddOnServiceListByTeamResult []WhitelistedAddOnService

Package v5 imports 16 packages (graph) and is imported by 4 packages. Updated 2019-07-11. Refresh now. Tools for package owners.