Skip to main content

Module generated

Module generated 

Source
Expand description

Everything the API document describes, written by the SDK generator and never by hand.

It is reached as a module rather than flattened into this one on purpose. The document declares schemas called Event and EventType, which are the API’s own resources and not the Event an emitter fills in here; re-exporting them side by side would either fail to compile or, worse, let a glob quietly drop whichever one lost. Under a module of its own, every name the document declares is reachable, unambiguous, and safe for the API to add to.

It follows the producer feature because everything it declares is the control plane of the API: a consumer that only verifies webhook signatures pulls in none of it. Everything the API document describes: one type per schema it declares, one closed enum per enumeration it names, one variant per problem it can report, and one method per operation, grouped by the entity its operation id names.

Everything the document does not describe — reaching the network, retrying a send, verifying a webhook signature — is hand-written beside this directory and never regenerated. The two meet at the [Transport] trait declared here, which the hand-written half implements.

Structs§

Application
The Application the API declares.
ApplicationInfo
The ApplicationInfo the API declares.
ApplicationInfoConsumption
The ApplicationInfoConsumption the API declares.
ApplicationInfoOnboardingSteps
The ApplicationInfoOnboardingSteps the API declares.
ApplicationInfoQuotas
The ApplicationInfoQuotas the API declares.
ApplicationPost
The ApplicationPost the API declares.
ApplicationSecret
The ApplicationSecret the API declares.
ApplicationSecretPost
The ApplicationSecretPost the API declares.
ApplicationSecretsApi
What the API declares under applicationSecrets.
ApplicationsApi
What the API declares under applications.
ErrorsApi
What the API declares under errors.
Event
The Event the API declares.
EventPost
The EventPost the API declares.
EventType
The EventType the API declares.
EventTypePost
The EventTypePost the API declares.
EventTypesApi
What the API declares under eventTypes.
EventWithPayload
The EventWithPayload the API declares.
EventsApi
What the API declares under events.
EventsPerDayApi
What the API declares under events_per_day.
EventsPerDayEntry
The EventsPerDayEntry the API declares.
IngestedEvent
The IngestedEvent the API declares.
InstanceApi
What the API declares under instance.
InstanceConfig
The InstanceConfig the API declares.
InstanceConfigFormbricks
The InstanceConfigFormbricks the API declares.
InstanceConfigMatomo
The InstanceConfigMatomo the API declares.
Organization
The Organization the API declares.
OrganizationInfo
The OrganizationInfo the API declares.
OrganizationInfoConsumption
The OrganizationInfoConsumption the API declares.
OrganizationInfoOnboardingSteps
The OrganizationInfoOnboardingSteps the API declares.
OrganizationInfoPlan
The OrganizationInfoPlan the API declares.
OrganizationInfoQuotas
The OrganizationInfoQuotas the API declares.
OrganizationInfoUsers
The OrganizationInfoUsers the API declares.
OrganizationPlan
The OrganizationPlan the API declares.
PayloadContentTypesApi
What the API declares under payload_content_types.
Problem
The Problem the API declares.
ProblemError
What the API answered when it did not answer a success.
QuotasApi
What the API declares under quotas.
QuotasResponse
The QuotasResponse the API declares.
QuotasResponseLimits
The QuotasResponseLimits the API declares.
ReplayEvent
The ReplayEvent the API declares.
RequestAttempt
The RequestAttempt the API declares.
RequestAttemptEvent
The RequestAttemptEvent the API declares.
RequestAttemptStatus
The RequestAttemptStatus the API declares.
RequestAttemptSubscription
The RequestAttemptSubscription the API declares.
RequestAttemptsApi
What the API declares under requestAttempts.
Response
The Response the API declares.
ResponseApi
What the API declares under response.
ServiceToken
The ServiceToken the API declares.
ServiceTokenApi
What the API declares under serviceToken.
ServiceTokenPost
The ServiceTokenPost the API declares.
Subscription
The Subscription the API declares.
SubscriptionPost
The SubscriptionPost the API declares.
SubscriptionPostTarget
The SubscriptionPostTarget the API declares.
SubscriptionTarget
The SubscriptionTarget the API declares.
SubscriptionsApi
What the API declares under subscriptions.

Enums§

ApplicationInfoOnboardingStepsEvent
One of the values the API answers with.
ApplicationInfoOnboardingStepsEventType
One of the values the API answers with.
ApplicationInfoOnboardingStepsSubscription
One of the values the API answers with.
OrganizationInfoOnboardingStepsApplication
One of the values the API answers with.
OrganizationInfoOnboardingStepsEvent
One of the values the API answers with.
OrganizationInfoOnboardingStepsEventType
One of the values the API answers with.
OrganizationInfoOnboardingStepsSubscription
One of the values the API answers with.
ProblemId
One of the values the API answers with.
RequestAttemptStatusType
One of the values the API answers with.
RequestError
Everything a generated method answers instead of what it was asked for.

Traits§

Transport
What a generated method issues its request through.

Functions§

problem_for
The failure the API reported, and nothing at all when what it answered was a success.