Class Invite
-
- All Implemented Interfaces:
public final class InviteRepresents an individual
inviteto the organization.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classInvite.BuilderA builder for Invite.
public final classInvite.Projectpublic final classInvite.Roleownerorreaderpublic final classInvite.Statusaccepted,expired, orpending
-
Method Summary
Modifier and Type Method Description final Stringid()The identifier, which can be referenced in API endpoints final LongcreatedAt()The Unix timestamp (in seconds) of when the invite was sent. final Stringemail()The email address of the individual to whom the invite was sent final JsonValue_object_()The object type, which is always organization.inviteExpected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("organization.invite")final List<Invite.Project>projects()The projects that were granted membership upon acceptance of the invite. final Invite.Rolerole()ownerorreaderfinal Invite.Statusstatus()accepted,expired, orpendingfinal Optional<Long>acceptedAt()The Unix timestamp (in seconds) of when the invite was accepted. final Optional<Long>expiresAt()The Unix timestamp (in seconds) of when the invite expires. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<Long>_createdAt()Returns the raw JSON value of createdAt. final JsonField<String>_email()Returns the raw JSON value of email. final JsonField<List<Invite.Project>>_projects()Returns the raw JSON value of projects. final JsonField<Invite.Role>_role()Returns the raw JSON value of role. final JsonField<Invite.Status>_status()Returns the raw JSON value of status. final JsonField<Long>_acceptedAt()Returns the raw JSON value of acceptedAt. final JsonField<Long>_expiresAt()Returns the raw JSON value of expiresAt. final Map<String, JsonValue>_additionalProperties()final Invite.BuildertoBuilder()final Invitevalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Invite.Builderbuilder()Returns a mutable builder for constructing an instance of Invite. -
-
Method Detail
-
_object_
final JsonValue _object_()
The object type, which is always
organization.inviteExpected to always return the following:
JsonValue.from("organization.invite")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
projects
final List<Invite.Project> projects()
The projects that were granted membership upon acceptance of the invite.
-
role
final Invite.Role role()
ownerorreader
-
status
final Invite.Status status()
accepted,expired, orpending
-
acceptedAt
final Optional<Long> acceptedAt()
The Unix timestamp (in seconds) of when the invite was accepted.
-
expiresAt
final Optional<Long> expiresAt()
The Unix timestamp (in seconds) of when the invite expires.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_email
final JsonField<String> _email()
Returns the raw JSON value of email.
Unlike email, this method doesn't throw if the JSON field has an unexpected type.
-
_projects
final JsonField<List<Invite.Project>> _projects()
Returns the raw JSON value of projects.
Unlike projects, this method doesn't throw if the JSON field has an unexpected type.
-
_role
final JsonField<Invite.Role> _role()
Returns the raw JSON value of role.
Unlike role, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<Invite.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_acceptedAt
final JsonField<Long> _acceptedAt()
Returns the raw JSON value of acceptedAt.
Unlike acceptedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_expiresAt
final JsonField<Long> _expiresAt()
Returns the raw JSON value of expiresAt.
Unlike expiresAt, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Invite.Builder toBuilder()
-
validate
final Invite validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static Invite.Builder builder()
Returns a mutable builder for constructing an instance of Invite.
The following fields are required:
.id() .createdAt() .email() .projects() .role() .status()
-
-
-
-