ex_heroku_client v0.1.0 Heroku.App

Summary

Functions

Calls POST /apps

Calls DELETE /apps/#{app_identity}

Calls GET /apps/#{app_identity}

Calls GET /apps

Calls GET /users/#{account_identity}/apps

Calls PATCH /apps/#{app_identity}

Functions

create(params \\ %{})

Calls POST /apps

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "name": {
      "description": "unique name of app",
      "example": "example",
      "pattern": "^[a-z][a-z0-9-]{2,29}$",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "region": {
      "anyOf": [
        {
          "description": "unique identifier of region",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        },
        {
          "description": "unique name of region",
          "example": "us",
          "readOnly": true,
          "type": [
            "string"
          ]
        }
      ]
    },
    "stack": {
      "anyOf": [
        {
          "description": "unique name of stack",
          "example": "cedar-14",
          "readOnly": true,
          "type": [
            "string"
          ]
        },
        {
          "description": "unique identifier of stack",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        }
      ]
    }
  },
  "type": [
    "object"
  ]
}
destroy(app_identity)

Calls DELETE /apps/#{app_identity}

get(app_identity)

Calls GET /apps/#{app_identity}

index_4()

Calls GET /apps

index_5(account_identity)

Calls GET /users/#{account_identity}/apps

update(app_identity, params \\ %{})

Calls PATCH /apps/#{app_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "build_stack": {
      "anyOf": [
        {
          "description": "unique name of stack",
          "example": "cedar-14",
          "readOnly": true,
          "type": [
            "string"
          ]
        },
        {
          "description": "unique identifier of stack",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        }
      ]
    },
    "maintenance": {
      "default": false,
      "description": "maintenance status of app",
      "example": false,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "name": {
      "description": "unique name of app",
      "example": "example",
      "pattern": "^[a-z][a-z0-9-]{2,29}$",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}