Class: Mirah::Data::Invitation

Inherits:
BaseObject show all
Defined in:
lib/mirah/data/invitation.rb

Overview

Invitations represent the Mirah system's intent for a given person to take an assessment during a given time period as part of a given measurement. It tracks when the user can take it and the notifications associated with such an invitation.

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseObject

from_graphql_hash, #initialize, #to_graphql_hash

Constructor Details

This class inherits a constructor from Mirah::BaseObject

Instance Attribute Details

#idstring (readonly)

Returns The internal Mirah identifier.

Returns:

  • (string)

    The internal Mirah identifier


11
# File 'lib/mirah/data/invitation.rb', line 11

attribute :id

#last_notification_dateDate (readonly)

Returns The date the latest notification was sent at.

Returns:

  • (Date)

    The date the latest notification was sent at


27
# File 'lib/mirah/data/invitation.rb', line 27

attribute :last_notification_date, serializer: Serializers::DateTimeSerializer.new

#notification_status"SENT", ... (readonly)

Returns The status of the invitation.

Returns:

  • ("SENT", "SCHEDULED", "FORBIDDEN", "MISSING_DETAILS", "NOT_NEEDED")

    The status of the invitation.


23
# File 'lib/mirah/data/invitation.rb', line 23

attribute :notification_status

#phase"BEFORE", ... (readonly)

Returns The phase this invitation should be taken as part of.

Returns:

  • ("BEFORE", "DURING", "AFTER")

    The phase this invitation should be taken as part of.


15
# File 'lib/mirah/data/invitation.rb', line 15

attribute :phase

#status"FUTURE", ... (readonly)

Returns The status of the invitation.

Returns:

  • ("FUTURE", "NEW", "SCHEDULED", "SENT", "BEGUN", "COMPLETE", "LOCKED_OUT")

    The status of the invitation.


19
# File 'lib/mirah/data/invitation.rb', line 19

attribute :status