sdk

7.0.1

Explore all defined data models and types for this version. For live editing and client SDK generators, inspect on TypeHub.

Open in TypeHub
Defined Types (275)
Backend_AccountChangePassword
Type
Backend_Action
This object represents the business logic which can be executed either through an operation or cronjob
Type
Backend_ActionCollection
A paginated collection of action objects
Type
Backend_ActionCommit
An action commit which represents a change in the action configuration
Type
Backend_ActionCommitCollection
A paginated collection of action commit objects
Type
Backend_ActionConfig
The action configuration which contains arbitrary key-value entries
Type
Backend_ActionCreate
Type
Backend_ActionExecuteRequest
Represents a request to execute an action
Type
Backend_ActionExecuteRequestBody
Represents a request body
Type
Backend_ActionExecuteResponse
Represents an action execution response
Type
Backend_ActionExecuteResponseBody
Represents a response body
Type
Backend_ActionExecuteResponseHeaders
Represents a map of headers
Type
Backend_ActionIndex
Contains all possible classes which can be used at an action as class
Type
Backend_ActionIndexEntry
Represents a concrete action class
Type
Backend_ActionUpdate
Type
Backend_Agent
This object represents an agent
Type
Backend_AgentCollection
Represents a collection of agent messages
Type
Backend_AgentContent
Agent message
Type
Backend_AgentContentBinary
Binary agent message
Type
Backend_AgentContentChoice
Choice agent message
Type
Backend_AgentContentObject
Structured agent message
Type
Backend_AgentContentText
Text agent message
Type
Backend_AgentContentToolCall
Tool call agent message
Type
Backend_AgentContentToolCallFunction
Concrete values for a function tool call
Type
Backend_AgentCreate
Type
Backend_AgentInput
This object represents an agent input
Type
Backend_AgentMessage
This object represents an agent message
Type
Backend_AgentMessageCollection
Represents a collection of agent messages
Type
Backend_AgentOutput
This object represents an agent output
Type
Backend_AgentTool
Represents a concrete tool
Type
Backend_AgentTools
Represents a collection of available tools
Type
Backend_AgentUpdate
Type
Backend_App
This object represents an app to access the API on-behalf of a user
Type
Backend_AppCollection
A paginated collection of app objects
Type
Backend_AppCreate
Type
Backend_AppUpdate
Type
Backend_Audit
This object represents an audit which is created every time something was changed at the system
Type
Backend_AuditCollection
A paginated collection of audit objects
Type
Backend_AuditObject
A key value object containing the changes
Type
Backend_BackupExport
Export of the complete system configuration
Type
Backend_BackupImport
Import a previously exported system configuration
Type
Backend_BackupImportResult
Result of a backup import operation
Type
Backend_Bundle
This object represents a bundle which contains action, schema, event, cronjob and trigger configurations from you local instance
Type
Backend_BundleCollection
A paginated collection of bundle objects
Type
Backend_BundleConfig
Type
Backend_BundleCreate
Type
Backend_BundleUpdate
Type
Backend_Category
This object represents a category. Every user is assigned to a category and can only view objects which are also assigned to the same category, through this it is possible to build separate areas for external developers
Type
Backend_CategoryCollection
A paginated collection of category objects
Type
Backend_CategoryCreate
Type
Backend_CategoryUpdate
Type
Backend_Config
This object represents a system configuration
Type
Backend_ConfigCollection
A paginated collection of config objects
Type
Backend_ConfigUpdate
Type
Backend_Connection
This object represents a connection to an external system like i.e. a database, message-queue or client-sdk
Type
Backend_ConnectionCollection
A paginated collection of connection objects
Type
Backend_ConnectionConfig
The connection configuration which contains arbitrary key-value entries
Type
Backend_ConnectionCreate
Type
Backend_ConnectionIndex
Contains all possible classes which can be used at an connection as class
Type
Backend_ConnectionIndexEntry
Represents a concrete connection class
Type
Backend_ConnectionRedirectResponse
Redirect response to initiate an OAuth2 flow
Type
Backend_ConnectionUpdate
Type
Backend_Cronjob
This object represents a cronjob which can invoke an action at a specific interval
Type
Backend_CronjobCollection
A paginated collection of cronjob objects
Type
Backend_CronjobCreate
Type
Backend_CronjobError
Represents an error which occurred on cronjob execution
Type
Backend_CronjobUpdate
Type
Backend_Dashboard
Represents an object containing all widget data for the dashboard
Type
Backend_DatabaseRow
This object represents a row on a relational table
Type
Backend_DatabaseRowCollection
A paginated collection of database rows
Type
Backend_DatabaseTable
This object represents a relational table on a database connection
Type
Backend_DatabaseTableCollection
Type
Backend_DatabaseTableColumn
This object represents a column at a relation table
Type
Backend_DatabaseTableForeignKeyConstraint
This object represents a foreign key constraint on a relational database
Type
Backend_DatabaseTableIndex
This object represents a table index on a relational database
Type
Backend_Event
This object represents an event which can be triggered by an action
Type
Backend_EventCollection
A paginated collection of event objects
Type
Backend_EventCreate
Type
Backend_EventUpdate
Type
Backend_File
This object represents a file on the filesystem
Type
Backend_FileCollection
A paginated collection of file objects
Type
Backend_Firewall
This object represents a firewall rule which blocks specific IP addresses
Type
Backend_FirewallCollection
A paginated collection of firewall objects
Type
Backend_FirewallCreate
Type
Backend_FirewallUpdate
Type
Backend_Form
This object represents a form which helps to dynamically generate a form at a frontend app
Type
Backend_FormCollection
A paginated collection of form objects
Type
Backend_FormCreate
Type
Backend_FormUpdate
Type
Backend_GeneratorIndexProvider
Represents a concrete generator class
Type
Backend_GeneratorIndexProviders
Contains all possible classes which can be used at an generator as class
Type
Backend_GeneratorProvider
Type
Backend_GeneratorProviderChangelog
Type
Backend_GeneratorProviderConfig
Type
Backend_HttpRequest
This object represents a HTTP request
Type
Backend_HttpResponse
This object represents a HTTP response
Type
Backend_Identity
This object represents an identity which allows to authenticate with a remote identity provider
Type
Backend_IdentityCollection
A paginated collection of identity objects
Type
Backend_IdentityConfig
Type
Backend_IdentityCreate
Type
Backend_IdentityIndex
Contains all possible classes which can be used at an identity as class
Type
Backend_IdentityIndexEntry
Represents a concrete identity class
Type
Backend_IdentityUpdate
Type
Backend_Log
This object represents a log entry. Every HTTP requests to the system generates such a log entry.
Type
Backend_LogCollection
A paginated collection of log objects
Type
Backend_LogError
Type
Backend_LogErrorCollection
A paginated collection of log error objects
Type
Backend_Operation
This object represents an operation, an operation invokes an action in case a specific HTTP method and path was requested. It defines also schema information about the request and response payload
Type
Backend_OperationCollection
A paginated collection of operation objects
Type
Backend_OperationCreate
Type
Backend_OperationParameters
Type
Backend_OperationSchema
Type
Backend_OperationThrows
Type
Backend_OperationUpdate
Type
Backend_Page
This object represents a page at the developer portal
Type
Backend_PageCollection
A paginated collection of page objects
Type
Backend_PageCreate
Type
Backend_PageUpdate
Type
Backend_Plan
This object represents a plan, a plan allows users to obtain points or in general subscribe to your app
Type
Backend_PlanCollection
A paginated collection of plan objects
Type
Backend_PlanCreate
Type
Backend_PlanUpdate
Type
Backend_Rate
This object represents a rate limitation, which allows to limit the requests which a user can send
Type
Backend_RateAllocation
This object represents a rate allocation, in case a request matches it gets assigned to the attached rate
Type
Backend_RateCollection
A paginated collection of rate objects
Type
Backend_RateCreate
Type
Backend_RateUpdate
Type
Backend_Role
This object represents a role, every user is assigned to a role and all scopes of the role are automatically attached to the user
Type
Backend_RoleCollection
A paginated collection of role objects
Type
Backend_RoleCreate
Type
Backend_RoleUpdate
Type
Backend_Schema
This object represents a schema to describe a JSON payload
Type
Backend_SchemaCollection
A paginated collection of schema objects
Type
Backend_SchemaCommit
A schema commit which represents a change in the schema source
Type
Backend_SchemaCommitCollection
A paginated collection of schema commit objects
Type
Backend_SchemaCreate
Type
Backend_SchemaPreviewResponse
Type
Backend_SchemaSource
Contains the TypeSchema specification
Type
Backend_SchemaUpdate
Type
Backend_Scope
This object represents a scope. A scope is assigned to a user and is required to access operations
Type
Backend_ScopeCategories
Type
Backend_ScopeCategory
Type
Backend_ScopeCategoryScope
Type
Backend_ScopeCollection
A paginated collection of scope objects
Type
Backend_ScopeCreate
Type
Backend_ScopeOperation
Type
Backend_ScopeUpdate
Type
Backend_SdkGenerate
Type
Backend_SdkMessage
Type
Backend_SdkResponse
Type
Backend_SdkTypes
Represents available SDK type which can be generated
Type
Backend_StatisticChart
Type
Backend_StatisticChartSeries
Type
Backend_StatisticCount
Type
Backend_Taxonomy
This object represents a taxonomy. A taxonomy helps to internally organize operations, actions and other entities
Type
Backend_TaxonomyCollection
A paginated collection of taxonomy objects
Type
Backend_TaxonomyCreate
Type
Backend_TaxonomyMove
Moves the provided objects to a taxonomy
Type
Backend_TaxonomyUpdate
Type
Backend_Test
This object represents a test. A test helps to verify that all operations work as expected
Type
Backend_TestCollection
A paginated collection of test objects
Type
Backend_TestConfig
Type
Backend_Token
This object represents a token, this an access token which was requested by a user
Type
Backend_TokenCollection
A paginated collection of token objects
Type
Backend_Transaction
This object represents a transaction. The system generates a transaction in case a payment was successfully executed
Type
Backend_TransactionCollection
A paginated collection of transaction objects
Type
Backend_TrashData
Type
Backend_TrashDataCollection
A paginated collection of deleted objects
Type
Backend_TrashRestore
Type
Backend_TrashTypes
Type
Backend_Trigger
This object represents a trigger which can invoke an action on a custom event
Type
Backend_TriggerCollection
A paginated collection of trigger objects
Type
Backend_TriggerCreate
Type
Backend_TriggerUpdate
Type
Backend_User
This object represents a user
Type
Backend_UserCollection
A paginated collection of user objects
Type
Backend_UserCreate
Type
Backend_UserUpdate
Type
Backend_Webhook
This object represents a webhook, a webhook is called in case a specific event was triggered
Type
Backend_WebhookCollection
A paginated collection of webhook objects
Type
Backend_WebhookCreate
Type
Backend_WebhookResponse
Type
Backend_WebhookUpdate
Type
Common_Collection
Base collection
Type
Common_FormContainer
Represents a config form with a list of elements
Type
Common_FormElement
Form base element
Type
Common_FormElementInput
Form element which represents an input element
Type
Common_FormElementSelect
Form element which represents a select element
Type
Common_FormElementSelectOption
Represents a concrete option entry
Type
Common_FormElementTag
Form element which represents an input tag editor to enter comma-separated values
Type
Common_FormElementTextArea
Form element which represents a textarea
Type
Common_Message
Common error message
Type
Common_Metadata
Type
Consumer_App
Type
Consumer_AppCollection
Type
Consumer_AppCreate
Type
Consumer_AppUpdate
Type
Consumer_AuthorizeMeta
Type
Consumer_AuthorizeRequest
Type
Consumer_AuthorizeResponse
Type
Consumer_Event
Type
Consumer_EventCollection
Type
Consumer_Form
Type
Consumer_FormCollection
Type
Consumer_Grant
Type
Consumer_GrantCollection
Type
Consumer_Identity
Type
Consumer_IdentityCollection
Type
Consumer_Log
Type
Consumer_LogCollection
Type
Consumer_Page
Type
Consumer_PageCollection
Type
Consumer_PaymentCheckoutRequest
Type
Consumer_PaymentCheckoutResponse
Type
Consumer_PaymentPortalRequest
Type
Consumer_PaymentPortalResponse
Type
Consumer_Plan
Type
Consumer_PlanCollection
Type
Consumer_Scope
Type
Consumer_ScopeCategories
Type
Consumer_ScopeCategory
Type
Consumer_ScopeCategoryScope
Type
Consumer_ScopeCollection
Type
Consumer_Token
Type
Consumer_TokenAccessToken
Type
Consumer_TokenCollection
Type
Consumer_TokenCreate
Type
Consumer_TokenUpdate
Type
Consumer_Transaction
Type
Consumer_TransactionCollection
Type
Consumer_UserAccount
Type
Consumer_UserActivate
Type
Consumer_UserEmail
Type
Consumer_UserJWT
Type
Consumer_UserLogin
Type
Consumer_UserPasswordReset
Type
Consumer_UserPlan
Type
Consumer_UserRefresh
Type
Consumer_UserRegister
Type
Consumer_Webhook
Type
Consumer_WebhookCollection
Type
Consumer_WebhookCreate
Type
Consumer_WebhookResponse
Type
Consumer_WebhookUpdate
Type
MarketplaceAction
Type
MarketplaceActionCollection
Type
MarketplaceActionConfig
Type
MarketplaceApp
Type
MarketplaceAppCollection
Type
MarketplaceBundle
Type
MarketplaceBundleAction
Type
MarketplaceBundleActionConfig
Type
MarketplaceBundleCollection
Type
MarketplaceBundleConfig
Type
MarketplaceBundleCronjob
Type
MarketplaceBundleEvent
Type
MarketplaceBundleSchema
Type
MarketplaceBundleSchemaSource
Type
MarketplaceBundleTrigger
Type
MarketplaceCollection
Type
MarketplaceInstall
Installs an object from the marketplace
Type
MarketplaceMessage
Type
MarketplaceObject
Base class of all objects on the marketplace
Type
MarketplaceUser
Type
Passthru
No schema information available
Type
System_About
Type
System_AboutApps
Type
System_AboutLink
Type
System_HealthCheck
Type
System_Route
Type
System_RouteMethod
Type
System_RoutePath
Type
System_Schema
Type
System_SchemaForm
Type
System_SchemaTypeSchema
Type
part of the Apioo-Project