Thinkific.Api.GroupAnalysts (Thinkific API SDK v0.1.3)
API calls for all endpoints tagged GroupAnalysts
.
Link to this section Summary
Functions
addGroupToAnalyst Assign Group Analyst to groups. User need to be assigned the Group Analyst (group_analyst) role.
removeGroupFromAnalyst Remove an analyst from a group
Link to this section Functions
Link to this function
add_group_to_analyst(connection, user_id, opts \\ [])
Specs
add_group_to_analyst(Tesla.Env.client(), float(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
addGroupToAnalyst Assign Group Analyst to groups. User need to be assigned the Group Analyst (group_analyst) role.
Parameters
- connection (Thinkific.Connection): Connection to server
- user_id (float()): ID of the User in the form of an integer.
- opts (KeywordList): [optional] Optional parameters
- :body (GroupAnalystsAddGroupRequest): Group Analyst
Returns
} on success {:error, info} on failure
Link to this function
remove_group_from_analyst(connection, user_id, group_id, opts \\ [])
Specs
remove_group_from_analyst(Tesla.Env.client(), float(), float(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
removeGroupFromAnalyst Remove an analyst from a group
Parameters
- connection (Thinkific.Connection): Connection to server
- user_id (float()): ID of the User in the form of an integer.
- group_id (float()): ID of the Group in the form of an integer.
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure