HookSniffAPI.Api.Teams (HookSniff v0.3.0)

API calls for all endpoints tagged Teams.

Summary

Functions

teams_get(connection, opts \\ [])

List teams

teams_id_get(connection, id, opts \\ [])

Get team details

teams_id_invite_post(connection, id, invite_request, opts \\ [])

Invite a member to the team

teams_id_members_get(connection, id, opts \\ [])

List team members

teams_id_members_uid_delete(connection, id, uid, opts \\ [])

Remove member from team

teams_id_members_uid_role_put(connection, id, uid, change_role_request, opts \\ [])

Change member role

teams_post(connection, create_team_request, opts \\ [])

Create a team

Functions

teams_get(connection, opts \\ [])

@spec teams_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [HookSniffAPI.Model.Team.t()]} | {:error, Tesla.Env.t()}

List teams

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, [%Team{}, ...]} on success
{:error, Tesla.Env.t} on failure

teams_id_get(connection, id, opts \\ [])

@spec teams_id_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, HookSniffAPI.Model.TeamDetailResponse.t()} | {:error, Tesla.Env.t()}

Get team details

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.TeamDetailResponse.t} on success
{:error, Tesla.Env.t} on failure

teams_id_invite_post(connection, id, invite_request, opts \\ [])

@spec teams_id_invite_post(
  Tesla.Env.client(),
  String.t(),
  HookSniffAPI.Model.InviteRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Invite a member to the team

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
invite_request (InviteRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

teams_id_members_get(connection, id, opts \\ [])

@spec teams_id_members_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [HookSniffAPI.Model.TeamMember.t()]} | {:error, Tesla.Env.t()}

List team members

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, [%TeamMember{}, ...]} on success
{:error, Tesla.Env.t} on failure

teams_id_members_uid_delete(connection, id, uid, opts \\ [])

@spec teams_id_members_uid_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Remove member from team

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
uid (String.t):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

teams_id_members_uid_role_put(connection, id, uid, change_role_request, opts \\ [])

@spec teams_id_members_uid_role_put(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  HookSniffAPI.Model.ChangeRoleRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Change member role

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
uid (String.t):
change_role_request (ChangeRoleRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

teams_post(connection, create_team_request, opts \\ [])

@spec teams_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.CreateTeamRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.Team.t()} | {:error, Tesla.Env.t()}

Create a team

Parameters

connection (HookSniffAPI.Connection): Connection to server
create_team_request (CreateTeamRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.Team.t} on success
{:error, Tesla.Env.t} on failure