Airtable.Query

Documentation

module Airtable.Table

Configuration for Airtable requests.

data AirtableOptions

Options

Constructors

AirtableOptions

Fields

• apiKey :: String

  the API key for your project

• appId :: String

  the app ID for your project (http://api.airtable.com/v0/app...)

• apiVersion :: Int

  api version (http://api.airtable.com/v../...)

defaultAirtableOptions :: AirtableOptions

Airtable options defaulting to API version 0. Please change the apiKey and appId fields.

mkWreqOptions :: AirtableOptions -> Options

Produce Wreq options from AirtableOptions

tableNameToUrl :: AirtableOptions -> TableName -> String

Produce a request URL to a table.

API

getRecords :: (HasCallStack, FromJSON a) => AirtableOptions -> TableName -> IO (Table a)

Retrieve the records for a table from airtable.com given its name. Handles pagination correctly.

getRecordsFromUrl :: (HasCallStack, FromJSON a) => Options -> String -> IO (Table a)

Retrieve the records for a table given a URL and network (Wreq) options.

createRecord :: (HasCallStack, ToJSON a, FromJSON a) => AirtableOptions -> TableName -> a -> IO (Record a)

Upload a record to a given table. Returns the newly created RecordID.

updateRecord :: ToJSON a => AirtableOptions -> TableName -> RecordID -> a -> IO ()

Update a record on a given table, using the supplied fields (a).

deleteRecord :: AirtableOptions -> TableName -> RecordID -> IO ()

Delete a record on a table.

Low-level helpers

respJsonBody :: (HasCallStack, FromJSON a) => Response ByteString -> a