View Source hex_api_package_owner (hex_core v0.10.3)
Hex HTTP API - Package Owners.
Summary
Functions
Adds a packages owner.
Deletes a packages owner.
Gets a packages owner.
Lists the packages owners.
Functions
-spec add(hex_core:config(), binary(), binary(), binary(), boolean()) -> hex_api:response().
Adds a packages owner.
Examples:
> hex_api_package_owner:add(hex_core:default_config(), <<"package">>, <<"user">>, <<"full">>, false).
{ok, {200, ..., #{
<<"email">> => <<"user@example.com">>,
<<"full_name">> => <<"John Doe">>,
<<"handles">> => #{...},
<<"inserted_at">> => <<"2014-04-21T17:20:12Z">>,
<<"level">> => <<"full">>,
<<"updated_at">> => <<"2019-08-04T19:28:05Z">>,
<<"url">> => <<"https://hex.pm/api/users/user">>,
<<"username">> => <<"user">>
}}}
-spec delete(hex_core:config(), binary(), binary()) -> hex_api:response().
Deletes a packages owner.
Examples:
> hex_api_package_owner:delete(hex_core:default_config(), <<"package">>, <<"user">>).
{ok, {204, ..., nil}}
-spec get(hex_core:config(), binary(), binary()) -> hex_api:response().
Gets a packages owner.
Examples:
> hex_api_package_owner:get(hex_core:default_config(), <<"package">>, <<"user">>).
{ok, {200, ..., #{
<<"email">> => <<"user@example.com">>,
<<"full_name">> => <<"John Doe">>,
<<"handles">> => #{...},
<<"inserted_at">> => <<"2014-04-21T17:20:12Z">>,
<<"level">> => <<"full">>,
<<"updated_at">> => <<"2019-08-04T19:28:05Z">>,
<<"url">> => <<"https://hex.pm/api/users/user">>,
<<"username">> => <<"user">>
}}}
-spec list(hex_core:config(), binary()) -> hex_api:response().
Lists the packages owners.
Examples:
> hex_api_package_owner:list(hex_core:default_config(), <<"package">>).
{ok, {200, ..., [#{
<<"email">> => <<"user@example.com">>,
<<"full_name">> => <<"John Doe">>,
<<"handles">> => #{...},
<<"inserted_at">> => <<"2014-04-21T17:20:12Z">>,
<<"level">> => <<"full">>,
<<"updated_at">> => <<"2019-08-04T19:28:05Z">>,
<<"url">> => <<"https://hex.pm/api/users/user">>,
<<"username">> => <<"user">>
}]}}