Packages

hex_core

0.11.0
0.19.0 0.18.0 0.17.0 0.16.1 0.16.0 0.15.0 0.14.1 0.14.0 0.13.0 0.12.2 0.12.1 retired 0.12.0 0.11.0 0.10.3 0.10.2 0.10.1 0.10.0 0.9.0 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.10 0.6.9 0.6.8 0.6.7 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.1 0.5.0 0.4.0 0.3.0 retired 0.2.1 0.2.0 0.1.1 0.1.0

Reference implementation of Hex specifications

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
44 Versions
0 Dependencies
Dependants
2 Advisories
Files
Activity
hex_core src hex_api_organization.erl
Raw

src/hex_api_organization.erl 

%% @doc

%% Hex HTTP API - Organizations.

-module(hex_api_organization).

-export([

    get/1,

    list/1,

    update/2

]).



%% @doc

%% 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">>}

%%      }]}}

%% '''

-spec list(hex_core:config()) -> hex_api:response().

list(Config) when is_map(Config) ->

    hex_api:get(Config, ["orgs"]).



%% @doc

%% 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">>}

%%      }}}

%% '''

-spec get(hex_core:config()) -> hex_api:response().

get(Config) when is_map(Config) ->

    Path = hex_api:build_organization_path(Config, []),

    hex_api:get(Config, Path).



%% @doc

%% 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">>}

%%      }}}

%% '''

-spec update(hex_core:config(), pos_integer()) -> hex_api:response().

update(Config, Seats) when is_map(Config) and is_integer(Seats) ->

    Path = hex_api:build_organization_path(Config, []),

    Params = #{<<"seats">> => Seats},

    hex_api:post(Config, Path, Params).