Package ai.vectros.types

Class CreateInviteRequest.Builder

java.lang.Object

ai.vectros.types.CreateInviteRequest.Builder

All Implemented Interfaces:

CreateInviteRequest._FinalStage, CreateInviteRequest.AccessProfileStage, CreateInviteRequest.ContextIdStage, CreateInviteRequest.EmailStage

Enclosing class:

CreateInviteRequest

public static final class CreateInviteRequest.Builder
extends Object
implements CreateInviteRequest.EmailStage, CreateInviteRequest.ContextIdStage, CreateInviteRequest.AccessProfileStage, CreateInviteRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
CreateInviteRequest._FinalStage	acceptUrl(String acceptUrl)	Your landing page where the invitee accepts the invitation.
CreateInviteRequest._FinalStage	acceptUrl(Optional<String> acceptUrl)	Your landing page where the invitee accepts the invitation.
CreateInviteRequest._FinalStage	accessProfile(@NotNull AccessProfileSpec accessProfile)
CreateInviteRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
CreateInviteRequest.Builder	additionalProperty(String key, Object value)
CreateInviteRequest	build()
CreateInviteRequest.AccessProfileStage	contextId(@NotNull String contextId)	The app context the new member will operate in.
CreateInviteRequest.ContextIdStage	email(@NotNull String email)	Email address to invite.
CreateInviteRequest._FinalStage	firstName(String firstName)	Invitee's first name.
CreateInviteRequest._FinalStage	firstName(Optional<String> firstName)	Invitee's first name.
CreateInviteRequest.Builder	from(CreateInviteRequest other)
CreateInviteRequest._FinalStage	fromName(String fromName)	Display name shown in the From header of the invitation email.
CreateInviteRequest._FinalStage	fromName(Optional<String> fromName)	Display name shown in the From header of the invitation email.
CreateInviteRequest._FinalStage	lastName(String lastName)	Invitee's last name.
CreateInviteRequest._FinalStage	lastName(Optional<String> lastName)	Invitee's last name.
CreateInviteRequest._FinalStage	sendEmail(Boolean sendEmail)	Whether Vectros should deliver the invitation email for you.
CreateInviteRequest._FinalStage	sendEmail(Optional<Boolean> sendEmail)	Whether Vectros should deliver the invitation email for you.
CreateInviteRequest._FinalStage	ttlSeconds(Long ttlSeconds)	How long the invitation token stays valid, in seconds.
CreateInviteRequest._FinalStage	ttlSeconds(Optional<Long> ttlSeconds)	How long the invitation token stays valid, in seconds.

Methods inherited from class java.lang.Object

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

Method Details

from

public CreateInviteRequest.Builder from(CreateInviteRequest other)

Specified by:

from in interface CreateInviteRequest.EmailStage

email

public CreateInviteRequest.ContextIdStage email(@NotNull
 @NotNull String email)

Email address to invite. Must be a valid email address. If it already belongs to an active or suspended member of this app context the request is rejected; if it already has a pending invitation in this app context, that invitation is resent with a fresh token instead of a new one being created.

Email address to invite. Must be a valid email address. If it already belongs to an active or suspended member of this app context the request is rejected; if it already has a pending invitation in this app context, that invitation is resent with a fresh token instead of a new one being created.

Specified by:

email in interface CreateInviteRequest.EmailStage

Returns:

Reference to this so that method calls can be chained together.

contextId

public CreateInviteRequest.AccessProfileStage contextId(@NotNull
 @NotNull String contextId)

The app context the new member will operate in. Must reference an existing app context in your account. The invitee's access profile is bound to this context.

The app context the new member will operate in. Must reference an existing app context in your account. The invitee's access profile is bound to this context.

Specified by:

contextId in interface CreateInviteRequest.ContextIdStage

Returns:

Reference to this so that method calls can be chained together.

accessProfile

public CreateInviteRequest._FinalStage accessProfile(@NotNull
 @NotNull AccessProfileSpec accessProfile)

Specified by:

