@silkline/paramify 0.0.2

package/src/resources/issues/deviations.ts

@@ -0,0 +1,360 @@
+// 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 { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Deviations extends APIResource {
+  /**
+   * Creates a new deviation on the issue specified by the `issueId` path parameter.
+   * The `id` value of the deviation returned can be used as the `deviationId`
+   * parameter in the `deviations` route.Note that if not provided, the
+   * `acceptanceStatusDate` field will be set to the current date if the status field
+   * is set to accepted or rejected.
+   *
+   * @example
+   * ```ts
+   * const deviation = await client.issues.deviations.create(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   {
+   *     description: 'description',
+   *     deviationMetadata: { status: 'PENDING' },
+   *     method: 'TEST',
+   *     type: 'VENDOR_DEPENDENCY',
+   *   },
+   * );
+   * ```
+   */
+  create(issueID: string, body: DeviationCreateParams, options?: RequestOptions): APIPromise<Deviation> {
+    return this._client.post(path`/issues/${issueID}/deviations`, { body, ...options });
+  }
+
+  /**
+   * Returns the deviation specified by the `deviationId` path parameter and
+   * associated with the issue specified by `issueId`. The `id` value of the
+   * deviation returned can be used as the `deviationId` parameter in the
+   * `deviations` route.
+   *
+   * @example
+   * ```ts
+   * const deviation = await client.issues.deviations.retrieve(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   * );
+   * ```
+   */
+  retrieve(
+    deviationID: string,
+    params: DeviationRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<Deviation> {
+    const { issueId } = params;
+    return this._client.get(path`/issues/${issueId}/deviations/${deviationID}`, options);
+  }
+
+  /**
+   * Updates the deviation specified by the `deviationId` path parameter and
+   * associated with the issue specified by `issueId`. Upon successful operation, all
+   * fields that are not arrays will be overwritten. Fields that accept array values
+   * will add the provided values to the existing values.Note that if not provided,
+   * the `acceptanceStatusDate` field will be set to the current date if the status
+   * field is set to accepted or rejected.
+   *
+   * @example
+   * ```ts
+   * const deviation = await client.issues.deviations.update(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   * );
+   * ```
+   */
+  update(
+    deviationID: string,
+    params: DeviationUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<DeviationUpdateResponse> {
+    const { issueId, ...body } = params;
+    return this._client.patch(path`/issues/${issueId}/deviations/${deviationID}`, { body, ...options });
+  }
+
+  /**
+   * This endpoint returns all deviations for the specified issue. You may filter the
+   * results by `id` to retrieve several specific deviations at once.
+   *
+   * @example
+   * ```ts
+   * const deviations = await client.issues.deviations.list(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
+   */
+  list(
+    issueID: string,
+    query: DeviationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DeviationListResponse> {
+    return this._client.get(path`/issues/${issueID}/deviations`, { query, ...options });
+  }
+
+  /**
+   * Deletes the deviation specified by the `deviationId` path parameter (scoped to
+   * the issue specified by `issueId`). Warning: This action is irreversible.
+   *
+   * @example
+   * ```ts
+   * await client.issues.deviations.delete(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   * );
+   * ```
+   */
+  delete(deviationID: string, params: DeviationDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { issueId } = params;
+    return this._client.delete(path`/issues/${issueId}/deviations/${deviationID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface Deviation {
+  /**
+   * A uuid that uniquely identifies a deviation within Paramify
+   */
+  id: string;
+
+  /**
+   * The date the deviation was created
+   */
+  createdAt: string;
+
+  /**
+   * The description of the deviation
+   */
+  description: string;
+
+  /**
+   * The method used to create the deviation
+   */
+  method: 'TEST' | 'EXAMINE' | 'INTERVIEW' | 'UNKNOWN';
+
+  /**
+   * Deviation observation types
+   */
+  type: DeviationObservationTypes;
+
+  /**
+   * Deviation metadata object
+   */
+  deviationMetadata?: Deviation.DeviationMetadata;
+}
+
+export namespace Deviation {
+  /**
+   * Deviation metadata object
+   */
+  export interface DeviationMetadata {
+    status: 'PENDING' | 'ACCEPTED' | 'REJECTED';
+
+    /**
+     * The date the deviation status was accepted or rejected
+     */
+    acceptanceStatusDate?: string | null;
+
+    adjustedLevel?: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL' | null;
+  }
+}
+
+/**
+ * Deviation metadata object
+ */
+export interface DeviationMetadata {
+  /**
+   * The date the deviation status was accepted or rejected
+   */
+  acceptanceStatusDate?: string | null;
+
+  adjustedLevel?: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+
+  status?: 'PENDING' | 'ACCEPTED' | 'REJECTED';
+}
+
+/**
+ * Deviation observation types
+ */
+export type DeviationObservationTypes =
+  | 'FALSE_POSITIVE'
+  | 'OPERATIONAL_REQUIREMENT'
+  | 'RISK_ADJUSTMENT'
+  | 'VENDOR_DEPENDENCY';
+
+/**
+ * The deviation as it exists after the operation
+ */
+export interface DeviationUpdateResponse {
+  /**
+   * A uuid that uniquely identifies a deviation within Paramify
+   */
+  id: string;
+
+  /**
+   * The date the deviation was created
+   */
+  createdAt: string;
+
+  /**
+   * The description of the deviation
+   */
+  description: string;
+
+  /**
+   * The method used to create the deviation
+   */
+  method: 'TEST' | 'EXAMINE' | 'INTERVIEW' | 'UNKNOWN';
+
+  /**
+   * Deviation observation types
+   */
+  type: DeviationObservationTypes;
+
+  /**
+   * Deviation metadata object
+   */
+  deviationMetadata?: DeviationUpdateResponse.DeviationMetadata;
+}
+
+export namespace DeviationUpdateResponse {
+  /**
+   * Deviation metadata object
+   */
+  export interface DeviationMetadata {
+    status: 'PENDING' | 'ACCEPTED' | 'REJECTED';
+
+    /**
+     * The date the deviation status was accepted or rejected
+     */
+    acceptanceStatusDate?: string | null;
+
+    adjustedLevel?: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL' | null;
+  }
+}
+
+export interface DeviationListResponse {
+  deviations: Array<Deviation>;
+}
+
+export interface DeviationCreateParams {
+  /**
+   * The description of the deviation
+   */
+  description: string;
+
+  /**
+   * Deviation schema
+   */
+  deviationMetadata: DeviationCreateParams.DeviationMetadata;
+
+  method: 'TEST' | 'EXAMINE' | 'INTERVIEW' | 'UNKNOWN';
+
+  /**
+   * Deviation observation types
+   */
+  type: DeviationObservationTypes;
+
+  /**
+   * The date the deviation was created
+   */
+  createdAt?: string | null;
+}
+
+export namespace DeviationCreateParams {
+  /**
+   * Deviation schema
+   */
+  export interface DeviationMetadata {
+    status: 'PENDING' | 'ACCEPTED' | 'REJECTED';
+
+    /**
+     * The date the deviation status was accepted or rejected
+     */
+    acceptanceStatusDate?: string | null;
+
+    adjustedLevel?: 'NOT_SET' | 'CHILL' | 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL';
+  }
+}
+
+export interface DeviationRetrieveParams {
+  /**
+   * An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+}
+
+export interface DeviationUpdateParams {
+  /**
+   * Path param: An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+
+  /**
+   * Body param
+   */
+  id?: string;
+
+  /**
+   * Body param: The date the deviation was created
+   */
+  createdAt?: string;
+
+  /**
+   * Body param
+   */
+  description?: string;
+
+  /**
+   * Body param: Deviation metadata object
+   */
+  deviationMetadata?: DeviationMetadata;
+
+  /**
+   * Body param
+   */
+  method?: 'TEST' | 'EXAMINE' | 'INTERVIEW' | 'UNKNOWN';
+
+  /**
+   * Body param: Deviation observation types
+   */
+  type?: DeviationObservationTypes;
+}
+
+export interface DeviationListParams {
+  /**
+   * Filter deviations by ID. Multiple IDs can be provided to retrieve multiple
+   * deviations at once.
+   */
+  id?: Array<string>;
+}
+
+export interface DeviationDeleteParams {
+  /**
+   * An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+}
+
+export declare namespace Deviations {
+  export {
+    type Deviation as Deviation,
+    type DeviationMetadata as DeviationMetadata,
+    type DeviationObservationTypes as DeviationObservationTypes,
+    type DeviationUpdateResponse as DeviationUpdateResponse,
+    type DeviationListResponse as DeviationListResponse,
+    type DeviationCreateParams as DeviationCreateParams,
+    type DeviationRetrieveParams as DeviationRetrieveParams,
+    type DeviationUpdateParams as DeviationUpdateParams,
+    type DeviationListParams as DeviationListParams,
+    type DeviationDeleteParams as DeviationDeleteParams,
+  };
+}

package/src/resources/issues/index.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Deviations,
+  type Deviation,
+  type DeviationMetadata,
+  type DeviationObservationTypes,
+  type DeviationUpdateResponse,
+  type DeviationListResponse,
+  type DeviationCreateParams,
+  type DeviationRetrieveParams,
+  type DeviationUpdateParams,
+  type DeviationListParams,
+  type DeviationDeleteParams,
+} from './deviations';
+export {
+  Issues,
+  type Issue,
+  type IssueObservationTypes,
+  type Origin,
+  type IssueUpdateResponse,
+  type IssueListResponse,
+  type IssueCreateParams,
+  type IssueUpdateParams,
+  type IssueListParams,
+  type IssueExportOscalParams,
+} from './issues';
+export {
+  Milestones,
+  type Milestone,
+  type MilestoneCreateResponse,
+  type MilestoneRetrieveResponse,
+  type MilestoneUpdateResponse,
+  type MilestoneListResponse,
+  type MilestoneCreateParams,
+  type MilestoneRetrieveParams,
+  type MilestoneUpdateParams,
+  type MilestoneListParams,
+  type MilestoneDeleteParams,
+} from './milestones';
+export {
+  Recommendations,
+  type Recommendation,
+  type RecommendationUpdateResponse,
+  type RecommendationListResponse,
+  type RecommendationCreateParams,
+  type RecommendationRetrieveParams,
+  type RecommendationUpdateParams,
+  type RecommendationListParams,
+  type RecommendationDeleteParams,
+} from './recommendations';