platform-api 2.3.0.pre.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e5c181f162b1a58300c830b60882942c44e7a0a3df7934b981a51e8ddf90197
-  data.tar.gz: a31f82c2c643be9b590e5e7fa998b4f7bedc2978740d1348fa3688f988ae39c3
+  metadata.gz: a6e49cd394a0604607050110b325326eb7ede3f8fc106b4bd0fd9af469805e24
+  data.tar.gz: 58c8c8a6bc8f27960ef512faa4426dd29590ad9702403bfcc52e485913cd997a
 SHA512:
-  metadata.gz: a3ff6920f3910cd0bb903720e32b79e738344b026ac430df7718ab17c9610df0a43495bd386d7687757c294086377659f17cd76024cba073c86c42bba8fc76ed
-  data.tar.gz: f747bb0571bf6fba9de8a1f07d33018059f9f82a6194e391c73de6934b6efaba0c6a272da689723a27fa88bc6d2d540b2553eb5f48ed6d9fb786f03124f1be26
+  metadata.gz: 273953ff91506216f6623402f6bfdec5cbd0bc394578747a42f06999142d74d24834b0e02015bd6e3597c1b0421d443af4dff88432e13814a44da359f2e12561
+  data.tar.gz: decc03b9d7448b9f4087c7c09c68ce4ac2024c2be222e8c90d3dcab09bf9bea374d938fba1b1aefd41dd78f9c638c4ab65f9f94b4a2a0e79b51299ba89ee072b

data/.github/workflows/check_changelog.yml

@@ -1,5 +1,7 @@
 name: Check Changelog
-on: [pull_request]
+on:
+ pull_request:
+  types: [opened, reopened, edited, synchronize]
 jobs:
  build:
    runs-on: ubuntu-latest

data/CHANGELOG.md

@@ -1,10 +1,18 @@
 ## Master (unreleased)
 
+## 3.2.0
+
+- Pull latest JSON Schema and regenerated API.
+
+## 3.1.0
+
+- Pull latest JSON Schema and regenerated API.
+
 ## 3.0.0
 
