Nuon.Api.Orgs (nuon v0.19.132)
API calls for all endpoints tagged Orgs
.
Summary
Functions
Add a user to the current org
create a new org
Invite a user to the current org Invite a user (by email) to an org. This user will receive an email, and when they next log into the application will be added to the org.
Delete an org
Get an org
Get an org's health checks Fetch the most recent health checks for an org. Health checks are automatically performed once every 60 seconds.
Return org invites Returns a list of all invites to the org.
Return current user's orgs
Update current org
Functions
add_user(connection, service_create_org_user_request, opts \\ [])
@spec add_user( Tesla.Env.client(), Nuon.Model.ServiceCreateOrgUserRequest.t(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppUserOrg.t()} | {:error, Tesla.Env.t()}
Add a user to the current org
Parameters
connection
(Nuon.Connection): Connection to serverservice_create_org_user_request
(ServiceCreateOrgUserRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppUserOrg.t}
on success{:error, Tesla.Env.t}
on failure
create_org(connection, service_create_org_request, opts \\ [])
@spec create_org( Tesla.Env.client(), Nuon.Model.ServiceCreateOrgRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppOrg.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create a new org
Parameters
connection
(Nuon.Connection): Connection to serverservice_create_org_request
(ServiceCreateOrgRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppOrg.t}
on success{:error, Tesla.Env.t}
on failure
create_org_invite(connection, service_create_org_invite_request, opts \\ [])
@spec create_org_invite( Tesla.Env.client(), Nuon.Model.ServiceCreateOrgInviteRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppOrgInvite.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Invite a user to the current org Invite a user (by email) to an org. This user will receive an email, and when they next log into the application will be added to the org.
Parameters
connection
(Nuon.Connection): Connection to serverservice_create_org_invite_request
(ServiceCreateOrgInviteRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppOrgInvite.t}
on success{:error, Tesla.Env.t}
on failure
delete_org(connection, opts \\ [])
@spec delete_org( Tesla.Env.client(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, boolean()} | {:error, Tesla.Env.t()}
Delete an org
Parameters
connection
(Nuon.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, boolean()}
on success{:error, Tesla.Env.t}
on failure
get_org(connection, opts \\ [])
@spec get_org( Tesla.Env.client(), keyword() ) :: {:ok, Nuon.Model.AppOrg.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Get an org
Parameters
connection
(Nuon.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppOrg.t}
on success{:error, Tesla.Env.t}
on failure
get_org_health_checks(connection, opts \\ [])
@spec get_org_health_checks( Tesla.Env.client(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppOrgHealthCheck.t()]} | {:error, Tesla.Env.t()}
Get an org's health checks Fetch the most recent health checks for an org. Health checks are automatically performed once every 60 seconds.
Parameters
connection
(Nuon.Connection): Connection to serveropts
(keyword): Optional parameters:limit
(integer()): limit of health checks to return
Returns
{:ok, [%AppOrgHealthCheck{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_org_invites(connection, opts \\ [])
@spec get_org_invites( Tesla.Env.client(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppOrgInvite.t()]} | {:error, Tesla.Env.t()}
Return org invites Returns a list of all invites to the org.
Parameters
connection
(Nuon.Connection): Connection to serveropts
(keyword): Optional parameters:limit
(integer()): limit of health checks to return
Returns
{:ok, [%AppOrgInvite{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_orgs(connection, opts \\ [])
@spec get_orgs( Tesla.Env.client(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppOrg.t()]} | {:error, Tesla.Env.t()}
Return current user's orgs
Parameters
connection
(Nuon.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, [%AppOrg{}, ...]}
on success{:error, Tesla.Env.t}
on failure
update_org(connection, service_update_org_request, opts \\ [])
@spec update_org( Tesla.Env.client(), Nuon.Model.ServiceUpdateOrgRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppOrg.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Update current org
Parameters
connection
(Nuon.Connection): Connection to serverservice_update_org_request
(ServiceUpdateOrgRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppOrg.t}
on success{:error, Tesla.Env.t}
on failure