@zitadel/sdk 4.1.0-beta.10

package/dist/apis/beta-project-service-api.d.ts

@@ -0,0 +1,239 @@
+/**
+ * Zitadel SDK
+ * The Zitadel SDK is a convenience wrapper around the Zitadel APIs to assist you in integrating with your Zitadel environment. This SDK enables you to handle resources, settings, and configurations within the Zitadel platform.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * 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.js';
+import type { BetaProjectServiceActivateProjectGrantRequest, BetaProjectServiceActivateProjectGrantResponse, BetaProjectServiceActivateProjectRequest, BetaProjectServiceActivateProjectResponse, BetaProjectServiceAddProjectRoleRequest, BetaProjectServiceAddProjectRoleResponse, BetaProjectServiceCreateProjectGrantRequest, BetaProjectServiceCreateProjectGrantResponse, BetaProjectServiceCreateProjectRequest, BetaProjectServiceCreateProjectResponse, BetaProjectServiceDeactivateProjectGrantRequest, BetaProjectServiceDeactivateProjectGrantResponse, BetaProjectServiceDeactivateProjectRequest, BetaProjectServiceDeactivateProjectResponse, BetaProjectServiceDeleteProjectGrantRequest, BetaProjectServiceDeleteProjectGrantResponse, BetaProjectServiceDeleteProjectRequest, BetaProjectServiceDeleteProjectResponse, BetaProjectServiceGetProjectRequest, BetaProjectServiceGetProjectResponse, BetaProjectServiceListProjectGrantsRequest, BetaProjectServiceListProjectGrantsResponse, BetaProjectServiceListProjectRolesRequest, BetaProjectServiceListProjectRolesResponse, BetaProjectServiceListProjectsRequest, BetaProjectServiceListProjectsResponse, BetaProjectServiceRemoveProjectRoleRequest, BetaProjectServiceRemoveProjectRoleResponse, BetaProjectServiceUpdateProjectGrantRequest, BetaProjectServiceUpdateProjectGrantResponse, BetaProjectServiceUpdateProjectRequest, BetaProjectServiceUpdateProjectResponse, BetaProjectServiceUpdateProjectRoleRequest, BetaProjectServiceUpdateProjectRoleResponse } from '../models/index.js';
+export interface BetaProjectServiceApiActivateProjectRequest {
+    betaProjectServiceActivateProjectRequest: BetaProjectServiceActivateProjectRequest;
+}
+export interface BetaProjectServiceApiActivateProjectGrantRequest {
+    betaProjectServiceActivateProjectGrantRequest: BetaProjectServiceActivateProjectGrantRequest;
+}
+export interface BetaProjectServiceApiAddProjectRoleRequest {
+    betaProjectServiceAddProjectRoleRequest: BetaProjectServiceAddProjectRoleRequest;
+}
+export interface BetaProjectServiceApiCreateProjectRequest {
+    betaProjectServiceCreateProjectRequest: BetaProjectServiceCreateProjectRequest;
+}
+export interface BetaProjectServiceApiCreateProjectGrantRequest {
+    betaProjectServiceCreateProjectGrantRequest: BetaProjectServiceCreateProjectGrantRequest;
+}
+export interface BetaProjectServiceApiDeactivateProjectRequest {
+    betaProjectServiceDeactivateProjectRequest: BetaProjectServiceDeactivateProjectRequest;
+}
+export interface BetaProjectServiceApiDeactivateProjectGrantRequest {
+    betaProjectServiceDeactivateProjectGrantRequest: BetaProjectServiceDeactivateProjectGrantRequest;
+}
+export interface BetaProjectServiceApiDeleteProjectRequest {
+    betaProjectServiceDeleteProjectRequest: BetaProjectServiceDeleteProjectRequest;
+}
+export interface BetaProjectServiceApiDeleteProjectGrantRequest {
+    betaProjectServiceDeleteProjectGrantRequest: BetaProjectServiceDeleteProjectGrantRequest;
+}
+export interface BetaProjectServiceApiGetProjectRequest {
+    betaProjectServiceGetProjectRequest: BetaProjectServiceGetProjectRequest;
+}
+export interface BetaProjectServiceApiListProjectGrantsRequest {
+    betaProjectServiceListProjectGrantsRequest: BetaProjectServiceListProjectGrantsRequest;
+}
+export interface BetaProjectServiceApiListProjectRolesRequest {
+    betaProjectServiceListProjectRolesRequest: BetaProjectServiceListProjectRolesRequest;
+}
+export interface BetaProjectServiceApiListProjectsRequest {
+    betaProjectServiceListProjectsRequest: BetaProjectServiceListProjectsRequest;
+}
+export interface BetaProjectServiceApiRemoveProjectRoleRequest {
+    betaProjectServiceRemoveProjectRoleRequest: BetaProjectServiceRemoveProjectRoleRequest;
+}
+export interface BetaProjectServiceApiUpdateProjectRequest {
+    betaProjectServiceUpdateProjectRequest: BetaProjectServiceUpdateProjectRequest;
+}
+export interface BetaProjectServiceApiUpdateProjectGrantRequest {
+    betaProjectServiceUpdateProjectGrantRequest: BetaProjectServiceUpdateProjectGrantRequest;
+}
+export interface BetaProjectServiceApiUpdateProjectRoleRequest {
+    betaProjectServiceUpdateProjectRoleRequest: BetaProjectServiceUpdateProjectRoleRequest;
+}
+/**
+ *
+ */
+export declare class BetaProjectServiceApi extends runtime.BaseAPI {
+    /**
+     * Set the state of a project to active. Request returns no error if the project is already activated.   Required permission:    - `project.write`
+     * Activate Project
+     */
+    private activateProjectRaw;
+    /**
+     * Set the state of a project to active. Request returns no error if the project is already activated.   Required permission:    - `project.write`
+     * Activate Project
+     */
+    activateProject(requestParameters: BetaProjectServiceApiActivateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceActivateProjectResponse>;
+    /**
+     * Set the state of the project grant to activated.   Required permission:    - `project.grant.write`
+     * Activate Project Grant
+     */
+    private activateProjectGrantRaw;
+    /**
+     * Set the state of the project grant to activated.   Required permission:    - `project.grant.write`
+     * Activate Project Grant
+     */
+    activateProjectGrant(requestParameters: BetaProjectServiceApiActivateProjectGrantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceActivateProjectGrantResponse>;
+    /**
+     * Add a new project role to a project. The key must be unique within the project.   Required permission:    - `project.role.write`
+     * Add Project Role
+     */
+    private addProjectRoleRaw;
+    /**
+     * Add a new project role to a project. The key must be unique within the project.   Required permission:    - `project.role.write`
+     * Add Project Role
+     */
+    addProjectRole(requestParameters: BetaProjectServiceApiAddProjectRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceAddProjectRoleResponse>;
+    /**
+     * Create a new Project.   Required permission:    - `project.create`
+     * Create Project
+     */
+    private createProjectRaw;
+    /**
+     * Create a new Project.   Required permission:    - `project.create`
+     * Create Project
+     */
+    createProject(requestParameters: BetaProjectServiceApiCreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceCreateProjectResponse>;
+    /**
+     * Grant a project to another organization.  The project grant will allow the granted organization to access the project and manage the authorizations for its users.   Required permission:    - `project.grant.create`
+     * Create Project Grant
+     */
+    private createProjectGrantRaw;
+    /**
+     * Grant a project to another organization.  The project grant will allow the granted organization to access the project and manage the authorizations for its users.   Required permission:    - `project.grant.create`
+     * Create Project Grant
+     */
+    createProjectGrant(requestParameters: BetaProjectServiceApiCreateProjectGrantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceCreateProjectGrantResponse>;
+    /**
+     * Set the state of a project to deactivated. Request returns no error if the project is already deactivated.  Applications under deactivated projects are not able to login anymore.   Required permission:    - `project.write`
+     * Deactivate Project
+     */
+    private deactivateProjectRaw;
+    /**
+     * Set the state of a project to deactivated. Request returns no error if the project is already deactivated.  Applications under deactivated projects are not able to login anymore.   Required permission:    - `project.write`
+     * Deactivate Project
+     */
+    deactivateProject(requestParameters: BetaProjectServiceApiDeactivateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceDeactivateProjectResponse>;
+    /**
+     * Set the state of the project grant to deactivated.  Applications under deactivated projects grants are not able to login anymore.   Required permission:    - `project.grant.write`
+     * Deactivate Project Grant
+     */
+    private deactivateProjectGrantRaw;
+    /**
+     * Set the state of the project grant to deactivated.  Applications under deactivated projects grants are not able to login anymore.   Required permission:    - `project.grant.write`
+     * Deactivate Project Grant
+     */
+    deactivateProjectGrant(requestParameters: BetaProjectServiceApiDeactivateProjectGrantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceDeactivateProjectGrantResponse>;
+    /**
+     * Delete an existing project.  In case the project is not found, the request will return a successful response as  the desired state is already achieved.   Required permission:    - `project.delete`
+     * Delete Project
+     */
+    private deleteProjectRaw;
+    /**
+     * Delete an existing project.  In case the project is not found, the request will return a successful response as  the desired state is already achieved.   Required permission:    - `project.delete`
+     * Delete Project
+     */
+    deleteProject(requestParameters: BetaProjectServiceApiDeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceDeleteProjectResponse>;
+    /**
+     * Delete a project grant. All user grants for this project grant will also be removed.  A user will not have access to the project afterward (if permissions are checked).  In case the project grant is not found, the request will return a successful response as  the desired state is already achieved.   Required permission:    - `project.grant.delete`
+     * Delete Project Grant
+     */
+    private deleteProjectGrantRaw;
+    /**
+     * Delete a project grant. All user grants for this project grant will also be removed.  A user will not have access to the project afterward (if permissions are checked).  In case the project grant is not found, the request will return a successful response as  the desired state is already achieved.   Required permission:    - `project.grant.delete`
+     * Delete Project Grant
+     */
+    deleteProjectGrant(requestParameters: BetaProjectServiceApiDeleteProjectGrantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceDeleteProjectGrantResponse>;
+    /**
+     * Returns the project identified by the requested ID.   Required permission:    - `project.read`
+     * Get Project
+     */
+    private getProjectRaw;
+    /**
+     * Returns the project identified by the requested ID.   Required permission:    - `project.read`
+     * Get Project
+     */
+    getProject(requestParameters: BetaProjectServiceApiGetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceGetProjectResponse>;
+    /**
+     * Returns a list of project grants. A project grant is when the organization grants its project to another organization.   Required permission:    - `project.grant.write`
+     * List Project Grants
+     */
+    private listProjectGrantsRaw;
+    /**
+     * Returns a list of project grants. A project grant is when the organization grants its project to another organization.   Required permission:    - `project.grant.write`
+     * List Project Grants
+     */
+    listProjectGrants(requestParameters: BetaProjectServiceApiListProjectGrantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceListProjectGrantsResponse>;
+    /**
+     * Returns all roles of a project matching the search query.   Required permission:    - `project.role.read`
+     * List Project Roles
+     */
+    private listProjectRolesRaw;
+    /**
+     * Returns all roles of a project matching the search query.   Required permission:    - `project.role.read`
+     * List Project Roles
+     */
+    listProjectRoles(requestParameters: BetaProjectServiceApiListProjectRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceListProjectRolesResponse>;
+    /**
+     * List all matching projects. By default all projects of the instance that the caller has permission to read are returned.  Make sure to include a limit and sorting for pagination.   Required permission:    - `project.read`
+     * List Projects
+     */
+    private listProjectsRaw;
+    /**
+     * List all matching projects. By default all projects of the instance that the caller has permission to read are returned.  Make sure to include a limit and sorting for pagination.   Required permission:    - `project.read`
+     * List Projects
+     */
+    listProjects(requestParameters: BetaProjectServiceApiListProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceListProjectsResponse>;
+    /**
+     * Removes the role from the project and on every resource it has a dependency. This includes project grants and user grants.   Required permission:    - `project.role.write`
+     * Remove Project Role
+     */
+    private removeProjectRoleRaw;
+    /**
+     * Removes the role from the project and on every resource it has a dependency. This includes project grants and user grants.   Required permission:    - `project.role.write`
+     * Remove Project Role
+     */
+    removeProjectRole(requestParameters: BetaProjectServiceApiRemoveProjectRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceRemoveProjectRoleResponse>;
+    /**
+     * Update an existing project.   Required permission:    - `project.write`
+     * Update Project
+     */
+    private updateProjectRaw;
+    /**
+     * Update an existing project.   Required permission:    - `project.write`
+     * Update Project
+     */
+    updateProject(requestParameters: BetaProjectServiceApiUpdateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceUpdateProjectResponse>;
+    /**
+     * Change the roles of the project that is granted to another organization.  The project grant will allow the granted organization to access the project and manage the authorizations for its users.   Required permission:    - `project.grant.write`
+     * Update Project Grant
+     */
+    private updateProjectGrantRaw;
+    /**
+     * Change the roles of the project that is granted to another organization.  The project grant will allow the granted organization to access the project and manage the authorizations for its users.   Required permission:    - `project.grant.write`
+     * Update Project Grant
+     */
+    updateProjectGrant(requestParameters: BetaProjectServiceApiUpdateProjectGrantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceUpdateProjectGrantResponse>;
+    /**
+     * Change a project role. The key is not editable. If a key should change, remove the role and create a new one.   Required permission:    - `project.role.write`
+     * Update Project Role
+     */
+    private updateProjectRoleRaw;
+    /**
+     * Change a project role. The key is not editable. If a key should change, remove the role and create a new one.   Required permission:    - `project.role.write`
+     * Update Project Role
+     */
+    updateProjectRole(requestParameters: BetaProjectServiceApiUpdateProjectRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BetaProjectServiceUpdateProjectRoleResponse>;
+}