@silkline/paramify 0.0.2

package/resources/assessments/assessments.d.mts

@@ -0,0 +1,269 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as CyclesAPI from "./cycles.mjs";
+import { Cycle, CycleIntakeParams, CycleIntakeResponse, CycleListParams, CycleListResponse, CycleRetrieveParams, Cycles } from "./cycles.mjs";
+import * as ArtifactsAPI from "../evidence/artifacts.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { type Uploadable } from "../../core/uploads.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Assessments extends APIResource {
+    cycles: CyclesAPI.Cycles;
+    /**
+     * Get a single vulnerability or configuration assessment, including all of its
+     * assessment cycles, by its internal id (UUID).
+     *
+     * @example
+     * ```ts
+     * const assessment = await client.assessments.retrieve(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    retrieve(assessmentID: string, options?: RequestOptions): APIPromise<AssessmentRetrieveResponse>;
+    /**
+     * Get all vulnerability and configuration assessments, with all included
+     * assessment cycles, within a workspace. Assessments can be filtered by id,
+     * frequency, and type.
+     *
+     * @example
+     * ```ts
+     * const assessments = await client.assessments.list();
+     * ```
+     */
+    list(query?: AssessmentListParams | null | undefined, options?: RequestOptions): APIPromise<AssessmentListResponse>;
+    /**
+     * ## Overview
+     *
+     * Uploads a CSV, XML, JSON, or Nessus file as an artifact and attaches it to the
+     * intake on a vulnerability or configuration assessment specified by the
+     * `assessmentId`. Only CSV, XML, JSON, and Nessus files are supported.
+     *
+     * Maximum file size: 10 GB.
+     *
+     * ### Effective Date Handling
+     *
+     * The effective date specified will be used to determine what cycle(s) to upload
+     * the artifact to. If no effective date is specified, the current date will be
+     * used as the effective date.
+     *
+     * ### Cycle Creation and Management
+     *
+     * The artifact will be added to the intake for each cycle on the assessment whose
+     * start and end date overlap the artifact's effective date. If no such cycle can
+     * be found, a new one will be created. The created cycle's start date will be the
+     * beginning of the effective date's month. The cycle's end date will be calculated
+     * based on the assessment's frequency.
+     *
+     * ### Evidence Handling
+     *
+     * If the intake on the cycle does not have an attached evidence, the evidence from
+     * the previous cycle's intake will be used. If there is no previous cycle, a new
+     * evidence will be created.
+     *
+     * ### Multiple Cycle Behavior
+     *
+     * If multiple cycles fall within the range of the artifact's effective date, the
+     * artifact will be attached to each cycle's intake. If the multiple cycle intakes
+     * have different evidences, one artifact will be created for each evidence.
+     *
+     * ### Existing Artifacts
+     *
+     * If any of the cycle intakes already have artifacts attached, the new artifact
+     * will be added without removing existing artifacts.
+     *
+     * @example
+     * ```ts
+     * const response = await client.assessments.intake(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   {
+     *     artifact: {},
+     *     file: fs.createReadStream('path/to/file'),
+     *   },
+     * );
+     * ```
+     */
+    intake(assessmentID: string, body: AssessmentIntakeParams, options?: RequestOptions): APIPromise<AssessmentIntakeResponse>;
+}
+/**
+ * The assessment details with mechanism, target components, and cycles.
+ */
+export interface Assessment {
+    /**
+     * The internal UUID of the assessment. This id can be used as an `assessmentId` in
+     * other endpoints.
+     */
+    id: string;
+    /**
+     * The cycles associated with the assessment.
+     */
+    cycles: Array<CyclesAPI.Cycle>;
+    /**
+     * The frequency of the assessment.
+     */
+    frequency: 'MONTHLY' | 'QUARTERLY' | 'BIANNUALLY' | 'ANNUALLY' | null;
+    /**
+     * The component element used as the mechanism of the assessment.
+     */
+    mechanism: Assessment.Mechanism | null;
+    /**
+     * The name of the assessment.
+     */
+    name: string;
+    /**
+     * The human-readable reference identifier of the assessment.
+     */
+    referenceId: string | null;
+    /**
+     * The target component(s) assigned to the assessment.
+     */
+    targetComponents: Array<Assessment.TargetComponent>;
+    /**
+     * The type of assessment, either vulnerability or configuration (other assessment
+     * types are not supported).
+     */
+    type: 'VULNERABILITY' | 'CONFIGURATION';
+}
+export declare namespace Assessment {
+    /**
+     * The component element used as the mechanism of the assessment.
+     */
+    interface Mechanism {
+        /**
+         * The internal UUID of the assessment mechanism.
+         */
+        id: string;
+        /**
+         * The name of the assessment mechanism.
+         */
+        name: string;
+    }
+    interface TargetComponent {
+        /**
+         * The internal UUID of the target component.
+         */
+        id: string;
+        /**
+         * The name of the target component.
+         */
+        name: string;
+    }
+}
+/**
+ * The single assessment object, including all of its assessment cycles.
+ */
+export interface AssessmentRetrieveResponse {
+    /**
+     * The internal UUID of the assessment. This id can be used as an `assessmentId` in
+     * other endpoints.
+     */
+    id: string;
+    /**
+     * The cycles associated with the assessment.
+     */
+    cycles: Array<CyclesAPI.Cycle>;
+    /**
+     * The frequency of the assessment.
+     */
+    frequency: 'MONTHLY' | 'QUARTERLY' | 'BIANNUALLY' | 'ANNUALLY' | null;
+    /**
+     * The component element used as the mechanism of the assessment.
+     */
+    mechanism: AssessmentRetrieveResponse.Mechanism | null;
+    /**
+     * The name of the assessment.
+     */
+    name: string;
+    /**
+     * The human-readable reference identifier of the assessment.
+     */
+    referenceId: string | null;
+    /**
+     * The target component(s) assigned to the assessment.
+     */
+    targetComponents: Array<AssessmentRetrieveResponse.TargetComponent>;
+    /**
+     * The type of assessment, either vulnerability or configuration (other assessment
+     * types are not supported).
+     */
+    type: 'VULNERABILITY' | 'CONFIGURATION';
+}
+export declare namespace AssessmentRetrieveResponse {
+    /**
+     * The component element used as the mechanism of the assessment.
+     */
+    interface Mechanism {
+        /**
+         * The internal UUID of the assessment mechanism.
+         */
+        id: string;
+        /**
+         * The name of the assessment mechanism.
+         */
+        name: string;
+    }
+    interface TargetComponent {
+        /**
+         * The internal UUID of the target component.
+         */
+        id: string;
+        /**
+         * The name of the target component.
+         */
+        name: string;
+    }
+}
+export interface AssessmentListResponse {
+    /**
+     * Array of assessment objects, including all assessment cycles, matching the
+     * filter criteria. The `id` from each assessment can be used as an `assessmentId`
+     * in other endpoints.
+     */
+    assessments: Array<Assessment>;
+}
+/**
+ * An array of newly created artifacts. Typically only one artifact will be
+ * created, unless multiple assessment cycles overlap the effective date and have
+ * different evidences attached to their intakes. At least one artifact will always
+ * be created if the request was successful.
+ */
+export interface AssessmentIntakeResponse {
+    artifacts: Array<ArtifactsAPI.Artifact>;
+}
+export interface AssessmentListParams {
+    /**
+     * Filter assessments by id. If multiple ids are provided, multiple assessments
+     * will be returned.
+     */
+    id?: Array<string>;
+    /**
+     * Filter assessments by frequency. If multiple frequencies are provided,
+     * assessments with either frequency will be returned.
+     */
+    frequency?: Array<'MONTHLY' | 'QUARTERLY' | 'BIANNUALLY' | 'ANNUALLY'>;
+    /**
+     * Filter assessments by type, either vulnerability or configuration (other
+     * assessment types are not supported).
+     */
+    type?: Array<'CONFIGURATION' | 'VULNERABILITY'>;
+}
+export interface AssessmentIntakeParams {
+    /**
+     * Schema for creating new file artifacts. All fields are optional - you can upload
+     * a file with minimal metadata and enhance it later.
+     */
+    artifact: ArtifactsAPI.UploadArtifact;
+    /**
+     * The file to be uploaded as an artifact. Any file type is supported. The original
+     * filename will be preserved and used as the default title if no title is
+     * specified in the metadata.
+     *
+     * **IMPORTANT**: Filenames containing certain special characters may cause upload
+     * errors. URL-encode your filename to avoid issues -- it will be decoded
+     * automatically.
+     */
+    file: Uploadable;
+}
+export declare namespace Assessments {
+    export { type Assessment as Assessment, type AssessmentRetrieveResponse as AssessmentRetrieveResponse, type AssessmentListResponse as AssessmentListResponse, type AssessmentIntakeResponse as AssessmentIntakeResponse, type AssessmentListParams as AssessmentListParams, type AssessmentIntakeParams as AssessmentIntakeParams, };
+    export { Cycles as Cycles, type Cycle as Cycle, type CycleListResponse as CycleListResponse, type CycleIntakeResponse as CycleIntakeResponse, type CycleRetrieveParams as CycleRetrieveParams, type CycleListParams as CycleListParams, type CycleIntakeParams as CycleIntakeParams, };
+}
+//# sourceMappingURL=assessments.d.mts.map

