Files
formbricks/packages/api/README.md
Midka 7fa2a260e8 create: api wrapper & errors package (#262)
* add @formbricks/api (api abstraction layer) and @formbricks/errors package to monorepo
* use @formbricks/api in @formbricks/js to expose an api endpoint

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-06-01 14:02:53 +02:00

1014 B

@formbricks/api - API Wrapper for Formbricks

Installation

npm install @formbricks/api

Usage

Create API Client
import { FormbricksAPI, EnvironmentId } from "@formbricks/api";

const api = new FormbricksAPI({
  apiHost: "http://localhost:3000",
  environmentId: "clgwh8maj0005n2f66pwzev3r" as EnvironmentId,
});

Note

All of the following methods return a Result from the @formbricks/errors package.

Create a new response
const response = await api.createResponse({
  surveyId: "......" as SurveyId,
  personId: "......" as PersonId,
  data: {
    questionId: "response",
  },
});
Update an existing response
const response = await api.updateResponse({
  responseId: "......" as ResponseId, // If you pass response.value.id from createResponse, you dont need 'as ResponseId'
  data: {
    questionId: "response",
  },
});