Package software.xdev.sched.api

Class UserApi

java.lang.Object

software.xdev.sched.api.UserApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class UserApi
extends Object

Constructor Summary

Constructors

Constructor	Description
UserApi()
UserApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
UserAdded	addUser(String username, String email, String password, String phone, String privacy, String role, String sessions, String fullName, String about, URI avatar, String location, String company, String position, String booth, String sendEmail, String tags, String legacyApi)
UserAdded	addUser(String username, String email, String password, String phone, String privacy, String role, String sessions, String fullName, String about, URI avatar, String location, String company, String position, String booth, String sendEmail, String tags, String legacyApi, Map<String,String> additionalHeaders)
ApiClient	getApiClient()
List<User>	listUsers(String format, String fields)
List<User>	listUsers(String format, String fields, Map<String,String> additionalHeaders)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserApi

public UserApi()

UserApi

public UserApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addUser

public UserAdded addUser(String username,
 String email,
 String password,
 String phone,
 String privacy,
 String role,
 String sessions,
 String fullName,
 String about,
 URI avatar,
 String location,
 String company,
 String position,
 String booth,
 String sendEmail,
 String tags,
 String legacyApi)
                  throws ApiException

Parameters:

username - Required when email is not set; Allowed: alphanumerics, period, underscore (optional)

email - Required when username is not set (optional)

password - User's desired password. Optional. Random password will be generated if none provided. (optional)

phone - (optional)

privacy - Default is 1 (on), Set to 0 (off) (optional)

role - Currently one of the following: attendee, speaker, artist, sponsor, exhibitor (optional)

sessions - Comma separated string of session id's which the user will be connected to (optional)

fullName - (optional)

about - Short bio/description. Some HTML allowed (a,b,br,i,em,strong) (optional)

avatar - Publicly accessible, not shortened URL to gif, jpg or png image. Images are copied and resized on our server (optional)

location - (optional)

company - (optional)

position - (optional)

booth - Exhibitor booth (applies only to users with the role set to \"exhibitor\") (optional)

sendEmail - Default is 1 (on), Set to 0 (off). Whether to send e-mail with login credentials to user (optional)

tags - A comma separated list of tags to add to the user (optional)

legacyApi - Undocumented. Needed to link existing accounts with this email (optional)

Returns:

UserAdded

Throws:

ApiException - if fails to make API call

addUser

public UserAdded addUser(String username,
 String email,
 String password,
 String phone,
 String privacy,
 String role,
 String sessions,
 String fullName,
 String about,
 URI avatar,
 String location,
 String company,
 String position,
 String booth,
 String sendEmail,
 String tags,
 String legacyApi,
 Map<String,String> additionalHeaders)
                  throws ApiException

Parameters:

username - Required when email is not set; Allowed: alphanumerics, period, underscore (optional)

email - Required when username is not set (optional)

password - User's desired password. Optional. Random password will be generated if none provided. (optional)

phone - (optional)

privacy - Default is 1 (on), Set to 0 (off) (optional)

role - Currently one of the following: attendee, speaker, artist, sponsor, exhibitor (optional)

sessions - Comma separated string of session id's which the user will be connected to (optional)

fullName - (optional)

about - Short bio/description. Some HTML allowed (a,b,br,i,em,strong) (optional)

avatar - Publicly accessible, not shortened URL to gif, jpg or png image. Images are copied and resized on our server (optional)

location - (optional)

company - (optional)

position - (optional)

booth - Exhibitor booth (applies only to users with the role set to \"exhibitor\") (optional)

sendEmail - Default is 1 (on), Set to 0 (off). Whether to send e-mail with login credentials to user (optional)

tags - A comma separated list of tags to add to the user (optional)

legacyApi - Undocumented. Needed to link existing accounts with this email (optional)

additionalHeaders - additionalHeaders for this call

Returns:

UserAdded

Throws:

ApiException - if fails to make API call

listUsers

public List<User> listUsers(String format,
 String fields)
                     throws ApiException

Parameters:

format - (optional, default to json)

fields - Comma separated list of fields. Default: \"username\", \"name\", \"phone\", \"email\", \"joined\", \"lastactive\", \"avatar\", \"company\", \"position\", \"location\". Available fields: \"id\", \"username\", \"name\", \"phone\", \"email\", \"url\", \"about\", \"role\", \"joined\", \"lastactive\", \"avatar\", \"company\", \"position\", \"location\"; (optional)

Returns:

List<User>

Throws:

ApiException - if fails to make API call

listUsers

public List<User> listUsers(String format,
 String fields,
 Map<String,String> additionalHeaders)
                     throws ApiException

Parameters:

format - (optional, default to json)

fields - Comma separated list of fields. Default: \"username\", \"name\", \"phone\", \"email\", \"joined\", \"lastactive\", \"avatar\", \"company\", \"position\", \"location\". Available fields: \"id\", \"username\", \"name\", \"phone\", \"email\", \"url\", \"about\", \"role\", \"joined\", \"lastactive\", \"avatar\", \"company\", \"position\", \"location\"; (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<User>

Throws:

ApiException - if fails to make API call