projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
88 lines (87 loc) • 2.4 kB
TypeScript
/**
* ProjectManager API for TypeScript
*
* (c) ProjectManager.com, Inc.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @author ProjectManager.com <support@projectmanager.com>
* @copyright ProjectManager.com, Inc.
* @link https://github.com/projectmgr/projectmanager-sdk-typescript
*/
import { ExportDueDateFilterDto } from "../index.js";
import { ExportPriorityFilterDto } from "../index.js";
import { RiskExportProgressFilterDto } from "../index.js";
/**
* Export Settings for Risk Export
*/
export type RiskExportSettingsDto = {
/**
* the name used by the export
*/
name: string | null;
/**
* Format to export to, currently csv and excel are supported
*
* Valid options are:
* * Csv
* * excel
*/
format: string;
/**
* The list of column names to export
*/
columns: string[];
/**
* Which column should be used to order the data
*
* Valid options are:
* * name
* * createDate
* * assignees
* * dueDate
* * impact
* * level
* * likelihood
* * openClosed
* * priority
* * response
* * tags
* * description
* * resolution
*/
orderBy: string;
/**
* Specifies the direction of the order. Valid values are "asc" and "desc"
*
* Valid options are:
* * asc
* * desc
*/
orderDirection: string;
/**
* Timezone offset in minutes
*/
timeZoneOffset: number;
/**
* Specify the due date filter for the export. If left null, no due date filter will be applied
*/
dueDateFilter: ExportDueDateFilterDto | null;
/**
* Specify the priority filter for the export. If left null, no priority filter will be applied
*/
priorityFilter: ExportPriorityFilterDto | null;
/**
* Specify the progress filter for the export. If left null, no progress filter will be applied
*/
progressFilter: RiskExportProgressFilterDto | null;
/**
* A list of resourceIds to filter the risks by assignees. If left null or empty this will be ignored
*/
assignees: string[] | null;
/**
* A list of tagIds to filter the risks by tags. If left null or empty this will be ignored
*/
tags: string[] | null;
};