accessProfile in interface CreateInviteRequest.AccessProfileStage

sendEmail

public CreateInviteRequest._FinalStage sendEmail(Boolean sendEmail)

Whether Vectros should deliver the invitation email for you. When true (the default), the email is sent on your behalf. When false, no email is sent and the response instead returns the raw token and a ready-to-use accept link so you can deliver the invitation through your own email provider.

Specified by:

sendEmail in interface CreateInviteRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

sendEmail

public CreateInviteRequest._FinalStage sendEmail(Optional<Boolean> sendEmail)

Whether Vectros should deliver the invitation email for you. When true (the default), the email is sent on your behalf. When false, no email is sent and the response instead returns the raw token and a ready-to-use accept link so you can deliver the invitation through your own email provider.

Specified by:

sendEmail in interface CreateInviteRequest._FinalStage

ttlSeconds

public CreateInviteRequest._FinalStage ttlSeconds(Long ttlSeconds)

How long the invitation token stays valid, in seconds. Defaults to 604800 (7 days). Must be between 3600 (1 hour) and 2592000 (30 days).

Specified by:

ttlSeconds in interface CreateInviteRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

ttlSeconds

public CreateInviteRequest._FinalStage ttlSeconds(Optional<Long> ttlSeconds)

How long the invitation token stays valid, in seconds. Defaults to 604800 (7 days). Must be between 3600 (1 hour) and 2592000 (30 days).

Specified by:

ttlSeconds in interface CreateInviteRequest._FinalStage

fromName

public CreateInviteRequest._FinalStage fromName(String fromName)

Display name shown in the From header of the invitation email. Defaults to Vectros. Maximum 100 characters; must not contain newlines.

Specified by:

fromName in interface CreateInviteRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

fromName

public CreateInviteRequest._FinalStage fromName(Optional<String> fromName)

Display name shown in the From header of the invitation email. Defaults to Vectros. Maximum 100 characters; must not contain newlines.

Specified by:

fromName in interface CreateInviteRequest._FinalStage

acceptUrl

public CreateInviteRequest._FinalStage acceptUrl(String acceptUrl)

Your landing page where the invitee accepts the invitation. Required when sendEmail is true. The invitation token is appended as a t query parameter. Must be an https URL with a domain-name host (IP-literal hosts are rejected).

Specified by:

acceptUrl in interface CreateInviteRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

acceptUrl

public CreateInviteRequest._FinalStage acceptUrl(Optional<String> acceptUrl)

Your landing page where the invitee accepts the invitation. Required when sendEmail is true. The invitation token is appended as a t query parameter. Must be an https URL with a domain-name host (IP-literal hosts are rejected).

Specified by:

acceptUrl in interface CreateInviteRequest._FinalStage

lastName

public CreateInviteRequest._FinalStage lastName(String lastName)

Invitee's last name. Optional; accepted but not currently stored or returned.

Specified by:

lastName in interface CreateInviteRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

lastName

public CreateInviteRequest._FinalStage lastName(Optional<String> lastName)

Invitee's last name. Optional; accepted but not currently stored or returned.

Specified by:

lastName in interface CreateInviteRequest._FinalStage

firstName

public CreateInviteRequest._FinalStage firstName(String firstName)

Invitee's first name. Optional; used to personalize the invitation email greeting.

Specified by:

firstName in interface CreateInviteRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

firstName

public CreateInviteRequest._FinalStage firstName(Optional<String> firstName)

Invitee's first name. Optional; used to personalize the invitation email greeting.

Specified by:

firstName in interface CreateInviteRequest._FinalStage

build

public CreateInviteRequest build()

Specified by:

build in interface CreateInviteRequest._FinalStage

additionalProperty

public CreateInviteRequest.Builder additionalProperty(String key,
 Object value)

Specified by:

additionalProperty in interface CreateInviteRequest._FinalStage

additionalProperties

public CreateInviteRequest.Builder additionalProperties(Map<String,Object> additionalProperties)

Specified by:

additionalProperties in interface CreateInviteRequest._FinalStage