Module hex_api_organization
Function Index
get/1 | Gets an organzation. |
list/1 | Lists all organizations you are member of. |
update/2 | Updates the number of seats in an organzation. |
Function Details
get/1
get(Config::hex_core:config()) -> hex_api:response()
Gets an organzation.
Examples:
> hex_api_organization:get(hex_core:default_config()#{api_organization => <<"acme">>}).
{ok, {200, ..., #{
<<"billing_active">> => true,
<<"inserted_at">> => <<"2017-08-22T22:19:53Z">>,
<<"name">> => <<"acme">>,
<<"seats">> => 42,
<<"updated_at">> => <<"2019-01-18T08:47:29Z">>}
}}}
list/1
list(Config::hex_core:config()) -> hex_api:response()
Lists all organizations you are member of.
Examples:
> hex_api_organization:list(hex_core:default_config()#{api_organization => <<"acme">>}).
{ok, {200, ..., [#{
<<"billing_active">> => true,
<<"inserted_at">> => <<"2017-08-22T22:19:53Z">>,
<<"name">> => <<"acme">>,
<<"updated_at">> => <<"2019-01-18T08:47:29Z">>}
}]}}
update/2
update(Config::hex_core:config(), Seats::pos_integer()) -> hex_api:response()
Updates the number of seats in an organzation.
Examples:
> hex_api_organization:get(hex_core:default_config()#{api_organization => <<"acme">>}, 42).
{ok, {200, ..., #{
<<"billing_active">> => true,
<<"inserted_at">> => <<"2017-08-22T22:19:53Z">>,
<<"name">> => <<"acme">>,
<<"seats">> => 42,
<<"updated_at">> => <<"2019-01-18T08:47:29Z">>}
}}}