platform-api 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee0c328970505aab87e732a3030917e1a39a13ace925bee458a64e7c46e2b4a2
-  data.tar.gz: c6c5e31213b1cb83e778644602090eafb62fedd13f2e25705c65a9667b65f3ba
+  metadata.gz: a6e49cd394a0604607050110b325326eb7ede3f8fc106b4bd0fd9af469805e24
+  data.tar.gz: 58c8c8a6bc8f27960ef512faa4426dd29590ad9702403bfcc52e485913cd997a
 SHA512:
-  metadata.gz: dc9b94a51665c7baa26970c7a29fb8aa73611150ace42da706c0cfff817761c92d5c6cceb283a6fc7bd0182bbf6eae6624008d07befd48ba1cd908640e1a57d9
-  data.tar.gz: 382c4beea5afac407fc0d34b88d9e376390a015fcf023bfe7bb422111785481e4752f73a810a353c37178f8d36925e97d1dc149273d07781524c42f52c842147
+  metadata.gz: 273953ff91506216f6623402f6bfdec5cbd0bc394578747a42f06999142d74d24834b0e02015bd6e3597c1b0421d443af4dff88432e13814a44da359f2e12561
+  data.tar.gz: decc03b9d7448b9f4087c7c09c68ce4ac2024c2be222e8c90d3dcab09bf9bea374d938fba1b1aefd41dd78f9c638c4ab65f9f94b4a2a0e79b51299ba89ee072b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## 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. (https://github.com/heroku/platform-api/pull/104)

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/3.0.0"}
+    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]
@@ -860,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
@@ -1188,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)
@@ -1644,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
@@ -1652,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
@@ -3961,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": [
@@ -4174,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": {
@@ -4209,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,
@@ -5742,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",
@@ -7630,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"
@@ -7737,7 +7990,7 @@ module PlatformAPI
       "$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",
+      "stability": "production",
       "strictProperties": true,
       "type": [
         "object"
@@ -8911,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",
@@ -8935,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)}",
@@ -9014,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"
+          ]
         }
       }
     },
@@ -15727,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"
             }
@@ -16395,7 +16721,10 @@ module PlatformAPI
                 "string"
               ]
             }
-          }
+          },
+          "type": [
+            "object"
+          ]
         },
         "formation": {
           "description": "formations for application",
@@ -16785,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----- ...",
@@ -16810,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",
@@ -16829,6 +17192,12 @@ module PlatformAPI
             }
           ]
         },
+        "issuer": {
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
         "name": {
           "description": "unique name for SSL endpoint",
           "example": "example",
@@ -16855,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",
@@ -16983,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"
         }
@@ -17042,7 +17480,7 @@ module PlatformAPI
         },
         "name": {
           "description": "unique name of stack",
-          "example": "cedar-14",
+          "example": "heroku-18",
           "readOnly": true,
           "type": [
             "string"
@@ -18602,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": [
@@ -18627,6 +19074,9 @@ module PlatformAPI
             "properties": {
               "whitelisting-enabled": {
                 "$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
+              },
+              "addons-controls": {
+                "$ref": "#/definitions/team-preferences/definitions/addons-controls"
               }
             }
           },
@@ -18642,6 +19092,9 @@ module PlatformAPI
         },
         "whitelisting-enabled": {
           "$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
+        },
+        "addons-controls": {
+          "$ref": "#/definitions/team-preferences/definitions/addons-controls"
         }
       }
     },
@@ -20759,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"
     },