class IHookUser(Interface):
'A token'
token = AuthToken(title='Token',
description='The authentication token',
required=True)
groupId = ASCIILine(title='GroupIdentifier',
description='The group to add the person to',
required=True)
email = ASCIILine(title='Email address',
description='The email address of the new member',
required=True)
fn = TextLine(title='Name',
description='The name of the new member',
required=True)
biography = Text(
title='Biography',
description='The HTML-formatted biography of the new member',
required=False)
tz = ASCIILine(title='Timezone',
description='The timezone',
required=False)
class IGSGroupExists(Interface):
# TODO: Create a base email-address type
email = ASCIILine(title='Email Address',
description='The email address to check',
required=True)
token = AuthToken(title='Token',
description='The authentication token',
required=True)
class ISendNotification(Interface):
'''Declares the form that will be used to send the notification.'''
profileId = ASCIILine(
title='Profile identifier',
description='The identifier for the recipient of the notification',
required=True)
token = AuthToken(title='Token',
description='The authentication token',
required=True)
class IUserExists(Interface):
'Determine if a user exists'
user = ASCIILine(
title='Either the user identifier or email address',
description='The identifier for the person that is being searched',
required=True)
token = AuthToken(title='Token',
description='The authentication token',
required=True)
class IGSAddEmail(Interface):
emailMessage = Text(title='Email Message',
description='The email message to add',
required=True)
groupId = ASCIILine(title='Group Identifier',
description='The identifier of the group to add the '
'message to.',
required=True)
token = AuthToken(title='Token',
description='The authentication token',
required=True)
class IGSBounceHandler(Interface):
# TODO: Create a base email-address type
userEmail = ASCIILine(
title='User Email Address',
description='The email address of the user that is bouncing',
required=True)
groupEmail = ASCIILine(
title='Group Email Address',
description='The email of the of the group that received the '
'bounce notification.',
required=True)
token = AuthToken(title='Token',
description='The authentication token',
required=True)
class ISendDigest(Interface):
'''Declares the form that will be used to send digest to a group on the
site.'''
siteId = ASCIILine(
title='Site Identifier',
required=True)
groupId = ASCIILine(
title='Group Identifier',
required=True)
token = AuthToken(
title='Token',
description='The authentication token',
required=True)
class IGetDigestGroups(Interface):
'Get the digest groups'
token = AuthToken(
title='Token',
description='The authentication token',
required=True)
class IGetPeople(Interface):
'Get the people'
token = AuthToken(title='Token',
description='The authentication token',
required=True)