@cirrobio/api-client 0.9.0 → 0.9.1

package/dist/esm/apis/ProjectsApi.d.ts

@@ -0,0 +1,225 @@
+/**
+ * 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 { ApproveProjectAccessRequest, CreateProjectAccessRequest, CreateResponse, Project, ProjectAccessRequest, ProjectCreateOptions, ProjectDetail, ProjectInput, ProjectUser, SetUserProjectRoleRequest, Tag } from '../models/index';
+export interface ApproveAccessRequestRequest {
+    projectId: string;
+    accessRequestId: string;
+    approveProjectAccessRequest: ApproveProjectAccessRequest;
+}
+export interface ArchiveProjectRequest {
+    projectId: string;
+}
+export interface CreateAccessRequestRequest {
+    projectId: string;
+    createProjectAccessRequest: CreateProjectAccessRequest;
+}
+export interface CreateProjectRequest {
+    projectInput: ProjectInput;
+}
+export interface DenyAccessRequestRequest {
+    projectId: string;
+    accessRequestId: string;
+}
+export interface GetAccessRequestsRequest {
+    projectId: string;
+    includeClosed?: boolean;
+}
+export interface GetProjectRequest {
+    projectId: string;
+}
+export interface GetProjectUsersRequest {
+    projectId: string;
+}
+export interface RedeployProjectRequest {
+    projectId: string;
+}
+export interface SetUserProjectRoleOperationRequest {
+    projectId: string;
+    setUserProjectRoleRequest: SetUserProjectRoleRequest;
+}
+export interface UnarchiveProjectRequest {
+    projectId: string;
+}
+export interface UpdateProjectRequest {
+    projectId: string;
+    projectInput: ProjectInput;
+}
+export interface UpdateProjectTagsRequest {
+    projectId: string;
+    tag: Array<Tag>;
+}
+/**
+ *
+ */
+export declare class ProjectsApi extends runtime.BaseAPI {
+    /**
+     * Approves an access request for the project
+     * Approve access request
+     */
+    approveAccessRequestRaw(requestParameters: ApproveAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Approves an access request for the project
+     * Approve access request
+     */
+    approveAccessRequest(requestParameters: ApproveAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Sets the project status to archived
+     * Archive project
+     */
+    archiveProjectRaw(requestParameters: ArchiveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sets the project status to archived
+     * Archive project
+     */
+    archiveProject(requestParameters: ArchiveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates an access request for the project
+     * Create access request
+     */
+    createAccessRequestRaw(requestParameters: CreateAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Creates an access request for the project
+     * Create access request
+     */
+    createAccessRequest(requestParameters: CreateAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Creates a project
+     * Create project
+     */
+    createProjectRaw(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Creates a project
+     * Create project
+     */
+    createProject(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Denies an access request for the project
+     * Deny access request
+     */
+    denyAccessRequestRaw(requestParameters: DenyAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Denies an access request for the project
+     * Deny access request
+     */
+    denyAccessRequest(requestParameters: DenyAccessRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Gets users who have requested access to the project
+     * Get access requests
+     */
+    getAccessRequestsRaw(requestParameters: GetAccessRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectAccessRequest>>>;
+    /**
+     * Gets users who have requested access to the project
+     * Get access requests
+     */
+    getAccessRequests(requestParameters: GetAccessRequestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectAccessRequest>>;
+    /**
+     * Retrieve a list of projects that a user can request access to
+     * Get discoverable projects
+     */
+    getDiscoverableProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
+    /**
+     * Retrieve a list of projects that a user can request access to
+     * Get discoverable projects
+     */
+    getDiscoverableProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
+    /**
+     * Get detailed project information
+     * Get project
+     */
+    getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectDetail>>;
+    /**
+     * Get detailed project information
+     * Get project
+     */
+    getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectDetail>;
+    /**
+     * Get allowed options for creating a project
+     * Get project create options
+     */
+    getProjectCreateOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectCreateOptions>>;
+    /**
+     * Get allowed options for creating a project
+     * Get project create options
+     */
+    getProjectCreateOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectCreateOptions>;
+    /**
+     * Gets users who have access to the project
+     * Get project permissions
+     */
+    getProjectUsersRaw(requestParameters: GetProjectUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectUser>>>;
+    /**
+     * Gets users who have access to the project
+     * Get project permissions
+     */
+    getProjectUsers(requestParameters: GetProjectUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectUser>>;
+    /**
+     * Retrieve a list of projects
+     * Get projects
+     */
+    getProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
+    /**
+     * Retrieve a list of projects
+     * Get projects
+     */
+    getProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
+    /**
+     * Redeploys cloud resources for a project
+     * Redeploy project
+     */
+    redeployProjectRaw(requestParameters: RedeployProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Redeploys cloud resources for a project
+     * Redeploy project
+     */
+    redeployProject(requestParameters: RedeployProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Sets a user\'s role within a project
+     * Set role
+     */
+    setUserProjectRoleRaw(requestParameters: SetUserProjectRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sets a user\'s role within a project
+     * Set role
+     */
+    setUserProjectRole(requestParameters: SetUserProjectRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Sets the project status to active
+     * Unarchive project
+     */
+    unarchiveProjectRaw(requestParameters: UnarchiveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sets the project status to active
+     * Unarchive project
+     */
+    unarchiveProject(requestParameters: UnarchiveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Updates a project
+     * Update project
+     */
+    updateProjectRaw(requestParameters: UpdateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectDetail>>;
+    /**
+     * Updates a project
+     * Update project
+     */
+    updateProject(requestParameters: UpdateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectDetail>;
+    /**
+     * Sets tags on a project
+     * Set project tags
+     */
+    updateProjectTagsRaw(requestParameters: UpdateProjectTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sets tags on a project
+     * Set project tags
+     */
+    updateProjectTags(requestParameters: UpdateProjectTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}