NuonAPI.Api.Orgs (nuon v0.19.90)
API calls for all endpoints tagged Orgs
.
Summary
Functions
Add a user to the current org
create a new org
Delete an org
Get an org
Return current user's orgs
Update current org
Functions
Link to this function
add_user(connection, service_create_org_user_request, opts \\ [])
@spec add_user( Tesla.Env.client(), NuonAPI.Model.ServiceCreateOrgUserRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppUserOrg.t()} | {:error, Tesla.Env.t()}
Add a user to the current org
Parameters
connection
(NuonAPI.Connection): Connection to serverservice_create_org_user_request
(ServiceCreateOrgUserRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppUserOrg.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
create_org(connection, service_create_org_request, opts \\ [])
@spec create_org( Tesla.Env.client(), NuonAPI.Model.ServiceCreateOrgRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppOrg.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create a new org
Parameters
connection
(NuonAPI.Connection): Connection to serverservice_create_org_request
(ServiceCreateOrgRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppOrg.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
delete_org(connection, opts \\ [])
@spec delete_org( Tesla.Env.client(), keyword() ) :: {:ok, boolean()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Delete an org
Parameters
connection
(NuonAPI.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, boolean()}
on success{:error, Tesla.Env.t}
on failure
Link to this function
get_org(connection, opts \\ [])
@spec get_org( Tesla.Env.client(), keyword() ) :: {:ok, NuonAPI.Model.AppOrg.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Get an org
Parameters
connection
(NuonAPI.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppOrg.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
get_orgs(connection, opts \\ [])
@spec get_orgs( Tesla.Env.client(), keyword() ) :: {:ok, [NuonAPI.Model.AppOrg.t()]} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Return current user's orgs
Parameters
connection
(NuonAPI.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, [%AppOrg{}, ...]}
on success{:error, Tesla.Env.t}
on failure
Link to this function
update_org(connection, service_update_org_request, opts \\ [])
@spec update_org( Tesla.Env.client(), NuonAPI.Model.ServiceUpdateOrgRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppOrg.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Update current org
Parameters
connection
(NuonAPI.Connection): Connection to serverservice_update_org_request
(ServiceUpdateOrgRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppOrg.t}
on success{:error, Tesla.Env.t}
on failure