-- Rate throttling is on by default.
+- Rate throttling is on by default. (https://github.com/heroku/platform-api/pull/104)
 
 ## 2.3.0
 
-- Changes are now tracked in the CHANGELOG.md
-- Rate throttling is included by default but disabled.
+- Changes are now tracked in the CHANGELOG.md.
+- Rate throttling is included by default but disabled. (https://github.com/heroku/platform-api/pull/103)

data/config/client-config.rb

@@ -2,23 +2,14 @@
 require 'heroics'
 require 'rate_throttle_client'
 
-require File.join(File.expand_path('../..', __FILE__), 'lib', 'platform-api')
+require_relative '../lib/platform-api.rb'
 
 Heroics.default_configuration do |config|
   config.base_url = 'https://api.heroku.com'
   config.module_name = 'PlatformAPI'
   config.schema_filepath = File.join(File.expand_path('../..', __FILE__), 'schema.json')
 
-  PlatformAPI.rate_throttle = ->(&block) {
-    @deprecate_on_first ||= begin
-      message = String.new("[Warning] Starting in PlatformAPI version 3+, requests will include rate throttling logic\n")
-      message << "to opt-out of this behavior set: `PlatformAPI.rate_throttle = RateThrottleClient::Null.new`\n"
-      message << "to silence this warning and opt-in to this logic, upgrade to PlatformAPI version 3+"
-      warn message
-      true
-    end
-    block.call
-  }
+  PlatformAPI.rate_throttle = RateThrottleClient::ExponentialIncreaseProportionalRemainingDecrease.new
   config.rate_throttle = PlatformAPI.rate_throttle
   config.acceptable_status_codes = [429]
 

data/lib/platform-api.rb

@@ -1,5 +1,6 @@
 require 'heroics'
 require 'moneta'
+require 'platform-api/version'
 
 # Ruby HTTP client for the Heroku API.
 module PlatformAPI
@@ -18,4 +19,3 @@ end
 
 require_relative '../config/client-config'
 require 'platform-api/client'
-require 'platform-api/version'

data/lib/platform-api/client.rb

@@ -83,7 +83,7 @@ module PlatformAPI
 
   # Get the default options.
   def self.default_options
-    default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/2.3.0.pre.1"}
+    default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/3.2.0"}
     {
       default_headers: default_headers,
       url:             "https://api.heroku.com"
@@ -112,7 +112,7 @@ module PlatformAPI
       @account_resource ||= Account.new(@client)
     end
 
-    # 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.
+    # Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning. They allow add-on providers to (de)provision add-ons in the background and then report back when (de)provisioning is complete.
     #
     # @return [AddonAction]
     def addon_action
@@ -182,6 +182,13 @@ module PlatformAPI
       @addon_resource ||= Addon.new(@client)
     end
 
+    # Entities that have been allowed to be used by a Team
+    #
+    # @return [AllowedAddonService]
+    def allowed_addon_service
+      @allowed_addon_service_resource ||= AllowedAddonService.new(@client)
+    end
+
     # An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.
     #
     # @return [AppFeature]
@@ -245,6 +252,13 @@ module PlatformAPI
       @archive_resource ||= Archive.new(@client)
     end
 
+    # An audit trail event represents some action on the platform
+    #
+    # @return [AuditTrailEvent]
+    def audit_trail_event
+      @audit_trail_event_resource ||= AuditTrailEvent.new(@client)
+    end
+
     # A build represents the process of transforming a code tarball into a slug
     #
     # @return [Build]
@@ -329,13 +343,6 @@ module PlatformAPI
       @enterprise_account_resource ||= EnterpriseAccount.new(@client)
     end
 
-    # An audit trail event represents some action on the platform
-    #
-    # @return [Event]
-    def event
-      @event_resource ||= Event.new(@client)
-    end
-
     # 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.
     #
     # @return [FilterApps]
@@ -616,6 +623,13 @@ module PlatformAPI
       @space_nat_resource ||= SpaceNat.new(@client)
     end
 
+    # Space Topology provides you with a mechanism for viewing all the running dynos, formations and applications for a space. This is the same data thats used to power our DNS Service Discovery.
+    #
+    # @return [SpaceTopology]
+    def space_topology
+      @space_topology_resource ||= SpaceTopology.new(@client)
+    end
+
     # Transfer spaces between enterprise teams with the same Enterprise Account.
     #
     # @return [SpaceTransfer]
@@ -853,7 +867,7 @@ module PlatformAPI
     end
   end
 
-  # 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.
+  # Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning. They allow add-on providers to (de)provision add-ons in the background and then report back when (de)provisioning is complete.
   class AddonAction
     def initialize(client)
       @client = client
@@ -1181,6 +1195,36 @@ module PlatformAPI
     end
   end
 
+  # Entities that have been allowed to be used by a Team
+  class AllowedAddonService
+    def initialize(client)
+      @client = client
+    end
+
+    # List all allowed add-on services for a team
+    #
+    # @param team_name_or_team_id: unique name of team or unique identifier of team
+    def list_by_team(team_name_or_team_id)
+      @client.allowed_addon_service.list_by_team(team_name_or_team_id)
+    end
+
+    # Allow an Add-on Service
+    #
+    # @param team_name_or_team_id: unique name of team or unique identifier of team
+    # @param body: the object to pass as the request payload
+    def create_by_team(team_name_or_team_id, body = {})
+      @client.allowed_addon_service.create_by_team(team_name_or_team_id, body)
+    end
+
+    # Remove an allowed add-on service
+    #
+    # @param team_name_or_team_id: unique name of team or unique identifier of team
+    # @param allowed_addon_service_id_or_addon_service_name: unique identifier for this allowed add-on service record or unique name of this add-on-service
+    def delete_by_team(team_name_or_team_id, allowed_addon_service_id_or_addon_service_name)
+      @client.allowed_addon_service.delete_by_team(team_name_or_team_id, allowed_addon_service_id_or_addon_service_name)
+    end
+  end
+
   # An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.
   class AppFeature
     def initialize(client)
@@ -1464,6 +1508,20 @@ module PlatformAPI
     end
   end
 
+  # An audit trail event represents some action on the platform
+  class AuditTrailEvent
+    def initialize(client)
+      @client = client
+    end
+
+    # List existing events.
+    #
+    # @param enterprise_account_id: unique identifier of the enterprise account
+    def list(enterprise_account_id)
+      @client.audit_trail_event.list(enterprise_account_id)
+    end
+  end
+
   # A build represents the process of transforming a code tarball into a slug
   class Build
     def initialize(client)
@@ -1623,6 +1681,14 @@ module PlatformAPI
       @client = client
     end
 
+    # Create a new domain. Deprecated in favor of this same endpoint, but with a new required attribute of `sni_endpoint`. During the transitional phase sni_endpoint can be omitted entirely (current behavior), can be a valid id, or can be null which will skip auto-association.
+    #
+    # @param app_id_or_app_name: unique identifier of app or unique name of app
+    # @param body: the object to pass as the request payload
+    def create_deprecated(app_id_or_app_name, body = {})
+      @client.domain.create_deprecated(app_id_or_app_name, body)
+    end
+
     # Create a new domain.
     #
     # @param app_id_or_app_name: unique identifier of app or unique name of app
@@ -1631,6 +1697,15 @@ module PlatformAPI
       @client.domain.create(app_id_or_app_name, body)
     end
 
+    # Associate an SNI endpoint
+    #
+    # @param app_id_or_app_name: unique identifier of app or unique name of app
+    # @param domain_id_or_domain_hostname: unique identifier of this domain or full hostname
+    # @param body: the object to pass as the request payload
+    def update(app_id_or_app_name, domain_id_or_domain_hostname, body = {})
+      @client.domain.update(app_id_or_app_name, domain_id_or_domain_hostname, body)
+    end
+
     # Delete an existing domain
     #
     # @param app_id_or_app_name: unique identifier of app or unique name of app
@@ -1821,20 +1896,6 @@ module PlatformAPI
     end
   end
 
-  # An audit trail event represents some action on the platform
-  class Event
-    def initialize(client)
-      @client = client
-    end
-
-    # List existing events.
-    #
-    # @param enterprise_account_id: unique identifier of the enterprise account
-    def list(enterprise_account_id)
-      @client.event.list(enterprise_account_id)
-    end
-  end
-
   # 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.
   class FilterApps
     def initialize(client)
@@ -2907,6 +2968,20 @@ module PlatformAPI
     end
   end
 
+  # Space Topology provides you with a mechanism for viewing all the running dynos, formations and applications for a space. This is the same data thats used to power our DNS Service Discovery.
+  class SpaceTopology
+    def initialize(client)
+      @client = client
+    end
+
+    # Current space topology
+    #
+    # @param space_id_or_space_name: unique identifier of space or unique name of space
+    def topology(space_id_or_space_name)
+      @client.space_topology.topology(space_id_or_space_name)
+    end
+  end
+
   # Transfer spaces between enterprise teams with the same Enterprise Account.
   class SpaceTransfer
     def initialize(client)
@@ -3940,6 +4015,42 @@ module PlatformAPI
           "type": [
             "boolean"
           ]
+        },
+        "acknowledged_msa": {
+          "description": "whether account has acknowledged the MSA terms of service",
+          "example": false,
+          "readOnly": true,
+          "type": [
+            "boolean"
+          ]
+        },
+        "acknowledged_msa_at": {
+          "description": "when account has acknowledged the MSA terms of service",
+          "example": "2012-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "italian_customer_terms": {
+          "description": "whether account has acknowledged the Italian customer terms of service",
+          "example": "affirmatively_accepted",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "italian_partner_terms": {
+          "description": "whether account has acknowledged the Italian provider terms of service",
+          "example": "affirmatively_accepted",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
+          ]
         }
       },
       "links": [
@@ -4153,6 +4264,18 @@ module PlatformAPI
         "verified": {
           "$ref": "#/definitions/account/definitions/verified"
         },
+        "acknowledged_msa": {
+          "$ref": "#/definitions/account/definitions/acknowledged_msa"
+        },
+        "acknowledged_msa_at": {
+          "$ref": "#/definitions/account/definitions/acknowledged_msa_at"
+        },
+        "italian_customer_terms": {
+          "$ref": "#/definitions/account/definitions/italian_customer_terms"
+        },
+        "italian_partner_terms": {
+          "$ref": "#/definitions/account/definitions/italian_partner_terms"
+        },
         "default_organization": {
           "description": "team selected by default",
           "properties": {
@@ -4188,7 +4311,7 @@ module PlatformAPI
       }
     },
     "add-on-action": {
-      "description": "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.",
+      "description": "Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning. They allow add-on providers to (de)provision add-ons in the background and then report back when (de)provisioning is complete.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "stability": "development",
       "strictProperties": true,
@@ -5721,6 +5844,157 @@ module PlatformAPI
         }
       }
     },
