teamdesk
TypeScript icon, indicating that this package has built-in type declarations

1.2.1 • Public • Published

Siam Ahnaf

@siamf/teamdesk

A Node.js TeamDesk API client for placing API requests directly to TeamDesk from Node.js. It supports almost all teamdesk api method and query params

Buy Me A Coffee

  • Small Size
  • All Available Teamdesk Method
  • Place request or create URI

Installation

$ npm i @siamf/teamdesk
import { initTeamdesk } from "@siamf/teamdesk";

type Table = "Table 1" | "Table 2";

const teamdesk = initTeamdesk<Table>({
    baseUrl: "https://teamdesk.net/secure/api/v2", //Teamdesk Base URL
    databaseNo: 96301, //Teamdesk Database Number
    token: "teamdesk api token", //Teamdesk API token
});

interface Generated {
    id?: string;
    name?: string;
    description?: string;
    culture?: string;
    timeZone?: string;
    logo?: number;
}

//Generate URL
const url = teamdesk.describeTable.uri({
    table: "Table 1"
})
console.log(url);

//Place API Request
const { data, error } = await teamdesk.describeTable.request<Generated>({
    table: "Table 2"
});

console.log(data);
console.log(error);

Documentations

Please see the teamdesk API docs for details use.

Stay in touch

Package Sidebar

Install

npm i teamdesk

Weekly Downloads

0

Version

1.2.1

License

MIT

Unpacked Size

85.4 kB

Total Files

104

Last publish

Collaborators

  • siamahnaf