package/resources/assessments/assessments.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assessments.d.mts","sourceRoot":"","sources":["../../src/resources/assessments/assessments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EACL,KAAK,EACL,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,MAAM,EACP;OACM,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAMxC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,IAAI,CAAC;IAEtE;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAEpD;;;OAGG;IACH,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC;CACzC;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,IAAI,CAAC;IAEtE;;OAEG;IACH,SAAS,EAAE,0BAA0B,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,0BAA0B,CAAC,eAAe,CAAC,CAAC;IAEpE;;;OAGG;IACH,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC;CACzC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,CAAC,CAAC;IAEvE;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,EAAE,YAAY,CAAC,cAAc,CAAC;IAEtC;;;;;;;;OAQG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/assessments/assessments.d.ts

@@ -0,0 +1,269 @@
+import { APIResource } from "../../core/resource.js";
+import * as CyclesAPI from "./cycles.js";
+import { Cycle, CycleIntakeParams, CycleIntakeResponse, CycleListParams, CycleListResponse, CycleRetrieveParams, Cycles } from "./cycles.js";
+import * as ArtifactsAPI from "../evidence/artifacts.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { type Uploadable } from "../../core/uploads.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Assessments extends APIResource {
+    cycles: CyclesAPI.Cycles;
+    /**
+     * Get a single vulnerability or configuration assessment, including all of its
+     * assessment cycles, by its internal id (UUID).
+     *
+     * @example
+     * ```ts
+     * const assessment = await client.assessments.retrieve(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    retrieve(assessmentID: string, options?: RequestOptions): APIPromise<AssessmentRetrieveResponse>;
+    /**
+     * Get all vulnerability and configuration assessments, with all included
+     * assessment cycles, within a workspace. Assessments can be filtered by id,
+     * frequency, and type.
+     *
+     * @example
+     * ```ts
+     * const assessments = await client.assessments.list();
+     * ```
+     */
+    list(query?: AssessmentListParams | null | undefined, options?: RequestOptions): APIPromise<AssessmentListResponse>;
+    /**
+     * ## Overview
+     *
+     * Uploads a CSV, XML, JSON, or Nessus file as an artifact and attaches it to the
+     * intake on a vulnerability or configuration assessment specified by the
+     * `assessmentId`. Only CSV, XML, JSON, and Nessus files are supported.
+     *
+     * Maximum file size: 10 GB.
+     *
+     * ### Effective Date Handling
+     *
+     * The effective date specified will be used to determine what cycle(s) to upload
+     * the artifact to. If no effective date is specified, the current date will be
+     * used as the effective date.
+     *
+     * ### Cycle Creation and Management
+     *
+     * The artifact will be added to the intake for each cycle on the assessment whose
+     * start and end date overlap the artifact's effective date. If no such cycle can
+     * be found, a new one will be created. The created cycle's start date will be the
+     * beginning of the effective date's month. The cycle's end date will be calculated
+     * based on the assessment's frequency.
+     *
+     * ### Evidence Handling
+     *
+     * If the intake on the cycle does not have an attached evidence, the evidence from
+     * the previous cycle's intake will be used. If there is no previous cycle, a new
+     * evidence will be created.
+     *
+     * ### Multiple Cycle Behavior
+     *
+     * If multiple cycles fall within the range of the artifact's effective date, the
+     * artifact will be attached to each cycle's intake. If the multiple cycle intakes
+     * have different evidences, one artifact will be created for each evidence.
+     *
+     * ### Existing Artifacts
+     *
+     * If any of the cycle intakes already have artifacts attached, the new artifact
+     * will be added without removing existing artifacts.
+     *
+     * @example
+     * ```ts
+     * const response = await client.assessments.intake(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   {
+     *     artifact: {},
+     *     file: fs.createReadStream('path/to/file'),
+     *   },
+     * );
+     * ```
+     */
+    intake(assessmentID: string, body: AssessmentIntakeParams, options?: RequestOptions): APIPromise<AssessmentIntakeResponse>;
+}
+/**
+ * The assessment details with mechanism, target components, and cycles.
+ */
+export interface Assessment {
+    /**
+     * The internal UUID of the assessment. This id can be used as an `assessmentId` in
+     * other endpoints.
+     */
+    id: string;
+    /**
+     * The cycles associated with the assessment.
+     */
+    cycles: Array<CyclesAPI.Cycle>;
+    /**
+     * The frequency of the assessment.
+     */
+    frequency: 'MONTHLY' | 'QUARTERLY' | 'BIANNUALLY' | 'ANNUALLY' | null;
+    /**
+     * The component element used as the mechanism of the assessment.
+     */
+    mechanism: Assessment.Mechanism | null;
+    /**
+     * The name of the assessment.
+     */
+    name: string;
+    /**
+     * The human-readable reference identifier of the assessment.
+     */
+    referenceId: string | null;
+    /**
+     * The target component(s) assigned to the assessment.
+     */
+    targetComponents: Array<Assessment.TargetComponent>;
+    /**
+     * The type of assessment, either vulnerability or configuration (other assessment
+     * types are not supported).
+     */
+    type: 'VULNERABILITY' | 'CONFIGURATION';
+}
+export declare namespace Assessment {
+    /**
+     * The component element used as the mechanism of the assessment.
+     */
+    interface Mechanism {
+        /**
+         * The internal UUID of the assessment mechanism.
+         */
+        id: string;
+        /**
+         * The name of the assessment mechanism.
+         */
+        name: string;
+    }
+    interface TargetComponent {
+        /**
+         * The internal UUID of the target component.
+         */
+        id: string;
+        /**
+         * The name of the target component.
+         */
+        name: string;
+    }
+}
+/**
+ * The single assessment object, including all of its assessment cycles.
+ */
+export interface AssessmentRetrieveResponse {
+    /**
+     * The internal UUID of the assessment. This id can be used as an `assessmentId` in
+     * other endpoints.
+     */
+    id: string;
+    /**
+     * The cycles associated with the assessment.
+     */
+    cycles: Array<CyclesAPI.Cycle>;
+    /**
+     * The frequency of the assessment.
+     */
+    frequency: 'MONTHLY' | 'QUARTERLY' | 'BIANNUALLY' | 'ANNUALLY' | null;
+    /**
+     * The component element used as the mechanism of the assessment.
+     */
+    mechanism: AssessmentRetrieveResponse.Mechanism | null;
+    /**
+     * The name of the assessment.
+     */
+    name: string;
+    /**
+     * The human-readable reference identifier of the assessment.
+     */
+    referenceId: string | null;
+    /**
+     * The target component(s) assigned to the assessment.
+     */
+    targetComponents: Array<AssessmentRetrieveResponse.TargetComponent>;
+    /**
+     * The type of assessment, either vulnerability or configuration (other assessment
+     * types are not supported).
+     */
+    type: 'VULNERABILITY' | 'CONFIGURATION';
+}
+export declare namespace AssessmentRetrieveResponse {
+    /**
+     * The component element used as the mechanism of the assessment.
+     */
+    interface Mechanism {
+        /**
+         * The internal UUID of the assessment mechanism.
+         */
+        id: string;
+        /**
+         * The name of the assessment mechanism.
+         */
+        name: string;
+    }
+    interface TargetComponent {
+        /**
+         * The internal UUID of the target component.
+         */
+        id: string;
+        /**
+         * The name of the target component.
+         */
+        name: string;
+    }
+}
+export interface AssessmentListResponse {
+    /**
+     * Array of assessment objects, including all assessment cycles, matching the
+     * filter criteria. The `id` from each assessment can be used as an `assessmentId`
+     * in other endpoints.
+     */
+    assessments: Array<Assessment>;
+}
+/**
+ * An array of newly created artifacts. Typically only one artifact will be
+ * created, unless multiple assessment cycles overlap the effective date and have
+ * different evidences attached to their intakes. At least one artifact will always
+ * be created if the request was successful.
+ */
+export interface AssessmentIntakeResponse {
+    artifacts: Array<ArtifactsAPI.Artifact>;
+}
+export interface AssessmentListParams {
+    /**
+     * Filter assessments by id. If multiple ids are provided, multiple assessments
+     * will be returned.
+     */
+    id?: Array<string>;
+    /**
+     * Filter assessments by frequency. If multiple frequencies are provided,
+     * assessments with either frequency will be returned.
+     */
+    frequency?: Array<'MONTHLY' | 'QUARTERLY' | 'BIANNUALLY' | 'ANNUALLY'>;
+    /**
+     * Filter assessments by type, either vulnerability or configuration (other
+     * assessment types are not supported).
+     */
+    type?: Array<'CONFIGURATION' | 'VULNERABILITY'>;
+}
+export interface AssessmentIntakeParams {
+    /**
+     * Schema for creating new file artifacts. All fields are optional - you can upload
+     * a file with minimal metadata and enhance it later.
+     */
+    artifact: ArtifactsAPI.UploadArtifact;
+    /**
+     * The file to be uploaded as an artifact. Any file type is supported. The original
+     * filename will be preserved and used as the default title if no title is
+     * specified in the metadata.
+     *
+     * **IMPORTANT**: Filenames containing certain special characters may cause upload
+     * errors. URL-encode your filename to avoid issues -- it will be decoded
+     * automatically.
+     */
+    file: Uploadable;
+}
+export declare namespace Assessments {
+    export { type Assessment as Assessment, type AssessmentRetrieveResponse as AssessmentRetrieveResponse, type AssessmentListResponse as AssessmentListResponse, type AssessmentIntakeResponse as AssessmentIntakeResponse, type AssessmentListParams as AssessmentListParams, type AssessmentIntakeParams as AssessmentIntakeParams, };
+    export { Cycles as Cycles, type Cycle as Cycle, type CycleListResponse as CycleListResponse, type CycleIntakeResponse as CycleIntakeResponse, type CycleRetrieveParams as CycleRetrieveParams, type CycleListParams as CycleListParams, type CycleIntakeParams as CycleIntakeParams, };
+}
+//# sourceMappingURL=assessments.d.ts.map

