@omnibase/core-js 0.8.0 → 0.9.1

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

@@ -0,0 +1,220 @@
+/**
+ * Omnibase REST API
+ * Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services.  ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control via Ory Keto  ## Authentication Most endpoints require authentication via session cookies or JWT tokens. Use the appropriate security scheme based on the endpoint requirements.
+ *
+ * The version of the OpenAPI document: 0.9.1
+ * Contact: support@omnibase.dev
+ *
+ * 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 { AcceptInvite200Response, AssignRole200Response, CreateInvite200Response, CreateRole200Response, CreateTenant200Response, DeleteRole200Response, DeleteTenant200Response, GetRoleDefinitions200Response, GetTenantBillingStatus200Response, GetTenantJWT200Response, HandlersSuccessResponse, ListRoles200Response, ListTenantSubscriptions200Response, ListTenantUsers200Response, SwitchActiveTenant200Response, TenantsAcceptInviteRequest, TenantsAssignRoleRequest, TenantsCreateRoleRequest, TenantsCreateTenantRequest, TenantsCreateTenantUserInviteRequest, TenantsDeleteTenantUserRequest, TenantsSwitchTenantRequest, TenantsUpdateRoleRequest, TenantsUpdateTenantUserRoleRequest, UpdateTenantUserRole200Response } from '../models/index';
+export interface AcceptInviteRequest {
+    request: TenantsAcceptInviteRequest;
+}
+export interface AssignRoleRequest {
+    userId: string;
+    request: TenantsAssignRoleRequest;
+}
+export interface CreateInviteRequest {
+    request: TenantsCreateTenantUserInviteRequest;
+}
+export interface CreateRoleRequest {
+    request: TenantsCreateRoleRequest;
+}
+export interface CreateTenantRequest {
+    request: TenantsCreateTenantRequest;
+}
+export interface DeleteRoleRequest {
+    roleId: string;
+}
+export interface RemoveTenantUserRequest {
+    request: TenantsDeleteTenantUserRequest;
+}
+export interface SwitchActiveTenantRequest {
+    request: TenantsSwitchTenantRequest;
+}
+export interface UpdateRoleRequest {
+    roleId: string;
+    request: TenantsUpdateRoleRequest;
+}
+export interface UpdateTenantUserRoleRequest {
+    request: TenantsUpdateTenantUserRoleRequest;
+}
+/**
+ *
+ */
+export declare class TenantsApi extends runtime.BaseAPI {
+    /**
+     * Accepts a tenant invitation using the token from the invite email and adds the user to the organization.  ## Authentication Requires JWT token. User\'s email must match the invite email.  ## Process 1. Validates invite token and expiry 2. Verifies user\'s email matches invite email 3. Marks invite as used 4. Adds user to tenant 5. Assigns role with permissions 6. Sets as active tenant and returns JWT token
+     * Accept tenant invite
+     */
+    acceptInviteRaw(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AcceptInvite200Response>>;
+    /**
+     * Accepts a tenant invitation using the token from the invite email and adds the user to the organization.  ## Authentication Requires JWT token. User\'s email must match the invite email.  ## Process 1. Validates invite token and expiry 2. Verifies user\'s email matches invite email 3. Marks invite as used 4. Adds user to tenant 5. Assigns role with permissions 6. Sets as active tenant and returns JWT token
+     * Accept tenant invite
+     */
+    acceptInvite(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AcceptInvite200Response>;
+    /**
+     * Assigns a role to a user and creates all associated Keto relationships for the role\'s permissions.  ## Authentication Requires JWT token with tenant context and appropriate permissions.  ## Request Format Provide either `role_id` or `role_name` (not both).  ## Use Cases - Grant role to user - Assign permissions via role - User onboarding
+     * Assign role to user
+     */
+    assignRoleRaw(requestParameters: AssignRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssignRole200Response>>;
+    /**
+     * Assigns a role to a user and creates all associated Keto relationships for the role\'s permissions.  ## Authentication Requires JWT token with tenant context and appropriate permissions.  ## Request Format Provide either `role_id` or `role_name` (not both).  ## Use Cases - Grant role to user - Assign permissions via role - User onboarding
+     * Assign role to user
+     */
+    assignRole(requestParameters: AssignRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssignRole200Response>;
+    /**
+     * Creates a tenant invitation with a 7-day expiry token and sends an email to the invited user.  ## Authentication Requires JWT token with `invite_user` permission.  ## Process 1. Verifies user has invite permission 2. Creates invite with unique token (7-day expiry) 3. Sends invitation email asynchronously  ## Use Cases - Add team members to organization - Invite collaborators with specific roles
+     * Create tenant invite
+     */
+    createInviteRaw(requestParameters: CreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateInvite200Response>>;
+    /**
+     * Creates a tenant invitation with a 7-day expiry token and sends an email to the invited user.  ## Authentication Requires JWT token with `invite_user` permission.  ## Process 1. Verifies user has invite permission 2. Creates invite with unique token (7-day expiry) 3. Sends invitation email asynchronously  ## Use Cases - Add team members to organization - Invite collaborators with specific roles
+     * Create tenant invite
+     */
+    createInvite(requestParameters: CreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateInvite200Response>;
+    /**
+     * Creates a new custom role for the tenant with specified permissions.  ## Authentication Requires JWT token with tenant context and appropriate permissions.  ## Permission Format Permissions should be in the format: `namespace:resource#relation` - Tenant-wide: `tenant#relation` - Resource-specific: `project:uuid#relation`  ## Use Cases - Create custom roles for specific workflows - Define project-specific permissions - Build granular access control
+     * Create role
+     */
+    createRoleRaw(requestParameters: CreateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateRole200Response>>;
+    /**
+     * Creates a new custom role for the tenant with specified permissions.  ## Authentication Requires JWT token with tenant context and appropriate permissions.  ## Permission Format Permissions should be in the format: `namespace:resource#relation` - Tenant-wide: `tenant#relation` - Resource-specific: `project:uuid#relation`  ## Use Cases - Create custom roles for specific workflows - Define project-specific permissions - Build granular access control
+     * Create role
+     */
+    createRole(requestParameters: CreateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateRole200Response>;
+    /**
+     * Creates a new tenant organization with Stripe customer, sets up owner role, and makes it the active tenant for the creator.  ## Authentication Requires JWT token.  ## Process 1. Creates Stripe customer (if billing_email provided) 2. Creates tenant in database 3. Sets up default tenant settings 4. Adds creator as owner 5. Assigns owner role with all permissions 6. Sets as active tenant and returns JWT token
+     * Create tenant
+     */
+    createTenantRaw(requestParameters: CreateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateTenant200Response>>;
+    /**
+     * Creates a new tenant organization with Stripe customer, sets up owner role, and makes it the active tenant for the creator.  ## Authentication Requires JWT token.  ## Process 1. Creates Stripe customer (if billing_email provided) 2. Creates tenant in database 3. Sets up default tenant settings 4. Adds creator as owner 5. Assigns owner role with all permissions 6. Sets as active tenant and returns JWT token
+     * Create tenant
+     */
+    createTenant(requestParameters: CreateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateTenant200Response>;
+    /**
+     * Deletes a role and removes all associated Keto relationships for users who had this role assigned.  ## Authentication Requires JWT token with tenant context and appropriate permissions.  ## Use Cases - Remove obsolete roles - Clean up role definitions - Revoke all permissions from role users
+     * Delete role
+     */
+    deleteRoleRaw(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteRole200Response>>;
+    /**
+     * Deletes a role and removes all associated Keto relationships for users who had this role assigned.  ## Authentication Requires JWT token with tenant context and appropriate permissions.  ## Use Cases - Remove obsolete roles - Clean up role definitions - Revoke all permissions from role users
+     * Delete role
+     */
+    deleteRole(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteRole200Response>;
+    /**
+     * Deletes a tenant organization and performs cleanup of Stripe customer, Keto permissions, and user associations.  ## Authentication Requires JWT token with `delete_tenant` permission.  ## Process 1. Verifies user has delete permission 2. Archives Stripe customer 3. Deletes tenant (cascades to users, settings, invites) 4. Cleans up all affected users\' tenant state
+     * Delete tenant
+     */
+    deleteTenantRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteTenant200Response>>;
+    /**
+     * Deletes a tenant organization and performs cleanup of Stripe customer, Keto permissions, and user associations.  ## Authentication Requires JWT token with `delete_tenant` permission.  ## Process 1. Verifies user has delete permission 2. Archives Stripe customer 3. Deletes tenant (cascades to users, settings, invites) 4. Cleans up all affected users\' tenant state
+     * Delete tenant
+     */
+    deleteTenant(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteTenant200Response>;
+    /**
+     * Returns all available permission namespaces and their relations from the database.  ## Authentication Requires JWT token with appropriate permissions.  ## Use Cases - Discover available permission namespaces - List relations for each namespace - Build dynamic permission UIs
+     * Get namespace definitions
+     */
+    getRoleDefinitionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRoleDefinitions200Response>>;
+    /**
+     * Returns all available permission namespaces and their relations from the database.  ## Authentication Requires JWT token with appropriate permissions.  ## Use Cases - Discover available permission namespaces - List relations for each namespace - Build dynamic permission UIs
+     * Get namespace definitions
+     */
+    getRoleDefinitions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRoleDefinitions200Response>;
+    /**
+     * Checks whether the tenant has billing information configured in Stripe and if it\'s active.  ## Authentication Requires JWT token with tenant context.  ## Use Cases - Check if billing setup is required - Conditional feature access - Payment method verification
+     * Get billing status
+     */
+    getTenantBillingStatusRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTenantBillingStatus200Response>>;
+    /**
+     * Checks whether the tenant has billing information configured in Stripe and if it\'s active.  ## Authentication Requires JWT token with tenant context.  ## Use Cases - Check if billing setup is required - Conditional feature access - Payment method verification
+     * Get billing status
+     */
+    getTenantBillingStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTenantBillingStatus200Response>;
+    /**
+     * Generates a JWT token for direct PostgREST database access with the user\'s active tenant context.  ## Authentication Requires JWT token and active tenant.  ## Use Cases - Client-side database queries - Real-time subscriptions - Direct PostgREST API access
+     * Get PostgREST JWT token
+     */
+    getTenantJWTRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTenantJWT200Response>>;
+    /**
+     * Generates a JWT token for direct PostgREST database access with the user\'s active tenant context.  ## Authentication Requires JWT token and active tenant.  ## Use Cases - Client-side database queries - Real-time subscriptions - Direct PostgREST API access
+     * Get PostgREST JWT token
+     */
+    getTenantJWT(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTenantJWT200Response>;
+    /**
+     * Returns all roles for the authenticated tenant, including both system roles and custom tenant-specific roles.  ## Authentication Requires JWT token with tenant context.  ## Use Cases - Display available roles to assign - Role management UI - Permission auditing
+     * List roles
+     */
+    listRolesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListRoles200Response>>;
+    /**
+     * Returns all roles for the authenticated tenant, including both system roles and custom tenant-specific roles.  ## Authentication Requires JWT token with tenant context.  ## Use Cases - Display available roles to assign - Role management UI - Permission auditing
+     * List roles
+     */
+    listRoles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListRoles200Response>;
+    /**
+     * Returns all active Stripe subscriptions associated with the tenant\'s Stripe customer.  ## Authentication Requires JWT token with tenant context.  ## Use Cases - Display current subscriptions - Billing overview - Subscription management UI
+     * Get tenant subscriptions
+     */
+    listTenantSubscriptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListTenantSubscriptions200Response>>;
+    /**
+     * Returns all active Stripe subscriptions associated with the tenant\'s Stripe customer.  ## Authentication Requires JWT token with tenant context.  ## Use Cases - Display current subscriptions - Billing overview - Subscription management UI
+     * Get tenant subscriptions
+     */
+    listTenantSubscriptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListTenantSubscriptions200Response>;
+    /**
+     * Returns all users who are members of the tenant with their profile information and roles.  ## Authentication Requires JWT token with `view_users` permission.  ## Use Cases - Display team members list - User management UI - Member directory
+     * Get tenant users
+     */
+    listTenantUsersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListTenantUsers200Response>>;
+    /**
+     * Returns all users who are members of the tenant with their profile information and roles.  ## Authentication Requires JWT token with `view_users` permission.  ## Use Cases - Display team members list - User management UI - Member directory
+     * Get tenant users
+     */
+    listTenantUsers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListTenantUsers200Response>;
+    /**
+     * Removes a user from the tenant and cleans up all associated permissions and Keto relationships.  ## Authentication Requires JWT token with `remove_user` permission.  ## Restrictions - Cannot remove the last owner (must have at least one owner) - Removing an owner requires `remove_owner_role` permission  ## Process 1. Verifies permissions 2. Removes from role\'s user list 3. Deletes all Keto relationships 4. Removes from database 5. Cleans up user\'s tenant state
+     * Remove tenant user
+     */
+    removeTenantUserRaw(requestParameters: RemoveTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HandlersSuccessResponse>>;
+    /**
+     * Removes a user from the tenant and cleans up all associated permissions and Keto relationships.  ## Authentication Requires JWT token with `remove_user` permission.  ## Restrictions - Cannot remove the last owner (must have at least one owner) - Removing an owner requires `remove_owner_role` permission  ## Process 1. Verifies permissions 2. Removes from role\'s user list 3. Deletes all Keto relationships 4. Removes from database 5. Cleans up user\'s tenant state
+     * Remove tenant user
+     */
+    removeTenantUser(requestParameters: RemoveTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HandlersSuccessResponse>;
+    /**
+     * Updates the user\'s active tenant in Kratos identity and returns a new JWT token with updated tenant context.  ## Authentication Requires JWT token.  ## Use Cases - Switch between organizations - Change context for multi-tenant users
+     * Switch active tenant
+     */
+    switchActiveTenantRaw(requestParameters: SwitchActiveTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SwitchActiveTenant200Response>>;
+    /**
+     * Updates the user\'s active tenant in Kratos identity and returns a new JWT token with updated tenant context.  ## Authentication Requires JWT token.  ## Use Cases - Switch between organizations - Change context for multi-tenant users
+     * Switch active tenant
+     */
+    switchActiveTenant(requestParameters: SwitchActiveTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SwitchActiveTenant200Response>;
+    /**
+     * Updates the permissions for an existing role. This will update Keto relationships for all users assigned to this role.  ## Authentication Requires JWT token with tenant context and appropriate permissions.  ## Permission Format Permissions should be in the format: `namespace:resource#relation`  ## Use Cases - Modify role permissions - Grant or revoke access - Update role capabilities
+     * Update role
+     */
+    updateRoleRaw(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateRole200Response>>;
+    /**
+     * Updates the permissions for an existing role. This will update Keto relationships for all users assigned to this role.  ## Authentication Requires JWT token with tenant context and appropriate permissions.  ## Permission Format Permissions should be in the format: `namespace:resource#relation`  ## Use Cases - Modify role permissions - Grant or revoke access - Update role capabilities
+     * Update role
+     */
+    updateRole(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateRole200Response>;
+    /**
+     * Updates a user\'s role in the tenant and updates all associated Keto permissions.  ## Authentication Requires JWT token with `update_user_role` permission.  ## Restrictions - Promoting to owner requires `update_user_role_to_owner` permission - Demoting from owner requires `remove_owner_role` permission - Cannot demote the last owner (must have at least one owner)  ## Process 1. Verifies permissions 2. Removes old role permissions 3. Updates database 4. Assigns new role permissions
+     * Update user role
+     */
+    updateTenantUserRoleRaw(requestParameters: UpdateTenantUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateTenantUserRole200Response>>;
+    /**
+     * Updates a user\'s role in the tenant and updates all associated Keto permissions.  ## Authentication Requires JWT token with `update_user_role` permission.  ## Restrictions - Promoting to owner requires `update_user_role_to_owner` permission - Demoting from owner requires `remove_owner_role` permission - Cannot demote the last owner (must have at least one owner)  ## Process 1. Verifies permissions 2. Removes old role permissions 3. Updates database 4. Assigns new role permissions
+     * Update user role
+     */
+    updateTenantUserRole(requestParameters: UpdateTenantUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateTenantUserRole200Response>;
+}