Added descriptions for Helper Modules

Author: Sébastien Duverne

README.md

@@ -159,84 +159,84 @@ GetUserTokenAsync(enterpriseAccount, username, password, deviceId, deviceName, a
 Creates and returns an API Token for a specific user within a SendSecure enterprise account.
 Calling this method again with the exact same params will always return the same Token.
 
-Param             | Type              | Definition
-------------------|-------------------|-----------
-enterpriseAccount | String            | The SendSecure enterprise account
-username          | String            | The username of a SendSecure user of the current enterprise account
-password          | String            | The password of this user
-deviceId          | String            | The unique ID of the device used to get the Token 
-deviceName        | String            | The name of the device used to get the Token
-applicationType   | String            | The type/name of the application used to get the Token ("SendSecure C#" will be used by default if empty)
-endpoint          | Uri               | The URL to the SendSecure service ("https://portal.xmedius.com" will be used by default if empty)
-oneTimePassword   | String            | The one-time password of this user (if any)
-cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
+Param             | Definition
+------------------|-----------
+enterpriseAccount | The SendSecure enterprise account
+username          | The username of a SendSecure user of the current enterprise account
+password          | The password of this user
+deviceId          | The unique ID of the device used to get the Token 
+deviceName        | The name of the device used to get the Token
+applicationType   | The type/name of the application used to get the Token ("SendSecure C#" will be used by default if empty)
+endpoint          | The URL to the SendSecure service ("https://portal.xmedius.com" will be used by default if empty)
+oneTimePassword   | The one-time password of this user (if any)
+cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
 
 ### Client Object Constructor
 ```
 Client(apiToken, enterpriseAccount, endpoint, locale)
 ```
 
-Param             | Type   | Definition
-------------------|--------|-----------
-apiToken          | String | The API Token to be used for authentication with the SendSecure service
-enterpriseAccount | String | The SendSecure enterprise account
-endpoint          | Uri    | The URL to the SendSecure service ("https://portal.xmedius.com" will be used by default if empty)
-locale            | String | The locale in which the server errors will be returned ("en" will be used by default if empty)
+Param             | Definition
+------------------|-----------
+apiToken          | The API Token to be used for authentication with the SendSecure service
+enterpriseAccount | The SendSecure enterprise account
+endpoint          | The URL to the SendSecure service ("https://portal.xmedius.com" will be used by default if empty)
+locale            | The locale in which the server errors will be returned ("en" will be used by default if empty)
 
 ### Get Enterprise Settings
 ```
 EnterpriseSettingsAsync(cancellationToken)
 ```
 Returns all values/properties of the enterprise account's settings specific to SendSecure.
 
-Param             | Type              | Definition
-------------------|-------------------|-----------
-cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
+Param             | Definition
+------------------|-----------
+cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
 
 ### Get Default Security Profile
 ```
 DefaultSecurityProfileAsync(userEmail, cancellationToken)
 ```
 Returns the default security profile (if it has been set) for a specific user, with all its setting values/properties.
 
-Param             | Type              | Definition
-------------------|-------------------|-----------
-userEmail         | String            | The email address of a SendSecure user of the current enterprise account
-cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
+Param             | Definition
+------------------|-----------
+userEmail         | The email address of a SendSecure user of the current enterprise account
+cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
 
 ### Get Security Profiles
 ```
 SecurityProfilesAsync(userEmail, cancellationToken)
 ```
 Returns the list of all security profiles available to a specific user, with all their setting values/properties.
 
-Param             | Type              | Definition
-------------------|-------------------|-----------
-userEmail         | String            | The email address of a SendSecure user of the current enterprise account
-cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
+Param             | Definition
+------------------|-----------
+userEmail         | The email address of a SendSecure user of the current enterprise account
+cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
 
 ### Initialize SafeBox
 ```
 InitializeSafeboxAsync(safebox, cancellationToken)
 ```
-Pre-creates a SafeBox on the SendSecure system and returns the updated Safebox object with the necessary system parameters filled out (GUID, public encryption key, upload URL).
+Pre-creates a SafeBox on the SendSecure system and returns the updated [Safebox](#safebox) object with the necessary system parameters filled out (GUID, public encryption key, upload URL).
 
-Param             | Type              | Definition
-------------------|-------------------|-----------
-safebox           | String            | A Safebox object to be initialized by the SendSecure system
-cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
+Param             | Definition
+------------------|-----------
+safebox           | A [Safebox](#safebox) object to be initialized by the SendSecure system
+cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
 
 ### Upload Attachment
 ```
 UploadAttachmentAsync(safebox, attachment, cancellationToken)
 ```
-Uploads the specified file as an Attachment of the specified SafeBox and returns the updated Attachment object with the GUID parameter filled out.
+Uploads the specified file as an Attachment of the specified SafeBox and returns the updated [Attachment](#attachment) object with the GUID parameter filled out.
 
-Param             | Type              | Definition
-------------------|-------------------|-----------
-safebox           | Safebox           | An initialized Safebox object
-attachment        | Attachment        | An Attachment object - the file to upload to the SendSecure system
-cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
+Param             | Definition
+------------------|-----------
+safebox           | An initialized [Safebox](#safebox) object 
+attachment        | An [Attachment](#attachment) object - the file to upload to the SendSecure system
+cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
 
 ### Commit SafeBox
 ```
@@ -245,41 +245,126 @@ CommitSafeboxAsync(safebox, cancellationToken)
 Finalizes the creation (commit) of the SafeBox on the SendSecure system.
 This actually "Sends" the SafeBox with all content and contact info previously specified.
 
-Param             | Type              | Definition
-------------------|-------------------|-----------
-safebox           | Safebox           | A Safebox object already initialized, with security profile, recipient(s), subject and message already defined, and attachments already uploaded. 
-cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
+Param             | Definition
+------------------|-----------
+safebox           | A [Safebox](#safebox) object already initialized, with security profile, recipient(s), subject and message already defined, and attachments already uploaded. 
+cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
 
 ### Submit SafeBox
 ```
 SubmitSafeboxAsync(safebox, cancellationToken)
 ```
 This method is a high-level combo that initializes the SafeBox, uploads all attachments and commits the SafeBox.
 
-Param             | Type              | Definition
-------------------|-------------------|-----------
-safebox           | Safebox           | A non-initialized Safebox object with security profile, recipient(s), subject, message and attachments (not yet uploaded) already defined. 
-cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
+Param             | Definition
+------------------|-----------
+safebox           | A non-initialized [Safebox](#safebox) object with security profile, recipient(s), subject, message and attachments (not yet uploaded) already defined. 
+cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation
 
 
 ## Helper Modules
 
+<a name="safebox"></a>
 ### Safebox
 
+Builds an object to send all the necessary information to create a new Safebox.
+
+Attribute            | Definition
+---------------------|-----------
+Guid                 | The unique identifier of the SafeBox (filled by the system once the SafeBox is initialized).
+UploadUrl            | The URL used to upload the SafeBox attachments (filled by the system once the SafeBox is initialized).
+PublicEncryptionKey  | The key used to encrypt the SafeBox attachments and/or messages (filled by the system once the SafeBox is initialized).
+UserEmail            | The email address of the creator of the SafeBox (mandatory).
+Subject              | The subject of the SafeBox (optional).
+Message              | The initial message of the SafeBox (optional if the SafeBox has at least one attachment).
+Recipients           | The list of all [Recipient](#recipient) objects of the SafeBox (mandatory, at least one recipient).
+Attachments          | The list of all [Attachment](#attachment) objects of the SafeBox (optional if the SafeBox has a message).
+SecurityProfile      | The SecurityProfile object defining security options for the SafeBox (mandatory).
+<!-- NotificationLanguage | The language used for email notifications sent to the recipients (optional, English by default).
+MISSING -->
+
 ### SafeboxResponse
 
-### Attachment
+Represents the response to the successful creation of a SafeBox in the SendSecure system.
+All attributes are filled by the system once the SafeBox is successfully created (sent).
+
+Attribute            | Definition
+---------------------|-----------
+Guid                 | The unique identifier of the SafeBox.
+PreviewUrl           | The URL to access the SafeBox in the SendSecure Web Portal.
+EncryptionKey        | The key that may be required to decrypt the SafeBox content (only if Double Encryption is enabled in the Security Profile).
 
+<a name="recipient"></a>
 ### Recipient
 
+Builds an object to create a recipient for the SafeBox.
+
+Attribute            | Definition
+---------------------|-----------
+Email                | The email address of the recipient (mandatory).
+FirstName            | The first name of the recipient (optional).
+LastName             | The last name of the recipient (optional).
+CompanyName          | The company name of the recipient (optional).
+ContactMethods       | The list of all [ContactMethod](#contactmethod) objects of the recipient (may be mandatory depending on the Security Profile of the SafeBox).
+
+<a name="contactmethod"></a>
 ### ContactMethod
 
+Builds an object to create a phone number destination owned by the recipient (as part of the Recipient object attributes).
+Any ContactMethod – plus the recipient's email address – will be usable as Security Code delivery means to the recipient.
+All attributes are mandatory.
+
+Attribute            | Definition
+---------------------|-----------
+Destination          | A phone number owned by the recipient.
+DestinationType      | The phone number's type (i.e. home/cell/office/other).
+
+
+<a name="attachment"></a>
+### Attachment
+
+Builds an object to be uploaded to the server as attachment of the SafeBox.
+Can be created either with a [File Path](#file) or a [Stream](#stream).
+All attributes are mandatory.
+
+<a name="filepath"></a>
+#### File Path
+
+Attribute            | Definition
+---------------------|-----------
+Guid                 | The unique identifier of the attachment (filled by the system once the file is uploaded).
+ContentType          | The file Content-type (MIME). 
+FileName             | The path (full filename) of the file to upload.
+
+<a name="stream"></a>
+#### Stream
+
+Attribute            | Definition
+---------------------|-----------
+Guid                 | The unique identifier of the attachment (filled by the system once the file is uploaded).
+ContentType          | The file Content-type (MIME). 
+Stream               | The data to upload.
+Filename             | The file name.
+Size                 | The file size.
+
 ### SecurityProfile
 
+Represents the settings of a Security Profile.
+The use of specific attributes of this object rather takes place in advanced scenarios.
+To know all available attributes, please look in the library.
+
 ### EnterpriseSettings
 
+Represents the SendSecure settings of an Enterprise Account.
+The use of specific attributes of this object rather takes place in advanced scenarios.
+To know all available attributes, please look in the library.
+
 ### ExtensionFilter
 
+Represents the list of allowed/forbidden extensions for SafeBox attachments (part of the EnterpriseSettings).
+The use of specific attributes of this object rather takes place in advanced scenarios.
+To know all available attributes, please look in the library.
+
 <a name="license"></a>
 # License