ex_heroku_client v0.4.0 Heroku.TeamAppCollaborator

Summary

Functions

Calls POST /teams/apps/#{app_identity}/collaborators

Calls DELETE /teams/apps/#{team_app_identity}/collaborators/#{team_app_collaborator_identity}

Calls GET /teams/apps/#{team_app_identity}/collaborators/#{team_app_collaborator_identity}

Calls GET /teams/apps/#{team_app_identity}/collaborators

Calls PATCH /teams/apps/#{team_app_identity}/collaborators/#{team_app_collaborator_identity}

Functions

create(app_identity, params)

Calls POST /teams/apps/#{app_identity}/collaborators

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "permissions": {
      "additionalItems": true,
      "description": "An array of permissions to give to the collaborator.",
      "items": {
        "description": "The name of the app permission.",
        "example": "view",
        "readOnly": true,
        "type": [
          "string"
        ]
      },
      "type": [
        "array"
      ]
    },
    "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(team_app_identity, team_app_collaborator_identity)

Calls DELETE /teams/apps/#{team_app_identity}/collaborators/#{team_app_collaborator_identity}

get(team_app_identity, team_app_collaborator_identity)

Calls GET /teams/apps/#{team_app_identity}/collaborators/#{team_app_collaborator_identity}

index(team_app_identity)

Calls GET /teams/apps/#{team_app_identity}/collaborators

update(team_app_identity, team_app_collaborator_identity, params)

Calls PATCH /teams/apps/#{team_app_identity}/collaborators/#{team_app_collaborator_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "permissions": {
      "additionalItems": true,
      "description": "An array of permissions to give to the collaborator.",
      "items": {
        "description": "The name of the app permission.",
        "example": "view",
        "readOnly": true,
        "type": [
          "string"
        ]
      },
      "type": [
        "array"
      ]
    }
  },
  "required": [
    "permissions"
  ],
  "type": [
    "object"
  ]
}