module Ohanakapa::Client::Organizations

Methods for the Organizations API

@see ohanapi.herokuapp.com/api/docs

Public Instance Methods

org(id)
Alias for: organization
organization(id) click to toggle source

Get a single organization based on its ID @see ohanapi.herokuapp.com/api/docs#!/api/GET-api-organizations–id—format-_get_1

@param id [String] Organization ID. @return [Sawyer::Resource] @example

Ohanakapa.organization('519c44065634241897000023')

@example

Ohanakapa.org('519c44065634241897000023')
# File lib/ohanakapa/client/organizations.rb, line 36
def organization(id)
  get("organizations/#{id}")
end
Also aliased as: org
organizations() click to toggle source

List all organizations

This provides a dump of every organization, in the order that they were uploaded to the Ohana DB.

@see ohanapi.herokuapp.com/api/docs#!/api/GET-api-organizations—format-_get_0

@return [Array<Sawyer::Resource>] List of Organizations.

@example

Ohanakapa.organizations

@example

Ohanakapa.orgs
# File lib/ohanakapa/client/organizations.rb, line 22
def organizations
  get "organizations"
end
Also aliased as: orgs
orgs()
Alias for: organizations