@silkline/paramify 0.0.2

package/resources/assessments/assessments.mjs

@@ -0,0 +1,95 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as CyclesAPI from "./cycles.mjs";
+import { Cycles, } from "./cycles.mjs";
+import { multipartFormRequestOptions } from "../../internal/uploads.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Assessments extends 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(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(path `/assessment/${assessmentID}/intake`, multipartFormRequestOptions({ body, ...options }, this._client));
+    }
+}
+Assessments.Cycles = Cycles;
+//# sourceMappingURL=assessments.mjs.map

package/resources/assessments/assessments.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"assessments.mjs","sourceRoot":"","sources":["../../src/resources/assessments/assessments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAOL,MAAM,GACP;OAKM,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;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,IAAI,CAAA,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,IAAI,CAAA,eAAe,YAAY,SAAS,EACxC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF;AAoND,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC"}

package/resources/assessments/cycles.d.mts

@@ -0,0 +1,209 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Cycles extends APIResource {
+    /**
+     * Get a specific assessment cycle from a vulnerability or configuration assessment
+     * specified by the `assessmentId` and `cycleId`.
+     *
+     * @example
+     * ```ts
+     * const cycle = await client.assessments.cycles.retrieve(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   { assessmentId: '123e4567-e89b-12d3-a456-426614174000' },
+     * );
+     * ```
+     */
+    retrieve(cycleID: string, params: CycleRetrieveParams, options?: RequestOptions): APIPromise<Cycle>;
+    /**
+     * Get the assessment cycles on a vulnerability or configuration assessment
+     * specified by the `assessmentId`. Assessment cycles can optionally be filtered by
+     * id, start date, or end date.
+     *
+     * @example
+     * ```ts
+     * const cycles = await client.assessments.cycles.list(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    list(assessmentID: string, query?: CycleListParams | null | undefined, options?: RequestOptions): APIPromise<CycleListResponse>;
+    /**
+     * ## Overview
+     *
+     * Attaches an existing CSV, XML, JSON, or Nessus file artifact to the intake of
+     * the assessment cycle specified by the `assessmentId` and `cycleId`. Only file
+     * artifacts with a CSV, XML, JSON, or Nessus file will be accepted. The specified
+     * cycle must be a cycle on the specified assessment.
+     *
+     * ### Evidence Handling
+     *
+     * If the cycle's intake does not have an attached evidence, the evidence the
+     * artifact is attached to will automatically be attached to the intake. If the
+     * evidence attached to the cycle's intake is different from the evidence that the
+     * artifact is on, an error will be thrown.
+     *
+     * ### Existing Artifacts
+     *
+     * If the cycle's intake already has artifacts attached, the new artifact will be
+     * added without removing existing artifacts.
+     *
+     * @example
+     * ```ts
+     * const response = await client.assessments.cycles.intake(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   {
+     *     assessmentId: '123e4567-e89b-12d3-a456-426614174000',
+     *     artifactId: '123e4567-e89b-12d3-a456-426614174000',
+     *   },
+     * );
+     * ```
+     */
+    intake(cycleID: string, params: CycleIntakeParams, options?: RequestOptions): APIPromise<CycleIntakeResponse>;
+}
+/**
+ * An object containing information about an assessment cycle.
+ */
+export interface Cycle {
+    /**
+     * The internal uuid that uniquely identifies an assessment cycle.
+     */
+    id: string;
+    /**
+     * The ISO 8601 timestamp when the assessment cycle was created.
+     */
+    createdAt: string;
+    /**
+     * The ISO 8601 date when the assessment cycle ends.
+     */
+    endDate: string;
+    /**
+     * The name of the assessment cycle. By default this is the month the cycle began
+     * or the year of the cycle for annual cycles.
+     */
+    name: string;
+    /**
+     * A custom reference identifier for the assessment cycle.
+     */
+    referenceId: string | null;
+    /**
+     * The ISO 8601 date when the assessment cycle begins.
+     */
+    startDate: string;
+}
+/**
+ * Array of assessment cycle objects matching the filter criteria. The `id` from
+ * each cycle can be used as a `cycleId` in other endpoints.
+ */
+export interface CycleListResponse {
+    cycles: Array<Cycle>;
+}
+/**
+ * The artifact that was attached to the assessment cycle's intake.
+ */
+export interface CycleIntakeResponse {
+    /**
+     * Unique identifier for the artifact
+     */
+    id: string;
+    /**
+     * ISO 8601 timestamp when the artifact was created in the system
+     */
+    createdAt: string;
+    /**
+     * Information about the user who created the artifact
+     */
+    createdBy: CycleIntakeResponse.CreatedBy;
+    /**
+     * Indicates the artifact type: true for URL artifacts, false for uploaded file
+     * artifacts
+     */
+    isUrl: boolean;
+    /**
+     * For file artifacts: the direct URL to retrieve the stored file. This link may
+     * expire after about 60 minutes; request the artifact again to get a new link. For
+     * URL artifacts: this is the full external URL to the resource.
+     */
+    pathname: string;
+    /**
+     * Display title of the artifact. For file uploads, this defaults to the original
+     * filename if not provided during creation.
+     */
+    title: string;
+    /**
+     * Information about the validators that have run or are running on the artifact
+     */
+    validators: Array<CycleIntakeResponse.Validator>;
+    /**
+     * The date when this artifact was effective or relevant. This may differ from
+     * createdAt and represents when the data was actually valid.
+     */
+    effectiveDate?: string;
+    /**
+     * MIME type of the file (e.g., application/pdf, image/png). This field is null for
+     * URL artifacts.
+     */
+    fileType?: string | null;
+    /**
+     * Additional notes or comments about the artifact. Can be null if no note was
+     * provided.
+     */
+    note?: string | null;
+    /**
+     * The original filename when the artifact was uploaded. This field is null for URL
+     * artifacts.
+     */
+    originalFileName?: string | null;
+}
+export declare namespace CycleIntakeResponse {
+    /**
+     * Information about the user who created the artifact
+     */
+    interface CreatedBy {
+        email: string | null;
+        username: string | null;
+    }
+    interface Validator {
+        id: string | null;
+        name: string;
+        result: 'PASS' | 'FAIL' | 'NOT_SET' | 'ERROR' | null;
+    }
+}
+export interface CycleRetrieveParams {
+    /**
+     * An id that represents an assessment within the Paramify application.
+     */
+    assessmentId: string;
+}
+export interface CycleListParams {
+    /**
+     * Filter cycles by internal id (UUID). If multiple ids are provided, multiple
+     * cycles will be returned.
+     */
+    cycleId?: Array<string>;
+    /**
+     * Filter cycles by their end date. Date format should be YYYY-MM-DD. If multiple
+     * dates are provided, any cycle with any of those end dates will be returned.
+     */
+    endDate?: Array<string>;
+    /**
+     * Filter cycles by their start date. Date format should be YYYY-MM-DD. If multiple
+     * dates are provided, any cycle with any of those start dates will be returned.
+     */
+    startDate?: Array<string>;
+}
+export interface CycleIntakeParams {
+    /**
+     * Path param: An id that represents an assessment within the Paramify application.
+     */
+    assessmentId: string;
+    /**
+     * Body param: The internal uuid of the CSV file artifact to attach to the
+     * assessment cycle's intake.
+     */
+    artifactId: string;
+}
+export declare namespace Cycles {
+    export { 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=cycles.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cycles.d.mts","sourceRoot":"","sources":["../../src/resources/assessments/cycles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAKnG;;;;;;;;;;;OAWG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAInC;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAEzC;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAEjD;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,SAAS;QACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,SAAS;QACxB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC;KACtD;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,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/cycles.d.ts

@@ -0,0 +1,209 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Cycles extends APIResource {
+    /**
+     * Get a specific assessment cycle from a vulnerability or configuration assessment
+     * specified by the `assessmentId` and `cycleId`.
+     *
+     * @example
+     * ```ts
+     * const cycle = await client.assessments.cycles.retrieve(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   { assessmentId: '123e4567-e89b-12d3-a456-426614174000' },
+     * );
+     * ```
+     */
+    retrieve(cycleID: string, params: CycleRetrieveParams, options?: RequestOptions): APIPromise<Cycle>;
+    /**
+     * Get the assessment cycles on a vulnerability or configuration assessment
+     * specified by the `assessmentId`. Assessment cycles can optionally be filtered by
+     * id, start date, or end date.
+     *
+     * @example
+     * ```ts
+     * const cycles = await client.assessments.cycles.list(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    list(assessmentID: string, query?: CycleListParams | null | undefined, options?: RequestOptions): APIPromise<CycleListResponse>;
+    /**
+     * ## Overview
+     *
+     * Attaches an existing CSV, XML, JSON, or Nessus file artifact to the intake of
+     * the assessment cycle specified by the `assessmentId` and `cycleId`. Only file
+     * artifacts with a CSV, XML, JSON, or Nessus file will be accepted. The specified
+     * cycle must be a cycle on the specified assessment.
+     *
+     * ### Evidence Handling
+     *
+     * If the cycle's intake does not have an attached evidence, the evidence the
+     * artifact is attached to will automatically be attached to the intake. If the
+     * evidence attached to the cycle's intake is different from the evidence that the
+     * artifact is on, an error will be thrown.
+     *
+     * ### Existing Artifacts
+     *
+     * If the cycle's intake already has artifacts attached, the new artifact will be
+     * added without removing existing artifacts.
+     *
+     * @example
+     * ```ts
+     * const response = await client.assessments.cycles.intake(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   {
+     *     assessmentId: '123e4567-e89b-12d3-a456-426614174000',
+     *     artifactId: '123e4567-e89b-12d3-a456-426614174000',
+     *   },
+     * );
+     * ```
+     */
+    intake(cycleID: string, params: CycleIntakeParams, options?: RequestOptions): APIPromise<CycleIntakeResponse>;
+}
+/**
+ * An object containing information about an assessment cycle.
+ */
+export interface Cycle {
+    /**
+     * The internal uuid that uniquely identifies an assessment cycle.
+     */
+    id: string;
+    /**
+     * The ISO 8601 timestamp when the assessment cycle was created.
+     */
+    createdAt: string;
+    /**
+     * The ISO 8601 date when the assessment cycle ends.
+     */
+    endDate: string;
+    /**
+     * The name of the assessment cycle. By default this is the month the cycle began
+     * or the year of the cycle for annual cycles.
+     */
+    name: string;
+    /**
+     * A custom reference identifier for the assessment cycle.
+     */
+    referenceId: string | null;
+    /**
+     * The ISO 8601 date when the assessment cycle begins.
+     */
+    startDate: string;
+}
+/**
+ * Array of assessment cycle objects matching the filter criteria. The `id` from
+ * each cycle can be used as a `cycleId` in other endpoints.
+ */
+export interface CycleListResponse {
+    cycles: Array<Cycle>;
+}
+/**
+ * The artifact that was attached to the assessment cycle's intake.
+ */
+export interface CycleIntakeResponse {
+    /**
+     * Unique identifier for the artifact
+     */
+    id: string;
+    /**
+     * ISO 8601 timestamp when the artifact was created in the system
+     */
+    createdAt: string;
+    /**
+     * Information about the user who created the artifact
+     */
+    createdBy: CycleIntakeResponse.CreatedBy;
+    /**
+     * Indicates the artifact type: true for URL artifacts, false for uploaded file
+     * artifacts
+     */
+    isUrl: boolean;
+    /**
+     * For file artifacts: the direct URL to retrieve the stored file. This link may
+     * expire after about 60 minutes; request the artifact again to get a new link. For
+     * URL artifacts: this is the full external URL to the resource.
+     */
+    pathname: string;
+    /**
+     * Display title of the artifact. For file uploads, this defaults to the original
+     * filename if not provided during creation.
+     */
+    title: string;
+    /**
+     * Information about the validators that have run or are running on the artifact
+     */
+    validators: Array<CycleIntakeResponse.Validator>;
+    /**
+     * The date when this artifact was effective or relevant. This may differ from
+     * createdAt and represents when the data was actually valid.
+     */
+    effectiveDate?: string;
+    /**
+     * MIME type of the file (e.g., application/pdf, image/png). This field is null for
+     * URL artifacts.
+     */
+    fileType?: string | null;
+    /**
+     * Additional notes or comments about the artifact. Can be null if no note was
+     * provided.
+     */
+    note?: string | null;
+    /**
+     * The original filename when the artifact was uploaded. This field is null for URL
+     * artifacts.
+     */
+    originalFileName?: string | null;
+}
+export declare namespace CycleIntakeResponse {
+    /**
+     * Information about the user who created the artifact
+     */
+    interface CreatedBy {
+        email: string | null;
+        username: string | null;
+    }
+    interface Validator {
+        id: string | null;
+        name: string;
+        result: 'PASS' | 'FAIL' | 'NOT_SET' | 'ERROR' | null;
+    }
+}
+export interface CycleRetrieveParams {
+    /**
+     * An id that represents an assessment within the Paramify application.
+     */
+    assessmentId: string;
+}
+export interface CycleListParams {
+    /**
+     * Filter cycles by internal id (UUID). If multiple ids are provided, multiple
+     * cycles will be returned.
+     */
+    cycleId?: Array<string>;
+    /**
+     * Filter cycles by their end date. Date format should be YYYY-MM-DD. If multiple
+     * dates are provided, any cycle with any of those end dates will be returned.
+     */
+    endDate?: Array<string>;
+    /**
+     * Filter cycles by their start date. Date format should be YYYY-MM-DD. If multiple
+     * dates are provided, any cycle with any of those start dates will be returned.
+     */
+    startDate?: Array<string>;
+}
+export interface CycleIntakeParams {
+    /**
+     * Path param: An id that represents an assessment within the Paramify application.
+     */
+    assessmentId: string;
+    /**
+     * Body param: The internal uuid of the CSV file artifact to attach to the
+     * assessment cycle's intake.
+     */
+    artifactId: string;
+}
+export declare namespace Cycles {
+    export { 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=cycles.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cycles.d.ts","sourceRoot":"","sources":["../../src/resources/assessments/cycles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAKnG;;;;;;;;;;;OAWG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAInC;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAEzC;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAEjD;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,SAAS;QACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,SAAS;QACxB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC;KACtD;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,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/cycles.js

@@ -0,0 +1,76 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cycles = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Cycles extends resource_1.APIResource {
+    /**
+     * Get a specific assessment cycle from a vulnerability or configuration assessment
+     * specified by the `assessmentId` and `cycleId`.
+     *
+     * @example
+     * ```ts
+     * const cycle = await client.assessments.cycles.retrieve(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   { assessmentId: '123e4567-e89b-12d3-a456-426614174000' },
+     * );
+     * ```
+     */
+    retrieve(cycleID, params, options) {
+        const { assessmentId } = params;
+        return this._client.get((0, path_1.path) `/assessment/${assessmentId}/cycle/${cycleID}`, options);
+    }
+    /**
+     * Get the assessment cycles on a vulnerability or configuration assessment
+     * specified by the `assessmentId`. Assessment cycles can optionally be filtered by
+     * id, start date, or end date.
+     *
+     * @example
+     * ```ts
+     * const cycles = await client.assessments.cycles.list(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    list(assessmentID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/assessment/${assessmentID}/cycle`, { query, ...options });
+    }
+    /**
+     * ## Overview
+     *
+     * Attaches an existing CSV, XML, JSON, or Nessus file artifact to the intake of
+     * the assessment cycle specified by the `assessmentId` and `cycleId`. Only file
+     * artifacts with a CSV, XML, JSON, or Nessus file will be accepted. The specified
+     * cycle must be a cycle on the specified assessment.
+     *
+     * ### Evidence Handling
+     *
+     * If the cycle's intake does not have an attached evidence, the evidence the
+     * artifact is attached to will automatically be attached to the intake. If the
+     * evidence attached to the cycle's intake is different from the evidence that the
+     * artifact is on, an error will be thrown.
+     *
+     * ### Existing Artifacts
+     *
+     * If the cycle's intake already has artifacts attached, the new artifact will be
+     * added without removing existing artifacts.
+     *
+     * @example
+     * ```ts
+     * const response = await client.assessments.cycles.intake(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   {
+     *     assessmentId: '123e4567-e89b-12d3-a456-426614174000',
+     *     artifactId: '123e4567-e89b-12d3-a456-426614174000',
+     *   },
+     * );
+     * ```
+     */
+    intake(cycleID, params, options) {
+        const { assessmentId, ...body } = params;
+        return this._client.post((0, path_1.path) `/assessment/${assessmentId}/cycle/${cycleID}/intake`, { body, ...options });
+    }
+}
+exports.Cycles = Cycles;
+//# sourceMappingURL=cycles.js.map

package/resources/assessments/cycles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cycles.js","sourceRoot":"","sources":["../../src/resources/assessments/cycles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAe,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,YAAY,UAAU,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,YAAoB,EACpB,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,YAAY,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CACJ,OAAe,EACf,MAAyB,EACzB,OAAwB;QAExB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,YAAY,UAAU,OAAO,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;CACF;AA7ED,wBA6EC"}

package/resources/assessments/cycles.mjs

@@ -0,0 +1,72 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Cycles extends APIResource {
+    /**
+     * Get a specific assessment cycle from a vulnerability or configuration assessment
+     * specified by the `assessmentId` and `cycleId`.
+     *
+     * @example
+     * ```ts
+     * const cycle = await client.assessments.cycles.retrieve(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   { assessmentId: '123e4567-e89b-12d3-a456-426614174000' },
+     * );
+     * ```
+     */
+    retrieve(cycleID, params, options) {
+        const { assessmentId } = params;
+        return this._client.get(path `/assessment/${assessmentId}/cycle/${cycleID}`, options);
+    }
+    /**
+     * Get the assessment cycles on a vulnerability or configuration assessment
+     * specified by the `assessmentId`. Assessment cycles can optionally be filtered by
+     * id, start date, or end date.
+     *
+     * @example
+     * ```ts
+     * const cycles = await client.assessments.cycles.list(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     * );
+     * ```
+     */
+    list(assessmentID, query = {}, options) {
+        return this._client.get(path `/assessment/${assessmentID}/cycle`, { query, ...options });
+    }
+    /**
+     * ## Overview
+     *
+     * Attaches an existing CSV, XML, JSON, or Nessus file artifact to the intake of
+     * the assessment cycle specified by the `assessmentId` and `cycleId`. Only file
+     * artifacts with a CSV, XML, JSON, or Nessus file will be accepted. The specified
+     * cycle must be a cycle on the specified assessment.
+     *
+     * ### Evidence Handling
+     *
+     * If the cycle's intake does not have an attached evidence, the evidence the
+     * artifact is attached to will automatically be attached to the intake. If the
+     * evidence attached to the cycle's intake is different from the evidence that the
+     * artifact is on, an error will be thrown.
+     *
+     * ### Existing Artifacts
+     *
+     * If the cycle's intake already has artifacts attached, the new artifact will be
+     * added without removing existing artifacts.
+     *
+     * @example
+     * ```ts
+     * const response = await client.assessments.cycles.intake(
+     *   '123e4567-e89b-12d3-a456-426614174000',
+     *   {
+     *     assessmentId: '123e4567-e89b-12d3-a456-426614174000',
+     *     artifactId: '123e4567-e89b-12d3-a456-426614174000',
+     *   },
+     * );
+     * ```
+     */
+    intake(cycleID, params, options) {
+        const { assessmentId, ...body } = params;
+        return this._client.post(path `/assessment/${assessmentId}/cycle/${cycleID}/intake`, { body, ...options });
+    }
+}
+//# sourceMappingURL=cycles.mjs.map