Appsheet-connect NPM

AppSheet Connect

appsheet-connect is a library for interacting with the AppSheet API. It allows you to perform CRUD (create, read, update, and delete) operations on tables within AppSheet applications.

Installation

To install the library, you can use npm:

npm install appsheet-connect

Or with yarn:

yarn add appsheet-connect

Usage

`AppSheetUser` Class

The AppSheetUser class represents a user for the AppSheet API and is used to authenticate requests.

Constructor

constructor(
  idApp: string,
  apiKey: string,
  format?: boolean,
  region?: 'global' | 'ue'
)

idApp (string): The ID of the application.
apiKey (string): The API key used for authentication.
format (boolean, optional): Specifies whether to format the data. Defaults to true. For example, a value of 'Y' will be converted to true, and a value of 'N' will be converted to false.
region ('global' | 'ue', optional): The region for the AppSheet API endpoint. Can be 'global' (equivalent to 'www.appsheet.com') or 'ue' (equivalent to 'eu.appsheet.com'). Defaults to 'global'.

Example

import { AppSheetUser } from 'appsheet-connect'

const user = new AppSheetUser('my-app-id', 'my-api-key', true, 'ue')

Functions

`getTable`

Fetches data from a table in the AppSheet application.

export function getTable(
  appSheetUser: AppSheetUser,
  tableId: string,
  rows?: object | object[] | null,
  properties?: Record<string, any>
): Promise<any>

appSheetUser (AppSheetUser): An instance of AppSheetUser containing authentication details and configuration.
tableId (string): The ID of the table to fetch data from.
rows (object | object[] | null, optional): Filter criteria for the rows to fetch. Can be an object, an array of objects, or null to fetch all rows.
properties (Record<string, any>, optional): Additional properties to include in the request.

`patchTable`

Updates data in a table in the AppSheet application.

export function patchTable(
  appSheetUser: AppSheetUser,
  tableId: string,
  data: object | object[],
  properties?: Record<string, any>
): Promise<any>

appSheetUser (AppSheetUser): An instance of AppSheetUser containing authentication details and configuration.
tableId (string): The ID of the table to update.
data (object | object[]): Data to update in the table. Can be an object or an array of objects.
properties (Record<string, any>, optional): Additional properties to include in the request.

`deleteTable`

Deletes data from a table in the AppSheet application.

export function deleteTable(
  appSheetUser: AppSheetUser,
  tableId: string,
  data: object | object[],
  properties?: Record<string, any>
): Promise<any>

appSheetUser (AppSheetUser): An instance of AppSheetUser containing authentication details and configuration.
tableId (string): The ID of the table from which to delete data.
data (object | object[]): Data to delete from the table. Can be an object or an array of objects.
properties (Record<string, any>, optional): Additional properties to include in the request.

`postTable`

Adds data to a table in the AppSheet application.

export function postTable(
  appSheetUser: AppSheetUser,
  tableId: string,
  data: object | object[],
  properties?: Record<string, any>
): Promise<any>

appSheetUser (AppSheetUser): An instance of AppSheetUser containing authentication details and configuration.
tableId (string): The ID of the table to add data to.
data (object | object[]): Data to add to the table. Can be an object or an array of objects.
properties (Record<string, any>, optional): Additional properties to include in the request.