Package com.onshape.api.requests

Class CompaniesAddUserRequest.Builder

java.lang.Object

com.onshape.api.requests.CompaniesAddUserRequest.Builder

Enclosing class:

CompaniesAddUserRequest

public static final class CompaniesAddUserRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Boolean	admin()	Get If the new user is an admin.
CompaniesAddUserRequest.Builder	admin(Boolean value)	Set If the new user is an admin.
CompaniesAddUserResponse	call(String cid)	Calls addUser method, Adds user to company.
String	companyId()	Get The company ID - should match the path.
CompaniesAddUserRequest.Builder	companyId(String value)	Set The company ID - should match the path.
String	email()	Get The email.
CompaniesAddUserRequest.Builder	email(String value)	Set The email.
Number[]	globalPermissions()	Get List of global permissions for the new user.
CompaniesAddUserRequest.Builder	globalPermissions(Number[] value)	Set List of global permissions for the new user.
Boolean	guest()	Get If the new user is a guest.
CompaniesAddUserRequest.Builder	guest(Boolean value)	Set If the new user is a guest.
Boolean	light()	Get If the new user is a light user.
CompaniesAddUserRequest.Builder	light(Boolean value)	Set If the new user is a light user.
Boolean	sendEmail()	Get If the new user should get an email.
CompaniesAddUserRequest.Builder	sendEmail(Boolean value)	Set If the new user should get an email.

Methods inherited from class java.lang.Object

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

Method Detail

companyId

public final String companyId()

Get The company ID - should match the path.

Returns:

The company ID - should match the path.

companyId

public final CompaniesAddUserRequest.Builder companyId(String value)

Set The company ID - should match the path.

Parameters:

value - The company ID - should match the path.

Returns:

the Builder object.

email

public final String email()

Get The email.

Returns:

The email.

email

public final CompaniesAddUserRequest.Builder email(String value)

Set The email.

Parameters:

value - The email.

Returns:

the Builder object.

admin

public final Boolean admin()

Get If the new user is an admin.

Returns:

If the new user is an admin.

admin

public final CompaniesAddUserRequest.Builder admin(Boolean value)

Set If the new user is an admin.

Parameters:

value - If the new user is an admin.

Returns:

the Builder object.

guest

public final Boolean guest()

Get If the new user is a guest.

Returns:

If the new user is a guest.

guest

public final CompaniesAddUserRequest.Builder guest(Boolean value)

Set If the new user is a guest.

Parameters:

value - If the new user is a guest.

Returns:

the Builder object.

light

public final Boolean light()

Get If the new user is a light user.

Returns:

If the new user is a light user.

light

public final CompaniesAddUserRequest.Builder light(Boolean value)

Set If the new user is a light user.

Parameters:

value - If the new user is a light user.

Returns:

the Builder object.

sendEmail

public final Boolean sendEmail()

Get If the new user should get an email.

Returns:

If the new user should get an email.

sendEmail

public final CompaniesAddUserRequest.Builder sendEmail(Boolean value)

Set If the new user should get an email.

Parameters:

value - If the new user should get an email.

Returns:

the Builder object.

globalPermissions

public final Number[] globalPermissions()

Get List of global permissions for the new user. OWNER=100, DELETE=90, RESHARE=80, WRITE=70, READ=60, LINK=50, COPY=30, EXPORT=20, COMMENT=10, ANONYMOUS_ACCESS=5.

Returns:

List of global permissions for the new user. OWNER=100, DELETE=90, RESHARE=80, WRITE=70, READ=60, LINK=50, COPY=30, EXPORT=20, COMMENT=10, ANONYMOUS_ACCESS=5.

globalPermissions

public final CompaniesAddUserRequest.Builder globalPermissions(Number[] value)

Set List of global permissions for the new user. OWNER=100, DELETE=90, RESHARE=80, WRITE=70, READ=60, LINK=50, COPY=30, EXPORT=20, COMMENT=10, ANONYMOUS_ACCESS=5.

Parameters:

value - List of global permissions for the new user. OWNER=100, DELETE=90, RESHARE=80, WRITE=70, READ=60, LINK=50, COPY=30, EXPORT=20, COMMENT=10, ANONYMOUS_ACCESS=5.

Returns:

the Builder object.

call

public final CompaniesAddUserResponse call(String cid)
                                    throws OnshapeException

Calls addUser method, Adds user to company. Must have Company Admin level privileges to call.

Parameters:

cid - Company id

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error