@silkline/paramify 0.0.2

package/src/resources/assessments/cycles.ts

@@ -0,0 +1,267 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+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: string, params: CycleRetrieveParams, options?: RequestOptions): APIPromise<Cycle> {
+    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: string,
+    query: CycleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CycleListResponse> {
+    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: string,
+    params: CycleIntakeParams,
+    options?: RequestOptions,
+  ): APIPromise<CycleIntakeResponse> {
+    const { assessmentId, ...body } = params;
+    return this._client.post(path`/assessment/${assessmentId}/cycle/${cycleID}/intake`, { body, ...options });
+  }
+}
+
+/**
+ * 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 namespace CycleIntakeResponse {
+  /**
+   * Information about the user who created the artifact
+   */
+  export interface CreatedBy {
+    email: string | null;
+
+    username: string | null;
+  }
+
+  export 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,
+  };
+}

package/src/resources/assessments/index.ts

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Assessments,
+  type Assessment,
+  type AssessmentRetrieveResponse,
+  type AssessmentListResponse,
+  type AssessmentIntakeResponse,
+  type AssessmentListParams,
+  type AssessmentIntakeParams,
+} from './assessments';
+export {
+  Cycles,
+  type Cycle,
+  type CycleListResponse,
+  type CycleIntakeResponse,
+  type CycleRetrieveParams,
+  type CycleListParams,
+  type CycleIntakeParams,
+} from './cycles';

package/src/resources/assessments.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './assessments/index';

package/src/resources/audit-assessments/audit-assessments.ts

@@ -0,0 +1,92 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ControlImplementationsAPI from './control-implementations';
+import { ControlImplementationListResponse, ControlImplementations } from './control-implementations';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class AuditAssessments extends APIResource {
+  controlImplementations: ControlImplementationsAPI.ControlImplementations =
+    new ControlImplementationsAPI.ControlImplementations(this._client);
+
+  /**
+   * Retrieves a specific audit assessment by its internal ID (UUID). Returns the
+   * complete audit assessment object with all associated data.
+   */
+  retrieve(auditAssessmentID: string, options?: RequestOptions): APIPromise<AuditAssessmentRetrieveResponse> {
+    return this._client.get(path`/audit-assessments/${auditAssessmentID}`, options);
+  }
+
+  /**
+   * Get all audit assessments
+   */
+  list(options?: RequestOptions): APIPromise<AuditAssessmentListResponse> {
+    return this._client.get('/audit-assessments', options);
+  }
+}
+
+export interface AuditAssessmentRetrieveResponse {
+  /**
+   * A uuid that uniquely identifies an individual audit assessment within Paramify
+   */
+  id: string;
+
+  /**
+   * The name of the audit assessment
+   */
+  name: string;
+
+  /**
+   * The ID that represents a project within the Paramify application.
+   */
+  projectId: string;
+
+  /**
+   * The name of the project
+   */
+  projectName: string;
+}
+
+export interface AuditAssessmentListResponse {
+  auditAssessments: Array<AuditAssessmentListResponse.AuditAssessment>;
+}
+
+export namespace AuditAssessmentListResponse {
+  export interface AuditAssessment {
+    /**
+     * A uuid that uniquely identifies an individual audit assessment within Paramify
+     */
+    id: string;
+
+    /**
+     * The name of the audit assessment
+     */
+    name: string;
+
+    /**
+     * The ID that represents a project within the Paramify application.
+     */
+    projectId: string;
+
+    /**
+     * The name of the project
+     */
+    projectName: string;
+  }
+}
+
+AuditAssessments.ControlImplementations = ControlImplementations;
+
+export declare namespace AuditAssessments {
+  export {
+    type AuditAssessmentRetrieveResponse as AuditAssessmentRetrieveResponse,
+    type AuditAssessmentListResponse as AuditAssessmentListResponse,
+  };
+
+  export {
+    ControlImplementations as ControlImplementations,
+    type ControlImplementationListResponse as ControlImplementationListResponse,
+  };
+}

package/src/resources/audit-assessments/control-implementations.ts

@@ -0,0 +1,49 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class ControlImplementations extends APIResource {
+  /**
+   * Retrieves all control implementations associated with the specified audit
+   * assessment. Control implementations represent how controls are implemented and
+   * tested within the audit context.
+   */
+  list(auditAssessmentID: string, options?: RequestOptions): APIPromise<ControlImplementationListResponse> {
+    return this._client.get(path`/audit-assessments/${auditAssessmentID}/control-implementations`, options);
+  }
+}
+
+export interface ControlImplementationListResponse {
+  controlImplementations: Array<ControlImplementationListResponse.ControlImplementation>;
+}
+
+export namespace ControlImplementationListResponse {
+  export interface ControlImplementation {
+    /**
+     * A uuid that uniquely identifies an individual element within Paramify
+     */
+    id: string;
+
+    /**
+     * The name of the control
+     */
+    control: string;
+
+    /**
+     * The full name of the control implementation
+     */
+    name: string;
+
+    /**
+     * The name of the requirement
+     */
+    requirement: string;
+  }
+}
+
+export declare namespace ControlImplementations {
+  export { type ControlImplementationListResponse as ControlImplementationListResponse };
+}

package/src/resources/audit-assessments/index.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AuditAssessments,
+  type AuditAssessmentRetrieveResponse,
+  type AuditAssessmentListResponse,
+} from './audit-assessments';
+export { ControlImplementations, type ControlImplementationListResponse } from './control-implementations';

package/src/resources/audit-assessments.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './audit-assessments/index';

package/src/resources/elements.ts

@@ -0,0 +1,152 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Elements extends APIResource {
+  /**
+   * Retrieves a specific element by its internal ID (UUID). Returns the complete
+   * element object.
+   */
+  retrieve(elementID: string, options?: RequestOptions): APIPromise<ElementRetrieveResponse> {
+    return this._client.get(path`/elements/${elementID}`, options);
+  }
+
+  /**
+   * Get all elements
+   */
+  list(options?: RequestOptions): APIPromise<ElementListResponse> {
+    return this._client.get('/elements', options);
+  }
+}
+
+export interface ElementRetrieveResponse {
+  /**
+   * A uuid that uniquely identifies an individual element within Paramify
+   */
+  id: string;
+
+  /**
+   * The name of the element
+   */
+  name: string;
+
+  /**
+   * The short name of the element
+   */
+  shortName: string;
+
+  /**
+   * The subtype of the element
+   */
+  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 type of the element
+   */
+  type: 'COMPONENT' | 'PARTY' | 'ROLE' | 'LOCATION' | 'DATA';
+}
+
+export interface ElementListResponse {
+  elements: Array<ElementListResponse.Element>;
+}
+
+export namespace ElementListResponse {
+  export interface Element {
+    /**
+     * A uuid that uniquely identifies an individual element within Paramify
+     */
+    id: string;
+
+    /**
+     * The name of the element
+     */
+    name: string;
+
+    /**
+     * The short name of the element
+     */
+    shortName: string;
+
+    /**
+     * The subtype of the element
+     */
+    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 type of the element
+     */
+    type: 'COMPONENT' | 'PARTY' | 'ROLE' | 'LOCATION' | 'DATA';
+  }
+}
+
+export declare namespace Elements {
+  export {
+    type ElementRetrieveResponse as ElementRetrieveResponse,
+    type ElementListResponse as ElementListResponse,
+  };
+}