mcdev 6.0.2 → 7.0.0

package/@types/lib/metadataTypes/DataExtensionField.d.ts

@@ -0,0 +1,236 @@
+export default DataExtensionField;
+export type BuObject = import('../../types/mcdev.d.js').BuObject;
+export type CodeExtract = import('../../types/mcdev.d.js').CodeExtract;
+export type CodeExtractItem = import('../../types/mcdev.d.js').CodeExtractItem;
+export type MetadataTypeItem = import('../../types/mcdev.d.js').MetadataTypeItem;
+export type MetadataTypeItemDiff = import('../../types/mcdev.d.js').MetadataTypeItemDiff;
+export type MetadataTypeItemObj = import('../../types/mcdev.d.js').MetadataTypeItemObj;
+export type MetadataTypeMap = import('../../types/mcdev.d.js').MetadataTypeMap;
+export type MetadataTypeMapObj = import('../../types/mcdev.d.js').MetadataTypeMapObj;
+export type SoapRequestParams = import('../../types/mcdev.d.js').SoapRequestParams;
+export type TemplateMap = import('../../types/mcdev.d.js').TemplateMap;
+export type DataExtensionFieldMap = import('../../types/mcdev.d.js').DataExtensionFieldMap;
+export type DataExtensionFieldItem = import('../../types/mcdev.d.js').DataExtensionFieldItem;
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+/**
+ * @typedef {import('../../types/mcdev.d.js').DataExtensionFieldMap} DataExtensionFieldMap
+ * @typedef {import('../../types/mcdev.d.js').DataExtensionFieldItem} DataExtensionFieldItem
+ */
+/**
+ * DataExtensionField MetadataType
+ *
+ * @augments MetadataType
+ */
+declare class DataExtensionField extends MetadataType {
+    static fixShared_fields: any;
+    /**
+     * Retrieves all records and saves it to disk
+     *
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @param {string[]} [additionalFields] Returns specified fields even if their retrieve definition is not set to true
+     * @returns {Promise.<{metadata: DataExtensionFieldMap, type: string}>} Promise of items
+     */
+    static retrieve(retrieveDir: string, additionalFields?: string[]): Promise<{
+        metadata: DataExtensionFieldMap;
+        type: string;
+    }>;
+    /**
+     * Retrieves all records for caching
+     *
+     * @param {SoapRequestParams} [requestParams] required for the specific request (filter for example)
+     * @param {string[]} [additionalFields] Returns specified fields even if their retrieve definition is not set to true
+     * @returns {Promise.<{metadata: DataExtensionFieldMap, type: string}>} Promise of items
+     */
+    static retrieveForCacheDE(requestParams?: SoapRequestParams, additionalFields?: string[]): Promise<{
+        metadata: DataExtensionFieldMap;
+        type: string;
+    }>;
+    /**
+     * helper for DataExtension.retrieveFieldsForSingleDe that sorts the fields into an array
+     *
+     * @param {DataExtensionFieldMap} fieldsObj customerKey-based list of fields for one dataExtension
+     * @returns {DataExtensionFieldItem[]} sorted array of field objects
+     */
+    static convertToSortedArray(fieldsObj: DataExtensionFieldMap): DataExtensionFieldItem[];
+    /**
+     * sorting method to ensure `Ordinal` is respected
+     *
+     * @param {DataExtensionFieldItem} a -
+     * @param {DataExtensionFieldItem} b -
+     * @returns {number} sorting based on Ordinal
+     */
+    static sortDeFields(a: DataExtensionFieldItem, b: DataExtensionFieldItem): number;
+    /**
+     * manages post retrieve steps; only used by DataExtension class
+     *
+     * @param {DataExtensionFieldItem} metadata a single item
+     * @returns {DataExtensionFieldItem} metadata
+     */
+    static postRetrieveTasksDE(metadata: DataExtensionFieldItem): DataExtensionFieldItem;
+    /**
+     * Mofifies passed deployColumns for update by mapping ObjectID to their target column's values.
+     * Removes FieldType field if its the same in deploy and target column, because it results in an error even if its of the same type
+     *
+     * @param {DataExtensionFieldItem[]} deployColumns Columns of data extension that will be deployed
+     * @param {string} deKey external/customer key of Data Extension
+     * @returns {Promise.<Object.<string, DataExtensionFieldItem>>} existing fields by their original name to allow re-adding FieldType after update
+     */
+    static prepareDeployColumnsOnUpdate(deployColumns: DataExtensionFieldItem[], deKey: string): Promise<{
+        [x: string]: DataExtensionFieldItem;
+    }>;
+    /**
+     * Delete a data extension from the specified business unit
+     *
+     * @param {string} customerKey Identifier of metadata
+     * @param {string} [fieldId] for programmatic deletes only one can pass in the ID directly
+     * @returns {Promise.<boolean>} deletion success flag
+     */
+    static deleteByKeySOAP(customerKey: string, fieldId?: string): Promise<boolean>;
+    /**
+     * clean up after deleting a metadata item
+     *
+     * @param {string} customerKey Identifier of metadata item
+     * @returns {Promise.<void>} -
+     */
+    static postDeleteTasks(customerKey: string): Promise<void>;
+}
+declare namespace DataExtensionField {
+    let definition: {
+        bodyIteratorField: string;
+        dependencies: any[];
+        filter: {};
+        hasExtended: boolean;
+        idField: string;
+        keyIsFixed: boolean;
+        keyField: string;
+        nameField: string;
+        restPagination: boolean;
+        type: string;
+        typeDescription: string;
+        typeRetrieveByDefault: boolean;
+        typeName: string;
+        fields: {
+            'Client.ID': {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            CreatedDate: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            CustomerKey: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            'DataExtension.CustomerKey': {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            'DataExtension.PartnerKey': {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            'DataExtension.ObjectID': {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            DefaultValue: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            FieldType: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            IsPrimaryKey: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            IsRequired: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            MaxLength: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            ModifiedDate: {
+                isCreateable: boolean;
+                /**
+                 * helper for DataExtension.retrieveFieldsForSingleDe that sorts the fields into an array
+                 *
+                 * @param {DataExtensionFieldMap} fieldsObj customerKey-based list of fields for one dataExtension
+                 * @returns {DataExtensionFieldItem[]} sorted array of field objects
+                 */
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            Name: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            ObjectID: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            Ordinal: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            PartnerKey: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            Scale: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+        };
+    };
+}
+import MetadataType from './MetadataType.js';
+//# sourceMappingURL=DataExtensionField.d.ts.map

package/@types/lib/metadataTypes/DataExtensionField.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataExtensionField.d.ts","sourceRoot":"","sources":["../../../lib/metadataTypes/DataExtensionField.js"],"names":[],"mappings":";uBAMa,OAAO,wBAAwB,EAAE,QAAQ;0BACzC,OAAO,wBAAwB,EAAE,WAAW;8BAC5C,OAAO,wBAAwB,EAAE,eAAe;+BAChD,OAAO,wBAAwB,EAAE,gBAAgB;mCACjD,OAAO,wBAAwB,EAAE,oBAAoB;kCACrD,OAAO,wBAAwB,EAAE,mBAAmB;8BACpD,OAAO,wBAAwB,EAAE,eAAe;iCAChD,OAAO,wBAAwB,EAAE,kBAAkB;gCACnD,OAAO,wBAAwB,EAAE,iBAAiB;0BAClD,OAAO,wBAAwB,EAAE,WAAW;oCAG5C,OAAO,wBAAwB,EAAE,qBAAqB;qCACtD,OAAO,wBAAwB,EAAE,sBAAsB;AAdpE;;;;;;;;;;;GAWG;AACH;;;GAGG;AACH;;;;GAIG;AACH;IACI,6BAAwB;IACxB;;;;;;OAMG;IACH,6BAJW,MAAM,qBACN,MAAM,EAAE,GACN,QAAS;QAAC,QAAQ,EAAE,qBAAqB,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,CAAC,CAIrE;IACD;;;;;;OAMG;IACH,0CAJW,iBAAiB,qBACjB,MAAM,EAAE,GACN,QAAS;QAAC,QAAQ,EAAE,qBAAqB,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,CAAC,CAIrE;IACD;;;;;OAKG;IACH,uCAHW,qBAAqB,GACnB,sBAAsB,EAAE,CASpC;IAED;;;;;;OAMG;IACH,uBAJW,sBAAsB,KACtB,sBAAsB,GACpB,MAAM,CAIlB;IACD;;;;;OAKG;IACH,qCAHW,sBAAsB,GACpB,sBAAsB,CAelC;IACD;;;;;;;OAOG;IACH,mDAJW,sBAAsB,EAAE,SACxB,MAAM,GACJ;YAAiB,MAAM,GAAE,sBAAsB;MAAE,CAoK7D;IAYD;;;;;;OAMG;IACH,oCAJW,MAAM,YACN,MAAM,GACJ,QAAS,OAAO,CAAC,CAuD7B;IACD;;;;;OAKG;IACH,oCAHW,MAAM,GACJ,QAAS,IAAI,CAAC,CAO1B;CACJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA5SG;;;;;mBAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAnDkB,mBAAmB"}

package/@types/lib/metadataTypes/DataExtensionTemplate.d.ts

@@ -0,0 +1,175 @@
+export default DataExtensionTemplate;
+export type BuObject = import('../../types/mcdev.d.js').BuObject;
+export type CodeExtract = import('../../types/mcdev.d.js').CodeExtract;
+export type CodeExtractItem = import('../../types/mcdev.d.js').CodeExtractItem;
+export type MetadataTypeItem = import('../../types/mcdev.d.js').MetadataTypeItem;
+export type MetadataTypeItemDiff = import('../../types/mcdev.d.js').MetadataTypeItemDiff;
+export type MetadataTypeItemObj = import('../../types/mcdev.d.js').MetadataTypeItemObj;
+export type MetadataTypeMap = import('../../types/mcdev.d.js').MetadataTypeMap;
+export type MetadataTypeMapObj = import('../../types/mcdev.d.js').MetadataTypeMapObj;
+export type SoapRequestParams = import('../../types/mcdev.d.js').SoapRequestParams;
+export type TemplateMap = import('../../types/mcdev.d.js').TemplateMap;
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+/**
+ * DataExtensionTemplate MetadataType
+ *
+ * @augments MetadataType
+ */
+declare class DataExtensionTemplate extends MetadataType {
+    /**
+     * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
+     *
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @param {void | string[]} [_] unused parameter
+     * @param {void | string[]} [__] unused parameter
+     * @param {string} [key] customer key of single item to retrieve
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
+     */
+    static retrieve(retrieveDir: string, _?: void | string[], __?: void | string[], key?: string): Promise<MetadataTypeMapObj>;
+}
+declare namespace DataExtensionTemplate {
+    let definition: {
+        bodyIteratorField: string;
+        dependencies: any[];
+        filter: {};
+        hasExtended: boolean;
+        idField: string;
+        keyIsFixed: boolean;
+        keyField: string;
+        nameField: string;
+        restPagination: boolean;
+        type: string;
+        typeDescription: string;
+        typeRetrieveByDefault: boolean;
+        typeName: string;
+        fields: {
+            'Client.ID': {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            CreatedDate: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            ModifiedDate: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            CustomerKey: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            ObjectID: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            Name: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            Description: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean; /** @type {SoapRequestParams} */
+                template: boolean;
+            };
+            PartnerKey: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            PartnerProperties: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            IsSendable: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            IsTestable: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            SendableCustomObjectField: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            SendableSubscriberField: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            DataRetentionPeriodLength: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            DataRetentionPeriodUnitOfMeasure: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            RowBasedRetention: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            ResetRetentionPeriodOnImport: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            DeleteAtEndOfRetentionPeriod: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            RetainUntil: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+        };
+    };
+}
+import MetadataType from './MetadataType.js';
+//# sourceMappingURL=DataExtensionTemplate.d.ts.map

package/@types/lib/metadataTypes/DataExtensionTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataExtensionTemplate.d.ts","sourceRoot":"","sources":["../../../lib/metadataTypes/DataExtensionTemplate.js"],"names":[],"mappings":";uBAKa,OAAO,wBAAwB,EAAE,QAAQ;0BACzC,OAAO,wBAAwB,EAAE,WAAW;8BAC5C,OAAO,wBAAwB,EAAE,eAAe;+BAChD,OAAO,wBAAwB,EAAE,gBAAgB;mCACjD,OAAO,wBAAwB,EAAE,oBAAoB;kCACrD,OAAO,wBAAwB,EAAE,mBAAmB;8BACpD,OAAO,wBAAwB,EAAE,eAAe;iCAChD,OAAO,wBAAwB,EAAE,kBAAkB;gCACnD,OAAO,wBAAwB,EAAE,iBAAiB;0BAClD,OAAO,wBAAwB,EAAE,WAAW;AAVzD;;;;;;;;;;;GAWG;AAEH;;;;GAIG;AACH;IACI;;;;;;;;OAQG;IACH,6BANW,MAAM,MACN,IAAI,GAAG,MAAM,EAAE,OACf,IAAI,GAAG,MAAM,EAAE,QACf,MAAM,GACJ,QAAS,kBAAkB,CAAC,CAexC;CACJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCAbO,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBA/Bf,mBAAmB"}

package/@types/lib/metadataTypes/DataExtract.d.ts

@@ -0,0 +1,217 @@
+export default DataExtract;
+export type BuObject = import('../../types/mcdev.d.js').BuObject;
+export type CodeExtract = import('../../types/mcdev.d.js').CodeExtract;
+export type CodeExtractItem = import('../../types/mcdev.d.js').CodeExtractItem;
+export type MetadataTypeItem = import('../../types/mcdev.d.js').MetadataTypeItem;
+export type MetadataTypeItemDiff = import('../../types/mcdev.d.js').MetadataTypeItemDiff;
+export type MetadataTypeItemObj = import('../../types/mcdev.d.js').MetadataTypeItemObj;
+export type MetadataTypeMap = import('../../types/mcdev.d.js').MetadataTypeMap;
+export type MetadataTypeMapObj = import('../../types/mcdev.d.js').MetadataTypeMapObj;
+export type SoapRequestParams = import('../../types/mcdev.d.js').SoapRequestParams;
+export type TemplateMap = import('../../types/mcdev.d.js').TemplateMap;
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+/**
+ * DataExtract MetadataType
+ *
+ * @augments MetadataType
+ */
+declare class DataExtract extends MetadataType {
+    /**
+     * Retrieves Metadata of Data Extract Activity.
+     * Endpoint /automation/v1/dataextracts/ returns all Data Extracts
+     *
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @param {void | string[]} [_] unused parameter
+     * @param {void | string[]} [__] unused parameter
+     * @param {string} [key] customer key of single item to retrieve
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
+     */
+    static retrieve(retrieveDir: string, _?: void | string[], __?: void | string[], key?: string): Promise<MetadataTypeMapObj>;
+    /**
+     * Retrieves Metadata of  Data Extract Activity for caching
+     *
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
+     */
+    static retrieveForCache(): Promise<MetadataTypeMapObj>;
+    /**
+     * Retrieve a specific dataExtract Definition by Name
+     *
+     * @param {string} templateDir Directory where retrieved metadata directory will be saved
+     * @param {string} name name of the metadata file
+     * @param {TemplateMap} templateVariables variables to be replaced in the metadata
+     * @returns {Promise.<MetadataTypeItemObj>} Promise of metadata
+     */
+    static retrieveAsTemplate(templateDir: string, name: string, templateVariables: TemplateMap): Promise<MetadataTypeItemObj>;
+    /**
+     * Creates a single Data Extract
+     *
+     * @param {MetadataTypeItem} dataExtract a single Data Extract
+     * @returns {Promise} Promise
+     */
+    static create(dataExtract: MetadataTypeItem): Promise<any>;
+    /**
+     * Updates a single Data Extract
+     *
+     * @param {MetadataTypeItem} dataExtract a single Data Extract
+     * @returns {Promise} Promise
+     */
+    static update(dataExtract: MetadataTypeItem): Promise<any>;
+    /**
+     * prepares a dataExtract for deployment
+     *
+     * @param {MetadataTypeItem} metadata a single dataExtract activity definition
+     * @returns {MetadataTypeItem} metadata object
+     */
+    static preDeployTasks(metadata: MetadataTypeItem): MetadataTypeItem;
+    /**
+     * manages post retrieve steps
+     *
+     * @param {MetadataTypeItem} metadata a single item
+     * @returns {MetadataTypeItem} metadata
+     */
+    static postRetrieveTasks(metadata: MetadataTypeItem): MetadataTypeItem;
+    /**
+     * helper to allow us to select single metadata entries via REST
+     *
+     * @private
+     * @param {string} key customer key
+     * @returns {Promise.<string>} objectId or enpty string
+     */
+    private static _getObjectIdForSingleRetrieve;
+}
+declare namespace DataExtract {
+    let definition: {
+        bodyIteratorField: string;
+        dependencies: string[];
+        hasExtended: boolean;
+        idField: string;
+        keyIsFixed: boolean;
+        keyField: string;
+        createdDateField: string;
+        createdNameField: string;
+        lastmodDateField: string;
+        lastmodNameField: string;
+        nameField: string;
+        restPagination: boolean;
+        maxKeyLength: number;
+        type: string;
+        typeDescription: string;
+        typeRetrieveByDefault: boolean;
+        typeName: string;
+        fields: {
+            createdBy: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            createdDate: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            dataExtractDefinitionId: {
+                isCreateable: boolean;
+                isUpdateable: boolean; /**
+                 * Retrieves Metadata of Data Extract Activity.
+                 * Endpoint /automation/v1/dataextracts/ returns all Data Extracts
+                 *
+                 * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+                 * @param {void | string[]} [_] unused parameter
+                 * @param {void | string[]} [__] unused parameter
+                 * @param {string} [key] customer key of single item to retrieve
+                 * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
+                 */
+                retrieving: boolean;
+                template: boolean;
+            };
+            dataExtractTypeId: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            dataFields: {
+                skipValidation: boolean;
+            };
+            description: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            endDate: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            fileSpec: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            intervalType: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean; /**
+                 * Retrieve a specific dataExtract Definition by Name
+                 *
+                 * @param {string} templateDir Directory where retrieved metadata directory will be saved
+                 * @param {string} name name of the metadata file
+                 * @param {TemplateMap} templateVariables variables to be replaced in the metadata
+                 * @returns {Promise.<MetadataTypeItemObj>} Promise of metadata
+                 */
+            };
+            key: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            modifiedBy: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            modifiedDate: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            name: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            startDate: {
+                isCreateable: boolean;
+                isUpdateable: boolean;
+                retrieving: boolean;
+                template: boolean;
+            };
+            r__dataExtractType_name: {
+                skipValidation: boolean;
+            };
+        };
+    };
+}
+import MetadataType from './MetadataType.js';
+//# sourceMappingURL=DataExtract.d.ts.map

package/@types/lib/metadataTypes/DataExtract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataExtract.d.ts","sourceRoot":"","sources":["../../../lib/metadataTypes/DataExtract.js"],"names":[],"mappings":";uBAQa,OAAO,wBAAwB,EAAE,QAAQ;0BACzC,OAAO,wBAAwB,EAAE,WAAW;8BAC5C,OAAO,wBAAwB,EAAE,eAAe;+BAChD,OAAO,wBAAwB,EAAE,gBAAgB;mCACjD,OAAO,wBAAwB,EAAE,oBAAoB;kCACrD,OAAO,wBAAwB,EAAE,mBAAmB;8BACpD,OAAO,wBAAwB,EAAE,eAAe;iCAChD,OAAO,wBAAwB,EAAE,kBAAkB;gCACnD,OAAO,wBAAwB,EAAE,iBAAiB;0BAClD,OAAO,wBAAwB,EAAE,WAAW;AAVzD;;;;;;;;;;;GAWG;AAEH;;;;GAIG;AACH;IACI;;;;;;;;;OASG;IACH,6BANW,MAAM,MACN,IAAI,GAAG,MAAM,EAAE,OACf,IAAI,GAAG,MAAM,EAAE,QACf,MAAM,GACJ,QAAS,kBAAkB,CAAC,CAIxC;IACD;;;;OAIG;IACH,2BAFa,QAAS,kBAAkB,CAAC,CAIxC;IAED;;;;;;;OAOG;IACH,uCALW,MAAM,QACN,MAAM,qBACN,WAAW,GACT,QAAS,mBAAmB,CAAC,CA4CzC;IAED;;;;;OAKG;IACH,2BAHW,gBAAgB,gBAK1B;IAED;;;;;OAKG;IACH,2BAHW,gBAAgB,gBAQ1B;IAED;;;;;OAKG;IACH,gCAHW,gBAAgB,GACd,gBAAgB,CAW5B;IACD;;;;;OAKG;IACH,mCAHW,gBAAgB,GACd,gBAAgB,CAiB5B;IACD;;;;;;OAMG;IACH,6CASC;CAiBJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uCAxKG;;;;;;;;;mBASG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mCAaH;;;;;;;mBAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBArDkB,mBAAmB"}