Trash 
=====

.. _TrashRoot:

TrashRoot
---------

Dataroom's ``trash`` collection

.. code-block:: json

 message TrashRoot {
  string id = 1;
  string dataroom_id = 2;
  string name = 3;
  string type = 4;
  string document_class = 5;
  optional string author = 6;
  string title = 7;
  string path = 8;
  string version = 9;
  google.protobuf.Timestamp creation_date = 10;
  google.protobuf.Timestamp modification_date = 11;
  string icon = 12;
  uint32 num_children = 13; // collections only => subDocs
  EffectivePermission effective_permission = 14;
  string description = 15;
  ItemType item_type = 31;
  optional string parent_id = 32;
 }

+--------------------------+-------------------------------+------------------------------------------------------+
| Field                    | Type                          | Description                                          |
+==========================+===============================+======================================================+
| ``id``                   | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``dataroom_id``          | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``name``                 | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``type``                 | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``document_class``       | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``author``               | ``string``                    | **Optional.**                                        |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``title``                | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``path``                 | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``version``              | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``creation_date``        | ``google.protobuf.Timestamp`` |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``modification_date``    | ``google.protobuf.Timestamp`` |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``icon``                 | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``num_children``         | ``uint32``                    | collections only -> subDocs                          |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``effective_permission`` | ``EffectivePermission``       | See :ref:`EffectivePermission <EffectivePermission>` |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``description``          | ``string``                    |                                                      |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``item_type``            | ``ItemType``                  | See :ref:`ItemType <ItemType>`                       |
+--------------------------+-------------------------------+------------------------------------------------------+
| ``parent_id``            | ``string``                    | **Optional.**                                        |
+--------------------------+-------------------------------+------------------------------------------------------+