@xata.io/client 0.0.0-alpha.vf61048f → 0.0.0-alpha.vf63fddb

package/.turbo/turbo-add-version.log

@@ -1,4 +1,4 @@
 
-> @xata.io/client@0.21.6 add-version /home/runner/work/client-ts/client-ts/packages/client
+> @xata.io/client@0.26.4 add-version /home/runner/work/client-ts/client-ts/packages/client
 > node ../../scripts/add-version-file.mjs
 

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @xata.io/client@0.21.6 build /home/runner/work/client-ts/client-ts/packages/client
+> @xata.io/client@0.26.4 build /home/runner/work/client-ts/client-ts/packages/client
 > rimraf dist && rollup -c
 
 
@@ -7,7 +7,7 @@
 created dist/index.cjs in 1s
 
 src/index.ts → dist/index.mjs...
-created dist/index.mjs in 853ms
+created dist/index.mjs in 751ms
 
 src/index.ts → dist/index.d.ts...
-created dist/index.d.ts in 6.3s
+created dist/index.d.ts in 8.3s

package/CHANGELOG.md

@@ -1,14 +1,206 @@
 # @xata.io/client
 
-## 0.0.0-alpha.vf61048f
+## 0.0.0-alpha.vf63fddb
+
+### Patch Changes
+
+- Force canary build
+
+## 0.26.4
+
+### Patch Changes
+
+- [#1160](https://github.com/xataio/client-ts/pull/1160) [`7166797c`](https://github.com/xataio/client-ts/commit/7166797c28839198d20a9115d0414cebc2fed39b) Thanks [@SferaDev](https://github.com/SferaDev)! - [Files] Return file id on array
+
+- [#1156](https://github.com/xataio/client-ts/pull/1156) [`b85df75f`](https://github.com/xataio/client-ts/commit/b85df75f2f466762a8b3d9824c9292c7e3db03fd) Thanks [@SferaDev](https://github.com/SferaDev)! - [Files] Add download transformation
+
+## 0.26.3
+
+### Patch Changes
+
+- [#1144](https://github.com/xataio/client-ts/pull/1144) [`4910dce2`](https://github.com/xataio/client-ts/commit/4910dce29d3cc17d13aadf32e4eb476ffb571fad) Thanks [@SferaDev](https://github.com/SferaDev)! - Support for JSON and Revlinks
+
+## 0.26.2
+
+### Patch Changes
+
+- [#1147](https://github.com/xataio/client-ts/pull/1147) [`22fccb51`](https://github.com/xataio/client-ts/commit/22fccb51709749c319897702c15749b74ce4b820) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose metadataSignedUrl
+
+## 0.26.1
+
+### Patch Changes
+
+- [#1139](https://github.com/xataio/client-ts/pull/1139) [`922e6e54`](https://github.com/xataio/client-ts/commit/922e6e54e8b31641770a36b6b4ff8f4fa65d304d) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix scenario with merging existing transformations
+
+- [#1140](https://github.com/xataio/client-ts/pull/1140) [`13f6f3e4`](https://github.com/xataio/client-ts/commit/13f6f3e4b1a2f925d50a5380b62ef1057f5c3893) Thanks [@SferaDev](https://github.com/SferaDev)! - Add metadata url for transformations
+
+- [#1136](https://github.com/xataio/client-ts/pull/1136) [`f02fc165`](https://github.com/xataio/client-ts/commit/f02fc165bf6558e4377eb9f8e1d0f4222f004c70) Thanks [@SferaDev](https://github.com/SferaDev)! - Fixes for Blob files in binary APIs
+
+## 0.26.0
 
 ### Minor Changes
 
-- [#852](https://github.com/xataio/client-ts/pull/852) [`b2a4def4`](https://github.com/xataio/client-ts/commit/b2a4def4baf3eb18cd323895635e0bccb7f876f4) Thanks [@SferaDev](https://github.com/SferaDev)! - [BREAKING CHANGE] Reduce column selection depth
+- [#893](https://github.com/xataio/client-ts/pull/893) [`6ec862f8`](https://github.com/xataio/client-ts/commit/6ec862f8f799eb692f62be79dd0b613b83a34780) Thanks [@SferaDev](https://github.com/SferaDev)! - Add SQL plugin
 
 ### Patch Changes
 
-- Force canary build
+- [#1134](https://github.com/xataio/client-ts/pull/1134) [`0c0149ad`](https://github.com/xataio/client-ts/commit/0c0149ad1ee3f7c0fe9d31030552b022c907edb0) Thanks [@SferaDev](https://github.com/SferaDev)! - Make transformImage accept object-shaped parameters
+
+## 0.25.3
+
+### Patch Changes
+
+- [#1131](https://github.com/xataio/client-ts/pull/1131) [`3b9e1984`](https://github.com/xataio/client-ts/commit/3b9e1984329cd0e9f885f6af4155cc85ab61ba41) Thanks [@xata-bot](https://github.com/xata-bot)! - Add json type for columns
+
+## 0.25.2
+
+### Patch Changes
+
+- [#1111](https://github.com/xataio/client-ts/pull/1111) [`9d1ace5f`](https://github.com/xataio/client-ts/commit/9d1ace5f12788755f3150449120b27cd030af3a9) Thanks [@SferaDev](https://github.com/SferaDev)! - Export file helpers
+
+- [#1114](https://github.com/xataio/client-ts/pull/1114) [`f6665593`](https://github.com/xataio/client-ts/commit/f6665593c301dc9400834cbd68ae32b92bbdea5d) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix warning with default env branch
+
+## 0.25.1
+
+### Patch Changes
+
+- [#1101](https://github.com/xataio/client-ts/pull/1101) [`321c33ff`](https://github.com/xataio/client-ts/commit/321c33ff684c416a6cc813be2a970fd8f826b885) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix bug with cancellable timeouts
+
+## 0.25.0
+
+### Minor Changes
+
+- [#1041](https://github.com/xataio/client-ts/pull/1041) [`ac3b968f`](https://github.com/xataio/client-ts/commit/ac3b968f7ca476f2c82b1b2719d020fbd7164f38) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for files and attachments
+
+### Patch Changes
+
+- [#1024](https://github.com/xataio/client-ts/pull/1024) [`aef9c834`](https://github.com/xataio/client-ts/commit/aef9c834a850494020e7585cb4ce67b446f9ccfc) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix type inconsistency with `xata` internal property
+
+- [#1085](https://github.com/xataio/client-ts/pull/1085) [`bcce0d3b`](https://github.com/xataio/client-ts/commit/bcce0d3b0b53468937accd4fee3b5485c35f69ad) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for sessions in ask endpoint
+
+- [#1067](https://github.com/xataio/client-ts/pull/1067) [`c1f2d264`](https://github.com/xataio/client-ts/commit/c1f2d2649e077cdffae97c90b9d2b1c75d6858fb) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix error 400 with partial filters
+
+- [#1071](https://github.com/xataio/client-ts/pull/1071) [`6c2c2630`](https://github.com/xataio/client-ts/commit/6c2c26308d4cbd25e7a9677c7d25c836396d4965) Thanks [@SferaDev](https://github.com/SferaDev)! - Add request timeout
+
+## 0.24.3
+
+### Patch Changes
+
+- [#1033](https://github.com/xataio/client-ts/pull/1033) [`f01d1580`](https://github.com/xataio/client-ts/commit/f01d1580fc450cbf06eb8af85d68cf052fbe83a1) Thanks [@xata-bot](https://github.com/xata-bot)! - [OpenAPI] Spec updates for column selection
+
+- [#1044](https://github.com/xataio/client-ts/pull/1044) [`52290feb`](https://github.com/xataio/client-ts/commit/52290feb5bba57384cdc14e7722fb5d9883dc581) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow undefined with createOrUpdate/createOrReplace
+
+## 0.24.2
+
+### Patch Changes
+
+- [#1038](https://github.com/xataio/client-ts/pull/1038) [`51561b52`](https://github.com/xataio/client-ts/commit/51561b52b56ad5ed9101d8faf12929891419cb2c) Thanks [@SferaDev](https://github.com/SferaDev)! - Show internal columns in filters
+
+## 0.24.1
+
+### Patch Changes
+
+- [#1030](https://github.com/xataio/client-ts/pull/1030) [`eaa774f5`](https://github.com/xataio/client-ts/commit/eaa774f542185ef92448155bcdff331686c4da9f) Thanks [@SferaDev](https://github.com/SferaDev)! - Make `xata` property enumerable
+
+## 0.24.0
+
+### Minor Changes
+
+- [#1009](https://github.com/xataio/client-ts/pull/1009) [`45aa2207`](https://github.com/xataio/client-ts/commit/45aa220728e98dd716a55a9a307474732a9b2bc1) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `createdAt` and `updatedAt` properties
+
+### Patch Changes
+
+- [#1008](https://github.com/xataio/client-ts/pull/1008) [`f28080f0`](https://github.com/xataio/client-ts/commit/f28080f034f02704fe00d64b8f42e1127bde30c7) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `failIfMissing` to delete transactions
+
+- [#994](https://github.com/xataio/client-ts/pull/994) [`ac9c0604`](https://github.com/xataio/client-ts/commit/ac9c06042bb85105d9a38624676ce6ea5a27d488) Thanks [@xata-bot](https://github.com/xata-bot)! - Update internal endpoints
+
+- [#1015](https://github.com/xataio/client-ts/pull/1015) [`c163b365`](https://github.com/xataio/client-ts/commit/c163b3658f23fb2eaad6243ebebc92624754099a) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `factor` to date boosters
+
+## 0.23.5
+
+### Patch Changes
+
+- [#970](https://github.com/xataio/client-ts/pull/970) [`20cc8c43`](https://github.com/xataio/client-ts/commit/20cc8c43e1659bf112ae2642948c84bfcf46a6ba) Thanks [@xata-bot](https://github.com/xata-bot)! - Add delete file endpoint
+
+- [#976](https://github.com/xataio/client-ts/pull/976) [`5099cbbd`](https://github.com/xataio/client-ts/commit/5099cbbd3065a60dcee2f1699afa1ee8ed5edb1c) Thanks [@SferaDev](https://github.com/SferaDev)! - Re-export JSONData helper type
+
+- [#972](https://github.com/xataio/client-ts/pull/972) [`89375e76`](https://github.com/xataio/client-ts/commit/89375e76b790fed7e6a26bf3ac4ea9eaed1aecae) Thanks [@SferaDev](https://github.com/SferaDev)! - Add types to exports
+
+- [#979](https://github.com/xataio/client-ts/pull/979) [`5eaee932`](https://github.com/xataio/client-ts/commit/5eaee932b828907ae352d7c0d0584e860845434b) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `size` to pagination meta
+
+- [#974](https://github.com/xataio/client-ts/pull/974) [`109b8790`](https://github.com/xataio/client-ts/commit/109b8790849532d9c442e7c03c67792aeafebd88) Thanks [@xata-bot](https://github.com/xata-bot)! - Make checksum mandatory
+
+## 0.23.4
+
+### Patch Changes
+
+- [#951](https://github.com/xataio/client-ts/pull/951) [`470cc71f`](https://github.com/xataio/client-ts/commit/470cc71f7c5c8b9fd50f789e157d2b2eecd0b3e8) Thanks [@SferaDev](https://github.com/SferaDev)! - Add random sorting
+
+## 0.23.3
+
+### Patch Changes
+
+- [#947](https://github.com/xataio/client-ts/pull/947) [`344b0d68`](https://github.com/xataio/client-ts/commit/344b0d687962d569872d1e90d59818d28df7579c) Thanks [@SferaDev](https://github.com/SferaDev)! - Add numeric operators
+
+## 0.23.2
+
+### Patch Changes
+
+- [#939](https://github.com/xataio/client-ts/pull/939) [`c477c177`](https://github.com/xataio/client-ts/commit/c477c17795c01cbf945be413217944a5a38655a5) Thanks [@SferaDev](https://github.com/SferaDev)! - Add deploy preview branch env variable loading
+
+- [#945](https://github.com/xataio/client-ts/pull/945) [`ecdc6553`](https://github.com/xataio/client-ts/commit/ecdc6553d4628289e88953ab6296b80f60e8f757) Thanks [@xata-bot](https://github.com/xata-bot)! - Add new types
+
+## 0.23.1
+
+### Patch Changes
+
+- [#941](https://github.com/xataio/client-ts/pull/941) [`3026d708`](https://github.com/xataio/client-ts/commit/3026d70847830fd0f2024413d823380ff323806c) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose records in ask SSE
+
+## 0.23.0
+
+### Minor Changes
+
+- [#867](https://github.com/xataio/client-ts/pull/867) [`5838113f`](https://github.com/xataio/client-ts/commit/5838113fca042163b44d7cc7cc1686d5ef89b302) Thanks [@SferaDev](https://github.com/SferaDev)! - [Workflow] Remove fallback branch
+
+## 0.22.4
+
+### Patch Changes
+
+- [#927](https://github.com/xataio/client-ts/pull/927) [`22e7dd29`](https://github.com/xataio/client-ts/commit/22e7dd29f7a51dccc087d5fd7fff32084c7733af) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose `ask` endpoint in the SDK
+
+- [#921](https://github.com/xataio/client-ts/pull/921) [`07fc879d`](https://github.com/xataio/client-ts/commit/07fc879d3f778536e39588e66d7a18b5a9d52ebe) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove git branch resolution
+
+- [#925](https://github.com/xataio/client-ts/pull/925) [`58a1c24e`](https://github.com/xataio/client-ts/commit/58a1c24e5d30025dce243eecce44f09d4f65ed66) Thanks [@xata-bot](https://github.com/xata-bot)! - Add new methods to API client
+
+- [#932](https://github.com/xataio/client-ts/pull/932) [`c2c6e244`](https://github.com/xataio/client-ts/commit/c2c6e24459b1acc07f0414066258071fbcf7dde9) Thanks [@xata-bot](https://github.com/xata-bot)! - Add new experimental copy branch endpoint
+
+## 0.22.3
+
+### Patch Changes
+
+- [#917](https://github.com/xataio/client-ts/pull/917) [`4210b8c3`](https://github.com/xataio/client-ts/commit/4210b8c3c4169ba781a56deed7ba09c99788db1f) Thanks [@xata-bot](https://github.com/xata-bot)! - [OpenAPI] Spec updates to add better types to Record input
+
+## 0.22.2
+
+### Patch Changes
+
+- [#898](https://github.com/xataio/client-ts/pull/898) [`72e13bf9`](https://github.com/xataio/client-ts/commit/72e13bf99d0ebefef91c984a995a28b0e8ca2a8f) Thanks [@SferaDev](https://github.com/SferaDev)! - Add methods for vector type
+
+## 0.22.1
+
+### Patch Changes
+
+- [#885](https://github.com/xataio/client-ts/pull/885) [`4cafde72`](https://github.com/xataio/client-ts/commit/4cafde728e4e9e5e83812d475d9980397ae78362) Thanks [@SferaDev](https://github.com/SferaDev)! - Update body of compareBranchSchemas
+
+- [#890](https://github.com/xataio/client-ts/pull/890) [`639710a5`](https://github.com/xataio/client-ts/commit/639710a52132f260bf3a26560a21ae2193abb71d) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose consistency settings in summarize
+
+## 0.22.0
+
+### Minor Changes
+
+- [#852](https://github.com/xataio/client-ts/pull/852) [`b2a4def4`](https://github.com/xataio/client-ts/commit/b2a4def4baf3eb18cd323895635e0bccb7f876f4) Thanks [@SferaDev](https://github.com/SferaDev)! - [BREAKING CHANGE] Reduce column selection depth
+
+### Patch Changes
 
 - [#835](https://github.com/xataio/client-ts/pull/835) [`379e6144`](https://github.com/xataio/client-ts/commit/379e61446b21e7cbadd7fc59267736c6845ec566) Thanks [@SferaDev](https://github.com/SferaDev)! - Add helper methods `toSerializable` and `toString`
 

package/README.md

@@ -4,277 +4,4 @@ The Xata SDK supports typescript definitions for your Xata database schema. It a
 
 It has zero dependencies and runs in Node.js, V8, Deno and Bun.
 
-## Installation
-
-See our [docs](https://xata.io/docs/sdk/typescript#installation) to get started using the Xata SDK.
-
-
-## Table of Contents
-
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Schema-generated Client](#schema-generated-client)
-  - [Schema-less Client](#schema-less-client)
-  - [API Design](#api-design)
-    - [Creating Records](#creating-records)
-    - [Query a Single Record by its ID](#query-a-single-record-by-its-id)
-    - [Querying Multiple Records](#querying-multiple-records)
-    - [Updating Records](#updating-records)
-    - [Deleting Records](#deleting-records)
-  - [API Client](#api-client)
-- [Deno support](#deno-support)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-## Manual Installation
-
-```bash
-npm install @xata.io/client
-```
-
-## Usage
-
-There are three ways to use the SDK:
-
-- **Schema-generated Client**: SDK to create/read/update/delete records in a given database following a schema file (with type-safety).
-- **Schema-less Client**: SDK to create/read/update/delete records in any database without schema validation (with partial type-safety).
-- **API Client**: SDK to interact with the whole Xata API and all its endpoints.
-
-### Schema-generated Client
-
-To use the schema-generated client, you need to run the code generator utility that comes with [our CLI](https://docs.xata.io/cli/getting-started).
-
-To run it (and assuming you have configured the project with `xata init`):
-
-```bash
-xata codegen
-```
-
-In a TypeScript file, start using the generated code like this:
-
-```ts
-import { XataClient } from './xata'; // or wherever you chose to generate the client
-
-const xata = new XataClient();
-```
-
-The import above will differ if you chose to generate the code in a different location.
-
-The `XataClient` constructor accepts an object with configuration options, like the `fetch` parameter, which is required only if your runtime doesn't provide a global `fetch` function. There's also a `databaseURL` argument that by default will contain a URL pointing to your database (e.g. `https://myworkspace-123abc.xata.sh/db/databasename`). It can be specified in the constructor to overwrite that value if for whatever reason you need to connect to a different workspace or database.
-
-The code generator will create two TypeScript types for each schema entity. The base one will be an `Identifiable` entity with the internal properties your entity has and the `Record` one will extend it with a set of operations (update, delete, etc...) and some schema metadata (xata version).
-
-```ts
-interface User extends Identifiable {
-  email?: string | null;
-}
-
-type UserRecord = User & XataRecord;
-
-async function initializeDatabase(admin: User): Promise<UserRecord> {
-  return xata.db.users.create(admin);
-}
-
-const admin = await initializeDatabase({ email: 'admin@example.com' });
-await admin.update({ email: 'admin@foo.bar' });
-await admin.delete();
-```
-
-You will learn more about the available operations below, under the [`API Design`](#api-design) section.
-
-### Schema-less Client
-
-If you don't have a schema file, or you are building a generic way to interact with Xata, you can use the `BaseClient` class without schema validation.
-
-```ts
-import { BaseClient } from '@xata.io/client';
-
-const xata = new BaseClient({
-  branch: 'branchname',
-  apiKey: 'xau_1234abcdef',
-  fetch: fetchImplementation // Required if your runtime doesn't provide a global `fetch` function.
-});
-```
-
-It works the same way as the code-generated `XataClient` but doesn't provide type-safety for your model.
-
-You can read more on the methods available below, in the next section.
-
-### API Design
-
-The Xata SDK to create/read/update/delete records follows the [repository pattern](https://lyz-code.github.io/blue-book/architecture/repository_pattern/). Each table will have a repository object available at `xata.db.[table-name]`.
-
-For example if you have a `users` table, there'll be a repository at `xata.db.users`. If you're using the schema-less client, you can also use the `xata.db.[table-name]` syntax to access the repository but without TypeScript auto-completion.
-
-#### Creating Records
-
-Invoke the `create()` method in the repository. Example:
-
-```ts
-const user = await xata.db.users.create({
-  fullName: 'John Smith'
-});
-```
-
-If you want to create a record with a specific ID, you can provide the id as parameter to the `create()` method.
-
-```ts
-const user = await xata.db.users.create('user_admin', {
-  fullName: 'John Smith'
-});
-```
-
-And if you want to create or update a record with a specific ID, you can invoke `createOrUpdate()` with an id parameter.
-
-```ts
-const user = await xata.db.users.createOrUpdate('user_admin', {
-  fullName: 'John Smith'
-});
-```
-
-#### Query a Single Record by its ID
-
-```ts
-// `user` will be null if the record cannot be found
-const user = await xata.db.users.read('rec_1234abcdef');
-```
-
-#### Querying Multiple Records
-
-```ts
-// Query records selecting all fields.
-const page = await xata.db.users.select().getPaginated();
-const user = await xata.db.users.select().getFirst();
-
-// You can also use `xata.db.users` directly, since it's an immutable Query too!
-const page = await xata.db.users.getPaginated();
-const user = await xata.db.users.getFirst();
-
-// Query records selecting just one or more fields
-const page = await xata.db.users.select('email', 'profile').getPaginated();
-
-// Apply constraints
-const page = await xata.db.users.filter('email', 'foo@example.com').getPaginated();
-
-// Sorting
-const page = await xata.db.users.sort('full_name', 'asc').getPaginated();
-```
-
-Query operations (`select()`, `filter()`, `sort()`) return a `Query` object. These objects are immutable. You can add additional constraints, `sort`, etc. by calling their methods, and a new query will be returned. In order to finally make a query to the database you'll invoke `getPaginated()`, `getMany()`, `getAll()`, or `getFirst()`.
-
-To learn the differences between these methods, see the [reference](https://docs.xata.io/sdk/reference#query).
-
-```ts
-// Operators that combine multiple conditions can be deconstructed
-const { filter, any, all, not, sort } = xata.db.users;
-const query = filter('email', 'foo@example.com');
-
-// Single-column operators are imported directly from the package
-import { gt, includes, startsWith } from '@xata.io/client';
-filter('email', startsWith('username')).not(filter('created_at', gt(somePastDate)));
-
-// Queries are immutable objects. This is useful to derive queries from other queries
-const admins = filter('admin', true);
-const spaniardsAdmins = admins.filter('country', 'Spain');
-await admins.getAll(); // still returns all admins
-
-// Finally fetch the results of the query
-const users = await query.getAll();
-const firstUser = await query.getFirst();
-```
-
-The `getPaginated()` method will return a `Page` object. It's a wrapper that internally uses cursor based pagination.
-
-```ts
-page.records; // Array of records
-page.hasNextPage(); // Boolean
-
-const nextPage = await page.nextPage(); // Page object
-const previousPage = await page.previousPage(); // Page object
-const startPage = await page.startPage(); // Page object
-const endPage = await page.endPage(); // Page object
-```
-
-If you want to use an iterator, both the Repository and the Query classes implement an `AsyncIterable`. Alternatively you can use `getIterator()` and customize the batch size of the iterator:
-
-```ts
-for await (const record of xata.db.users) {
-  console.log(record);
-}
-
-for await (const record of xata.db.users.filter('team.id', teamId)) {
-  console.log(record);
-}
-
-for await (const records of xata.db.users.getIterator({ batchSize: 100 })) {
-  console.log(records);
-}
-```
-
-#### Updating Records
-
-Updating a record leaves the existing object unchanged, but returns a new object with the updated values.
-
-```ts
-// Using an existing object
-const updatedUser = await user.update({
-  fullName: 'John Smith Jr.'
-});
-
-// Using a record id
-const updatedUser = await xata.db.users.update('rec_1234abcdef', {
-  fullName: 'John Smith Jr.'
-});
-```
-
-#### Deleting Records
-
-```ts
-// Using an existing object
-await user.delete();
-
-// Using a record id
-await xata.db.users.delete('rec_1234abcdef');
-```
-
-### API Client
-
-One of the main features of the SDK is the ability to interact with the whole Xata API and perform administrative operations such as creating/reading/updating/deleting [workspaces](https://docs.xata.io/concepts/workspaces), databases, tables, branches...
-
-To communicate with the SDK we provide a constructor called `XataApiClient` that accepts an API token and an optional fetch implementation method.
-
-```ts
-const api = new XataApiClient({ apiKey: process.env.XATA_API_KEY });
-```
-
-Once you have initialized the API client, the operations are organized following the same hiearchy as in the [official documentation](https://docs.xata.io). You have different namespaces for each entity (ie. `workspaces`, `databases`, `tables`, `branches`, `users`, `records`...).
-
-```ts
-const { id: workspace } = await api.workspaces.createWorkspace({ name: 'example' });
-const { databaseName } = await api.database.createDatabase(workspace, 'database', { region: 'eu-west-1' });
-
-await api.branches.createBranch(workspace, databaseName, 'branch');
-await api.tables.createTable(workspace, databaseName, 'branch', 'table');
-await api.tables.setTableSchema(workspace, databaseName, 'branch', 'table', {
-  columns: [{ name: 'email', type: 'string' }]
-});
-
-const { id: recordId } = await api.records.insertRecord(workspace, databaseName, 'branch', 'table', {
-  email: 'example@foo.bar'
-});
-
-const record = await api.records.getRecord(workspace, databaseName, 'branch', 'table', recordId);
-
-await api.workspaces.deleteWorkspace(workspace);
-```
-
-## Deno support
-
-We publish the client on [deno.land](https://deno.land/x/xata). You can use it by changing the import in the auto-generated `xata.ts` file:
-
-```ts
-import { buildClient, BaseClientOptions, XataRecord } from 'https://deno.land/x/xata/mod.ts';
-```
+You can find the SDK documentation [here](https://xata.io/docs/typescript-client/overview).