ex_heroku_client v0.3.0 Heroku.Account

Summary

Functions

Calls DELETE /account

Calls DELETE /users/#{account_identity}

Calls GET /account

Calls GET /users/#{account_identity}

Calls PATCH /account

Calls PATCH /account

Calls PATCH /account

Calls PATCH /users/#{account_identity}

Calls PATCH /users/#{account_identity}

Calls PATCH /users/#{account_identity}

Functions

destroy_4()

Calls DELETE /account

destroy_9(account_identity)

Calls DELETE /users/#{account_identity}

get_0()

Calls GET /account

get_5(account_identity)

Calls GET /users/#{account_identity}

update_1(params \\ %{})

Calls PATCH /account

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "allow_tracking": {
      "default": true,
      "description": "whether to allow third party web activity tracking",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "beta": {
      "default": false,
      "description": "whether allowed to utilize beta Heroku features",
      "example": false,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "name": {
      "description": "full name of the account owner",
      "example": "Tina Edmonds",
      "readOnly": false,
      "type": [
        "string",
        "null"
      ]
    },
    "password": {
      "description": "current password on the account",
      "example": "currentpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}
update_2(params)

Calls PATCH /account

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"
      ]
    },
    "password": {
      "description": "current password on the account",
      "example": "currentpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "password",
    "email"
  ],
  "type": [
    "object"
  ]
}
update_3(params)

Calls PATCH /account

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "new_password": {
      "description": "the new password for the account when changing the password",
      "example": "newpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "password": {
      "description": "current password on the account",
      "example": "currentpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "new_password",
    "password"
  ],
  "type": [
    "object"
  ]
}
update_6(account_identity, params \\ %{})

Calls PATCH /users/#{account_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "allow_tracking": {
      "default": true,
      "description": "whether to allow third party web activity tracking",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "beta": {
      "default": false,
      "description": "whether allowed to utilize beta Heroku features",
      "example": false,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "name": {
      "description": "full name of the account owner",
      "example": "Tina Edmonds",
      "readOnly": false,
      "type": [
        "string",
        "null"
      ]
    },
    "password": {
      "description": "current password on the account",
      "example": "currentpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}
update_7(account_identity, params)

Calls PATCH /users/#{account_identity}

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"
      ]
    },
    "password": {
      "description": "current password on the account",
      "example": "currentpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "password",
    "email"
  ],
  "type": [
    "object"
  ]
}
update_8(account_identity, params)

Calls PATCH /users/#{account_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "new_password": {
      "description": "the new password for the account when changing the password",
      "example": "newpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "password": {
      "description": "current password on the account",
      "example": "currentpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "new_password",
    "password"
  ],
  "type": [
    "object"
  ]
}