mudbase-sdk 1.3.13 → 2.3.13

package/docs/RoleElevationApi.md

@@ -2,76 +2,54 @@
 
 All URIs are relative to *https://cloud.mudbase.dev*
 
-| Method | HTTP request | Description |
+|Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-| [**approveRoleElevation**](RoleElevationApi.md#approveroleelevationoperation) | **POST** /api/orgs/{orgId}/role-elevation/{requestId}/approve | Approve/reject role elevation request (admin only) |
-| [**getPendingRoleElevationRequests**](RoleElevationApi.md#getpendingroleelevationrequests) | **GET** /api/orgs/{orgId}/role-elevation/pending | Get pending role elevation requests (admin only) |
-| [**getRoleElevationStatus**](RoleElevationApi.md#getroleelevationstatus) | **GET** /api/projects/{projectId}/role-elevation/status | Get role elevation status |
-| [**requestRoleElevation**](RoleElevationApi.md#requestroleelevationoperation) | **POST** /api/projects/{projectId}/role-elevation/request | Request role elevation |
-| [**uploadVerificationDocuments**](RoleElevationApi.md#uploadverificationdocumentsoperation) | **POST** /api/projects/{projectId}/role-elevation/documents | Upload verification documents |
+|[**approveRoleElevation**](#approveroleelevation) | **POST** /api/orgs/{orgId}/role-elevation/{requestId}/approve | Approve/reject role elevation request (admin only)|
+|[**getPendingRoleElevationRequests**](#getpendingroleelevationrequests) | **GET** /api/orgs/{orgId}/role-elevation/pending | Get pending role elevation requests (admin only)|
+|[**getRoleElevationStatus**](#getroleelevationstatus) | **GET** /api/projects/{projectId}/role-elevation/status | Get role elevation status|
+|[**requestRoleElevation**](#requestroleelevation) | **POST** /api/projects/{projectId}/role-elevation/request | Request role elevation|
+|[**uploadVerificationDocuments**](#uploadverificationdocuments) | **POST** /api/projects/{projectId}/role-elevation/documents | Upload verification documents|
 
-
-
-## approveRoleElevation
-
-> ApproveRoleElevation200Response approveRoleElevation(orgId, requestId, approveRoleElevationRequest)
-
-Approve/reject role elevation request (admin only)
+# **approveRoleElevation**
+> ApproveRoleElevation200Response approveRoleElevation(approveRoleElevationRequest)
 
 Admin approves or rejects a role elevation request
 
 ### Example
 
-```ts
+```typescript
 import {
-  Configuration,
-  RoleElevationApi,
+    RoleElevationApi,
+    Configuration,
+    ApproveRoleElevationRequest
 } from 'mudbase-sdk';
-import type { ApproveRoleElevationOperationRequest } from 'mudbase-sdk';
-
-async function example() {
-  console.log("🚀 Testing mudbase-sdk SDK...");
-  const config = new Configuration({ 
-    // Configure HTTP bearer authorization: OrgBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-    // Configure HTTP bearer authorization: ProjectBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-  });
-  const api = new RoleElevationApi(config);
-
-  const body = {
-    // string
-    orgId: orgId_example,
-    // string
-    requestId: requestId_example,
-    // ApproveRoleElevationRequest
-    approveRoleElevationRequest: {"approved":true,"reason":"All requirements met"},
-  } satisfies ApproveRoleElevationOperationRequest;
-
-  try {
-    const data = await api.approveRoleElevation(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
+
+const configuration = new Configuration();
+const apiInstance = new RoleElevationApi(configuration);
+
+let orgId: string; // (default to undefined)
+let requestId: string; // (default to undefined)
+let approveRoleElevationRequest: ApproveRoleElevationRequest; //
+
+const { status, data } = await apiInstance.approveRoleElevation(
+    orgId,
+    requestId,
+    approveRoleElevationRequest
+);
 ```
 
 ### Parameters
 
-
-| Name | Type | Description  | Notes |
+|Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **orgId** | `string` |  | [Defaults to `undefined`] |
-| **requestId** | `string` |  | [Defaults to `undefined`] |
-| **approveRoleElevationRequest** | [ApproveRoleElevationRequest](ApproveRoleElevationRequest.md) |  | |
+| **approveRoleElevationRequest** | **ApproveRoleElevationRequest**|  | |
+| **orgId** | [**string**] |  | defaults to undefined|
+| **requestId** | [**string**] |  | defaults to undefined|
+
 
 ### Return type
 
-[**ApproveRoleElevation200Response**](ApproveRoleElevation200Response.md)
+**ApproveRoleElevation200Response**
 
 ### Authorization
 
@@ -79,84 +57,62 @@ example().catch(console.error);
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
+ - **Content-Type**: application/json
+ - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Request approved/rejected |  -  |
-| **400** | Requirements not met |  -  |
-| **403** | Insufficient permissions |  -  |
-| **404** | Request not found |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
+|**200** | Request approved/rejected |  -  |
+|**400** | Requirements not met |  -  |
+|**403** | Insufficient permissions |  -  |
+|**404** | Request not found |  -  |
 
-## getPendingRoleElevationRequests
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-> GetPendingRoleElevationRequests200Response getPendingRoleElevationRequests(orgId, status, page, limit)
-
-Get pending role elevation requests (admin only)
+# **getPendingRoleElevationRequests**
+> GetPendingRoleElevationRequests200Response getPendingRoleElevationRequests()
 
 Get all pending role elevation requests requiring admin approval
 
 ### Example
 
-```ts
+```typescript
 import {
-  Configuration,
-  RoleElevationApi,
+    RoleElevationApi,
+    Configuration
 } from 'mudbase-sdk';
-import type { GetPendingRoleElevationRequestsRequest } from 'mudbase-sdk';
-
-async function example() {
-  console.log("🚀 Testing mudbase-sdk SDK...");
-  const config = new Configuration({ 
-    // Configure HTTP bearer authorization: OrgBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-    // Configure HTTP bearer authorization: ProjectBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-  });
-  const api = new RoleElevationApi(config);
-
-  const body = {
-    // string
-    orgId: orgId_example,
-    // 'pending' | 'approved' | 'rejected' (optional)
-    status: status_example,
-    // number (optional)
-    page: 56,
-    // number (optional)
-    limit: 56,
-  } satisfies GetPendingRoleElevationRequestsRequest;
-
-  try {
-    const data = await api.getPendingRoleElevationRequests(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
+
+const configuration = new Configuration();
+const apiInstance = new RoleElevationApi(configuration);
+
+let orgId: string; // (default to undefined)
+let status: 'pending' | 'approved' | 'rejected'; // (optional) (default to 'pending')
+let page: number; // (optional) (default to 1)
+let limit: number; // (optional) (default to 50)
+
+const { status, data } = await apiInstance.getPendingRoleElevationRequests(
+    orgId,
+    status,
+    page,
+    limit
+);
 ```
 
 ### Parameters
 
-
-| Name | Type | Description  | Notes |
+|Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **orgId** | `string` |  | [Defaults to `undefined`] |
-| **status** | `pending`, `approved`, `rejected` |  | [Optional] [Defaults to `'pending'`] [Enum: pending, approved, rejected] |
-| **page** | `number` |  | [Optional] [Defaults to `1`] |
-| **limit** | `number` |  | [Optional] [Defaults to `50`] |
+| **orgId** | [**string**] |  | defaults to undefined|
+| **status** | [**&#39;pending&#39; | &#39;approved&#39; | &#39;rejected&#39;**]**Array<&#39;pending&#39; &#124; &#39;approved&#39; &#124; &#39;rejected&#39;>** |  | (optional) defaults to 'pending'|
+| **page** | [**number**] |  | (optional) defaults to 1|
+| **limit** | [**number**] |  | (optional) defaults to 50|
+
 
 ### Return type
 
-[**GetPendingRoleElevationRequests200Response**](GetPendingRoleElevationRequests200Response.md)
+**GetPendingRoleElevationRequests200Response**
 
 ### Authorization
 
@@ -164,76 +120,54 @@ example().catch(console.error);
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | List of pending requests |  -  |
-| **403** | Insufficient permissions |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
+|**200** | List of pending requests |  -  |
+|**403** | Insufficient permissions |  -  |
 
-## getRoleElevationStatus
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-> GetRoleElevationStatus200Response getRoleElevationStatus(projectId, roleSlug)
-
-Get role elevation status
+# **getRoleElevationStatus**
+> GetRoleElevationStatus200Response getRoleElevationStatus()
 
 Get status of pending role elevation requests for current user
 
 ### Example
 
-```ts
+```typescript
 import {
-  Configuration,
-  RoleElevationApi,
+    RoleElevationApi,
+    Configuration
 } from 'mudbase-sdk';
-import type { GetRoleElevationStatusRequest } from 'mudbase-sdk';
-
-async function example() {
-  console.log("🚀 Testing mudbase-sdk SDK...");
-  const config = new Configuration({ 
-    // Configure HTTP bearer authorization: OrgBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-    // Configure HTTP bearer authorization: ProjectBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-  });
-  const api = new RoleElevationApi(config);
-
-  const body = {
-    // string
-    projectId: projectId_example,
-    // string (optional)
-    roleSlug: roleSlug_example,
-  } satisfies GetRoleElevationStatusRequest;
-
-  try {
-    const data = await api.getRoleElevationStatus(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
+
+const configuration = new Configuration();
+const apiInstance = new RoleElevationApi(configuration);
+
+let projectId: string; // (default to undefined)
+let roleSlug: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getRoleElevationStatus(
+    projectId,
+    roleSlug
+);
 ```
 
 ### Parameters
 
-
-| Name | Type | Description  | Notes |
+|Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **projectId** | `string` |  | [Defaults to `undefined`] |
-| **roleSlug** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **projectId** | [**string**] |  | defaults to undefined|
+| **roleSlug** | [**string**] |  | (optional) defaults to undefined|
+
 
 ### Return type
 
-[**GetRoleElevationStatus200Response**](GetRoleElevationStatus200Response.md)
+**GetRoleElevationStatus200Response**
 
 ### Authorization
 
@@ -241,75 +175,54 @@ example().catch(console.error);
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | List of role elevation requests |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+|**200** | List of role elevation requests |  -  |
 
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-## requestRoleElevation
-
-> RequestRoleElevation200Response requestRoleElevation(projectId, requestRoleElevationRequest)
-
-Request role elevation
+# **requestRoleElevation**
+> RequestRoleElevation200Response requestRoleElevation(requestRoleElevationRequest)
 
 User requests to upgrade to a specific role. May require payment, KYC, or admin approval based on role configuration.
 
 ### Example
 
-```ts
+```typescript
 import {
-  Configuration,
-  RoleElevationApi,
+    RoleElevationApi,
+    Configuration,
+    RequestRoleElevationRequest
 } from 'mudbase-sdk';
-import type { RequestRoleElevationOperationRequest } from 'mudbase-sdk';
-
-async function example() {
-  console.log("🚀 Testing mudbase-sdk SDK...");
-  const config = new Configuration({ 
-    // Configure HTTP bearer authorization: OrgBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-    // Configure HTTP bearer authorization: ProjectBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-  });
-  const api = new RoleElevationApi(config);
-
-  const body = {
-    // string
-    projectId: projectId_example,
-    // RequestRoleElevationRequest
-    requestRoleElevationRequest: {"roleSlug":"seller"},
-  } satisfies RequestRoleElevationOperationRequest;
-
-  try {
-    const data = await api.requestRoleElevation(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
+
+const configuration = new Configuration();
+const apiInstance = new RoleElevationApi(configuration);
+
+let projectId: string; // (default to undefined)
+let requestRoleElevationRequest: RequestRoleElevationRequest; //
+
+const { status, data } = await apiInstance.requestRoleElevation(
+    projectId,
+    requestRoleElevationRequest
+);
 ```
 
 ### Parameters
 
-
-| Name | Type | Description  | Notes |
+|Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **projectId** | `string` |  | [Defaults to `undefined`] |
-| **requestRoleElevationRequest** | [RequestRoleElevationRequest](RequestRoleElevationRequest.md) |  | |
+| **requestRoleElevationRequest** | **RequestRoleElevationRequest**|  | |
+| **projectId** | [**string**] |  | defaults to undefined|
+
 
 ### Return type
 
-[**RequestRoleElevation200Response**](RequestRoleElevation200Response.md)
+**RequestRoleElevation200Response**
 
 ### Authorization
 
@@ -317,78 +230,57 @@ example().catch(console.error);
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
+ - **Content-Type**: application/json
+ - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Role elevation request created or auto-approved |  -  |
-| **400** | Invalid request or already has role |  -  |
-| **403** | Cannot request role with higher hierarchy |  -  |
-| **404** | Role not found |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## uploadVerificationDocuments
+|**200** | Role elevation request created or auto-approved |  -  |
+|**400** | Invalid request or already has role |  -  |
+|**403** | Cannot request role with higher hierarchy |  -  |
+|**404** | Role not found |  -  |
 
-> uploadVerificationDocuments(projectId, uploadVerificationDocumentsRequest)
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-Upload verification documents
+# **uploadVerificationDocuments**
+> uploadVerificationDocuments(uploadVerificationDocumentsRequest)
 
 Upload KYC/verification documents for role elevation
 
 ### Example
 
-```ts
+```typescript
 import {
-  Configuration,
-  RoleElevationApi,
+    RoleElevationApi,
+    Configuration,
+    UploadVerificationDocumentsRequest
 } from 'mudbase-sdk';
-import type { UploadVerificationDocumentsOperationRequest } from 'mudbase-sdk';
-
-async function example() {
-  console.log("🚀 Testing mudbase-sdk SDK...");
-  const config = new Configuration({ 
-    // Configure HTTP bearer authorization: OrgBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-    // Configure HTTP bearer authorization: ProjectBearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-  });
-  const api = new RoleElevationApi(config);
-
-  const body = {
-    // string
-    projectId: projectId_example,
-    // UploadVerificationDocumentsRequest
-    uploadVerificationDocumentsRequest: {"roleSlug":"seller","documents":[{"type":"id","url":"https://example.com/id.pdf"}]},
-  } satisfies UploadVerificationDocumentsOperationRequest;
-
-  try {
-    const data = await api.uploadVerificationDocuments(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
+
+const configuration = new Configuration();
+const apiInstance = new RoleElevationApi(configuration);
+
+let projectId: string; // (default to undefined)
+let uploadVerificationDocumentsRequest: UploadVerificationDocumentsRequest; //
+
+const { status, data } = await apiInstance.uploadVerificationDocuments(
+    projectId,
+    uploadVerificationDocumentsRequest
+);
 ```
 
 ### Parameters
 
-
-| Name | Type | Description  | Notes |
+|Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **projectId** | `string` |  | [Defaults to `undefined`] |
-| **uploadVerificationDocumentsRequest** | [UploadVerificationDocumentsRequest](UploadVerificationDocumentsRequest.md) |  | |
+| **uploadVerificationDocumentsRequest** | **UploadVerificationDocumentsRequest**|  | |
+| **projectId** | [**string**] |  | defaults to undefined|
+
 
 ### Return type
 
-`void` (Empty response body)
+void (empty response body)
 
 ### Authorization
 
@@ -396,14 +288,14 @@ example().catch(console.error);
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
-- **Accept**: Not defined
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Documents uploaded successfully |  -  |
+|**200** | Documents uploaded successfully |  -  |
 
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)