ex_heroku_client v0.1.0 Heroku.Organization

Summary

Functions

Calls POST /organizations

Calls DELETE /organizations/#{organization_identity}

Calls GET /organizations/#{organization_identity}

Calls GET /organizations

Calls PATCH /organizations/#{organization_identity}

Functions

create(params)

Calls POST /organizations

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "address_1": {
      "description": "street address line 1",
      "example": "40 Hickory Lane",
      "type": [
        "string"
      ]
    },
    "address_2": {
      "description": "street address line 2",
      "example": "Suite 103",
      "type": [
        "string"
      ]
    },
    "card_number": {
      "description": "encrypted card number of payment method",
      "example": "encrypted-card-number",
      "type": [
        "string"
      ]
    },
    "city": {
      "description": "city",
      "example": "San Francisco",
      "type": [
        "string"
      ]
    },
    "country": {
      "description": "country",
      "example": "US",
      "type": [
        "string"
      ]
    },
    "cvv": {
      "description": "card verification value",
      "example": "123",
      "type": [
        "string"
      ]
    },
    "expiration_month": {
      "description": "expiration month",
      "example": "11",
      "type": [
        "string"
      ]
    },
    "expiration_year": {
      "description": "expiration year",
      "example": "2014",
      "type": [
        "string"
      ]
    },
    "first_name": {
      "description": "the first name for payment method",
      "example": "Jason",
      "type": [
        "string"
      ]
    },
    "last_name": {
      "description": "the last name for payment method",
      "example": "Walker",
      "type": [
        "string"
      ]
    },
    "name": {
      "description": "unique name of organization",
      "example": "example",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "other": {
      "description": "metadata",
      "example": "Additional information for payment method",
      "type": [
        "string"
      ]
    },
    "postal_code": {
      "description": "postal code",
      "example": "90210",
      "type": [
        "string"
      ]
    },
    "state": {
      "description": "state",
      "example": "CA",
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "name"
  ],
  "type": [
    "object"
  ]
}
destroy(organization_identity)

Calls DELETE /organizations/#{organization_identity}

get(organization_identity)

Calls GET /organizations/#{organization_identity}

index()

Calls GET /organizations

update(organization_identity, params \\ %{})

Calls PATCH /organizations/#{organization_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "default": {
      "description": "whether to use this organization when none is specified",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "name": {
      "description": "unique name of organization",
      "example": "example",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}