@silkline/paramify 0.0.2

package/src/resources/issues/recommendations.ts

@@ -0,0 +1,417 @@
+// 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 Recommendations extends APIResource {
+  /**
+   * Creates a new recommendation within the issue specified by the `issueId`. The
+   * `id` value of the recommendation returned can be used as the `recommendationId`
+   * parameter in other routes or request bodies.
+   *
+   * @example
+   * ```ts
+   * const recommendation =
+   *   await client.issues.recommendations.create(
+   *     '123e4567-e89b-12d3-a456-426614174000',
+   *     {
+   *       description:
+   *         'This is a detailed description of the recommendation.',
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    issueID: string,
+    body: RecommendationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<Recommendation> {
+    return this._client.post(path`/issues/${issueID}/recommendations`, { body, ...options });
+  }
+
+  /**
+   * Gets the recommendation specified by the `recommendationId` within the issue
+   * specified by the `issueId`. The `id` value of the recommendation returned can be
+   * used as the `recommendationId` parameter in other routes or request bodies.
+   *
+   * @example
+   * ```ts
+   * const recommendation =
+   *   await client.issues.recommendations.retrieve(
+   *     '123e4567-e89b-12d3-a456-426614174000',
+   *     { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   *   );
+   * ```
+   */
+  retrieve(
+    recommendationID: string,
+    params: RecommendationRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<Recommendation> {
+    const { issueId } = params;
+    return this._client.get(path`/issues/${issueId}/recommendations/${recommendationID}`, options);
+  }
+
+  /**
+   * Updates the recommendation specified by the `recommendationId`. 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.
+   *
+   * @example
+   * ```ts
+   * const recommendation =
+   *   await client.issues.recommendations.update(
+   *     '123e4567-e89b-12d3-a456-426614174000',
+   *     { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   *   );
+   * ```
+   */
+  update(
+    recommendationID: string,
+    params: RecommendationUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<RecommendationUpdateResponse> {
+    const { issueId, ...body } = params;
+    return this._client.patch(path`/issues/${issueId}/recommendations/${recommendationID}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Gets all recommendations within the issue specified by the `issueId`, and
+   * optionally filtered by `id`. The `id` value of the recommendation(s) returned
+   * can be used as the `recommendationId` parameter in other routes or request
+   * bodies.
+   *
+   * @example
+   * ```ts
+   * const recommendations =
+   *   await client.issues.recommendations.list(
+   *     '123e4567-e89b-12d3-a456-426614174000',
+   *   );
+   * ```
+   */
+  list(
+    issueID: string,
+    query: RecommendationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RecommendationListResponse> {
+    return this._client.get(path`/issues/${issueID}/recommendations`, { query, ...options });
+  }
+
+  /**
+   * Deletes the recommendation specified by the `recommendationId` within the issue
+   * specified by the `issueId`. Warning: This action is irreversible.
+   *
+   * @example
+   * ```ts
+   * await client.issues.recommendations.delete(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   { issueId: '123e4567-e89b-12d3-a456-426614174000' },
+   * );
+   * ```
+   */
+  delete(
+    recommendationID: string,
+    params: RecommendationDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { issueId } = params;
+    return this._client.delete(path`/issues/${issueId}/recommendations/${recommendationID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface Recommendation {
+  /**
+   * A uuid that uniquely identifies the recommendation
+   */
+  id: string;
+
+  /**
+   * A uuid that uniquely identifies the issue associated with the recommendation
+   */
+  issueId: string;
+
+  /**
+   * The origins of the recommendation
+   */
+  origins: Array<Recommendation.Origin>;
+
+  /**
+   * The description of the recommendation
+   */
+  description?: string;
+}
+
+export namespace Recommendation {
+  /**
+   * The name and subtype of the element within Paramify that created the issue
+   */
+  export interface Origin {
+    name: string;
+
+    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 recommendation as it exists after the operation
+ */
+export interface RecommendationUpdateResponse {
+  /**
+   * A uuid that uniquely identifies the recommendation
+   */
+  id: string;
+
+  /**
+   * A uuid that uniquely identifies the issue associated with the recommendation
+   */
+  issueId: string;
+
+  /**
+   * The origins of the recommendation
+   */
+  origins: Array<RecommendationUpdateResponse.Origin>;
+
+  /**
+   * The description of the recommendation
+   */
+  description?: string;
+}
+
+export namespace RecommendationUpdateResponse {
+  /**
+   * The name and subtype of the element within Paramify that created the issue
+   */
+  export interface Origin {
+    name: string;
+
+    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';
+  }
+}
+
+export interface RecommendationListResponse {
+  recommendations: Array<Recommendation>;
+}
+
+export interface RecommendationCreateParams {
+  /**
+   * The description of the recommendation
+   */
+  description: string;
+
+  /**
+   * The origins of the recommendation
+   */
+  origins?: Array<RecommendationCreateParams.Origin> | null;
+}
+
+export namespace RecommendationCreateParams {
+  /**
+   * The name and subtype of the element within Paramify that created the issue
+   */
+  export interface Origin {
+    name: string;
+
+    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';
+  }
+}
+
+export interface RecommendationRetrieveParams {
+  /**
+   * An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+}
+
+export interface RecommendationUpdateParams {
+  /**
+   * Path param: An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+
+  /**
+   * Body param: A uuid that uniquely identifies the recommendation
+   */
+  id?: string;
+
+  /**
+   * Body param: The description of the recommendation
+   */
+  description?: string;
+
+  /**
+   * Body param: The origins of the recommendation
+   */
+  origins?: Array<RecommendationUpdateParams.Origin>;
+}
+
+export namespace RecommendationUpdateParams {
+  /**
+   * The name and subtype of the element within Paramify that created the issue
+   */
+  export interface Origin {
+    name: string;
+
+    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';
+  }
+}
+
+export interface RecommendationListParams {
+  /**
+   * Filter recommendations by ID. Multiple IDs can be provided to retrieve multiple
+   * recommendations at once.
+   */
+  id?: Array<string>;
+}
+
+export interface RecommendationDeleteParams {
+  /**
+   * An id that represents an issue within the Paramify application.
+   */
+  issueId: string;
+}
+
+export declare namespace Recommendations {
+  export {
+    type Recommendation as Recommendation,
+    type RecommendationUpdateResponse as RecommendationUpdateResponse,
+    type RecommendationListResponse as RecommendationListResponse,
+    type RecommendationCreateParams as RecommendationCreateParams,
+    type RecommendationRetrieveParams as RecommendationRetrieveParams,
+    type RecommendationUpdateParams as RecommendationUpdateParams,
+    type RecommendationListParams as RecommendationListParams,
+    type RecommendationDeleteParams as RecommendationDeleteParams,
+  };
+}

package/src/resources/issues.ts

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

package/src/resources/projects/control-implementations.ts

@@ -0,0 +1,47 @@
+// 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 project.
+   */
+  list(projectID: string, options?: RequestOptions): APIPromise<ControlImplementationListResponse> {
+    return this._client.get(path`/projects/${projectID}/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/projects/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { ControlImplementations, type ControlImplementationListResponse } from './control-implementations';
+export { Projects, type Project, type ProjectListResponse } from './projects';

package/src/resources/projects/projects.ts

@@ -0,0 +1,128 @@
+// 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 Projects extends APIResource {
+  controlImplementations: ControlImplementationsAPI.ControlImplementations =
+    new ControlImplementationsAPI.ControlImplementations(this._client);
+
+  /**
+   * Returns the project specified by the `projectId` query parameter and accessible
+   * to the api key. A project is called a `Program` in the Paramify application.The
+   * `id` value of the project returned can be used as the `projectId` parameter in
+   * other routes or request bodies.
+   */
+  retrieve(projectID: string, options?: RequestOptions): APIPromise<Project> {
+    return this._client.get(path`/projects/${projectID}`, options);
+  }
+
+  /**
+   * Returns all projects accessible to the api key. These are referred to as
+   * `Programs` in the Paramify application.The `id` value of any of the projects
+   * listed is referred to as the `projectId` query parameter in other routes or
+   * request bodies.
+   */
+  list(options?: RequestOptions): APIPromise<ProjectListResponse> {
+    return this._client.get('/projects', options);
+  }
+}
+
+/**
+ * An object containing information about projects accessible to the API key.
+ */
+export interface Project {
+  /**
+   * A uuid that uniquely identifies an individual project within Paramify
+   */
+  id: string;
+
+  /**
+   * The name of the project
+   */
+  name: string;
+
+  /**
+   * The impact levels of the project
+   */
+  programImpactLevels: Array<Project.ProgramImpactLevel>;
+
+  systemName: string;
+
+  systemShortName: string;
+
+  /**
+   * The type of project
+   */
+  type:
+    | 'CUSTOM'
+    | 'FEDRAMP_REV_4'
+    | 'FEDRAMP_REV_5'
+    | 'FEDRAMP_20x_P1'
+    | 'FEDRAMP_20x_P2'
+    | 'DOD_ADDENDUM_REV_4'
+    | 'DOD_REV_5'
+    | 'DOD_ADDENDUM_REV_5'
+    | 'STATERAMP'
+    | 'TXRAMP'
+    | 'CMMC_REV_2'
+    | 'ADOBE_CCF_V5'
+    | 'FISMA';
+}
+
+export namespace Project {
+  export interface ProgramImpactLevel {
+    programImpactLevel:
+      | 'CMMC_LEVEL_1'
+      | 'CMMC_LEVEL_2'
+      | 'CMMC_LEVEL_3'
+      | 'LI_SAAS'
+      | 'LOW'
+      | 'MODERATE'
+      | 'HIGH'
+      | 'LOW_SR'
+      | 'MODERATE_SR'
+      | 'TX_LEVEL_1'
+      | 'TX_LEVEL_2'
+      | 'IL2_ADDENDUM'
+      | 'IL4_ADDENDUM'
+      | 'IL5_ADDENDUM'
+      | 'IL6_ADDENDUM'
+      | 'IL2'
+      | 'IL4_FEDRAMP_MODERATE'
+      | 'IL4_FEDRAMP_HIGH'
+      | 'IL5'
+      | 'IL6'
+      | 'SOC_2_C'
+      | 'SOC_2_CC'
+      | 'SOC_2_A'
+      | 'FISMA_LOW'
+      | 'FISMA_MODERATE'
+      | 'FISMA_HIGH'
+      | 'FEDRAMP_20x_P1_LOW'
+      | 'FEDRAMP_20x_P2_LOW'
+      | 'FEDRAMP_20x_P2_MODERATE'
+      | 'FEDRAMP_20x_P2_HIGH';
+
+    remarks: string | null;
+  }
+}
+
+export interface ProjectListResponse {
+  projects: Array<Project>;
+}
+
+Projects.ControlImplementations = ControlImplementations;
+
+export declare namespace Projects {
+  export { type Project as Project, type ProjectListResponse as ProjectListResponse };
+
+  export {
+    ControlImplementations as ControlImplementations,
+    type ControlImplementationListResponse as ControlImplementationListResponse,
+  };
+}

package/src/resources/projects.ts

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

package/src/resources/solution-capabilities.ts

@@ -0,0 +1,85 @@
+// 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 SolutionCapabilities extends APIResource {
+  /**
+   * Retrieves a specific solution capability by its internal ID (UUID). Returns the
+   * complete solution capability object.
+   */
+  retrieve(
+    solutionCapabilityID: string,
+    options?: RequestOptions,
+  ): APIPromise<SolutionCapabilityRetrieveResponse> {
+    return this._client.get(path`/solution-capabilities/${solutionCapabilityID}`, options);
+  }
+
+  /**
+   * Get all solution capabilities
+   */
+  list(options?: RequestOptions): APIPromise<SolutionCapabilityListResponse> {
+    return this._client.get('/solution-capabilities', options);
+  }
+}
+
+export interface SolutionCapabilityRetrieveResponse {
+  /**
+   * A uuid that uniquely identifies an individual solution capability within
+   * Paramify
+   */
+  id: string;
+
+  /**
+   * The family of the solution capability
+   */
+  family: string;
+
+  /**
+   * The name of the solution capability
+   */
+  name: string;
+
+  /**
+   * The subfamily of the solution capability
+   */
+  subfamily: string;
+}
+
+export interface SolutionCapabilityListResponse {
+  solutionCapabilities: Array<SolutionCapabilityListResponse.SolutionCapability>;
+}
+
+export namespace SolutionCapabilityListResponse {
+  export interface SolutionCapability {
+    /**
+     * A uuid that uniquely identifies an individual solution capability within
+     * Paramify
+     */
+    id: string;
+
+    /**
+     * The family of the solution capability
+     */
+    family: string;
+
+    /**
+     * The name of the solution capability
+     */
+    name: string;
+
+    /**
+     * The subfamily of the solution capability
+     */
+    subfamily: string;
+  }
+}
+
+export declare namespace SolutionCapabilities {
+  export {
+    type SolutionCapabilityRetrieveResponse as SolutionCapabilityRetrieveResponse,
+    type SolutionCapabilityListResponse as SolutionCapabilityListResponse,
+  };
+}