feature/1294 add documentation of retention policy and upgrade test cases

lib/metadataTypes/DataExtension.js

@@ -1286,6 +1286,35 @@ class DataExtension extends MetadataType {
         if (json.r__dataExtensionTemplate_name) {
             output += `**Template:** ${json.r__dataExtensionTemplate_name}\n\n`;
         }
+        // Retention
+        output += `**Retention Policy:** ${json.c__retentionPolicy}\n\n`;
+        switch (json.c__retentionPolicy) {
+            case 'allRecords':
+            case 'allRecordsAndDataextension': {
+                if (json.DataRetentionPeriodLength) {
+                    // if period length was selected, show it plus the optional reset-on-import; the retain-until date IS returned by the api but does not matter for documentation
+                    output += `- **Retention Period:** ${json.DataRetentionPeriodLength} ${json.c__dataRetentionPeriodUnitOfMeasure}\n`;
+                    output += `- **Reset Retention Period on import:** ${json.ResetRetentionPeriodOnImport ? 'yes' : 'no'}\n`;
+                } else {
+                    // if a date was selected instead, the GUI auto-deselects reset-on-import
+                    output += `- **Retain Until:** ${json.c__retainUntil}\n`;
+                }
+                // add empty line after retention:
+                output += `\n`;
+                break;
+            }
+            case 'individialRecords': {
+                output += `- **Retention Period:** ${json.DataRetentionPeriodLength} ${json.c__dataRetentionPeriodUnitOfMeasure}\n`;
+                output += `- **Reset Retention Period on import:** ${json.ResetRetentionPeriodOnImport ? 'yes' : 'no'}\n`;
+                // add empty line after retention:
+                output += `\n`;
+                break;
+            }
+            case 'none': {
+                // nothing else to do
+                break;
+            }
+        }
 
         let tableSeparator = '';
         for (const column of tabled[0]) {

test/resources/1111111/dataExtension/retrieve-expected.md

@@ -10,6 +10,11 @@
 
 **Testable:** Yes
 
+**Retention Policy:** individialRecords
+
+- **Retention Period:** 6 Months
+- **Reset Retention Period on import:** no
+
 | Name | FieldType | MaxLength | IsPrimaryKey | IsNullable | DefaultValue |
 | --- | --- | --- | --- | --- | --- |
 | FirstName | Text | 50 | - | + |  |

test/resources/9999999/dataExtension/retrieve-expected.md

@@ -10,6 +10,11 @@
 
 **Testable:** Yes
 
+**Retention Policy:** allRecords
+
+- **Retention Period:** 6 Months
+- **Reset Retention Period on import:** no
+
 | Name | FieldType | MaxLength | IsPrimaryKey | IsNullable | DefaultValue |
 | --- | --- | --- | --- | --- | --- |
 | FirstName | Text | 50 | - | + |  |