ex_heroku_client v0.3.0 Heroku.OrganizationApp

Summary

Functions

Calls POST /organizations/apps

Calls GET /organizations/apps/#{organization_app_identity}

Calls GET /organizations/#{organization_identity}/apps

Calls PATCH /organizations/apps/#{organization_app_identity}

Functions

create(params \\ %{})

Calls POST /organizations/apps

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "locked": {
      "default": false,
      "description": "are other organization members forbidden from joining this app.",
      "example": false,
      "type": [
        "boolean"
      ]
    },
    "name": {
      "description": "unique name of app",
      "example": "example",
      "pattern": "^[a-z][a-z0-9-]{2,29}$",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "organization": {
      "description": "unique name of organization",
      "example": "example",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "personal": {
      "default": false,
      "description": "force creation of the app in the user account even if a default org is set.",
      "example": false,
      "type": [
        "boolean"
      ]
    },
    "region": {
      "description": "unique name of region",
      "example": "us",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "space": {
      "description": "unique name of space",
      "example": "nasa",
      "pattern": "^[a-z0-9](?:[a-z0-9]|-(?!-))+[a-z0-9]$",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "stack": {
      "description": "unique name of stack",
      "example": "cedar-14",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}
get(organization_app_identity)

Calls GET /organizations/apps/#{organization_app_identity}

list_apps_in_the_default_organization_or_in_personal_account_if_default_organization_is_not_set()

Calls GET /organizations/apps

list_organization_apps(organization_identity)

Calls GET /organizations/#{organization_identity}/apps

lock_or_unlock_an_organization_app(organization_app_identity, params)

Calls PATCH /organizations/apps/#{organization_app_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "locked": {
      "default": false,
      "description": "are other organization members forbidden from joining this app.",
      "example": false,
      "type": [
        "boolean"
      ]
    }
  },
  "required": [
    "locked"
  ],
  "type": [
    "object"
  ]
}
transfer_an_existing_organization_app_to_another_heroku_account(organization_app_identity, params)

Calls PATCH /organizations/apps/#{organization_app_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "owner": {
      "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": [
    "owner"
  ],
  "type": [
    "object"
  ]
}
transfer_an_existing_organization_app_to_another_organization(organization_app_identity, params)

Calls PATCH /organizations/apps/#{organization_app_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "owner": {
      "description": "unique name of organization",
      "example": "example",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "owner"
  ],
  "type": [
    "object"
  ]
}