package/resources/assessments/assessments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assessments.d.ts","sourceRoot":"","sources":["../../src/resources/assessments/assessments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EACL,KAAK,EACL,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,MAAM,EACP;OACM,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAMxC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,IAAI,CAAC;IAEtE;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAEpD;;;OAGG;IACH,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC;CACzC;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,IAAI,CAAC;IAEtE;;OAEG;IACH,SAAS,EAAE,0BAA0B,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,0BAA0B,CAAC,eAAe,CAAC,CAAC;IAEpE;;;OAGG;IACH,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC;CACzC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,CAAC,CAAC;IAEvE;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,EAAE,YAAY,CAAC,cAAc,CAAC;IAEtC;;;;;;;;OAQG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/assessments/assessments.js

@@ -0,0 +1,100 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Assessments = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const CyclesAPI = tslib_1.__importStar(require("./cycles.js"));
+const cycles_1 = require("./cycles.js");
+const uploads_1 = require("../../internal/uploads.js");
+const path_1 = require("../../internal/utils/path.js");
+class Assessments extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.cycles = new CyclesAPI.Cycles(this._client);
+    }
+    /**
+     * Get a single vulnerability or configuration assessment, including all of its
+     * assessment cycles, by its internal id (UUID).
+     *
+     * @example
+     * ```ts
+     * const assessment = await client.assessments.retrieve(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    retrieve(assessmentID, options) {
+        return this._client.get((0, path_1.path) `/assessment/${assessmentID}`, options);
+    }
+    /**
+     * Get all vulnerability and configuration assessments, with all included
+     * assessment cycles, within a workspace. Assessments can be filtered by id,
+     * frequency, and type.
+     *
+     * @example
+     * ```ts
+     * const assessments = await client.assessments.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/assessment', { query, ...options });
+    }
+    /**
+     * ## Overview
+     *
+     * Uploads a CSV, XML, JSON, or Nessus file as an artifact and attaches it to the
+     * intake on a vulnerability or configuration assessment specified by the
+     * `assessmentId`. Only CSV, XML, JSON, and Nessus files are supported.
+     *
+     * Maximum file size: 10 GB.
+     *
+     * ### Effective Date Handling
+     *
+     * The effective date specified will be used to determine what cycle(s) to upload
+     * the artifact to. If no effective date is specified, the current date will be
+     * used as the effective date.
+     *
+     * ### Cycle Creation and Management
+     *
+     * The artifact will be added to the intake for each cycle on the assessment whose
+     * start and end date overlap the artifact's effective date. If no such cycle can
+     * be found, a new one will be created. The created cycle's start date will be the
+     * beginning of the effective date's month. The cycle's end date will be calculated
+     * based on the assessment's frequency.
+     *
+     * ### Evidence Handling
+     *
+     * If the intake on the cycle does not have an attached evidence, the evidence from
+     * the previous cycle's intake will be used. If there is no previous cycle, a new
+     * evidence will be created.
+     *
+     * ### Multiple Cycle Behavior
+     *
+     * If multiple cycles fall within the range of the artifact's effective date, the
+     * artifact will be attached to each cycle's intake. If the multiple cycle intakes
+     * have different evidences, one artifact will be created for each evidence.
+     *
+     * ### Existing Artifacts
+     *
+     * If any of the cycle intakes already have artifacts attached, the new artifact
+     * will be added without removing existing artifacts.
+     *
+     * @example
+     * ```ts
+     * const response = await client.assessments.intake(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   {
+     *     artifact: {},
+     *     file: fs.createReadStream('path/to/file'),
+     *   },
+     * );
+     * ```
+     */
+    intake(assessmentID, body, options) {
+        return this._client.post((0, path_1.path) `/assessment/${assessmentID}/intake`, (0, uploads_1.multipartFormRequestOptions)({ body, ...options }, this._client));
+    }
+}
+exports.Assessments = Assessments;
+Assessments.Cycles = cycles_1.Cycles;
+//# sourceMappingURL=assessments.js.map

package/resources/assessments/assessments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assessments.js","sourceRoot":"","sources":["../../src/resources/assessments/assessments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,+DAAsC;AACtC,wCAQkB;AAKlB,uDAAqE;AACrE,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+FhE,CAAC;IA7FC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CACJ,YAAoB,EACpB,IAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,WAAI,EAAA,eAAe,YAAY,SAAS,EACxC,IAAA,qCAA2B,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF;AAhGD,kCAgGC;AAoND,WAAW,CAAC,MAAM,GAAG,eAAM,CAAC"}