@heroku-cli/schema/lib/index.d.ts

@heroku-cli/typescript-api-schema =================================

/**
 * This file was automatically generated by json-schema-to-typescript.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run json-schema-to-typescript to regenerate this file.
 */

/**
 * The platform API empowers developers to automate, extend and combine Heroku with other services.
 */
export interface HerokuPlatformApi {
  'account-feature'?: AccountFeature
  account?: Account
  'add-on-action'?: AddOnAction
  'add-on-attachment'?: AddOnAttachment
  'add-on-config'?: AddOnConfig
  'add-on-plan-action'?: AddOnPlanAction
  'add-on-region-capability'?: AddOnRegionCapability
  'add-on-service'?: AddOnService
  'add-on-webhook-delivery'?: AddOnWebhookDelivery
  'add-on-webhook-event'?: AddOnWebhookEvent
  'add-on-webhook'?: AddOnWebhook
  'add-on'?: AddOn
  'app-feature'?: AppFeature
  'app-formation-set'?: ApplicationFormationSet
  'app-setup'?: AppSetup
  'app-transfer'?: AppTransfer
  'app-webhook-delivery'?: AppWebhookDelivery
  'app-webhook-event'?: AppWebhookEvent
  'app-webhook'?: AppWebhook
  app?: App
  'build-result'?: BuildResult
  build?: Build
  'buildpack-installation'?: BuildpackInstallations
  collaborator?: Collaborator
  'config-var'?: ConfigVars
  credit?: Credit
  domain?: Domain
  'dyno-size'?: DynoSize
  dyno?: Dyno
  'filter-apps'?: Filters
  formation?: Formation
  'identity-provider'?: IdentityProvider
  'inbound-ruleset'?: InboundRuleset
  'invoice-address'?: InvoiceAddress
  invoice?: Invoice
  key?: Key
  'log-drain'?: LogDrain
  'log-session'?: LogSession
  'oauth-authorization'?: OAuthAuthorization
  'oauth-client'?: OAuthClient
  'oauth-grant'?: OAuthGrant
  'oauth-token'?: OAuthToken
  'organization-add-on'?: OrganizationAddOn
  'organization-app-collaborator'?: OrganizationAppCollaborator
  'organization-app'?: OrganizationApp
  'organization-feature'?: OrganizationFeature
  'organization-invitation'?: OrganizationInvitation
  'organization-invoice'?: OrganizationInvoice
  'organization-member'?: OrganizationMember
  'organization-preferences'?: OrganizationPreferences
  organization?: Organization
  'outbound-ruleset'?: OutboundRuleset
  'password-reset'?: PasswordReset
  'peering-info'?: PeeringInfo
  peering?: Peering
  'organization-app-permission'?: OrganizationAppPermission
  'pipeline-coupling'?: PipelineCoupling
  'pipeline-promotion-target'?: PipelinePromotionTarget
  'pipeline-promotion'?: PipelinePromotion
  pipeline?: Pipeline
  plan?: Plan
  'rate-limit'?: RateLimit
  region?: Region
  release?: Release
  slug?: Slug
  'sms-number'?: SmsNumber
  'sni-endpoint'?: SniEndpoint
  source?: Source
  'space-app-access'?: SpaceAccess
  'space-nat'?: SpaceNetworkAddressTranslation
  space?: Space
  'ssl-endpoint'?: SslEndpoint
  stack?: Stack
  'team-app-collaborator'?: TeamAppCollaborator
  'team-app-permission'?: TeamAppPermission
  'team-app'?: TeamApp
  'team-feature'?: TeamFeature
  'team-invitation'?: TeamInvitation
  'team-invoice'?: TeamInvoice
  'team-member'?: TeamMember
  'team-preferences'?: TeamPreferences
  team?: Team
  'user-preferences'?: UserPreferences
  'vpn-connection'?: PrivateSpacesVpn
  'whitelisted-add-on-service'?: WhitelistedEntity
  [k: string]: any
}
/**
 * An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
 */
export interface AccountFeature {
  /**
   * when account feature was created
   */
  created_at?: string
  /**
   * description of account feature
   */
  description?: string
  /**
   * documentation URL of account feature
   */
  doc_url?: string
  /**
   * whether or not account feature has been enabled
   */
  enabled?: boolean
  /**
   * unique identifier of account feature
   */
  id?: string
  /**
   * unique name of account feature
   */
  name?: string
  /**
   * state of account feature
   */
  state?: string
  /**
   * when account feature was updated
   */
  updated_at?: string
  /**
   * user readable feature name
   */
  display_name?: string
  /**
   * e-mail to send feedback about the feature
   */
  feedback_email?: string
  [k: string]: any
}
/**
 * An account represents an individual signed up to use the Heroku platform.
 */
export interface Account {
  /**
   * whether to allow third party web activity tracking
   */
  allow_tracking?: boolean
  /**
   * whether allowed to utilize beta Heroku features
   */
  beta?: boolean
  /**
   * when account was created
   */
  created_at?: string
  /**
   * unique email address of account
   */
  email?: string
  /**
   * whether the user is federated and belongs to an Identity Provider
   */
  federated?: boolean
  /**
   * unique identifier of an account
   */
  id?: string
  /**
   * Identity Provider details for federated users.
   */
  identity_provider?: {
    [k: string]: any
  } | null
  /**
   * when account last authorized with Heroku
   */
  last_login?: string | null
  /**
   * full name of the account owner
   */
  name?: string | null
  /**
   * SMS number of account
   */
  sms_number?: string | null
  /**
   * when account was suspended
   */
  suspended_at?: string | null
  /**
   * when account became delinquent
   */
  delinquent_at?: string | null
  /**
   * whether two-factor auth is enabled on the account
   */
  two_factor_authentication?: boolean
  /**
   * when account was updated
   */
  updated_at?: string
  /**
   * whether account has been verified with billing information
   */
  verified?: boolean
  /**
   * organization selected by default
   */
  default_organization?: {
    [k: string]: any
  } | null
  [k: string]: any
}
/**
 * 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.
 */