+    "allowed-add-on-service": {
+      "description": "Entities that have been allowed to be used by a Team",
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "stability": "prototype",
+      "strictProperties": true,
+      "title": "Heroku Platform API - Allowed Add-on Service",
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "added_at": {
+          "description": "when the add-on service was allowed",
+          "example": "2012-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "added_by": {
+          "description": "the user which allowed the add-on service",
+          "properties": {
+            "email": {
+              "$ref": "#/definitions/account/definitions/email",
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "id": {
+              "$ref": "#/definitions/account/definitions/id",
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "readOnly": true,
+          "type": [
+            "object"
+          ]
+        },
+        "addon_service": {
+          "description": "the add-on service allowed for use",
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/add-on-service/definitions/id"
+            },
+            "name": {
+              "$ref": "#/definitions/add-on-service/definitions/name"
+            },
+            "human_name": {
+              "$ref": "#/definitions/add-on-service/definitions/human_name"
+            }
+          },
+          "readOnly": true,
+          "type": [
+            "object"
+          ]
+        },
+        "id": {
+          "description": "unique identifier for this allowed add-on service record",
+          "example": "01234567-89ab-cdef-0123-456789abcdef",
+          "format": "uuid",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/allowed-add-on-service/definitions/id"
+            },
+            {
+              "$ref": "#/definitions/add-on-service/definitions/name"
+            }
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "List all allowed add-on services for a team",
+          "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/allowed-addon-services",
+          "method": "GET",
+          "rel": "instances",
+          "targetSchema": {
+            "items": {
+              "$ref": "#/definitions/allowed-add-on-service"
+            },
+            "type": [
+              "array"
+            ]
+          },
+          "title": "List By Team"
+        },
+        {
+          "description": "Allow an Add-on Service",
+          "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/allowed-addon-services",
+          "method": "POST",
+          "rel": "create",
+          "schema": {
+            "type": [
+              "object"
+            ],
+            "properties": {
+              "addon_service": {
+                "description": "name of the add-on service to allow",
+                "example": "heroku-postgresql",
+                "type": [
+                  "string"
+                ]
+              }
+            }
+          },
+          "targetSchema": {
+            "items": {
+              "$ref": "#/definitions/allowed-add-on-service"
+            },
+            "type": [
+              "array"
+            ]
+          },
+          "title": "Create By Team"
+        },
+        {
+          "description": "Remove an allowed add-on service",
+          "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/allowed-addon-services/{(%23%2Fdefinitions%2Fallowed-add-on-service%2Fdefinitions%2Fidentity)}",
+          "method": "DELETE",
+          "rel": "destroy",
+          "targetSchema": {
+            "$ref": "#/definitions/allowed-add-on-service"
+          },
+          "title": "Delete By Team"
+        }
+      ],
+      "properties": {
+        "added_at": {
+          "$ref": "#/definitions/allowed-add-on-service/definitions/added_at"
+        },
+        "added_by": {
+          "$ref": "#/definitions/allowed-add-on-service/definitions/added_by"
+        },
+        "addon_service": {
+          "$ref": "#/definitions/allowed-add-on-service/definitions/addon_service"
+        },
+        "id": {
+          "$ref": "#/definitions/allowed-add-on-service/definitions/id"
+        }
+      }
+    },
     "app-feature": {
       "description": "An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
@@ -7609,7 +7883,7 @@ module PlatformAPI
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "title": "Heroku Platform API - Audit Trail Archive",
       "description": "An audit trail archive represents a monthly json zipped file containing events",
-      "stability": "development",
+      "stability": "production",
       "strictProperties": true,
       "type": [
         "object"
@@ -7712,25 +7986,241 @@ module PlatformAPI
         }
       }
     },
