budibase/packages/sdk
Martin McKeaveney 84ab7862d1 fixes for google sheets, admin checklist, and deleting an app from API (#8846)
* fixes for google sheets, admin checklist, and deleting an app from API

* code review

* splitting unpublish endpoint, moving deploy endpoint to applications controller. Still to do public API work and move deployment controller into application controller

* updating REST method for unpublish in API test

* unpublish and publish endpoint on public API, delete endpoint unpublishes and deletes app

* removing skip_setup from prodAppDb call

* removing commented code

* unit tests and open API spec updates

* unpublish, publish unit tests - delete still in progress

* remove line updating app name in API test

* unit tests

* v2.1.46

* Update pro version to 2.1.46

* v2.2.0

* Update pro version to 2.2.0

* Fix for budibase plugin skeleton, which utilises the old import style.

* Fix side nav styles

* v2.2.1

* Update pro version to 2.2.1

* using dist folder to allow importing constants for openAPI specs

* v2.2.2

* Update pro version to 2.2.2

* Fix for user enrichment call (updating to @budibase/nano fork) (#9038)

* Fix for #9029 - this should fix the issue users have been experiencing with user enrichment calls in apps, essentially it utilises a fork of the nano library we use to interact with CouchDB, which has been updated to use a POST request rather than a GET request as it supports a larger set of data being sent as query parameters.

* Incrementing Nano version to attempt to fix yarn registry issues.

* v2.2.3

* Update pro version to 2.2.3

* Fix SQL table `_id` filtering (#9030)

* Re-add support for filtering on _id using external SQL tables and fix filter key prefixes not working with _id field

* Remove like operator from internal tables and only allow basic operators on SQL table _id column

* Update data section filtering to respect new rules

* Update automation section filtering to respect new rules

* Update dynamic filter component to respect new rules

* v2.2.4

* Update pro version to 2.2.4

* lock changes (#9047)

* v2.2.5

* Update pro version to 2.2.5

* Make looping arrow point in right direction (#9053)

* v2.2.6

* Update pro version to 2.2.6

* Types/attaching license to account (#9065)

* adding license type to account

* removing planDuration

* v2.2.7

* Update pro version to 2.2.7

* Environment variable type coercion fix (#9074)

* Environment variable type coercion fix

* Update .gitignore

* v2.2.8

* Update pro version to 2.2.8

* tests passing

* all tests passing, updates to public API response

* update unpublish call to return 204, openAPI spec and unit

* fixing API tests

Co-authored-by: Budibase Release Bot <>
Co-authored-by: mike12345567 <me@michaeldrury.co.uk>
Co-authored-by: Andrew Kingston <andrew@kingston.dev>
Co-authored-by: melohagan <101575380+melohagan@users.noreply.github.com>
Co-authored-by: Rory Powell <rory.codes@gmail.com>
2022-12-19 13:18:00 +00:00
..
scripts Use promises when generating public API SDK rather than promisifying after 2022-09-15 15:38:09 +01:00
src Export SDK as a class to allow multiple instances 2022-09-21 19:12:25 +01:00
.gitignore Improve SDK generation and wrap, promisify and simplify SDK client configuration 2022-09-15 15:17:19 +01:00
README.md Improve SDK generation and wrap, promisify and simplify SDK client configuration 2022-09-15 15:17:19 +01:00
package.json fixes for google sheets, admin checklist, and deleting an app from API (#8846) 2022-12-19 13:18:00 +00:00
rollup.config.js Improve SDK generation and wrap, promisify and simplify SDK client configuration 2022-09-15 15:17:19 +01:00
yarn.lock Update delete endpoints to be called destroy 2022-09-26 14:18:31 +01:00

README.md

Budibase Public API SDK

JS SDK for the Budibase Public API.

This SDK is generated by swagger-codegen.

Docker is used to run the generator, so Java is not required. Docker is the only requirement to generate the SDK.

The generated code will only run in a browser. It is not currently useable in a NodeJS environment.

Example usage

import { configure, ApplicationsApi } from "@budibase/sdk"

// Configure the API client
configure({
  apiKey: "my-api-key",
  host: "https://my.budibase.app"
})

// Search for an app.
// We can use the promisified version...
const res = await ApplicationsApi.applicationsSearchPost({ name: "foo" })
console.log("Applications:", res.data)

// ...or the callback version
ApplicationsApi.applicationsSearchPost({ name: "foo" }, ((error, data) => {
  if (error) {
    console.error("Failed to search:", error)
  } else {
    console.log("Applications:", data.data)
  }
}))