@silkline/paramify 0.0.2

package/resources/issues/issues.d.ts

@@ -0,0 +1,878 @@
+import { APIResource } from "../../core/resource.js";
+import * as DeviationsAPI from "./deviations.js";
+import { Deviation as DeviationsAPIDeviation, DeviationCreateParams, DeviationDeleteParams, DeviationListParams, DeviationListResponse, DeviationMetadata as DeviationsAPIDeviationMetadata, DeviationObservationTypes, DeviationRetrieveParams, DeviationUpdateParams, DeviationUpdateResponse, Deviations } from "./deviations.js";
+import * as MilestonesAPI from "./milestones.js";
+import { Milestone as MilestonesAPIMilestone, MilestoneCreateParams, MilestoneCreateResponse, MilestoneDeleteParams, MilestoneListParams, MilestoneListResponse, MilestoneRetrieveParams, MilestoneRetrieveResponse, MilestoneUpdateParams, MilestoneUpdateResponse, Milestones } from "./milestones.js";
+import * as RecommendationsAPI from "./recommendations.js";
+import { Recommendation as RecommendationsAPIRecommendation, RecommendationCreateParams, RecommendationDeleteParams, RecommendationListParams, RecommendationListResponse, RecommendationRetrieveParams, RecommendationUpdateParams, RecommendationUpdateResponse, Recommendations } from "./recommendations.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Issues extends APIResource {
+    recommendations: RecommendationsAPI.Recommendations;
+    deviations: DeviationsAPI.Deviations;
+    milestones: MilestonesAPI.Milestones;
+    /**
+     * Creates a new issue within the project specified by the request body's
+     * `projectId`. The `id` value of the issue returned can be used as the `issueId`
+     * parameter in other routes or request bodies.
+     *
+     * @example
+     * ```ts
+     * const issue = await client.issues.create({
+     *   originalLevel: 'HIGH',
+     *   projectId: '123e4567-e89b-12d3-a456-426614174000',
+     *   statusDate: '2022-01-01T00:00:00.000Z',
+     *   title: 'Issue Title Example',
+     *   type: 'CONTROL',
+     * });
+     * ```
+     */
+    create(body: IssueCreateParams, options?: RequestOptions): APIPromise<Issue>;
+    /**
+     * Returns the issue specified by the `issueId` query parameter and accessible to
+     * the api key. The `id` value of the issue returned can be used as the `issueId`
+     * parameter in other routes or request bodies.
+     *
+     * @example
+     * ```ts
+     * const issue = await client.issues.retrieve(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    retrieve(issueID: string, options?: RequestOptions): APIPromise<Issue>;
+    /**
+     * Updates the issue specified by the `issueId`. Upon successful operation, all
+     * fields that are not arrays will be overwritten. Fields that accept array values
+     * will add the provided values to the existing values.
+     *
+     * @example
+     * ```ts
+     * const issue = await client.issues.update(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    update(issueID: string, body: IssueUpdateParams, options?: RequestOptions): APIPromise<IssueUpdateResponse>;
+    /**
+     * Gets all issues within the project specified by the query parameter `projectId`,
+     * and optionally filtered by various parameters.
+     *
+     * **Basic Filtering:**
+     *
+     * - **Multiple IDs**: Pass several `id` values to retrieve multiple issues at once
+     * - **POAM IDs**: Pass several `poamId` values to retrieve multiple issues
+     *   (requires `projectId`)
+     *
+     * **Content Filtering:**
+     *
+     * - **`deviationType`**: Retrieve issues containing deviations of the specified
+     *   type
+     * - **`title`**: Retrieve issues whose title contains the provided string
+     *   (case-insensitive)
+     * - **`kev`**: Retrieve issues containing CVE IDs present in the Known Exploited
+     *   Vulnerabilities (KEV) catalog
+     * - **`cveId`**: Retrieve issues containing the specified CVE identifier (OR logic
+     *   for multiple CVE IDs)
+     * - **`asset`**: Retrieve issues with at least one of the provided asset names
+     *   (case-sensitive, exact match)
+     * - **`internetReachableVulnerability`**: Filter issues by whether they represent
+     *   an internet-reachable vulnerability (boolean)
+     * - **`likelyExploitableVulnerability`**: Filter issues by whether they represent
+     *   a likely-exploitable vulnerability (boolean)
+     *
+     * **Date Range Filtering:**
+     *
+     * Date ranges are inclusive. You may provide one side of the date range to get an
+     * unbounded range. Date format for all filters: YYYY-MM-DD (e.g., "2024-01-01")
+     *
+     * - **Effective Date**: Use `effectiveDateStart` and `effectiveDateEnd` (filters
+     *   the `createdAt` field returned by the API)
+     * - **Due Date**: Use `dueDateStart` and `dueDateEnd`
+     * - **Status Date**: Use `statusDateStart` and `statusDateEnd`
+     * - **Evaluation Date**: Use `evaluationDateStart` and `evaluationDateEnd`
+     *
+     * @example
+     * ```ts
+     * const issues = await client.issues.list();
+     * ```
+     */
+    list(query?: IssueListParams | null | undefined, options?: RequestOptions): APIPromise<IssueListResponse>;
+    /**
+     * Deletes the issue specified by the `issueId` query parameter. Warning: This
+     * action is irreversible.
+     *
+     * @example
+     * ```ts
+     * await client.issues.delete(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    delete(issueID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Downloads Plan of Action & Milestones (POAM) data in OSCAL XML format. When a
+     * `projectId` is provided, returns the POAM for that specific project. When
+     * omitted, returns a combined POAM for all projects in the workspace.
+     *
+     * @example
+     * ```ts
+     * await client.issues.exportOscal();
+     * ```
+     */
+    exportOscal(query?: IssueExportOscalParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * An object containing information about issues contained within a project
+ */
+export interface Issue {
+    /**
+     * A uuid that uniquely identifies an individual issue within Paramify
+     */
+    id: string;
+    /**
+     * The date the issue was created
+     */
+    createdAt: string;
+    /**
+     * The current risk level of the issue
+     */
+    level: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+    /**
+     * The original risk level of the issue
+     */
+    originalLevel: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+    /**
+     * A user defined identifier for this issue
+     */
+    poamId: string;
+    /**
+     * The title of the issue
+     */
+    title: string;
+    /**
+     * The type of observation for the issue
+     */
+    type: 'CONTROL' | 'VULNERABILITY' | 'DOCUMENTATION' | 'CONFIGURATION' | 'NOT_SET';
+    /**
+     * The assets associated with the issue
+     */
+    assets?: Array<string> | null;
+    /**
+     * The CVE IDs associated with the issue
+     */
+    cveIds?: Array<string> | null;
+    /**
+     * Text describing the issue
+     */
+    description?: string | null;
+    /**
+     * The deviations associated with the issue
+     */
+    deviations?: Array<DeviationsAPI.Deviation> | null;
+    /**
+     * The date the issue is due
+     */
+    dueDate?: string | null;
+    /**
+     * The evaluation date for the issue.
+     */
+    evaluationDate?: string | null;
+    /**
+     * Whether the issue represents an internet-reachable vulnerability.
+     */
+    internetReachableVulnerability?: boolean | null;
+    /**
+     * Whether the issue represents a likely-exploitable vulnerability.
+     */
+    likelyExploitableVulnerability?: boolean | null;
+    /**
+     * Links associated with the issue
+     */
+    links?: Array<Issue.Link> | null;
+    /**
+     * The milestones associated with the issue
+     */
+    milestones?: Array<Issue.Milestone> | null;
+    /**
+     * The origins of the issue
+     */
+    origins?: Array<Origin> | null;
+    /**
+     * The plugin id associated with the issue
+     */
+    pluginId?: string | null;
+    /**
+     * The point of contact for the issue
+     */
+    pointOfContact?: Issue.PointOfContact | null;
+    /**
+     * The recommendations associated with the issue
+     */
+    recommendations?: Array<RecommendationsAPI.Recommendation> | null;
+    /**
+     * Additional remarks or notes about the issue
+     */
+    remarks?: string | null;
+    /**
+     * Description of the remediation for the issue
+     */
+    remediationDescription?: string | null;
+    /**
+     * The requirements associated with the issue
+     */
+    requirements?: Array<string> | null;
+    /**
+     * The current status of the issue
+     */
+    status?: 'OPEN' | 'CLOSED' | null;
+    /**
+     * The date the current status was set
+     */
+    statusDate?: string | null;
+}
+export declare namespace Issue {
+    interface Link {
+        url: string;
+        title?: string;
+    }
+    interface Milestone {
+        /**
+         * A uuid that uniquely identifies the milestone
+         */
+        id: string;
+        /**
+         * The description of the milestone
+         */
+        description: string;
+        /**
+         * The end date of the milestone
+         */
+        dueEnd: string | null;
+        /**
+         * The start date of the milestone
+         */
+        dueStart: string | null;
+        /**
+         * The title of the milestone
+         */
+        title: string;
+    }
+    /**
+     * The point of contact for the issue
+     */
+    interface PointOfContact {
+        name: string;
+        email?: string | null;
+    }
+}
+/**
+ * Issue observation types
+ */
+export type IssueObservationTypes = 'CONTROL' | 'VULNERABILITY' | 'DOCUMENTATION' | 'CONFIGURATION' | 'NOT_SET';
+/**
+ * The name and subtype of the element within Paramify that created the issue
+ */
+export interface Origin {
+    name: string;
+    subtype?: 'COM_AGREEMENT' | 'COM_CUSTOMER_MANAGED' | 'COM_FEDRAMP_SYSTEM' | 'COM_HARDWARE' | 'COM_IAAS' | 'COM_INTERCONNECTION' | 'COM_PAAS' | 'COM_PLAN' | 'COM_POLICY' | 'COM_PROCEDURE' | 'COM_PROCESS' | 'COM_SAAS' | 'COM_SERVICE' | 'COM_SOFTWARE' | 'COM_SUBNET' | 'COM_CRYPTOGRAPHIC_MODULE' | 'COM_STACK_PARAMETER' | 'PAR_ORGANIZATION' | 'PAR_PERSON' | 'ROL_NO_LOGICAL_ACCESS' | 'ROL_NOT_PRIVILEGED' | 'ROL_PRIVILEGED' | 'LOC_CAMPUS' | 'LOC_DATA_CENTER' | 'LOC_DATA_REGION_CLOUD' | 'LOC_OTHER' | 'LOC_REMOTE' | 'DAT_ACCOUNT_DATA' | 'DAT_CUSTOMER_DATA' | 'DAT_METADATA' | 'DAT_SUPPORT_ADMIN';
+}
+/**
+ * The issue as it exists after the operation
+ */
+export interface IssueUpdateResponse {
+    /**
+     * A uuid that uniquely identifies an individual issue within Paramify
+     */
+    id: string;
+    /**
+     * The date the issue was created
+     */
+    createdAt: string;
+    /**
+     * The current risk level of the issue
+     */
+    level: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+    /**
+     * The original risk level of the issue
+     */
+    originalLevel: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+    /**
+     * A user defined identifier for this issue
+     */
+    poamId: string;
+    /**
+     * The title of the issue
+     */
+    title: string;
+    /**
+     * The type of observation for the issue
+     */
+    type: 'CONTROL' | 'VULNERABILITY' | 'DOCUMENTATION' | 'CONFIGURATION' | 'NOT_SET';
+    /**
+     * The assets associated with the issue
+     */
+    assets?: Array<string> | null;
+    /**
+     * The CVE IDs associated with the issue
+     */
+    cveIds?: Array<string> | null;
+    /**
+     * Text describing the issue
+     */
+    description?: string | null;
+    /**
+     * The deviations associated with the issue
+     */
+    deviations?: Array<DeviationsAPI.Deviation> | null;
+    /**
+     * The date the issue is due
+     */
+    dueDate?: string | null;
+    /**
+     * The evaluation date for the issue.
+     */
+    evaluationDate?: string | null;
+    /**
+     * Whether the issue represents an internet-reachable vulnerability.
+     */
+    internetReachableVulnerability?: boolean | null;
+    /**
+     * Whether the issue represents a likely-exploitable vulnerability.
+     */
+    likelyExploitableVulnerability?: boolean | null;
+    /**
+     * Links associated with the issue
+     */
+    links?: Array<IssueUpdateResponse.Link> | null;
+    /**
+     * The milestones associated with the issue
+     */
+    milestones?: Array<IssueUpdateResponse.Milestone> | null;
+    /**
+     * The origins of the issue
+     */
+    origins?: Array<Origin> | null;
+    /**
+     * The plugin id associated with the issue
+     */
+    pluginId?: string | null;
+    /**
+     * The point of contact for the issue
+     */
+    pointOfContact?: IssueUpdateResponse.PointOfContact | null;
+    /**
+     * The recommendations associated with the issue
+     */
+    recommendations?: Array<RecommendationsAPI.Recommendation> | null;
+    /**
+     * Additional remarks or notes about the issue
+     */
+    remarks?: string | null;
+    /**
+     * Description of the remediation for the issue
+     */
+    remediationDescription?: string | null;
+    /**
+     * The requirements associated with the issue
+     */
+    requirements?: Array<string> | null;
+    /**
+     * The current status of the issue
+     */
+    status?: 'OPEN' | 'CLOSED' | null;
+    /**
+     * The date the current status was set
+     */
+    statusDate?: string | null;
+}
+export declare namespace IssueUpdateResponse {
+    interface Link {
+        url: string;
+        title?: string;
+    }
+    interface Milestone {
+        /**
+         * A uuid that uniquely identifies the milestone
+         */
+        id: string;
+        /**
+         * The description of the milestone
+         */
+        description: string;
+        /**
+         * The end date of the milestone
+         */
+        dueEnd: string | null;
+        /**
+         * The start date of the milestone
+         */
+        dueStart: string | null;
+        /**
+         * The title of the milestone
+         */
+        title: string;
+    }
+    /**
+     * The point of contact for the issue
+     */
+    interface PointOfContact {
+        name: string;
+        email?: string | null;
+    }
+}
+export interface IssueListResponse {
+    issues: Array<Issue>;
+}
+export interface IssueCreateParams {
+    /**
+     * The original risk level of the issue
+     */
+    originalLevel: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+    /**
+     * A uuid that uniquely identifies the project this issue is associated with
+     */
+    projectId: string;
+    /**
+     * The date the current status was set
+     */
+    statusDate: string;
+    /**
+     * The title of the issue
+     */
+    title: string;
+    /**
+     * The type of observation for the issue
+     */
+    type: 'CONTROL' | 'VULNERABILITY' | 'DOCUMENTATION' | 'CONFIGURATION' | 'NOT_SET';
+    /**
+     * The assets associated with the issue
+     */
+    assets?: Array<string> | null;
+    /**
+     * The date the issue was created. If not provided, the current date will be used.
+     */
+    createdAt?: string | null;
+    /**
+     * The CVE IDs associated with the issue
+     */
+    cveIds?: Array<string> | null;
+    /**
+     * Text describing the issue
+     */
+    description?: string | null;
+    /**
+     * The deviations associated with the issue
+     */
+    deviations?: Array<IssueCreateParams.Deviation> | null;
+    /**
+     * The date the issue is due
+     */
+    dueDate?: string | null;
+    /**
+     * The evaluation date for the issue. If not provided, it will default to the
+     * issue's effective date.
+     */
+    evaluationDate?: string | null;
+    /**
+     * Whether the issue represents an internet-reachable vulnerability.
+     */
+    internetReachableVulnerability?: boolean | null;
+    /**
+     * Whether the issue represents a likely-exploitable vulnerability.
+     */
+    likelyExploitableVulnerability?: boolean | null;
+    /**
+     * Links associated with the issue
+     */
+    links?: Array<IssueCreateParams.Link> | null;
+    /**
+     * The milestones associated with the issue
+     */
+    milestones?: Array<MilestonesAPI.Milestone> | null;
+    /**
+     * The origins of the issue
+     */
+    origins?: Array<IssueCreateParams.Origin> | null;
+    /**
+     * The plugin id associated with the issue
+     */
+    pluginId?: string | null;
+    /**
+     * A user defined identifier for this issue
+     */
+    poamId?: string | null;
+    /**
+     * The point of contact for the issue
+     */
+    pointOfContact?: IssueCreateParams.PointOfContact | null;
+    /**
+     * The recommendations associated with the issue
+     */
+    recommendations?: Array<IssueCreateParams.Recommendation> | null;
+    /**
+     * Additional remarks or notes about the issue
+     */
+    remarks?: string | null;
+    /**
+     * Description of the remediation for the issue
+     */
+    remediationDescription?: string | null;
+    /**
+     * The requirements associated with the issue
+     */
+    requirements?: Array<string> | null;
+    /**
+     * The current status of the issue
+     */
+    status?: 'OPEN' | 'CLOSED' | null;
+}
+export declare namespace IssueCreateParams {
+    interface Deviation {
+        /**
+         * The description of the deviation
+         */
+        description: string;
+        /**
+         * Deviation schema
+         */
+        deviationMetadata: Deviation.DeviationMetadata;
+        method: 'TEST' | 'EXAMINE' | 'INTERVIEW' | 'UNKNOWN';
+        /**
+         * Deviation observation types
+         */
+        type: DeviationsAPI.DeviationObservationTypes;
+        /**
+         * The date the deviation was created
+         */
+        createdAt?: string | null;
+    }
+    namespace Deviation {
+        /**
+         * Deviation schema
+         */
+        interface DeviationMetadata {
+            status: 'PENDING' | 'ACCEPTED' | 'REJECTED';
+            /**
+             * The date the deviation status was accepted or rejected
+             */
+            acceptanceStatusDate?: string | null;
+            adjustedLevel?: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+        }
+    }
+    interface Link {
+        url: string;
+        title?: string;
+    }
+    /**
+     * The name and subtype of the element within Paramify that created the issue
+     */
+    interface Origin {
+        name: string;
+        subtype: 'COM_AGREEMENT' | 'COM_CUSTOMER_MANAGED' | 'COM_FEDRAMP_SYSTEM' | 'COM_HARDWARE' | 'COM_IAAS' | 'COM_INTERCONNECTION' | 'COM_PAAS' | 'COM_PLAN' | 'COM_POLICY' | 'COM_PROCEDURE' | 'COM_PROCESS' | 'COM_SAAS' | 'COM_SERVICE' | 'COM_SOFTWARE' | 'COM_SUBNET' | 'COM_CRYPTOGRAPHIC_MODULE' | 'COM_STACK_PARAMETER' | 'PAR_ORGANIZATION' | 'PAR_PERSON' | 'ROL_NO_LOGICAL_ACCESS' | 'ROL_NOT_PRIVILEGED' | 'ROL_PRIVILEGED' | 'LOC_CAMPUS' | 'LOC_DATA_CENTER' | 'LOC_DATA_REGION_CLOUD' | 'LOC_OTHER' | 'LOC_REMOTE' | 'DAT_ACCOUNT_DATA' | 'DAT_CUSTOMER_DATA' | 'DAT_METADATA' | 'DAT_SUPPORT_ADMIN';
+    }
+    /**
+     * The point of contact for the issue
+     */
+    interface PointOfContact {
+        email: string;
+        name: string;
+    }
+    interface Recommendation {
+        /**
+         * The description of the recommendation
+         */
+        description: string;
+        /**
+         * The origins of the recommendation
+         */
+        origins?: Array<Recommendation.Origin> | null;
+    }
+    namespace Recommendation {
+        /**
+         * The name and subtype of the element within Paramify that created the issue
+         */
+        interface Origin {
+            name: string;
+            subtype: 'COM_AGREEMENT' | 'COM_CUSTOMER_MANAGED' | 'COM_FEDRAMP_SYSTEM' | 'COM_HARDWARE' | 'COM_IAAS' | 'COM_INTERCONNECTION' | 'COM_PAAS' | 'COM_PLAN' | 'COM_POLICY' | 'COM_PROCEDURE' | 'COM_PROCESS' | 'COM_SAAS' | 'COM_SERVICE' | 'COM_SOFTWARE' | 'COM_SUBNET' | 'COM_CRYPTOGRAPHIC_MODULE' | 'COM_STACK_PARAMETER' | 'PAR_ORGANIZATION' | 'PAR_PERSON' | 'ROL_NO_LOGICAL_ACCESS' | 'ROL_NOT_PRIVILEGED' | 'ROL_PRIVILEGED' | 'LOC_CAMPUS' | 'LOC_DATA_CENTER' | 'LOC_DATA_REGION_CLOUD' | 'LOC_OTHER' | 'LOC_REMOTE' | 'DAT_ACCOUNT_DATA' | 'DAT_CUSTOMER_DATA' | 'DAT_METADATA' | 'DAT_SUPPORT_ADMIN';
+        }
+    }
+}
+export interface IssueUpdateParams {
+    /**
+     * The assets associated with the issue
+     */
+    assets?: Array<string>;
+    /**
+     * The date the issue was created
+     */
+    createdAt?: string;
+    /**
+     * The CVE IDs associated with the issue
+     */
+    cveIds?: Array<string> | null;
+    /**
+     * Text describing the issue
+     */
+    description?: string;
+    /**
+     * The deviations associated with the issue
+     */
+    deviations?: Array<IssueUpdateParams.Deviation>;
+    /**
+     * The date the issue is due
+     */
+    dueDate?: string | null;
+    /**
+     * The evaluation date for the issue.
+     */
+    evaluationDate?: string;
+    /**
+     * Whether the issue represents an internet-reachable vulnerability.
+     */
+    internetReachableVulnerability?: boolean;
+    /**
+     * Whether the issue represents a likely-exploitable vulnerability.
+     */
+    likelyExploitableVulnerability?: boolean;
+    /**
+     * Links associated with the issue
+     */
+    links?: Array<IssueUpdateParams.Link>;
+    /**
+     * The milestones associated with the issue
+     */
+    milestones?: Array<IssueUpdateParams.Milestone>;
+    /**
+     * The original risk level of the issue
+     */
+    originalLevel?: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+    /**
+     * The origins of the issue
+     */
+    origins?: Array<IssueUpdateParams.Origin>;
+    /**
+     * The plugin id associated with the issue
+     */
+    pluginId?: string;
+    /**
+     * A user defined identifier for this issue
+     */
+    poamId?: string;
+    /**
+     * The point of contact for the issue
+     */
+    pointOfContact?: IssueUpdateParams.PointOfContact;
+    /**
+     * The recommendations associated with the issue
+     */
+    recommendations?: Array<IssueUpdateParams.Recommendation>;
+    /**
+     * Additional remarks or notes about the issue
+     */
+    remarks?: string;
+    /**
+     * Description of the remediation for the issue
+     */
+    remediationDescription?: string;
+    /**
+     * The requirements associated with the issue
+     */
+    requirements?: Array<string>;
+    /**
+     * The current status of the issue
+     */
+    status?: 'OPEN' | 'CLOSED';
+    /**
+     * The date the current status was set
+     */
+    statusDate?: string;
+    /**
+     * The title of the issue
+     */
+    title?: string;
+    /**
+     * Issue observation types
+     */
+    type?: IssueObservationTypes;
+}
+export declare namespace IssueUpdateParams {
+    interface Deviation {
+        id?: string;
+        /**
+         * The date the deviation was created
+         */
+        createdAt?: string;
+        description?: string;
+        /**
+         * Deviation metadata object
+         */
+        deviationMetadata?: DeviationsAPI.DeviationMetadata;
+        method?: 'TEST' | 'EXAMINE' | 'INTERVIEW' | 'UNKNOWN';
+        /**
+         * Deviation observation types
+         */
+        type?: DeviationsAPI.DeviationObservationTypes;
+    }
+    interface Link {
+        url: string;
+        title?: string;
+    }
+    interface Milestone {
+        /**
+         * A uuid that uniquely identifies the milestone
+         */
+        id?: string;
+        /**
+         * The description of the milestone
+         */
+        description?: string;
+        /**
+         * The date the milestone is due to be completed
+         */
+        dueEnd?: string;
+        /**
+         * The date progress on the milestone should start
+         */
+        dueStart?: string;
+        /**
+         * The title of the milestone
+         */
+        title?: string;
+    }
+    /**
+     * The name and subtype of the element within Paramify that created the issue
+     */
+    interface Origin {
+        name: string;
+        subtype: 'COM_AGREEMENT' | 'COM_CUSTOMER_MANAGED' | 'COM_FEDRAMP_SYSTEM' | 'COM_HARDWARE' | 'COM_IAAS' | 'COM_INTERCONNECTION' | 'COM_PAAS' | 'COM_PLAN' | 'COM_POLICY' | 'COM_PROCEDURE' | 'COM_PROCESS' | 'COM_SAAS' | 'COM_SERVICE' | 'COM_SOFTWARE' | 'COM_SUBNET' | 'COM_CRYPTOGRAPHIC_MODULE' | 'COM_STACK_PARAMETER' | 'PAR_ORGANIZATION' | 'PAR_PERSON' | 'ROL_NO_LOGICAL_ACCESS' | 'ROL_NOT_PRIVILEGED' | 'ROL_PRIVILEGED' | 'LOC_CAMPUS' | 'LOC_DATA_CENTER' | 'LOC_DATA_REGION_CLOUD' | 'LOC_OTHER' | 'LOC_REMOTE' | 'DAT_ACCOUNT_DATA' | 'DAT_CUSTOMER_DATA' | 'DAT_METADATA' | 'DAT_SUPPORT_ADMIN';
+    }
+    /**
+     * The point of contact for the issue
+     */
+    interface PointOfContact {
+        email: string;
+        name: string;
+    }
+    interface Recommendation {
+        /**
+         * A uuid that uniquely identifies the recommendation
+         */
+        id?: string;
+        /**
+         * The description of the recommendation
+         */
+        description?: string;
+        /**
+         * The origins of the recommendation
+         */
+        origins?: Array<Recommendation.Origin>;
+    }
+    namespace Recommendation {
+        /**
+         * The name and subtype of the element within Paramify that created the issue
+         */
+        interface Origin {
+            name: string;
+            subtype: 'COM_AGREEMENT' | 'COM_CUSTOMER_MANAGED' | 'COM_FEDRAMP_SYSTEM' | 'COM_HARDWARE' | 'COM_IAAS' | 'COM_INTERCONNECTION' | 'COM_PAAS' | 'COM_PLAN' | 'COM_POLICY' | 'COM_PROCEDURE' | 'COM_PROCESS' | 'COM_SAAS' | 'COM_SERVICE' | 'COM_SOFTWARE' | 'COM_SUBNET' | 'COM_CRYPTOGRAPHIC_MODULE' | 'COM_STACK_PARAMETER' | 'PAR_ORGANIZATION' | 'PAR_PERSON' | 'ROL_NO_LOGICAL_ACCESS' | 'ROL_NOT_PRIVILEGED' | 'ROL_PRIVILEGED' | 'LOC_CAMPUS' | 'LOC_DATA_CENTER' | 'LOC_DATA_REGION_CLOUD' | 'LOC_OTHER' | 'LOC_REMOTE' | 'DAT_ACCOUNT_DATA' | 'DAT_CUSTOMER_DATA' | 'DAT_METADATA' | 'DAT_SUPPORT_ADMIN';
+        }
+    }
+}
+export interface IssueListParams {
+    /**
+     * An id that represents an issue within the Paramify application. You may pass in
+     * several `id` values at once.
+     */
+    id?: Array<string>;
+    /**
+     * A string that represents an asset of an issue.
+     */
+    asset?: Array<string>;
+    /**
+     * A valid CVE ID. Can be passed multiple times to filter by multiple CVE IDs.
+     */
+    cveId?: Array<string>;
+    /**
+     * The type of deviations.
+     */
+    deviationType?: 'FALSE_POSITIVE' | 'OPERATIONAL_REQUIREMENT' | 'RISK_ADJUSTMENT' | 'VENDOR_DEPENDENCY';
+    /**
+     * The end date of the due date range. The due date should be less than or equal to
+     * this date.
+     */
+    dueDateEnd?: string;
+    /**
+     * The start date of the due date range. The due date should be greater than or
+     * equal to this date.
+     */
+    dueDateStart?: string;
+    /**
+     * A date that will be used to filter issues that have an effective date less than
+     * or equal to the date passed in. Date format: YYYY-MM-DD.
+     */
+    effectiveDateEnd?: string;
+    /**
+     * A date that will be used to filter issues that have an effective date greater
+     * than or equal to the date passed in. Date format: YYYY-MM-DD.
+     */
+    effectiveDateStart?: string;
+    /**
+     * The end date of the evaluation date range. The evaluation date should be less
+     * than or equal to this date.
+     */
+    evaluationDateEnd?: string;
+    /**
+     * The start date of the evaluation date range. The evaluation date should be
+     * greater than or equal to this date.
+     */
+    evaluationDateStart?: string;
+    /**
+     * Filter issues by whether they represent an internet-reachable vulnerability
+     */
+    internetReachableVulnerability?: boolean;
+    /**
+     * Add to filter issues containing CVE IDs from the Known Exploited Vulnerabilities
+     * (KEV) catalog or not
+     */
+    kev?: boolean;
+    /**
+     * Filter issues by whether they represent a likely-exploitable vulnerability
+     */
+    likelyExploitableVulnerability?: boolean;
+    /**
+     * User defined identifier for this issue. You may pass in several `poamId` values
+     * at once. If used, the projectId is required.
+     */
+    poamId?: Array<string>;
+    /**
+     * An id that represents a project within the Paramify application.
+     */
+    projectId?: string;
+    /**
+     * The end date of the status date range. The status date should be less than or
+     * equal to this date.
+     */
+    statusDateEnd?: string;
+    /**
+     * The start date of the status date range. The status date should be greater than
+     * or equal to this date.
+     */
+    statusDateStart?: string;
+    /**
+     * A string that represents the title or part of the title of an issue.
+     */
+    title?: string;
+}
+export interface IssueExportOscalParams {
+    /**
+     * An id that represents a project within the Paramify application.
+     */
+    projectId?: string;
+}
+export declare namespace Issues {
+    export { type Issue as Issue, type IssueObservationTypes as IssueObservationTypes, type Origin as Origin, type IssueUpdateResponse as IssueUpdateResponse, type IssueListResponse as IssueListResponse, type IssueCreateParams as IssueCreateParams, type IssueUpdateParams as IssueUpdateParams, type IssueListParams as IssueListParams, type IssueExportOscalParams as IssueExportOscalParams, };
+    export { Recommendations as Recommendations, type RecommendationsAPIRecommendation as Recommendation, type RecommendationUpdateResponse as RecommendationUpdateResponse, type RecommendationListResponse as RecommendationListResponse, type RecommendationCreateParams as RecommendationCreateParams, type RecommendationRetrieveParams as RecommendationRetrieveParams, type RecommendationUpdateParams as RecommendationUpdateParams, type RecommendationListParams as RecommendationListParams, type RecommendationDeleteParams as RecommendationDeleteParams, };
+    export { Deviations as Deviations, type DeviationsAPIDeviation as Deviation, type DeviationsAPIDeviationMetadata as DeviationMetadata, type DeviationObservationTypes as DeviationObservationTypes, type DeviationUpdateResponse as DeviationUpdateResponse, type DeviationListResponse as DeviationListResponse, type DeviationCreateParams as DeviationCreateParams, type DeviationRetrieveParams as DeviationRetrieveParams, type DeviationUpdateParams as DeviationUpdateParams, type DeviationListParams as DeviationListParams, type DeviationDeleteParams as DeviationDeleteParams, };
+    export { Milestones as Milestones, type MilestonesAPIMilestone as Milestone, type MilestoneCreateResponse as MilestoneCreateResponse, type MilestoneRetrieveResponse as MilestoneRetrieveResponse, type MilestoneUpdateResponse as MilestoneUpdateResponse, type MilestoneListResponse as MilestoneListResponse, type MilestoneCreateParams as MilestoneCreateParams, type MilestoneRetrieveParams as MilestoneRetrieveParams, type MilestoneUpdateParams as MilestoneUpdateParams, type MilestoneListParams as MilestoneListParams, type MilestoneDeleteParams as MilestoneDeleteParams, };
+}
+//# sourceMappingURL=issues.d.ts.map