ex_heroku_client v0.1.0 Heroku.AppTransfer
Summary
Functions
Calls POST /account/app-transfers
Calls DELETE /account/app-transfers/#{app-transfer_identity}
Calls GET /account/app-transfers/#{app-transfer_identity}
Calls GET /account/app-transfers
Calls PATCH /account/app-transfers/#{app-transfer_identity}
Functions
Calls POST /account/app-transfers
params
is JSON encoded and passed as the request body.
params Schema
{
"properties": {
"app": {
"anyOf": [
{
"description": "unique identifier of app",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"format": "uuid",
"readOnly": true,
"type": [
"string"
]
},
{
"description": "unique name of app",
"example": "example",
"pattern": "^[a-z][a-z0-9-]{2,29}$",
"readOnly": false,
"type": [
"string"
]
}
]
},
"recipient": {
"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"
]
}
]
},
"silent": {
"default": false,
"description": "whether to suppress email notification when transferring apps",
"example": false,
"readOnly": true,
"type": [
"boolean"
]
}
},
"required": [
"app",
"recipient"
],
"type": [
"object"
]
}
Calls PATCH /account/app-transfers/#{app-transfer_identity}
params
is JSON encoded and passed as the request body.
params Schema
{
"properties": {
"state": {
"description": "the current state of an app transfer",
"enum": [
"pending",
"accepted",
"declined"
],
"example": "pending",
"readOnly": true,
"type": [
"string"
]
}
},
"required": [
"state"
],
"type": [
"object"
]
}