Package ai.vectros.types

Interface CreateInviteRequest._FinalStage

All Known Implementing Classes:

CreateInviteRequest.Builder

Enclosing class:

CreateInviteRequest

public static interface CreateInviteRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
CreateInviteRequest._FinalStage	acceptUrl(String acceptUrl)
CreateInviteRequest._FinalStage	acceptUrl(Optional<String> acceptUrl)	Your landing page where the invitee accepts the invitation.
CreateInviteRequest._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
CreateInviteRequest._FinalStage	additionalProperty(String key, Object value)
CreateInviteRequest	build()
CreateInviteRequest._FinalStage	firstName(String firstName)
CreateInviteRequest._FinalStage	firstName(Optional<String> firstName)	Invitee's first name.
CreateInviteRequest._FinalStage	fromName(String fromName)
CreateInviteRequest._FinalStage	fromName(Optional<String> fromName)	Display name shown in the From header of the invitation email.
CreateInviteRequest._FinalStage	lastName(String lastName)
CreateInviteRequest._FinalStage	lastName(Optional<String> lastName)	Invitee's last name.
CreateInviteRequest._FinalStage	sendEmail(Boolean sendEmail)
CreateInviteRequest._FinalStage	sendEmail(Optional<Boolean> sendEmail)	Whether Vectros should deliver the invitation email for you.
CreateInviteRequest._FinalStage	ttlSeconds(Long ttlSeconds)
CreateInviteRequest._FinalStage	ttlSeconds(Optional<Long> ttlSeconds)	How long the invitation token stays valid, in seconds.

Method Details

build

CreateInviteRequest build()

additionalProperty

CreateInviteRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

CreateInviteRequest._FinalStage additionalProperties(Map<String,Object> additionalProperties)

firstName

CreateInviteRequest._FinalStage firstName(Optional<String> firstName)

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

firstName

CreateInviteRequest._FinalStage firstName(String firstName)

lastName

CreateInviteRequest._FinalStage lastName(Optional<String> lastName)

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

lastName

CreateInviteRequest._FinalStage lastName(String lastName)

acceptUrl

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).

acceptUrl

CreateInviteRequest._FinalStage acceptUrl(String acceptUrl)

fromName

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.

fromName

CreateInviteRequest._FinalStage fromName(String fromName)

ttlSeconds

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).

ttlSeconds

CreateInviteRequest._FinalStage ttlSeconds(Long ttlSeconds)

sendEmail

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.

sendEmail

CreateInviteRequest._FinalStage sendEmail(Boolean sendEmail)