Struct Invitation

pub struct Invitation {
    pub created_at: Option<DateTime<Utc>>,
    pub email: Option<String>,
    pub id: Option<String>,
    pub object: Option<String>,
    pub organization_id: Option<String>,
    pub role: Option<InvitationRole>,
}

An invitation is a request to join an organization. An invitation is sent to an email address, and the recipient can accept or decline the invitation.

JSON schema

{
 "description": "An invitation is a request to join an organization. An invitation is sent to an email address, and the recipient can accept or decline the invitation.",
 "type": "object",
 "properties": {
   "created_at": {
     "description": "Time at which the project was created",
     "readOnly": true,
     "examples": [
       "2022-03-01T00:00:00Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "email": {
     "description": "Email of the user",
     "type": "string"
   },
   "id": {
     "description": "Unique identifier for the invitation",
     "readOnly": true,
     "type": "string"
   },
   "object": {
     "description": "String representing the object's type. Objects of the same type share the same value",
     "readOnly": true,
     "examples": [
       "project"
     ],
     "type": "string"
   },
   "organization_id": {
     "description": "Unique identifier for the organization the project belongs to",
     "examples": [
       "d290f1ee-6c54-4b01-90e6-d701748f0851"
     ],
     "type": "string"
   },
   "role": {
     "description": "The future role of the user in the organization.",
     "type": "string",
     "enum": [
       "admin",
       "member"
     ]
   }
 }
}

Fields

created_at: Option<DateTime<Utc>>

Time at which the project was created

email: Option<String>

Email of the user

id: Option<String>

Unique identifier for the invitation

object: Option<String>

String representing the object’s type. Objects of the same type share the same value

organization_id: Option<String>

Unique identifier for the organization the project belongs to

role: Option<InvitationRole>

The future role of the user in the organization.

Implementations

impl Invitation

pub fn builder() -> Invitation

Trait Implementations

impl Clone for Invitation

fn clone(&self) -> Invitation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Invitation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Invitation

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Invitation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Invitation> for Invitation

fn from(value: &Invitation) -> Self

Converts to this type from the input type.

impl From<Invitation> for Invitation

fn from(value: Invitation) -> Self

Converts to this type from the input type.

impl JsonSchema for Invitation

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for Invitation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Invitation> for Invitation

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Invitation) -> Result<Self, ConversionError>

Performs the conversion.