mudbase-sdk 1.0.0

package/docs/Function.md

@@ -0,0 +1,53 @@
+
+# Function
+
+Serverless function entity (id, name, description, projectId, trigger, stats, isActive).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`projectId` | string
+`trigger` | [FunctionTrigger](FunctionTrigger.md)
+`stats` | [FunctionStats](FunctionStats.md)
+`isActive` | boolean
+`createdBy` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { Function } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "projectId": null,
+  "trigger": null,
+  "stats": null,
+  "isActive": null,
+  "createdBy": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies Function
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Function
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionExecution.md

@@ -0,0 +1,55 @@
+
+# FunctionExecution
+
+Single function execution record (id, executedAt, executionTime, success, payload, result, error).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`executedAt` | Date
+`executionTime` | number
+`success` | boolean
+`payload` | object
+`result` | object
+`error` | string
+`triggerType` | string
+`triggerEvent` | string
+`invokedBy` | string
+`retryCount` | number
+
+## Example
+
+```typescript
+import type { FunctionExecution } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "executedAt": null,
+  "executionTime": null,
+  "success": null,
+  "payload": null,
+  "result": null,
+  "error": null,
+  "triggerType": null,
+  "triggerEvent": null,
+  "invokedBy": null,
+  "retryCount": null,
+} satisfies FunctionExecution
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionExecution
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionExecutionResponse.md

@@ -0,0 +1,37 @@
+
+# FunctionExecutionResponse
+
+Response from function execution (success, result, error, executionTime).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [FunctionExecutionResponseData](FunctionExecutionResponseData.md)
+
+## Example
+
+```typescript
+import type { FunctionExecutionResponse } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies FunctionExecutionResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionExecutionResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionExecutionResponseData.md

@@ -0,0 +1,40 @@
+
+# FunctionExecutionResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`result` | object
+`error` | string
+`executionTime` | number
+
+## Example
+
+```typescript
+import type { FunctionExecutionResponseData } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "result": null,
+  "error": null,
+  "executionTime": null,
+} satisfies FunctionExecutionResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionExecutionResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionListResponse.md

@@ -0,0 +1,37 @@
+
+# FunctionListResponse
+
+Paginated list of functions.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [FunctionListResponseData](FunctionListResponseData.md)
+
+## Example
+
+```typescript
+import type { FunctionListResponse } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies FunctionListResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionListResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionListResponseData.md

@@ -0,0 +1,36 @@
+
+# FunctionListResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`functions` | [Array<Function>](Function.md)
+`pagination` | [Pagination](Pagination.md)
+
+## Example
+
+```typescript
+import type { FunctionListResponseData } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "functions": null,
+  "pagination": null,
+} satisfies FunctionListResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionListResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionLogsResponse.md

@@ -0,0 +1,37 @@
+
+# FunctionLogsResponse
+
+Paginated function execution logs and stats.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [FunctionLogsResponseData](FunctionLogsResponseData.md)
+
+## Example
+
+```typescript
+import type { FunctionLogsResponse } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies FunctionLogsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionLogsResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionLogsResponseData.md

@@ -0,0 +1,36 @@
+
+# FunctionLogsResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`executions` | [Array<FunctionExecution>](FunctionExecution.md)
+`stats` | [FunctionStats](FunctionStats.md)
+
+## Example
+
+```typescript
+import type { FunctionLogsResponseData } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "executions": null,
+  "stats": null,
+} satisfies FunctionLogsResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionLogsResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionResponse.md

@@ -0,0 +1,37 @@
+
+# FunctionResponse
+
+Response containing a single function (success, data).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [Function](Function.md)
+
+## Example
+
+```typescript
+import type { FunctionResponse } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies FunctionResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionStats.md

@@ -0,0 +1,43 @@
+
+# FunctionStats
+
+Function execution stats (total, successful, failed, avgExecutionTime, lastExecution).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalExecutions` | number
+`successfulExecutions` | number
+`failedExecutions` | number
+`avgExecutionTime` | number
+`lastExecution` | Date
+
+## Example
+
+```typescript
+import type { FunctionStats } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalExecutions": null,
+  "successfulExecutions": null,
+  "failedExecutions": null,
+  "avgExecutionTime": null,
+  "lastExecution": null,
+} satisfies FunctionStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FunctionTrigger.md

@@ -0,0 +1,47 @@
+
+# FunctionTrigger
+
+Function trigger config (type, event, schedule, path, method, collectionId, bucketId).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`event` | string
+`schedule` | string
+`path` | string
+`method` | string
+`collectionId` | string
+`bucketId` | string
+
+## Example
+
+```typescript
+import type { FunctionTrigger } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "event": null,
+  "schedule": null,
+  "path": null,
+  "method": null,
+  "collectionId": null,
+  "bucketId": null,
+} satisfies FunctionTrigger
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FunctionTrigger
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+