@cirrobio/api-client 0.9.0 → 0.9.1

package/dist/apis/GovernanceApi.d.ts

@@ -0,0 +1,253 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ClassificationInput, ContactInput, FulfillmentResponse, GovernanceClassification, GovernanceContact, GovernanceFileInput, GovernanceRequirement, ProjectRequirement, RequirementFulfillmentInput, RequirementInput } from '../models/index';
+export interface CreateClassificationRequest {
+    classificationInput: ClassificationInput;
+}
+export interface CreateContactRequest {
+    contactInput: ContactInput;
+}
+export interface CreateRequirementRequest {
+    requirementInput: RequirementInput;
+}
+export interface DeleteClassificationRequest {
+    classificationId: string;
+}
+export interface DeleteContactRequest {
+    contactId: string;
+}
+export interface DeleteRequirementRequest {
+    requirementId: string;
+}
+export interface FulfillRequirementRequest {
+    projectId: string;
+    requirementId: string;
+    requirementFulfillmentInput: RequirementFulfillmentInput;
+}
+export interface GetClassificationRequest {
+    classificationId: string;
+}
+export interface GetContactRequest {
+    contactId: string;
+}
+export interface GetRequirementRequest {
+    requirementId: string;
+}
+export interface GetRequirementsRequest {
+    projectId?: string;
+}
+export interface GetRequirementsByProjectRequest {
+    projectId: string;
+}
+export interface UpdateClassificationRequest {
+    classificationId: string;
+    classificationInput: ClassificationInput;
+}
+export interface UpdateContactRequest {
+    contactId: string;
+    contactInput: ContactInput;
+}
+export interface UpdateRequirementRequest {
+    requirementId: string;
+    requirementInput: RequirementInput;
+}
+export interface UpdateRequirementFileForProjectRequest {
+    requirementId: string;
+    projectId: string;
+    governanceFileInput: GovernanceFileInput;
+}
+/**
+ *
+ */
+export declare class GovernanceApi extends runtime.BaseAPI {
+    /**
+     * Creates a classification
+     * Create classification
+     */
+    createClassificationRaw(requestParameters: CreateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceClassification>>;
+    /**
+     * Creates a classification
+     * Create classification
+     */
+    createClassification(requestParameters: CreateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification>;
+    /**
+     * Creates a contact
+     * Create contact
+     */
+    createContactRaw(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
+    /**
+     * Creates a contact
+     * Create contact
+     */
+    createContact(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
+    /**
+     * Creates a requirement
+     * Create requirement
+     */
+    createRequirementRaw(requestParameters: CreateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
+    /**
+     * Creates a requirement
+     * Create requirement
+     */
+    createRequirement(requestParameters: CreateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
+    /**
+     * Deletes the classification, and removes it from all projects.
+     * Delete a classification
+     */
+    deleteClassificationRaw(requestParameters: DeleteClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes the classification, and removes it from all projects.
+     * Delete a classification
+     */
+    deleteClassification(requestParameters: DeleteClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Deletes the contact, and removes it from all governance requirements.
+     * Delete a contact
+     */
+    deleteContactRaw(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes the contact, and removes it from all governance requirements.
+     * Delete a contact
+     */
+    deleteContact(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Deletes the requirement, and removes it from all governance fulfillments and classifications.
+     * Delete a requirement
+     */
+    deleteRequirementRaw(requestParameters: DeleteRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes the requirement, and removes it from all governance fulfillments and classifications.
+     * Delete a requirement
+     */
+    deleteRequirement(requestParameters: DeleteRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Saves a record of the fulfillment of a governance requirement
+     * Fulfill a project\'s requirement
+     */
+    fulfillRequirementRaw(requestParameters: FulfillRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FulfillmentResponse>>;
+    /**
+     * Saves a record of the fulfillment of a governance requirement
+     * Fulfill a project\'s requirement
+     */
+    fulfillRequirement(requestParameters: FulfillRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FulfillmentResponse>;
+    /**
+     * Retrieve a data classification
+     * Get a classification
+     */
+    getClassificationRaw(requestParameters: GetClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceClassification>>;
+    /**
+     * Retrieve a data classification
+     * Get a classification
+     */
+    getClassification(requestParameters: GetClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification>;
+    /**
+     * Retrieve a list of data classifications
+     * Get classifications
+     */
+    getClassificationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceClassification>>>;
+    /**
+     * Retrieve a list of data classifications
+     * Get classifications
+     */
+    getClassifications(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceClassification>>;
+    /**
+     * Retrieve a governance contact
+     * Get a contact
+     */
+    getContactRaw(requestParameters: GetContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
+    /**
+     * Retrieve a governance contact
+     * Get a contact
+     */
+    getContact(requestParameters: GetContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
+    /**
+     * Retrieve a list of governance contacts
+     * Get contacts
+     */
+    getContactsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceContact>>>;
+    /**
+     * Retrieve a list of governance contacts
+     * Get contacts
+     */
+    getContacts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceContact>>;
+    /**
+     * Retrieve a governance requirement
+     * Get a requirement
+     */
+    getRequirementRaw(requestParameters: GetRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
+    /**
+     * Retrieve a governance requirement
+     * Get a requirement
+     */
+    getRequirement(requestParameters: GetRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
+    /**
+     * Retrieve a list of governance requirements
+     * Get requirements
+     */
+    getRequirementsRaw(requestParameters: GetRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceRequirement>>>;
+    /**
+     * Retrieve a list of governance requirements
+     * Get requirements
+     */
+    getRequirements(requestParameters?: GetRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceRequirement>>;
+    /**
+     * Retrieve governance requirements for a project with fulfillment information for the current user
+     * Get project requirements
+     */
+    getRequirementsByProjectRaw(requestParameters: GetRequirementsByProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectRequirement>>>;
+    /**
+     * Retrieve governance requirements for a project with fulfillment information for the current user
+     * Get project requirements
+     */
+    getRequirementsByProject(requestParameters: GetRequirementsByProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectRequirement>>;
+    /**
+     * Updates a classification
+     * Update classification
+     */
+    updateClassificationRaw(requestParameters: UpdateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceClassification>>;
+    /**
+     * Updates a classification
+     * Update classification
+     */
+    updateClassification(requestParameters: UpdateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification>;
+    /**
+     * Updates a contact
+     * Update contact
+     */
+    updateContactRaw(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceContact>>;
+    /**
+     * Updates a contact
+     * Update contact
+     */
+    updateContact(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceContact>;
+    /**
+     * Updates a requirement
+     * Update requirement
+     */
+    updateRequirementRaw(requestParameters: UpdateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceRequirement>>;
+    /**
+     * Updates a requirement
+     * Update requirement
+     */
+    updateRequirement(requestParameters: UpdateRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceRequirement>;
+    /**
+     * Updates the project-specific file for a requirement
+     * Update the project file for a requirement
+     */
+    updateRequirementFileForProjectRaw(requestParameters: UpdateRequirementFileForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates the project-specific file for a requirement
+     * Update the project file for a requirement
+     */
+    updateRequirementFileForProject(requestParameters: UpdateRequirementFileForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}