export interface AddOnAction {
  [k: string]: any
}
/**
 * An add-on attachment represents a connection between an app and an add-on that it has been given access to.
 */
export interface AddOnAttachment {
  /**
   * identity of add-on
   */
  addon?: {
    /**
     * unique identifier of add-on
     */
    id: string
    /**
     * globally unique name of the add-on
     */
    name: string
    /**
     * billing application associated with this add-on
     */
    app: {
      /**
       * unique identifier of app
       */
      id?: string
      /**
       * unique name of app
       */
      name?: string
      [k: string]: any
    }
  }
  /**
   * application that is attached to add-on
   */
  app?: {
    /**
     * unique identifier of app
     */
    id?: string
    /**
     * unique name of app
     */
    name?: string
    [k: string]: any
  }
  /**
   * when add-on attachment was created
   */
  created_at?: string
  /**
   * unique identifier of this add-on attachment
   */
  id?: string
  /**
   * unique name for this add-on attachment to this app
   */
  name?: string
  /**
   * attachment namespace
   */
  namespace?: null | string
  /**
   * when add-on attachment was updated
   */
  updated_at?: string
  /**
   * URL for logging into web interface of add-on in attached app context
   */
  web_url?: null | string
  [k: string]: any
}
/**
 * Configuration of an Add-on
 */
export interface AddOnConfig {
  /**
   * unique name of the config
   */
  name?: string
  /**
   * value of the config
   */
  value?: string | null
  [k: string]: any
}
/**
 * Add-on Plan Actions are Provider functionality for specific add-on installations
 */
export interface AddOnPlanAction {
  /**
   * a unique identifier
   */
  id?: string
  /**
   * the display text shown in Dashboard
   */
  label?: string
  /**
   * identifier of the action to take that is sent via SSO
   */
  action?: string
  /**
   * absolute URL to use instead of an action
   */
  url?: string
  /**
   * if the action requires the user to own the app
   */
  requires_owner?: boolean
  [k: string]: any
}
/**
 * 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.
 */
export interface AddOnRegionCapability {
  /**
   * unique identifier of this add-on-region-capability
   */
  id?: string
  /**
   * whether the add-on can be installed to a Space
   */
  supports_private_networking?: boolean
  addon_service?: AddOnService
  region?: Region
  [k: string]: any
}
/**
 * Add-on services represent add-ons that may be provisioned for apps. Endpoints under add-on services can be accessed without authentication.
 */