-    "build": {
+    "audit-trail-event": {
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
-      "description": "A build represents the process of transforming a code tarball into a slug",
-      "title": "Heroku Build API - Build",
+      "title": "Heroku Platform API - Audit Trail Event",
+      "description": "An audit trail event represents some action on the platform",
       "stability": "production",
       "strictProperties": true,
       "type": [
         "object"
       ],
       "definitions": {
-        "buildpacks": {
-          "description": "buildpacks executed for this build, in order",
+        "id": {
+          "description": "unique identifier of event",
+          "readOnly": true,
+          "format": "uuid",
           "type": [
-            "array",
-            "null"
-          ],
-          "items": {
-            "description": "Buildpack to execute in a build",
-            "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/audit-trail-event/definitions/id"
+            }
+          ]
+        },
+        "type": {
+          "description": "type of event",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "action": {
+          "description": "action for the event",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "actor": {
+          "description": "user who caused event",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "format": "uuid",
+              "type": [
+                "string"
+              ]
+            },
+            "email": {
+              "format": "email",
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
+        "app": {
+          "description": "app upon which event took place",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "format": "uuid",
+              "type": [
+                "string"
+              ]
+            },
+            "name": {
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
+        "owner": {
+          "description": "owner of the app targeted by the event",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "format": "uuid",
+              "type": [
+                "string"
+              ]
+            },
+            "email": {
+              "format": "email",
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
+        "enterprise_account": {
+          "description": "enterprise account on which the event happened",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "format": "uuid",
+              "type": [
+                "string"
+              ]
+            },
+            "name": {
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
+        "team": {
+          "description": "team on which the event happened",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "format": "uuid",
+              "type": [
+                "string"
+              ]
+            },
+            "name": {
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
+        "request": {
+          "description": "information about where the action was triggered",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "ip_address": {
+              "format": "ipv4",
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
+        "data": {
+          "description": "data specific to the event",
+          "readOnly": true,
+          "type": [
+            "object"
+          ]
+        },
+        "created_at": {
+          "description": "when event was created",
+          "format": "date-time",
+          "type": [
+            "string"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "List existing events.",
+          "href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}/events",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List"
+        }
+      ],
+      "properties": {
+        "created_at": {
+          "$ref": "#/definitions/audit-trail-event/definitions/created_at"
+        },
+        "id": {
+          "$ref": "#/definitions/audit-trail-event/definitions/id"
+        },
+        "type": {
+          "$ref": "#/definitions/audit-trail-event/definitions/type"
+        },
+        "action": {
+          "$ref": "#/definitions/audit-trail-event/definitions/action"
+        },
+        "actor": {
+          "$ref": "#/definitions/audit-trail-event/definitions/actor"
+        },
+        "app": {
+          "$ref": "#/definitions/audit-trail-event/definitions/app"
+        },
+        "owner": {
+          "$ref": "#/definitions/audit-trail-event/definitions/owner"
+        },
+        "enterprise_account": {
+          "$ref": "#/definitions/audit-trail-event/definitions/enterprise_account"
+        },
+        "team": {
+          "$ref": "#/definitions/audit-trail-event/definitions/team"
+        },
+        "request": {
+          "$ref": "#/definitions/audit-trail-event/definitions/request"
+        },
+        "data": {
+          "$ref": "#/definitions/audit-trail-event/definitions/data"
+        }
+      }
+    },
+    "build": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "description": "A build represents the process of transforming a code tarball into a slug",
+      "title": "Heroku Build API - Build",
+      "stability": "production",
+      "strictProperties": true,
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "buildpacks": {
+          "description": "buildpacks executed for this build, in order",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "description": "Buildpack to execute in a build",
+            "type": [
               "object"
             ],
             "properties": {
@@ -8674,11 +9164,19 @@ module PlatformAPI
           "type": [
             "string"
           ]
+        },
+        "sni_endpoint": {
+          "description": "null or unique identifier or name for SNI endpoint",
+          "type": [
+            "null",
+            "string"
+          ]
         }
       },
       "links": [
         {
-          "description": "Create a new domain.",
+          "deactivate_on": "2021-10-31",
+          "description": "Create a new domain. Deprecated in favor of this same endpoint, but with a new required attribute of `sni_endpoint`. During the transitional phase sni_endpoint can be omitted entirely (current behavior), can be a valid id, or can be null which will skip auto-association.",
           "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains",
           "method": "POST",
           "rel": "create",
@@ -8698,8 +9196,58 @@ module PlatformAPI
           "targetSchema": {
             "$ref": "#/definitions/domain"
           },
+          "title": "Create - Deprecated"
+        },
+        {
+          "description": "Create a new domain.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains",
+          "method": "POST",
+          "rel": "create",
+          "schema": {
+            "properties": {
+              "hostname": {
+                "$ref": "#/definitions/domain/definitions/hostname"
+              },
+              "sni_endpoint": {
+                "$ref": "#/definitions/domain/definitions/sni_endpoint"
+              }
+            },
+            "required": [
+              "hostname",
+              "sni_endpoint"
+            ],
+            "type": [
+              "object"
+            ]
+          },
+          "targetSchema": {
+            "$ref": "#/definitions/domain"
+          },
           "title": "Create"
         },
+        {
+          "description": "Associate an SNI endpoint",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains/{(%23%2Fdefinitions%2Fdomain%2Fdefinitions%2Fidentity)}",
+          "method": "PATCH",
+          "rel": "update",
+          "schema": {
+            "properties": {
+              "sni_endpoint": {
+                "$ref": "#/definitions/domain/definitions/sni_endpoint"
+              }
+            },
+            "required": [
+              "sni_endpoint"
+            ],
+            "type": [
+              "object"
+            ]
+          },
+          "targetSchema": {
+            "$ref": "#/definitions/domain"
+          },
+          "title": "Update"
+        },
         {
           "description": "Delete an existing domain",
           "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains/{(%23%2Fdefinitions%2Fdomain%2Fdefinitions%2Fidentity)}",
@@ -8777,6 +9325,21 @@ module PlatformAPI
         },
         "status": {
           "$ref": "#/definitions/domain/definitions/status"
+        },
+        "sni_endpoint": {
+          "description": "sni endpoint the domain is associated with",
+          "properties": {
+            "name": {
+              "$ref": "#/definitions/sni-endpoint/definitions/name"
+            },
+            "id": {
+              "$ref": "#/definitions/sni-endpoint/definitions/id"
+            }
+          },
+          "type": [
+            "null",
+            "object"
+          ]
         }
       }
     },
@@ -9940,281 +10503,65 @@ module PlatformAPI
         },
         {
           "description": "Update enterprise account properties",
-          "href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
-          "method": "PATCH",
-          "schema": {
-            "properties": {
-              "name": {
-                "$ref": "#/definitions/enterprise-account/definitions/name"
-              }
-            },
-            "type": [
-              "object"
-            ]
-          },
-          "targetSchema": {
-            "$ref": "#/definitions/enterprise-account"
-          },
-          "title": "Update"
-        }
-      ],
-      "properties": {
-        "id": {
-          "$ref": "#/definitions/enterprise-account/definitions/id"
-        },
-        "created_at": {
-          "$ref": "#/definitions/enterprise-account/definitions/created_at"
-        },
-        "name": {
-          "$ref": "#/definitions/enterprise-account/definitions/name"
-        },
-        "updated_at": {
-          "$ref": "#/definitions/enterprise-account/definitions/updated_at"
-        },
-        "permissions": {
-          "$ref": "#/definitions/enterprise-account/definitions/permissions"
-        },
-        "trial": {
-          "$ref": "#/definitions/enterprise-account/definitions/trial"
-        },
-        "identity_provider": {
-          "description": "Identity Provider associated with the Enterprise Account",
-          "strictProperties": true,
-          "type": [
-            "null",
-            "object"
-          ],
-          "properties": {
-            "id": {
-              "$ref": "#/definitions/identity-provider/definitions/id"
-            },
-            "name": {
-              "description": "user-friendly unique identifier for this identity provider",
-              "example": "acme-sso",
-              "type": [
-                "string"
-              ]
-            },
-            "owner": {
-              "$ref": "#/definitions/identity-provider/definitions/owner"
-            }
-          }
-        }
-      }
-    },
-    "event": {
-      "$schema": "http://json-schema.org/draft-04/hyper-schema",
-      "title": "Heroku Platform API - Audit Trail Event",
-      "description": "An audit trail event represents some action on the platform",
-      "stability": "development",
-      "strictProperties": true,
-      "type": [
-        "object"
-      ],
-      "definitions": {
-        "id": {
-          "description": "unique identifier of event",
-          "readOnly": true,
-          "format": "uuid",
-          "type": [
-            "string"
-          ]
-        },
-        "identity": {
-          "anyOf": [
-            {
-              "$ref": "#/definitions/event/definitions/id"
-            }
-          ]
-        },
-        "type": {
-          "description": "type of event",
-          "readOnly": true,
-          "type": [
-            "string"
-          ]
-        },
-        "action": {
-          "description": "action for the event",
-          "readOnly": true,
-          "type": [
-            "string"
-          ]
-        },
-        "actor": {
-          "description": "user who caused event",
-          "readOnly": true,
-          "type": [
-            "object"
-          ],
-          "properties": {
-            "id": {
-              "format": "uuid",
-              "type": [
-                "string"
-              ]
-            },
-            "email": {
-              "format": "email",
-              "type": [
-                "string"
-              ]
-            }
-          }
-        },
-        "app": {
-          "description": "app upon which event took place",
-          "readOnly": true,
-          "type": [
-            "object"
-          ],
-          "properties": {
-            "id": {
-              "format": "uuid",
-              "type": [
-                "string"
-              ]
-            },
-            "name": {
-              "type": [
-                "string"
-              ]
-            }
-          }
-        },
-        "owner": {
-          "description": "owner of the app targeted by the event",
-          "readOnly": true,
-          "type": [
-            "object"
-          ],
-          "properties": {
-            "id": {
-              "format": "uuid",
-              "type": [
-                "string"
-              ]
-            },
-            "email": {
-              "format": "email",
-              "type": [
-                "string"
-              ]
-            }
-          }
-        },
-        "enterprise_account": {
-          "description": "enterprise account on which the event happened",
-          "readOnly": true,
-          "type": [
-            "object"
-          ],
-          "properties": {
-            "id": {
-              "format": "uuid",
-              "type": [
-                "string"
-              ]
-            },
-            "name": {
-              "type": [
-                "string"
-              ]
-            }
-          }
-        },
-        "team": {
-          "description": "team on which the event happened",
-          "readOnly": true,
-          "type": [
-            "object"
-          ],
-          "properties": {
-            "id": {
-              "format": "uuid",
-              "type": [
-                "string"
-              ]
-            },
-            "name": {
-              "type": [
-                "string"
-              ]
-            }
-          }
-        },
-        "request": {
-          "description": "information about where the action was triggered",
-          "readOnly": true,
-          "type": [
-            "object"
-          ],
-          "properties": {
-            "ip_address": {
-              "format": "ipv4",
-              "type": [
-                "string"
-              ]
-            }
-          }
-        },
-        "data": {
-          "description": "data specific to the event",
-          "readOnly": true,
-          "type": [
-            "object"
-          ]
-        },
-        "created_at": {
-          "description": "when event was created",
-          "format": "date-time",
-          "type": [
-            "string"
-          ]
-        }
-      },
-      "links": [
-        {
-          "description": "List existing events.",
-          "href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}/events",
-          "method": "GET",
-          "rel": "instances",
-          "title": "List"
+          "href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
+          "method": "PATCH",
+          "schema": {
+            "properties": {
+              "name": {
+                "$ref": "#/definitions/enterprise-account/definitions/name"
+              }
+            },
+            "type": [
+              "object"
+            ]
+          },
+          "targetSchema": {
+            "$ref": "#/definitions/enterprise-account"
+          },
+          "title": "Update"
         }
       ],
       "properties": {
-        "created_at": {
-          "$ref": "#/definitions/event/definitions/created_at"
-        },
         "id": {
-          "$ref": "#/definitions/event/definitions/id"
-        },
-        "type": {
-          "$ref": "#/definitions/event/definitions/type"
-        },
-        "action": {
-          "$ref": "#/definitions/event/definitions/action"
-        },
-        "actor": {
-          "$ref": "#/definitions/event/definitions/actor"
+          "$ref": "#/definitions/enterprise-account/definitions/id"
         },
-        "app": {
-          "$ref": "#/definitions/event/definitions/app"
+        "created_at": {
+          "$ref": "#/definitions/enterprise-account/definitions/created_at"
         },
-        "owner": {
-          "$ref": "#/definitions/event/definitions/owner"
+        "name": {
+          "$ref": "#/definitions/enterprise-account/definitions/name"
         },
-        "enterprise_account": {
-          "$ref": "#/definitions/event/definitions/enterprise_account"
+        "updated_at": {
+          "$ref": "#/definitions/enterprise-account/definitions/updated_at"
         },
-        "team": {
-          "$ref": "#/definitions/event/definitions/team"
+        "permissions": {
+          "$ref": "#/definitions/enterprise-account/definitions/permissions"
         },
-        "request": {
-          "$ref": "#/definitions/event/definitions/request"
+        "trial": {
+          "$ref": "#/definitions/enterprise-account/definitions/trial"
         },
-        "data": {
-          "$ref": "#/definitions/event/definitions/data"
+        "identity_provider": {
+          "description": "Identity Provider associated with the Enterprise Account",
+          "strictProperties": true,
+          "type": [
+            "null",
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/identity-provider/definitions/id"
+            },
+            "name": {
+              "description": "user-friendly unique identifier for this identity provider",
+              "example": "acme-sso",
+              "type": [
+                "string"
+              ]
+            },
+            "owner": {
+              "$ref": "#/definitions/identity-provider/definitions/owner"
+            }
+          }
         }
       }
     },
@@ -15078,7 +15425,7 @@ module PlatformAPI
           ]
         },
         "pr_number": {
-          "description": "GitHub Pull Request number if the Review app was created automatically",
+          "description": "pull request number the review app is built for",
           "example": 24,
           "readOnly": true,
           "type": [
@@ -15098,6 +15445,9 @@ module PlatformAPI
               "branch": {
                 "$ref": "#/definitions/review-app/definitions/branch"
               },
+              "pr_number": {
+                "$ref": "#/definitions/review-app/definitions/pr_number"
+              },
               "pipeline": {
                 "$ref": "#/definitions/pipeline/definitions/id"
               },
@@ -15703,7 +16053,7 @@ module PlatformAPI
               "size": 2048,
               "stack": {
                 "id": "01234567-89ab-cdef-0123-456789abcdef",
-                "name": "cedar-14"
+                "name": "heroku-18"
               },
               "updated_at": "2012-01-01T12:00:00Z"
             }
@@ -16326,6 +16676,140 @@ module PlatformAPI
         }
       }
     },
+    "space-topology": {
+      "description": "Space Topology provides you with a mechanism for viewing all the running dynos, formations and applications for a space. This is the same data thats used to power our DNS Service Discovery.",
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "stability": "prototype",
+      "strictProperties": true,
+      "title": "Heroku Platform API - Space Topology",
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "version": {
+          "description": "version of the space topology payload",
+          "example": 1,
+          "readOnly": true,
+          "type": [
+            "integer"
+          ]
+        },
+        "dyno": {
+          "description": "A dyno",
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/dyno/definitions/id"
+            },
+            "number": {
+              "description": "process number, e.g. 1 in web.1",
+              "example": 1,
+              "type": [
+                "integer"
+              ]
+            },
+            "private_ip": {
+              "description": "RFC1918 Address of Dyno",
+              "example": "10.0.134.42",
+              "type": [
+                "string"
+              ]
+            },
+            "hostname": {
+              "description": "localspace hostname of resource",
+              "example": "1.example-app-90210.app.localspace",
+              "type": [
+                "string"
+              ]
+            }
+          },
+          "type": [
+            "object"
+          ]
+        },
+        "formation": {
+          "description": "formations for application",
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/formation/definitions/id"
+            },
+            "process_type": {
+              "description": "Name of process type",
+              "example": "web",
+              "type": [
+                "string"
+              ]
+            },
+            "dynos": {
+              "description": "Current dynos for application",
+              "items": {
+                "$ref": "#/definitions/space-topology/definitions/dyno"
+              },
+              "type": [
+                "array"
+              ]
+            }
+          },
+          "type": [
+            "object"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Current space topology",
+          "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/topology",
+          "method": "GET",
+          "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/space-topology"
+          },
+          "title": "Topology"
+        }
+      ],
+      "properties": {
+        "version": {
+          "$ref": "#/definitions/space-topology/definitions/version"
+        },
+        "apps": {
+          "description": "The apps within this space",
+          "type": [
+            "array"
+          ],
+          "readOnly": true,
+          "items": {
+            "type": [
+              "object"
+            ],
+            "properties": {
+              "id": {
+                "$ref": "#/definitions/app/definitions/id",
+                "readOnly": true
+              },
+              "domains": {
+                "example": [
+                  "example.com",
+                  "example.net"
+                ],
+                "readOnly": true,
+                "type": [
+                  "array"
+                ]
+              },
+              "formation": {
+                "description": "formations for application",
+                "items": {
+                  "$ref": "#/definitions/space-topology/definitions/formation"
+                },
+                "type": [
+                  "array"
+                ],
+                "readOnly": true
+              }
+            }
+          }
+        }
+      }
+    },
     "space-transfer": {
       "description": "Transfer spaces between enterprise teams with the same Enterprise Account.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
@@ -16630,6 +17114,24 @@ module PlatformAPI
         "object"
       ],
       "definitions": {
+        "acm": {
+          "readOnly": true,
+          "type": [
+            "boolean"
+          ]
+        },
+        "ca_signed?": {
+          "readOnly": true,
+          "type": [
+            "boolean"
+          ]
+        },
+        "cert_domains": {
+          "readOnly": true,
+          "type": [
+            "array"
+          ]
+        },
         "certificate_chain": {
           "description": "raw contents of the public certificate chain (eg: .crt or .pem file)",
           "example": "-----BEGIN CERTIFICATE----- ...",
@@ -16655,6 +17157,22 @@ module PlatformAPI
             "string"
           ]
         },
+        "display_name": {
+          "description": "unique name for SSL endpoint",
+          "example": "example",
+          "pattern": "^[a-z][a-z0-9-]{2,29}$",
+          "readOnly": false,
+          "type": [
+            "string"
+          ]
+        },
+        "expires_at": {
+          "readOnly": true,
+          "format": "date-time",
+          "type": [
+            "string"
+          ]
+        },
         "id": {
           "description": "unique identifier of this SSL endpoint",
           "example": "01234567-89ab-cdef-0123-456789abcdef",
@@ -16674,6 +17192,12 @@ module PlatformAPI
             }
           ]
         },
+        "issuer": {
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
         "name": {
           "description": "unique name for SSL endpoint",
           "example": "example",
@@ -16700,6 +17224,25 @@ module PlatformAPI
             "string"
           ]
         },
+        "self_signed?": {
+          "readOnly": true,
+          "type": [
+            "boolean"
+          ]
+        },
+        "starts_at": {
+          "readOnly": true,
+          "format": "date-time",
+          "type": [
+            "string"
+          ]
+        },
+        "subject": {
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
         "updated_at": {
           "description": "when endpoint was updated",
           "example": "2012-01-01T12:00:00Z",
@@ -16828,12 +17371,62 @@ module PlatformAPI
         "created_at": {
           "$ref": "#/definitions/ssl-endpoint/definitions/created_at"
         },
+        "display_name": {
+          "$ref": "#/definitions/ssl-endpoint/definitions/display_name"
+        },
+        "domains": {
+          "description": "domains associated with this endpoint",
+          "type": [
+            "array"
+          ],
+          "items": {
+            "$ref": "#/definitions/domain/definitions/id"
+          }
+        },
         "id": {
           "$ref": "#/definitions/ssl-endpoint/definitions/id"
         },
         "name": {
           "$ref": "#/definitions/ssl-endpoint/definitions/name"
         },
+        "ssl_cert": {
+          "description": "certificate provided by this endpoint",
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "ca_signed?": {
+              "$ref": "#/definitions/ssl-endpoint/definitions/ca_signed?"
+            },
+            "cert_domains": {
+              "$ref": "#/definitions/ssl-endpoint/definitions/cert_domains"
+            },
+            "expires_at": {
+              "$ref": "#/definitions/ssl-endpoint/definitions/expires_at"
+            },
+            "issuer": {
+              "$ref": "#/definitions/ssl-endpoint/definitions/issuer"
+            },
+            "self_signed?": {
+              "$ref": "#/definitions/ssl-endpoint/definitions/self_signed?"
+            },
+            "starts_at": {
+              "$ref": "#/definitions/ssl-endpoint/definitions/starts_at"
+            },
+            "subject": {
+              "$ref": "#/definitions/ssl-endpoint/definitions/subject"
+            },
+            "id": {
+              "description": "unique identifier of this SSL certificate",
+              "example": "01234567-89ab-cdef-0123-456789abcdef",
+              "format": "uuid",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
         "updated_at": {
           "$ref": "#/definitions/ssl-endpoint/definitions/updated_at"
         }
@@ -16887,7 +17480,7 @@ module PlatformAPI
         },
         "name": {
           "description": "unique name of stack",
-          "example": "cedar-14",
+          "example": "heroku-18",
           "readOnly": true,
           "type": [
             "string"
@@ -18447,6 +19040,15 @@ module PlatformAPI
             "boolean",
             "null"
           ]
+        },
+        "addons-controls": {
+          "description": "Whether add-on service rules should be applied to add-on installations",
+          "example": true,
+          "readOnly": false,
+          "type": [
+            "boolean",
+            "null"
+          ]
         }
       },
       "links": [
@@ -18472,6 +19074,9 @@ module PlatformAPI
             "properties": {
               "whitelisting-enabled": {
                 "$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
+              },
+              "addons-controls": {
+                "$ref": "#/definitions/team-preferences/definitions/addons-controls"
               }
             }
           },
@@ -18487,6 +19092,9 @@ module PlatformAPI
         },
         "whitelisting-enabled": {
           "$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
+        },
+        "addons-controls": {
+          "$ref": "#/definitions/team-preferences/definitions/addons-controls"
         }
       }
     },
@@ -20604,6 +21212,9 @@ module PlatformAPI
     "add-on": {
       "$ref": "#/definitions/add-on"
     },
+    "allowed-add-on-service": {
+      "$ref": "#/definitions/allowed-add-on-service"
+    },
     "app-feature": {
       "$ref": "#/definitions/app-feature"
     },
@@ -20631,6 +21242,9 @@ module PlatformAPI
     "archive": {
       "$ref": "#/definitions/archive"
     },
+    "audit-trail-event": {
+      "$ref": "#/definitions/audit-trail-event"
+    },
     "build": {
       "$ref": "#/definitions/build"
     },
@@ -20667,9 +21281,6 @@ module PlatformAPI
     "enterprise-account": {
       "$ref": "#/definitions/enterprise-account"
     },
-    "event": {
-      "$ref": "#/definitions/event"
-    },
     "filter-apps": {
       "$ref": "#/definitions/filter-apps"
     },
@@ -20790,6 +21401,9 @@ module PlatformAPI
     "space-nat": {
       "$ref": "#/definitions/space-nat"
     },
+    "space-topology": {
+      "$ref": "#/definitions/space-topology"
+    },
     "space-transfer": {
       "$ref": "#/definitions/space-transfer"
     },