ex_heroku_client v0.3.0 Heroku.Collaborator

Summary

Functions

Calls POST /apps/#{app_identity}/collaborators

Calls DELETE /apps/#{app_identity}/collaborators/#{collaborator_identity}

Calls GET /apps/#{app_identity}/collaborators/#{collaborator_identity}

Calls GET /apps/#{app_identity}/collaborators

Functions

create(app_identity, params)

Calls POST /apps/#{app_identity}/collaborators

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "silent": {
      "default": false,
      "description": "whether to suppress email invitation when creating collaborator",
      "example": false,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "user": {
      "anyOf": [
        {
          "description": "unique email address of account",
          "example": "username@example.com",
          "format": "email",
          "readOnly": false,
          "type": [
            "string"
          ]
        },
        {
          "description": "unique identifier of an account",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        },
        {
          "description": "Implicit reference to currently authorized user",
          "enum": [
            "~"
          ],
          "example": "~",
          "readOnly": true,
          "type": [
            "string"
          ]
        }
      ]
    }
  },
  "required": [
    "user"
  ],
  "type": [
    "object"
  ]
}
destroy(app_identity, collaborator_identity)

Calls DELETE /apps/#{app_identity}/collaborators/#{collaborator_identity}

get(app_identity, collaborator_identity)

Calls GET /apps/#{app_identity}/collaborators/#{collaborator_identity}

index(app_identity)

Calls GET /apps/#{app_identity}/collaborators