appsheet-connect
v0.0.8
Published
A Node.js package that simplifies connecting to and interacting with the AppSheet API for automating tasks and managing app data efficiently.
Downloads
206
Maintainers
Readme
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 totrue
. For example, a value of'Y'
will be converted totrue
, and a value of'N'
will be converted tofalse
.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 ofAppSheetUser
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, ornull
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 ofAppSheetUser
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 ofAppSheetUser
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 ofAppSheetUser
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.
Contributing
Contributions are welcome. Please open an issue or a pull request on GitHub to discuss any changes or improvements.
License
This project is licensed under the MIT License. See the LICENSE file for details.