Thinkific.Api.Users (Thinkific API SDK v0.1.3)

API calls for all endpoints tagged Users.

Link to this section Summary

Functions

create_user(connection, body, opts \\ [])

createUser Create a new user

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

deleteUserByID Deletes a User identified by the provided id

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

getUserByID Retrieves a User identified by the provided id

get_users(connection, opts \\ [])

getUsers Retrieve a list of users

update_user_by_id(connection, id, body, opts \\ [])

updateUserByID Updates the user specified by the provided id

Link to this section Functions

create_user(connection, body, opts \\ [])

Specs

create_user(
  Tesla.Env.client(),
  Thinkific.Model.CreateUserRequest.t(),
  keyword()
) :: {:ok, Thinkific.Model.UserResponse.t()} | {:error, Tesla.Env.t()}

createUser Create a new user

Parameters

connection (Thinkific.Connection): Connection to server
body (CreateUserRequest): Create user request body
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

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

Specs

delete_user_by_id(Tesla.Env.client(), float(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

deleteUserByID Deletes a User identified by the provided id

Parameters

connection (Thinkific.Connection): Connection to server
id (float()): Id of the user in the form of an integer
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

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

Specs

get_user_by_id(Tesla.Env.client(), float(), keyword()) ::
  {:ok, Thinkific.Model.UserResponse.t()} | {:error, Tesla.Env.t()}

getUserByID Retrieves a User identified by the provided id

Parameters

connection (Thinkific.Connection): Connection to server
id (float()): Id of the user in the form of an integer
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

get_users(connection, opts \\ [])

Specs

get_users(Tesla.Env.client(), keyword()) ::
  {:ok, Thinkific.Model.GetUsersResponse.t()} | {:error, Tesla.Env.t()}

getUsers Retrieve a list of users

Parameters

connection (Thinkific.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :page (float()): The page within the collection to fetch
- :limit (float()): The number of items to be returned
- :query[email] (String.t): Search Users by email.
- :query[role] (String.t): Search Users by role.
- :query[external_source] (String.t): Search Users by external source.
- :query[custom_profile_field_label] (String.t): Search by custom profile field label (must be combined with custom_profile_field_value)
- :query[custom_profile_field_value] (String.t): Search by custom profile field value (must be combined with custom_profile_field_label)
- :query[group_id] (float()): Search by group id.

Returns

} on success {:error, info} on failure

update_user_by_id(connection, id, body, opts \\ [])

Specs

update_user_by_id(
  Tesla.Env.client(),
  float(),
  Thinkific.Model.UpdateUserRequest.t(),
  keyword()
) :: {:ok, Thinkific.Model.UpdateUserRequest.t()} | {:error, Tesla.Env.t()}

updateUserByID Updates the user specified by the provided id

Parameters

connection (Thinkific.Connection): Connection to server
id (float()): Id of the user in the form of an integer
body (UpdateUserRequest):
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure