@silkline/paramify 0.0.2

package/src/resources/evidence/evidence.ts

@@ -0,0 +1,609 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ArtifactsAPI from './artifacts';
+import {
+  Artifact,
+  ArtifactAddURLParams,
+  ArtifactArtifactAssociateParams,
+  ArtifactDeleteParams,
+  ArtifactListParams,
+  ArtifactListResponse,
+  ArtifactRetrieveParams,
+  ArtifactRetrieveResponse,
+  ArtifactUpdateParams,
+  ArtifactUpdateResponse,
+  ArtifactUploadParams,
+  Artifacts,
+  PatchArtifact,
+  PostURLArtifact,
+  UploadArtifact,
+} from './artifacts';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Evidence extends APIResource {
+  artifacts: ArtifactsAPI.Artifacts = new ArtifactsAPI.Artifacts(this._client);
+
+  /**
+   * Creates a new evidence record as a container for artifacts and compliance
+   * documentation.
+   *
+   * @example
+   * ```ts
+   * const evidence = await client.evidence.create({
+   *   name: 'Example name',
+   * });
+   * ```
+   */
+  create(body: EvidenceCreateParams, options?: RequestOptions): APIPromise<EvidenceCreateResponse> {
+    return this._client.post('/evidence', { body, ...options });
+  }
+
+  /**
+   * Retrieves a specific evidence record by its internal ID (UUID). Instructions and
+   * remarks are converted from rich text. Use the dedicated artifacts endpoint to
+   * retrieve artifacts.
+   *
+   * @example
+   * ```ts
+   * const evidence = await client.evidence.retrieve(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
+   */
+  retrieve(evidenceID: string, options?: RequestOptions): APIPromise<EvidenceRetrieveResponse> {
+    return this._client.get(path`/evidence/${evidenceID}`, options);
+  }
+
+  /**
+   * Updates an existing evidence record. Only provided fields are modified, others
+   * remain unchanged. `referenceId` must be unique if provided.
+   *
+   * @example
+   * ```ts
+   * const evidence = await client.evidence.update(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
+   */
+  update(
+    evidenceID: string,
+    body: EvidenceUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<EvidenceUpdateResponse> {
+    return this._client.patch(path`/evidence/${evidenceID}`, { body, ...options });
+  }
+
+  /**
+   * Retrieves all evidence records from your workspace. Filter by id (internal
+   * UUIDs) or referenceId (custom identifiers like "EVD-1"). Use the dedicated
+   * artifacts endpoint to retrieve artifacts for a specific evidence.
+   *
+   * @example
+   * ```ts
+   * const evidences = await client.evidence.list();
+   * ```
+   */
+  list(
+    query: EvidenceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EvidenceListResponse> {
+    return this._client.get('/evidence', { query, ...options });
+  }
+
+  /**
+   * Permanently deletes an evidence record and all associated artifacts. This
+   * operation is irreversible and creates an activity entry. All artifacts and files
+   * are also deleted.
+   *
+   * @example
+   * ```ts
+   * await client.evidence.delete(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
+   */
+  delete(evidenceID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/evidence/${evidenceID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Associates or disassociates an evidence record with a subject. Supported subject
+   * types are: `CONTROL_IMPLEMENTATION`, `SOLUTION_CAPABILITY`, `ELEMENT`, and
+   * `VALIDATOR`. Use the `associationType` field to connect or disconnect the
+   * association.
+   *
+   * @example
+   * ```ts
+   * await client.evidence.associate(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   {
+   *     associationType: 'CONNECT',
+   *     subjectId: '123e4567-e89b-12d3-a456-426614174000',
+   *     subjectType: 'CONTROL_IMPLEMENTATION',
+   *   },
+   * );
+   * ```
+   */
+  associate(evidenceID: string, body: EvidenceAssociateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/evidence/${evidenceID}/associate`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+/**
+ * Schema for creating new evidence records
+ */
+export interface PostEvidence {
+  /**
+   * The name or title of the evidence
+   */
+  name: string;
+
+  /**
+   * A detailed description of the evidence
+   */
+  description?: string | null;
+
+  /**
+   * The frequency of evidence artifacts collection
+   */
+  frequency?:
+    | 'NOT_SET'
+    | 'DAILY'
+    | 'THREE_DAY'
+    | 'WEEKLY'
+    | 'BIWEEKLY'
+    | 'MONTHLY'
+    | 'QUARTERLY'
+    | 'BIANNUAL'
+    | 'ANNUAL';
+
+  /**
+   * Instructions for how to use or interpret this evidence
+   */
+  instructions?: string | null;
+
+  /**
+   * A custom reference identifier for the evidence. Must be unique. If not provided,
+   * a system-generated ID will be used.
+   */
+  referenceId?: string | null;
+
+  /**
+   * Additional remarks or notes about the evidence
+   */
+  remarks?: string | null;
+
+  /**
+   * The start date for the evidence collection frequency schedule (YYYY-MM-DD)
+   */
+  startDate?: string | null;
+}
+
+export interface EvidenceCreateResponse {
+  /**
+   * Internal UUID identifier for the evidence record
+   */
+  id: string;
+
+  /**
+   * The number of artifacts associated with this evidence
+   */
+  artifactCount: number;
+
+  /**
+   * Indicates whether this evidence was collected through automated processes
+   */
+  automated: boolean;
+
+  /**
+   * The frequency of evidence artifacts collection
+   */
+  frequency:
+    | 'NOT_SET'
+    | 'DAILY'
+    | 'THREE_DAY'
+    | 'WEEKLY'
+    | 'BIWEEKLY'
+    | 'MONTHLY'
+    | 'QUARTERLY'
+    | 'BIANNUAL'
+    | 'ANNUAL';
+
+  /**
+   * Display name or title of the evidence
+   */
+  name: string;
+
+  /**
+   * Detailed description of what this evidence represents
+   */
+  description?: string;
+
+  /**
+   * Instructions for how to use or interpret this evidence (converted from rich
+   * text)
+   */
+  instructions?: string;
+
+  /**
+   * Human-readable reference identifier (e.g., "EVD-001")
+   */
+  referenceId?: string | null;
+
+  /**
+   * Additional notes or comments about the evidence (converted from rich text)
+   */
+  remarks?: string;
+
+  /**
+   * The start date for the evidence artifacts frequency schedule (YYYY-MM-DD)
+   */
+  startDate?: string | null;
+}
+
+/**
+ * The evidence object
+ */
+export interface EvidenceRetrieveResponse {
+  /**
+   * Internal UUID identifier for the evidence record
+   */
+  id: string;
+
+  /**
+   * The number of artifacts associated with this evidence
+   */
+  artifactCount: number;
+
+  /**
+   * Indicates whether this evidence was collected through automated processes
+   */
+  automated: boolean;
+
+  /**
+   * The frequency of evidence artifacts collection
+   */
+  frequency:
+    | 'NOT_SET'
+    | 'DAILY'
+    | 'THREE_DAY'
+    | 'WEEKLY'
+    | 'BIWEEKLY'
+    | 'MONTHLY'
+    | 'QUARTERLY'
+    | 'BIANNUAL'
+    | 'ANNUAL';
+
+  /**
+   * Display name or title of the evidence
+   */
+  name: string;
+
+  /**
+   * Detailed description of what this evidence represents
+   */
+  description?: string;
+
+  /**
+   * Instructions for how to use or interpret this evidence (converted from rich
+   * text)
+   */
+  instructions?: string;
+
+  /**
+   * Human-readable reference identifier (e.g., "EVD-001")
+   */
+  referenceId?: string | null;
+
+  /**
+   * Additional notes or comments about the evidence (converted from rich text)
+   */
+  remarks?: string;
+
+  /**
+   * The start date for the evidence artifacts frequency schedule (YYYY-MM-DD)
+   */
+  startDate?: string | null;
+}
+
+/**
+ * The updated evidence object as it exists after the operation
+ */
+export interface EvidenceUpdateResponse {
+  /**
+   * Internal UUID identifier for the evidence record
+   */
+  id: string;
+
+  /**
+   * The number of artifacts associated with this evidence
+   */
+  artifactCount: number;
+
+  /**
+   * Indicates whether this evidence was collected through automated processes
+   */
+  automated: boolean;
+
+  /**
+   * The frequency of evidence artifacts collection
+   */
+  frequency:
+    | 'NOT_SET'
+    | 'DAILY'
+    | 'THREE_DAY'
+    | 'WEEKLY'
+    | 'BIWEEKLY'
+    | 'MONTHLY'
+    | 'QUARTERLY'
+    | 'BIANNUAL'
+    | 'ANNUAL';
+
+  /**
+   * Display name or title of the evidence
+   */
+  name: string;
+
+  /**
+   * Detailed description of what this evidence represents
+   */
+  description?: string;
+
+  /**
+   * Instructions for how to use or interpret this evidence (converted from rich
+   * text)
+   */
+  instructions?: string;
+
+  /**
+   * Human-readable reference identifier (e.g., "EVD-001")
+   */
+  referenceId?: string | null;
+
+  /**
+   * Additional notes or comments about the evidence (converted from rich text)
+   */
+  remarks?: string;
+
+  /**
+   * The start date for the evidence artifacts frequency schedule (YYYY-MM-DD)
+   */
+  startDate?: string | null;
+}
+
+export interface EvidenceListResponse {
+  evidences: Array<EvidenceListResponse.Evidence>;
+}
+
+export namespace EvidenceListResponse {
+  export interface Evidence {
+    /**
+     * Internal UUID identifier for the evidence record
+     */
+    id: string;
+
+    /**
+     * The number of artifacts associated with this evidence
+     */
+    artifactCount: number;
+
+    /**
+     * Indicates whether this evidence was collected through automated processes
+     */
+    automated: boolean;
+
+    /**
+     * The frequency of evidence artifacts collection
+     */
+    frequency:
+      | 'NOT_SET'
+      | 'DAILY'
+      | 'THREE_DAY'
+      | 'WEEKLY'
+      | 'BIWEEKLY'
+      | 'MONTHLY'
+      | 'QUARTERLY'
+      | 'BIANNUAL'
+      | 'ANNUAL';
+
+    /**
+     * Display name or title of the evidence
+     */
+    name: string;
+
+    /**
+     * Detailed description of what this evidence represents
+     */
+    description?: string;
+
+    /**
+     * Instructions for how to use or interpret this evidence (converted from rich
+     * text)
+     */
+    instructions?: string;
+
+    /**
+     * Human-readable reference identifier (e.g., "EVD-001")
+     */
+    referenceId?: string | null;
+
+    /**
+     * Additional notes or comments about the evidence (converted from rich text)
+     */
+    remarks?: string;
+
+    /**
+     * The start date for the evidence artifacts frequency schedule (YYYY-MM-DD)
+     */
+    startDate?: string | null;
+  }
+}
+
+export interface EvidenceCreateParams {
+  /**
+   * The name or title of the evidence
+   */
+  name: string;
+
+  /**
+   * A detailed description of the evidence
+   */
+  description?: string | null;
+
+  /**
+   * The frequency of evidence artifacts collection
+   */
+  frequency?:
+    | 'NOT_SET'
+    | 'DAILY'
+    | 'THREE_DAY'
+    | 'WEEKLY'
+    | 'BIWEEKLY'
+    | 'MONTHLY'
+    | 'QUARTERLY'
+    | 'BIANNUAL'
+    | 'ANNUAL';
+
+  /**
+   * Instructions for how to use or interpret this evidence
+   */
+  instructions?: string | null;
+
+  /**
+   * A custom reference identifier for the evidence. Must be unique. If not provided,
+   * a system-generated ID will be used.
+   */
+  referenceId?: string | null;
+
+  /**
+   * Additional remarks or notes about the evidence
+   */
+  remarks?: string | null;
+
+  /**
+   * The start date for the evidence collection frequency schedule (YYYY-MM-DD)
+   */
+  startDate?: string | null;
+}
+
+export interface EvidenceUpdateParams {
+  /**
+   * The description of the evidence
+   */
+  description?: string;
+
+  /**
+   * The frequency of evidence artifacts collection
+   */
+  frequency?:
+    | 'NOT_SET'
+    | 'DAILY'
+    | 'THREE_DAY'
+    | 'WEEKLY'
+    | 'BIWEEKLY'
+    | 'MONTHLY'
+    | 'QUARTERLY'
+    | 'BIANNUAL'
+    | 'ANNUAL';
+
+  /**
+   * Instructions for how to use or interpret this evidence
+   */
+  instructions?: string;
+
+  /**
+   * The name or title of the evidence
+   */
+  name?: string;
+
+  /**
+   * The reference id of the evidence
+   */
+  referenceId?: string | null;
+
+  /**
+   * Additional remarks or notes about the evidence
+   */
+  remarks?: string;
+
+  /**
+   * The start date for the evidence artifacts frequency schedule (YYYY-MM-DD)
+   */
+  startDate?: string | null;
+}
+
+export interface EvidenceListParams {
+  /**
+   * Filter by ID. Multiple IDs can be provided to retrieve multiple evidence
+   * records.
+   */
+  id?: Array<string>;
+
+  /**
+   * Filter by reference ID. Multiple reference IDs can be provided to retrieve
+   * multiple evidence records.
+   */
+  referenceId?: Array<string>;
+}
+
+export interface EvidenceAssociateParams {
+  /**
+   * The type of association to make.
+   */
+  associationType: 'CONNECT' | 'DISCONNECT';
+
+  /**
+   * The ID of the subject to associate the evidence with.
+   */
+  subjectId: string;
+
+  /**
+   * The type of subject to associate the evidence with.
+   */
+  subjectType: 'CONTROL_IMPLEMENTATION' | 'SOLUTION_CAPABILITY' | 'ELEMENT' | 'VALIDATOR';
+}
+
+Evidence.Artifacts = Artifacts;
+
+export declare namespace Evidence {
+  export {
+    type PostEvidence as PostEvidence,
+    type EvidenceCreateResponse as EvidenceCreateResponse,
+    type EvidenceRetrieveResponse as EvidenceRetrieveResponse,
+    type EvidenceUpdateResponse as EvidenceUpdateResponse,
+    type EvidenceListResponse as EvidenceListResponse,
+    type EvidenceCreateParams as EvidenceCreateParams,
+    type EvidenceUpdateParams as EvidenceUpdateParams,
+    type EvidenceListParams as EvidenceListParams,
+    type EvidenceAssociateParams as EvidenceAssociateParams,
+  };
+
+  export {
+    Artifacts as Artifacts,
+    type Artifact as Artifact,
+    type PatchArtifact as PatchArtifact,
+    type PostURLArtifact as PostURLArtifact,
+    type UploadArtifact as UploadArtifact,
+    type ArtifactRetrieveResponse as ArtifactRetrieveResponse,
+    type ArtifactUpdateResponse as ArtifactUpdateResponse,
+    type ArtifactListResponse as ArtifactListResponse,
+    type ArtifactRetrieveParams as ArtifactRetrieveParams,
+    type ArtifactUpdateParams as ArtifactUpdateParams,
+    type ArtifactListParams as ArtifactListParams,
+    type ArtifactDeleteParams as ArtifactDeleteParams,
+    type ArtifactAddURLParams as ArtifactAddURLParams,
+    type ArtifactArtifactAssociateParams as ArtifactArtifactAssociateParams,
+    type ArtifactUploadParams as ArtifactUploadParams,
+  };
+}

package/src/resources/evidence/index.ts

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Artifacts,
+  type Artifact,
+  type PatchArtifact,
+  type PostURLArtifact,
+  type UploadArtifact,
+  type ArtifactRetrieveResponse,
+  type ArtifactUpdateResponse,
+  type ArtifactListResponse,
+  type ArtifactRetrieveParams,
+  type ArtifactUpdateParams,
+  type ArtifactListParams,
+  type ArtifactDeleteParams,
+  type ArtifactAddURLParams,
+  type ArtifactArtifactAssociateParams,
+  type ArtifactUploadParams,
+} from './artifacts';
+export {
+  Evidence,
+  type PostEvidence,
+  type EvidenceCreateResponse,
+  type EvidenceRetrieveResponse,
+  type EvidenceUpdateResponse,
+  type EvidenceListResponse,
+  type EvidenceCreateParams,
+  type EvidenceUpdateParams,
+  type EvidenceListParams,
+  type EvidenceAssociateParams,
+} from './evidence';

package/src/resources/evidence.ts

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

package/src/resources/index.ts

@@ -0,0 +1,55 @@
+// 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/assessments';
+export {
+  AuditAssessments,
+  type AuditAssessmentRetrieveResponse,
+  type AuditAssessmentListResponse,
+} from './audit-assessments/audit-assessments';
+export { Elements, type ElementRetrieveResponse, type ElementListResponse } from './elements';
+export {
+  Evidence,
+  type PostEvidence,
+  type EvidenceCreateResponse,
+  type EvidenceRetrieveResponse,
+  type EvidenceUpdateResponse,
+  type EvidenceListResponse,
+  type EvidenceCreateParams,
+  type EvidenceUpdateParams,
+  type EvidenceListParams,
+  type EvidenceAssociateParams,
+} from './evidence/evidence';
+export {
+  Issues,
+  type Issue,
+  type IssueObservationTypes,
+  type Origin,
+  type IssueUpdateResponse,
+  type IssueListResponse,
+  type IssueCreateParams,
+  type IssueUpdateParams,
+  type IssueListParams,
+  type IssueExportOscalParams,
+} from './issues/issues';
+export { Projects, type Project, type ProjectListResponse } from './projects/projects';
+export {
+  SolutionCapabilities,
+  type SolutionCapabilityRetrieveResponse,
+  type SolutionCapabilityListResponse,
+} from './solution-capabilities';
+export {
+  Validators,
+  type PostValidator,
+  type Validator,
+  type ValidatorListResponse,
+  type ValidatorCreateParams,
+  type ValidatorListParams,
+} from './validators';