Package ai.vectros.types

Class CreateInviteRequest

java.lang.Object
ai.vectros.types.CreateInviteRequest
public final class CreateInviteRequest extends Object

  • Method Details

    • getEmail

      public String getEmail()
      Returns:
      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.

    • getContextId

      public String getContextId()
      Returns:
      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.

    • getAccessProfile

      public AccessProfileSpec getAccessProfile()

    • getFirstName

      public Optional<String> getFirstName()
      Returns:
      Invitee's first name. Optional; used to personalize the invitation email greeting.

    • getLastName

      public Optional<String> getLastName()
      Returns:
      Invitee's last name. Optional; accepted but not currently stored or returned.

    • getAcceptUrl

      public Optional<String> getAcceptUrl()
      Returns:
      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).

    • getFromName

      public Optional<String> getFromName()
      Returns:
      Display name shown in the From header of the invitation email. Defaults to Vectros. Maximum 100 characters; must not contain newlines.

    • getTtlSeconds

      public Optional<Long> getTtlSeconds()
      Returns:
      How long the invitation token stays valid, in seconds. Defaults to 604800 (7 days). Must be between 3600 (1 hour) and 2592000 (30 days).

    • getSendEmail

      public Optional<Boolean> getSendEmail()
      Returns:
      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.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static CreateInviteRequest.EmailStage builder()