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
Applicationthe API declares. - Application
Info - The
ApplicationInfothe API declares. - Application
Info Consumption - The
ApplicationInfoConsumptionthe API declares. - Application
Info Onboarding Steps - The
ApplicationInfoOnboardingStepsthe API declares. - Application
Info Quotas - The
ApplicationInfoQuotasthe API declares. - Application
Post - The
ApplicationPostthe API declares. - Application
Secret - The
ApplicationSecretthe API declares. - Application
Secret Post - The
ApplicationSecretPostthe API declares. - Application
Secrets Api - What the API declares under
applicationSecrets. - Applications
Api - What the API declares under
applications. - Errors
Api - What the API declares under
errors. - Event
- The
Eventthe API declares. - Event
Post - The
EventPostthe API declares. - Event
Type - The
EventTypethe API declares. - Event
Type Post - The
EventTypePostthe API declares. - Event
Types Api - What the API declares under
eventTypes. - Event
With Payload - The
EventWithPayloadthe API declares. - Events
Api - What the API declares under
events. - Events
PerDay Api - What the API declares under
events_per_day. - Events
PerDay Entry - The
EventsPerDayEntrythe API declares. - Ingested
Event - The
IngestedEventthe API declares. - Instance
Api - What the API declares under
instance. - Instance
Config - The
InstanceConfigthe API declares. - Instance
Config Formbricks - The
InstanceConfigFormbricksthe API declares. - Instance
Config Matomo - The
InstanceConfigMatomothe API declares. - Organization
- The
Organizationthe API declares. - Organization
Info - The
OrganizationInfothe API declares. - Organization
Info Consumption - The
OrganizationInfoConsumptionthe API declares. - Organization
Info Onboarding Steps - The
OrganizationInfoOnboardingStepsthe API declares. - Organization
Info Plan - The
OrganizationInfoPlanthe API declares. - Organization
Info Quotas - The
OrganizationInfoQuotasthe API declares. - Organization
Info Users - The
OrganizationInfoUsersthe API declares. - Organization
Plan - The
OrganizationPlanthe API declares. - Payload
Content Types Api - What the API declares under
payload_content_types. - Problem
- The
Problemthe API declares. - Problem
Error - What the API answered when it did not answer a success.
- Quotas
Api - What the API declares under
quotas. - Quotas
Response - The
QuotasResponsethe API declares. - Quotas
Response Limits - The
QuotasResponseLimitsthe API declares. - Replay
Event - The
ReplayEventthe API declares. - Request
Attempt - The
RequestAttemptthe API declares. - Request
Attempt Event - The
RequestAttemptEventthe API declares. - Request
Attempt Status - The
RequestAttemptStatusthe API declares. - Request
Attempt Subscription - The
RequestAttemptSubscriptionthe API declares. - Request
Attempts Api - What the API declares under
requestAttempts. - Response
- The
Responsethe API declares. - Response
Api - What the API declares under
response. - Service
Token - The
ServiceTokenthe API declares. - Service
Token Api - What the API declares under
serviceToken. - Service
Token Post - The
ServiceTokenPostthe API declares. - Subscription
- The
Subscriptionthe API declares. - Subscription
Post - The
SubscriptionPostthe API declares. - Subscription
Post Target - The
SubscriptionPostTargetthe API declares. - Subscription
Target - The
SubscriptionTargetthe API declares. - Subscriptions
Api - What the API declares under
subscriptions.
Enums§
- Application
Info Onboarding Steps Event - One of the values the API answers with.
- Application
Info Onboarding Steps Event Type - One of the values the API answers with.
- Application
Info Onboarding Steps Subscription - One of the values the API answers with.
- Organization
Info Onboarding Steps Application - One of the values the API answers with.
- Organization
Info Onboarding Steps Event - One of the values the API answers with.
- Organization
Info Onboarding Steps Event Type - One of the values the API answers with.
- Organization
Info Onboarding Steps Subscription - One of the values the API answers with.
- Problem
Id - One of the values the API answers with.
- Request
Attempt Status Type - One of the values the API answers with.
- Request
Error - 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.