Class HttpService

HttpService class to interact with the Airtable API using Node.js native https module.

Index

Constructors

Methods

create delete list update

Constructors

constructor

new HttpService(token: string, baseId: string): HttpService
Creates an instance of HttpService.
Parameters
- token: string
  The API token for authentication.
- baseId: string
  The Airtable base ID.
Returns HttpService
- Defined in services/HttpService.ts:20

Methods

create

create(
tableName: string,
body: Record<string, unknown>,
): Promise<AirtableResult>
Creates a new record in a specified base and table.
Parameters
- tableName: string
  The name of the table.
- body: Record<string, unknown>
  The data to be inserted as a new record.
Returns Promise<AirtableResult>
A promise that resolves to an AirTableCreateMapping object.
- Defined in services/HttpService.ts:39

delete

delete(tableName: string, recordId: string): Promise<AirtableDeletion>
Deletes a record from a specified base and table.
Parameters
- tableName: string
  The name of the table.
- recordId: string
  The ID of the record to be deleted.
Returns Promise<AirtableDeletion>
A promise that resolves to an AirTableDeleteMapping object.
- Defined in services/HttpService.ts:74

list

list(tableName: string, options?: SelectOptions): Promise<AirtableList>
Lists records from a specified base and table.
Parameters
- tableName: string
  The name of the table.
- Optionaloptions: SelectOptions
  Optional parameters for selecting records.
Returns Promise<AirtableList>
A promise that resolves to an AirTableListMapping object.
- Defined in services/HttpService.ts:28

update

update(
    tableName: string,
    recordId: string,
    body: Record<string, unknown>,
): Promise<AirtableUpdateResult>
Updates an existing record in a specified base and table.
Parameters
- tableName: string
  The name of the table.
- recordId: string
  The ID of the record to be updated.
- body: Record<string, unknown>
  The data to update the record with.
Returns Promise<AirtableUpdateResult>
A promise that resolves to an AirTableCreateMapping object.
- Defined in services/HttpService.ts:58