ex_heroku_client v0.1.0 Heroku.Invitation
Summary
Functions
Calls GET /invitations/#{invitation_identity}
Calls POST /invitations
Calls PATCH /invitations/#{invitation_identity}
Functions
Calls POST /invitations
params
is JSON encoded and passed as the request body.
params Schema
{
"properties": {
"email": {
"description": "unique email address of account",
"example": "username@example.com",
"format": "email",
"readOnly": false,
"type": [
"string"
]
},
"name": {
"description": "full name of the account owner",
"example": "Tina Edmonds",
"readOnly": false,
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"name"
],
"type": [
"object"
]
}
Calls PATCH /invitations/#{invitation_identity}
params
is JSON encoded and passed as the request body.
params Schema
{
"properties": {
"password": {
"description": "current password on the account",
"example": "currentpassword",
"readOnly": true,
"type": [
"string"
]
},
"password_confirmation": {
"description": "current password on the account",
"example": "currentpassword",
"readOnly": true,
"type": [
"string"
]
},
"receive_newsletter": {
"description": "whether this user should receive a newsletter or not",
"example": false,
"readOnly": true,
"type": [
"boolean"
]
}
},
"required": [
"password",
"password_confirmation"
],
"type": [
"object"
]
}