export interface AddOnService {
  /**
   * npm package name of the add-on service's Heroku CLI plugin
   */
  cli_plugin_name?: string | null
  /**
   * when add-on-service was created
   */
  created_at?: string
  /**
   * human-readable name of the add-on service provider
   */
  human_name?: string
  /**
   * unique identifier of this add-on-service
   */
  id?: string
  /**
   * unique name of this add-on-service
   */
  name?: string
  /**
   * release status for add-on service
   */
  state?: 'alpha' | 'beta' | 'ga' | 'shutdown'
  /**
   * whether or not apps can have access to more than one instance of this add-on at the same time
   */
  supports_multiple_installations?: boolean
  /**
   * whether or not apps can have access to add-ons billed to a different app
   */
  supports_sharing?: boolean
  /**
   * when add-on-service was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * A region represents a geographic location in which your application may run.
 */
export interface Region {
  /**
   * country where the region exists
   */
  country?: string
  /**
   * when region was created
   */
  created_at?: string
  /**
   * description of region
   */
  description?: string
  /**
   * unique identifier of region
   */
  id?: string
  /**
   * area in the country where the region exists
   */
  locale?: string
  /**
   * unique name of region
   */
  name?: string
  /**
   * whether or not region is available for creating a Private Space
   */
  private_capable?: boolean
  /**
   * provider of underlying substrate
   */
  provider?: {
    /**
     * name of provider
     */
    name?: string
    /**
     * region name used by provider
     */
    region?:
      | 'ap-south-1'
      | 'eu-west-1'
      | 'ap-southeast-1'
      | 'ap-southeast-2'
      | 'eu-central-1'
      | 'ap-northeast-2'
      | 'ap-northeast-1'
      | 'us-east-1'
      | 'sa-east-1'
      | 'us-west-1'
      | 'us-west-2'
    [k: string]: any
  }
  /**
   * when region was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * Represents the delivery of a webhook notification, including its current status.
 */
export interface AddOnWebhookDelivery {
  [k: string]: any
}
/**
 * Represents a webhook event that occurred.
 */
export interface AddOnWebhookEvent {
  [k: string]: any
}
/**
 * Represents the details of a webhook subscription
 */
export interface AddOnWebhook {
  /**
   * when the webhook was created
   */
  created_at: string
  /**
   * the webhook's unique identifier
   */
  id: string
  /**
   * the entities that the subscription provides notifications for
   */
  include: string[]
  /**
   * 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
   */
  level: 'notify' | 'sync'
  /**
   * when the webhook was updated
   */
  updated_at: string
  /**
   * the URL where the webhook's notification requests are sent
   */
  url: string
}
/**
 * Add-ons represent add-ons that have been provisioned and attached to one or more apps.
 */
export interface AddOn {
  /**
   * provider actions for this specific add-on
   */
  actions?: {
    [k: string]: any
  }[]
  /**
   * identity of add-on service
   */
  addon_service?: {
    /**
     * unique identifier of this add-on-service
     */
    id?: string
    /**
     * unique name of this add-on-service
     */
    name?: string
    [k: string]: any
  }
  /**
   * billing application associated with this add-on
   */
  app?: {
    /**
     * unique identifier of app
     */
    id?: string
    /**
     * unique name of app
     */
    name?: string
    [k: string]: any
  }
  /**
   * billed price
   */
  billed_price?: {
    [k: string]: any
  } | null
  /**
   * config vars exposed to the owning app by this add-on
   */
  config_vars?: string[]
  /**
   * when add-on was created
   */
  created_at?: string
  /**
   * unique identifier of add-on
   */
  id?: string
  /**
   * globally unique name of the add-on
   */
  name?: string
  /**
   * identity of add-on plan
   */
  plan?: {
    /**
     * unique identifier of this plan
     */
    id?: string
    /**
     * unique name of this plan
     */
    name?: string
    [k: string]: any
  }
  /**
   * id of this add-on with its provider
   */
  provider_id?: string
  /**
   * state in the add-on's lifecycle
   */
  state?: 'provisioning' | 'provisioned' | 'deprovisioned'
  /**
   * when add-on was updated
   */
  updated_at?: string
  /**
   * URL for logging into web interface of add-on (e.g. a dashboard)
   */
  web_url?: null | string
  [k: string]: any
}
/**
 * An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.
 */
export interface AppFeature {
  /**
   * when app feature was created
   */
  created_at?: string
  /**
   * description of app feature
   */
  description?: string
  /**
   * documentation URL of app feature
   */
  doc_url?: string
  /**
   * whether or not app feature has been enabled
   */
  enabled?: boolean
  /**
   * unique identifier of app feature
   */
  id?: string
  /**
   * unique name of app feature
   */
  name?: string
  /**
   * state of app feature
   */
  state?: string
  /**
   * when app feature was updated
   */
  updated_at?: string
  /**
   * user readable feature name
   */
  display_name?: string
  /**
   * e-mail to send feedback about the feature
   */
  feedback_email?: string
  [k: string]: any
}
/**
 * App formation set describes the combination of process types with their quantities and sizes as well as application process tier
 */
export interface ApplicationFormationSet {
  /**
   * a string representation of the formation set
   */
  description?: string
  /**
   * application process tier
   */
  process_tier?: 'production' | 'free' | 'hobby' | 'private'
  /**
   * app being described by the formation-set
   */
  app?: {
    /**
     * unique name of app
     */
    name?: string
    /**
     * unique identifier of app
     */
    id?: string
    [k: string]: any
  }
  /**
   * last time fomation-set was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
 */
export interface AppSetup {
  /**
   * unique identifier of app setup
   */
  id?: string
  /**
   * when app setup was created
   */
  created_at?: string
  /**
   * when app setup was updated
   */
  updated_at?: string
  /**
   * the overall status of app setup
   */
  status?: 'failed' | 'pending' | 'succeeded'
  /**
   * reason that app setup has failed
   */
  failure_message?: string | null
  /**
   * identity of app
   */
  app?: {
    /**
     * unique identifier of app
     */
    id?: string
    /**
     * unique name of app
     */
    name?: string
    [k: string]: any
  }
  /**
   * identity and status of build
   */
  build?: null | {
    [k: string]: any
  }
  /**
   * errors associated with invalid app.json manifest file
   */
  manifest_errors?: string[]
  /**
   * result of postdeploy script
   */
  postdeploy?: {
    [k: string]: any
  } | null
  /**
   * fully qualified success url
   */
  resolved_success_url?: string | null
  [k: string]: any
}
/**
 * An app transfer represents a two party interaction for transferring ownership of an app.
 */
export interface AppTransfer {
  /**
   * app involved in the transfer
   */
  app?: {
    /**
     * unique name of app
     */
    name?: string
    /**
     * unique identifier of app
     */
    id?: string
    [k: string]: any
  }
  /**
   * when app transfer was created
   */
  created_at?: string
  /**
   * unique identifier of app transfer
   */
  id?: string
  /**
   * identity of the owner of the transfer
   */
  owner?: {
    /**
     * unique email address of account
     */
    email?: string
    /**
     * unique identifier of an account
     */
    id?: string
    [k: string]: any
  }
  /**
   * identity of the recipient of the transfer
   */
  recipient?: {
    /**
     * unique email address of account
     */
    email?: string
    /**
     * unique identifier of an account
     */
    id?: string
    [k: string]: any
  }
  /**
   * the current state of an app transfer
   */
  state?: 'pending' | 'accepted' | 'declined'
  /**
   * when app transfer was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * Represents the delivery of a webhook notification, including its current status.
 */
export interface AppWebhookDelivery {
  /**
   * when the delivery was created
   */
  created_at?: string
  /**
   * identity of event
   */
  event?: {
    /**
     * the event's unique identifier
     */
    id?: string
    /**
     * the type of entity that the event is related to
     */
    include?: string
    [k: string]: any
  }
  /**
   * the delivery's unique identifier
   */
  id?: string
  /**
   * number of times a delivery has been attempted
   */
  num_attempts?: number
  /**
   * when delivery will be attempted again
   */
  next_attempt_at?: string | null
  /**
   * last attempt of a delivery
   */
  last_attempt?: {
    [k: string]: any
  } | null
  /**
   * the delivery's status
   */
  status?: 'pending' | 'scheduled' | 'retrying' | 'failed' | 'succeeded'
  /**
   * when the delivery was last updated
   */
  updated_at?: string
  /**
   * identity of webhook
   */
  webhook?: {
    /**
     * the webhook's unique identifier
     */
    id?: string
    /**
     * 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
     */
    level?: 'notify' | 'sync'
    [k: string]: any
  }
  [k: string]: any
}
/**
 * Represents a webhook event that occurred.
 */
export interface AppWebhookEvent {
  /**
   * when event was created
   */
  created_at?: string
  /**
   * the event's unique identifier
   */
  id?: string
  /**
   * the type of entity that the event is related to
   */
  include?: string
  /**
   * payload of event
   */
  payload?: {
    /**
     * the type of event that occurred
     */
    action?: string
    /**
     * user that caused event
     */
    actor?: {
      /**
       * unique email address of account
       */
      email?: string
      /**
       * unique identifier of an account
       */
      id?: string
      [k: string]: any
    }
    /**
     * the current details of the event
     */
    data?: {
      [k: string]: any
    }
    /**
     * previous details of the event (if any)
     */
    previous_data?: {
      [k: string]: any
    }
    /**
     * the type of resource associated with the event
     */
    resource?: string
    /**
     * the version of the details provided for the event
     */
    version?: string
    [k: string]: any
  }
  /**
   * when the event was last updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * Represents the details of a webhook subscription
 */
export interface AppWebhook {}
/**
 * An app represents the program that you would like to deploy and run on Heroku.
 */
export interface App {
  /**
   * ACM status of this app
   */
  acm?: boolean
  /**
   * when app was archived
   */
  archived_at?: null | string
  /**
   * description from buildpack of app
   */
  buildpack_provided_description?: null | string
  /**
   * identity of the stack that will be used for new builds
   */
  build_stack?: {
    /**
     * unique identifier of stack
     */
    id?: string
    /**
     * unique name of stack
     */
    name?: string
    [k: string]: any
  }
  /**
   * when app was created
   */
  created_at?: string
  /**
   * git repo URL of app
   */
  git_url?: string
  /**
   * unique identifier of app
   */
  id?: string
  /**
   * describes whether a Private Spaces app is externally routable or not
   */
  internal_routing?: boolean | null
  /**
   * maintenance status of app
   */
  maintenance?: boolean
  /**
   * unique name of app
   */
  name?: string
  /**
   * identity of app owner
   */
  owner?: {
    /**
     * unique email address of account
     */
    email?: string
    /**
     * unique identifier of an account
     */
    id?: string
    [k: string]: any
  }
  /**
   * identity of organization
   */
  organization?: null | {
    [k: string]: any
  }
  /**
   * identity of team
   */
  team?: null | {
    [k: string]: any
  }
  /**
   * identity of app region
   */
  region?: {
    /**
     * unique identifier of region
     */
    id?: string
    /**
     * unique name of region
     */
    name?: string
    [k: string]: any
  }
  /**
   * when app was released
   */
  released_at?: null | string
  /**
   * git repo size in bytes of app
   */
  repo_size?: number | null
  /**
   * slug size in bytes of app
   */
  slug_size?: number | null
  /**
   * identity of space
   */
  space?: null | {
    [k: string]: any
  }
  /**
   * identity of app stack
   */
  stack?: {
    /**
     * unique identifier of stack
     */
    id?: string
    /**
     * unique name of stack
     */
    name?: string
    [k: string]: any
  }
  /**
   * when app was updated
   */
  updated_at?: string
  /**
   * web URL of app
   */
  web_url?: string
  [k: string]: any
}
/**
 * A build result contains the output from a build.
 */
export interface BuildResult {
  /**
   * identity of build
   */
  build?: {
    /**
     * unique identifier of build
     */
    id?: string
    /**
     * status of build
     */
    status?: 'failed' | 'pending' | 'succeeded'
    /**
     * 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`).
     */
    output_stream_url?: string
    [k: string]: any
  }
  /**
   * status from the build
   */
  exit_code?: number
  /**
   * A list of all the lines of a build's output. This has been replaced by the `output_stream_url` attribute on the build resource.
   */
  lines?: {
    /**
     * The output stream where the line was sent.
     */
    stream?: 'STDOUT' | 'STDERR'
    /**
     * A line of output from the build.
     */
    line?: string
    [k: string]: any
  }[]
  [k: string]: any
}
/**
 * A build represents the process of transforming a code tarball into a slug
 */
export interface Build {
  /**
   * app that the build belongs to
   */
  app?: {
    /**
     * unique identifier of app
     */
    id?: string
    [k: string]: any
  }
  /**
   * buildpacks executed for this build, in order
   */
  buildpacks?: {
    /**
     * location of the buildpack for the app. Either a url (unofficial buildpacks) or an internal urn (heroku official buildpacks).
     */
    url?: string
    [k: string]: any
  }[]
  /**
   * when build was created
   */
  created_at?: string
  /**
   * unique identifier of build
   */
  id?: string
  /**
   * 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`).
   */
  output_stream_url?: string
  /**
   * location of gzipped tarball of source code used to create build
   */
  source_blob?: {
    /**
     * an optional checksum of the gzipped tarball for verifying its integrity
     */
    checksum?: null | string
    /**
     * URL where gzipped tar archive of source code for build was downloaded.
     */
    url?: string
    /**
     * Version of the gzipped tarball.
     */
    version?: string | null
    [k: string]: any
  }
  /**
   * release resulting from the build
   */
  release?: null | {
    [k: string]: any
  }
  /**
   * slug created by this build
   */
  slug?: {
    [k: string]: any
  } | null
  /**
   * stack of build
   */
  stack?: string
  /**
   * status of build
   */
  status?: 'failed' | 'pending' | 'succeeded'
  /**
   * when build was updated
   */
  updated_at?: string
  /**
   * user that started the build
   */
  user?: {
    /**
     * unique identifier of an account
     */
    id?: string
    /**
     * unique email address of account
     */
    email?: string
    [k: string]: any
  }
  [k: string]: any
}
/**
 * A buildpack installation represents a buildpack that will be run against an app.
 */
export interface BuildpackInstallations {
  /**
   * determines the order in which the buildpacks will execute
   */
  ordinal?: number
  /**
   * buildpack
   */
  buildpack?: {
    /**
     * location of the buildpack for the app. Either a url (unofficial buildpacks) or an internal urn (heroku official buildpacks).
     */
    url?: string
    /**
     * either the shorthand name (heroku official buildpacks) or url (unofficial buildpacks) of the buildpack for the app
     */
    name?: string
    [k: string]: any
  }
  [k: string]: any
}
/**
 * A collaborator represents an account that has been given access to an app on Heroku.
 */
export interface Collaborator {
  /**
   * app collaborator belongs to
   */
  app: {
    /**
     * unique name of app
     */
    name?: string
    /**
     * unique identifier of app
     */
    id?: string
    [k: string]: any
  }
  /**
   * when collaborator was created
   */
  created_at: string
  /**
   * unique identifier of collaborator
   */
  id: string
  permissions?: TeamAppPermission[]
  /**
   * role in the team
   */
  role?: 'admin' | 'collaborator' | 'member' | 'owner' | null
  /**
   * when collaborator was updated
   */
  updated_at: string
  /**
   * identity of collaborated account
   */
  user: {
    /**
     * unique email address of account
     */
    email?: string
    /**
     * whether the user is federated and belongs to an Identity Provider
     */
    federated?: boolean
    /**
     * unique identifier of an account
     */
    id?: string
    [k: string]: any
  }
}
/**
 * A team app permission is a behavior that is assigned to a user in a team app.
 */
export interface TeamAppPermission {
  /**
   * The name of the app permission.
   */
  name?: string
  /**
   * A description of what the app permission allows.
   */
  description?: string
  [k: string]: any
}
/**
 * Config Vars allow you to manage the configuration information provided to an app on Heroku.
 */
export interface ConfigVars {
  /**
   * This interface was referenced by `ConfigVars`'s JSON-Schema definition
   * via the `patternProperty` "^\w+$".
   */
  [k: string]: string
}
/**
 * A credit represents value that will be used up before further charges are assigned to an account.
 */
export interface Credit {
  /**
   * total value of credit in cents
   */
  amount?: number
  /**
   * remaining value of credit in cents
   */
  balance?: number
  /**
   * when credit was created
   */
  created_at?: string
  /**
   * when credit will expire
   */
  expires_at?: string
  /**
   * unique identifier of credit
   */
  id?: string
  /**
   * a name for credit
   */
  title?: string
  /**
   * when credit was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * Domains define what web routes should be routed to an app on Heroku.
 */
export interface Domain {
  /**
   * status of this record's ACM
   */
  acm_status?: null | string
  /**
   * reason for the status of this record's ACM
   */
  acm_status_reason?: null | string
  /**
   * app that owns the domain
   */
  app?: {
    /**
     * unique name of app
     */
    name?: string
    /**
     * unique identifier of app
     */
    id?: string
    [k: string]: any
  }
  /**
   * canonical name record, the address to point a domain at
   */
  cname?: null | string
  /**
   * when domain was created
   */
  created_at?: string
  /**
   * full hostname
   */
  hostname?: string
  /**
   * unique identifier of this domain
   */
  id?: string
  /**
   * type of domain name
   */
  kind?: 'heroku' | 'custom'
  /**
   * when domain was updated
   */
  updated_at?: string
  /**
   * status of this record's cname
   */
  status?: string
  [k: string]: any
}
/**
 * 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.heroku.com/articles/dyno-types).
 */
export interface DynoSize {
  /**
   * minimum vCPUs, non-dedicated may get more depending on load
   */
  compute?: number
  /**
   * price information for this dyno size
   */
  cost?: null | {
    [k: string]: any
  }
  /**
   * whether this dyno will be dedicated to one user
   */
  dedicated?: boolean
  /**
   * unit of consumption for Heroku Enterprise customers
   */
  dyno_units?: number
  /**
   * unique identifier of this dyno size
   */
  id?: string
  /**
   * amount of RAM in GB
   */
  memory?: number
  /**
   * the name of this dyno-size
   */
  name?: string
  /**
   * whether this dyno can only be provisioned in a private space
   */
  private_space_only?: boolean
  [k: string]: any
}
/**
 * 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.heroku.com/articles/dyno-types).
 */
export interface Dyno {
  /**
   * a URL to stream output from for attached processes or null for non-attached processes
   */
  attach_url?: string | null
  /**
   * command used to start this process
   */
  command?: string
  /**
   * when dyno was created
   */
  created_at?: string
  /**
   * unique identifier of this dyno
   */
  id?: string
  /**
   * the name of this process on this dyno
   */
  name?: string
  /**
   * app release of the dyno
   */
  release?: {
    /**
     * unique identifier of release
     */
    id?: string
    /**
     * unique version assigned to the release
     */
    version?: number
    [k: string]: any
  }
  /**
   * app formation belongs to
   */
  app?: {
    /**
     * unique name of app
     */
    name?: string
    /**
     * unique identifier of app
     */
    id?: string
    [k: string]: any
  }
  /**
   * dyno size (default: "standard-1X")
   */
  size?: string
  /**
   * current status of process (either: crashed, down, idle, starting, or up)
   */
  state?: string
  /**
   * type of process
   */
  type?: string
  /**
   * when process last changed state
   */
  updated_at?: string
  [k: string]: any
}
/**
 * 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.
 */
export interface Filters {
  [k: string]: any
}
/**
 * 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.
 */
export interface Formation {
  /**
   * app formation belongs to
   */
  app?: {
    /**
     * unique name of app
     */
    name?: string
    /**
     * unique identifier of app
     */
    id?: string
    [k: string]: any
  }
  /**
   * command to use to launch this process
   */
  command?: string
  /**
   * when process type was created
   */
  created_at?: string
  /**
   * unique identifier of this process type
   */
  id?: string
  /**
   * number of processes to maintain
   */
  quantity?: number
  /**
   * dyno size (default: "standard-1X")
   */
  size?: string
  /**
   * type of process to maintain
   */
  type?: string
  /**
   * when dyno type was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * Identity Providers represent the SAML configuration of an Organization.
 */
export interface IdentityProvider {
  /**
   * raw contents of the public certificate (eg: .crt or .pem file)
   */
  certificate?: string
  /**
   * when provider record was created
   */
  created_at?: string
  /**
   * URL identifier provided by the identity provider
   */
  entity_id?: string
  /**
   * unique identifier of this identity provider
   */
  id?: string
  /**
   * single log out URL for this identity provider
   */
  slo_target_url?: string
  /**
   * single sign on URL for this identity provider
   */
  sso_target_url?: string
  /**
   * organization associated with this identity provider
   */
  organization?: null | {
    [k: string]: any
  }
  /**
   * when the identity provider record was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * An inbound-ruleset is a collection of rules that specify what hosts can or cannot connect to an application.
 */
export interface InboundRuleset {
  /**
   * unique identifier of an inbound-ruleset
   */
  id?: string
  /**
   * identity of space
   */
  space?: {
    /**
     * unique identifier of space
     */
    id?: string
    /**
     * unique name of space
     */
    name?: string
    [k: string]: any
  }
  /**
   * when inbound-ruleset was created
   */
  created_at?: string
  rules?: {
    /**
     * states whether the connection is allowed or denied
     */
    action: 'allow' | 'deny'
    /**
     * is the request’s source in CIDR notation
     */
    source: string
    [k: string]: any
  }[]
  /**
   * unique email address of account
   */
  created_by?: string
  [k: string]: any
}
/**
 * An invoice address represents the address that should be listed on an invoice.
 */
export interface InvoiceAddress {
  /**
   * invoice street address line 1
   */
  address_1?: string
  /**
   * invoice street address line 2
   */
  address_2?: string
  /**
   * invoice city
   */
  city?: string
  /**
   * country
   */
  country?: string
  heroku_id?: string
  /**
   * metadata / additional information to go on invoice
   */
  other?: string
  /**
   * invoice zip code
   */
  postal_code?: string
  /**
   * invoice state
   */
  state?: string
  /**
   * flag to use the invoice address for an account or not
   */
  use_invoice_address?: boolean
  [k: string]: any
}
/**
 * An invoice is an itemized bill of goods for an account which includes pricing and charges.
 */
export interface Invoice {
  /**
   * total charges on this invoice
   */
  charges_total?: number
  /**
   * when invoice was created
   */
  created_at?: string
  /**
   * total credits on this invoice
   */
  credits_total?: number
  /**
   * unique identifier of this invoice
   */
  id?: string
  /**
   * human readable invoice number
   */
  number?: number
  /**
   * the ending date that the invoice covers
   */
  period_end?: string
  /**
   * the starting date that this invoice covers
   */
  period_start?: string
  /**
   * payment status for this invoice (pending, successful, failed)
   */
  state?: number
  /**
   * combined total of charges and credits on this invoice
   */
  total?: number
  /**
   * when invoice was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.
 */
export interface Key {
  /**
   * comment on the key
   */
  comment?: string
  /**
   * when key was created
   */
  created_at?: string
  /**
   * deprecated. Please refer to 'comment' instead
   */
  email?: string
  /**
   * a unique identifying string based on contents
   */
  fingerprint?: string
  /**
   * unique identifier of this key
   */
  id?: string
  /**
   * full public_key as uploaded
   */
  public_key?: string
  /**
   * when key was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * [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.
 */
export interface LogDrain {
  /**
   * add-on that created the drain
   */
  addon?: {
    [k: string]: any
  } | null
  /**
   * when log drain was created
   */
  created_at?: string
  /**
   * unique identifier of this log drain
   */
  id?: string
  /**
   * token associated with the log drain
   */
  token?: string
  /**
   * when log drain was updated
   */
  updated_at?: string
  /**
   * url associated with the log drain
   */
  url?: string
  [k: string]: any
}
/**
 * A log session is a reference to the http based log stream for an app.
 */
export interface LogSession {
  /**
   * when log connection was created
   */
  created_at?: string
  /**
   * unique identifier of this log session
   */
  id?: string
  /**
   * URL for log streaming session
   */
  logplex_url?: string
  /**
   * when log session was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * 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)
 */
export interface OAuthAuthorization {
  /**
   * access token for this authorization
   */
  access_token?: null | {
    [k: string]: any
  }
  /**
   * identifier of the client that obtained this authorization, if any
   */
  client?: null | {
    [k: string]: any
  }
  /**
   * when OAuth authorization was created
   */
  created_at?: string
  /**
   * this authorization's grant
   */
  grant?: null | {
    [k: string]: any
  }
  /**
   * unique identifier of OAuth authorization
   */
  id?: string
  /**
   * refresh token for this authorization
   */
  refresh_token?: null | {
    [k: string]: any
  }
  /**
   * The scope of access OAuth authorization allows
   */
  scope?: string[]
  /**
   * when OAuth authorization was updated
   */
  updated_at?: string
  /**
   * authenticated user associated with this authorization
   */
  user?: {
    /**
     * unique identifier of an account
     */
    id?: string
    /**
     * unique email address of account
     */
    email?: string
    /**
     * full name of the account owner
     */
    full_name?: string | null
    [k: string]: any
  }
  [k: string]: any
}
/**
 * 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).
 */
export interface OAuthClient {
  /**
   * when OAuth client was created
   */
  created_at?: string
  /**
   * unique identifier of this OAuth client
   */
  id?: string
  /**
   * whether the client is still operable given a delinquent account
   */
  ignores_delinquent?: boolean | null
  /**
   * OAuth client name
   */
  name?: string
  /**
   * endpoint for redirection after authorization with OAuth client
   */
  redirect_uri?: string
  /**
   * secret used to obtain OAuth authorizations under this client
   */
  secret?: string
  /**
   * when OAuth client was updated
   */
  updated_at?: string
  [k: string]: any
}
/**
 * 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)
 */
export interface OAuthGrant {
  [k: string]: any
}
/**
 * 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)
 */
export interface OAuthToken {
  /**
   * current access token
   */
  access_token?: {
    /**
     * seconds until OAuth token expires; may be `null` for tokens with indefinite lifetime
     */
    expires_in?: null | number
    /**
     * unique identifier of OAuth token
     */
    id?: string
    /**
     * contents of the token to be used for authorization
     */
    token?: string
    [k: string]: any
  }
  /**
   * authorization for this set of tokens
   */
  authorization?: {
    /**
     * unique identifier of OAuth authorization
     */
    id?: string
    [k: string]: any
  }
  /**
   * OAuth client secret used to obtain token
   */
  client?: null | {
    [k: string]: any
  }
  /**
   * when OAuth token was created
   */
  created_at?: string
  /**
   * grant used on the underlying authorization
   */
  grant?: {
    /**
     * grant code received from OAuth web application authorization
     */
    code?: string
    /**
     * type of grant requested, one of `authorization_code` or `refresh_token`
     */
    type?: string
    [k: string]: any
  }
  /**
   * unique identifier of OAuth token
   */
  id?: string
  /**
   * refresh token for this authorization
   */
  refresh_token?: {
    /**
     * seconds until OAuth token expires; may be `null` for tokens with indefinite lifetime
     */
    expires_in?: null | number
    /**
     * unique identifier of OAuth token
     */
    id?: string
    /**
     * contents of the token to be used for authorization
     */
    token?: string
    [k: string]: any
  }
  /**
   * OAuth session using this token
   */
  session?: {
    /**
     * unique identifier of OAuth token
     */
    id?: string
    [k: string]: any
  }
  /**
   * when OAuth token was updated
   */
  updated_at?: string
  /**
   * Reference to the user associated with this token
   */
  user?: {
    /**
     * unique identifier of an account
     */
    id?: string
    [k: string]: any
  }
  [k: string]: any
}
/**
 * Deprecated: A list of add-ons the Organization uses across all apps
 */
export interface OrganizationAddOn {
  [k: string]: any
}
/**
 * Deprecated: An organization collaborator represents an account that has been given access to an organization app on Heroku.
 */
export interface OrganizationAppCollaborator {
  /**
   * app collaborator belongs to
   */
  app?: {
    /**
     * unique name of app
     */
    name?: string
    /**
     * unique identifier of app
     */
    id?: string
    [k: string]: any
  }
  /**
   * when collaborator was created
   */
  created_at?: string
  /**
   * unique identifier of collaborator
   */
  id?: string
  /**
   * role in the organization
   */
  role?: 'admin' | 'collaborator' | 'member' | 'owner' | null
  /**
   * when collaborator was updated
   */
  updated_at?: string
  /**
   * identity of collaborated account
   */
  user?: {
    /**
     * unique email address of account
     */
    email?: string
    /**
     * whether the user is federated and belongs to an Identity Provider
     */
    federated?: boolean
    /**
     * unique identifier of an account
     */
    id?: string
    [k: string]: any
  }
  [k: string]: any
}
/**
 * Deprecated: An organization app encapsulates the organization specific functionality of Heroku apps.
 */
export interface OrganizationApp {
  /**
   * when app was archived
   */
  archived_at?: null | string
  /**
   * description from buildpack of app
   */
  buildpack_provided_description?: null | string
  /**
   * identity of the stack that will be used for new builds
   */
  build_stack?: {
    /**
     * unique identifier of stack
     */
    id?: string
    /**
     * unique name of stack
     */
    name?: string
    [k: string]: any
  }
  /**
   * when app was created
   */
  created_at?: string
  /**
   * git repo URL of app
   */
  git_url?: string
  /**
   * unique identifier of app
   */
  id?: string
  /**
   * is the current member a collaborator on this app.
   */
  joined?: boolean
  /**
   * are other organization members forbidden from joining this app.
   */
  locked?: boolean
  /**
   * maintenance status of app
   */
  maintenance?: boolean
  /**
   * unique name of app
   */
  name?: string
  /**
   * organization that owns this app
   */
  organization?: null | {
    [k: string]: any
  }
  /**
   * identity of app owner
   */
  owner?: null | {
    [k: string]: any
  }
  /**
   * identity of app region
   */
  region?: {
    /**
     * unique identifier of region
     */
    id?: string
    /**
     * unique name of region
     */
    name?: string
    [k: string]: any
  }
  /**
   * when app was released
   */
  released_at?: null | string
  /**
   * git repo size in bytes of app
   */
  repo_size?: number | null
  /**
   * slug size in bytes of app
   */
  slug_size?: number | null
  /**
   * identity of space
   */
  space?: null | {
    [k: string]: any
  }
  /**
   * identity of app stack
   */
  stack?: {
    /**
     * unique identifier of stack
     */
    id?: string
    /**
     * unique name of stack
     */
    name?: string
    [k: string]: any
  }
  /**
   * when app was updated
   */
  updated_at?: string
  /**
   * web URL of app
   */
  web_url?: string
  [k: string]: any
}
/**
 * Deprecated: An organization feature represents a feature enabled on an organization account.
 */
export interface OrganizationFeature {
  /**
   * when organization feature was created
   */
  created_at?: string
  /**
   * description of organization feature
   */
  description?: string
  /**
   * documentation URL of organization feature
   */
  doc_url?: string
  /**
   * whether or not organization feature has been enabled
   */
  enabled?: boolean
  /**
   * unique identifier of organization feature
   */
  id?: string
  /**
   * unique name of organization feature
   */
  name?: string
  /**
   * state of organization feature
   */
  state?: string
  /**
   * when organization feature was updated
   */
  updated_at?: string
  /**
   * user readable feature name
   */
  display_name?: string
  /**
   * e-mail to send feedback about the feature
   */
  feedback_email?: string
  [k: string]: any
}
/**
 * Deprecated: An organization invitation represents an invite to an organization.
 */
export interface OrganizationInvitation {
  /**
   * when invitation was created
   */
  created_at?: string
  /**
   * Unique identifier of an invitation
   */
  id?: string
  invited_by?: {
    /**
     * unique email address of account
     */
    email?: string
    /**
     * unique identifier of an account
     */
    id?: string
    /**
     * full name of the account owner
     */
    name?: string | null
    [k: string]: any
  }
  organization?: {
    /**
     * unique identifier of organization
     */
    id?: string
    /**
     * unique name of organization
     */
    name?: string
    [k: string]: any
  }
  /**
   * role in the organization
   */
  role?: 'admin' | 'collaborator' | 'member' | 'owner' | null
  /**
   * when invitation was updated
   */
  updated_at?: string
  user?: {
    /**
     * unique email address of account
     */
    email?: string
    /**
     * unique identifier of an account
     */
    id?: string
    /**
     * full name of the account owner
     */
    name?: string | null
    [k: string]: any
  }
  [k: string]: any
}
/**
 * Deprecated: An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.
 */
export interface OrganizationInvoice {
  /**
   * total add-ons charges in on this invoice
   */
  addons_total?: number
  /**
   * total database charges on this invoice
   */
  database_total?: number
  /**
   * total charges on this invoice
   */
  charges_total?: number
  /**
   * when invoice was created
   */
  created_at?: string
  /**
   * total credits on this invoice
   */
  credits_total?: number
  /**
   * The total amount of dyno units consumed across dyno types.
   */
  dyno_units?: number
  /**
   * unique identifier of this invoice
   */
  id?: string
  /**
   * human readable invoice number
   */
  number?: number
  /**
   * Status of the invoice payment.
   */
  payment_status?: string
  /**
   * the ending date that the invoice covers
   */
  period_end?: string
  /**
   * the starting date that this invoice covers
   */
  period_start?: string
  /**
   * total platform charges on this invoice
   */
  platform_total?: number
  /**
   * payment status for this invoice (pending, successful, failed)
   */
  state?: number
  /**
   * combined total of charges and credits on this invoice
   */
  total?: number
  /**
   * when invoice was updated
   */
  updated_at?: string
  /**
   * The total amount of hours consumed across dyno types.
   */
  weighted_dyno_hours?: number
  [k: string]: any
}
/**
 * Deprecated: An organization member is an individual with access to an organization.
 */
export interface OrganizationMember {
  /**
   * when the membership record was created
   */
  created_at: string
  /**
   * email address of the organization member
   */
  email: string
  /**
   * whether the user is federated and belongs to an Identity Provider
   */
  federated: boolean
  /**
   * unique identifier of organization member
   */
  id?: string
  /**
   * role in the organization
   */
  role?: 'admin' |