@itplusx/sevdesk-api-ts-client
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

@itplusx/sevdesk-api-ts-client

NPM Version NPM License NPM Downloads

TypeScript Client for sevdesk API (2.0.0)

Usage

Install package:

# ✨ Auto-detect
npx nypm install @itplusx/sevdesk-api-ts-client

# npm
npm install @itplusx/sevdesk-api-ts-client

# yarn
yarn add @itplusx/sevdesk-api-ts-client

# pnpm
pnpm add @itplusx/sevdesk-api-ts-client

# bun
bun install @itplusx/sevdesk-api-ts-client

Usage:

ESM (Node.js, Bun)

import { SevdeskApiClient } from '@itplusx/sevdesk-api-ts-client'

const sevdeskApiClient = new SevdeskApiClient({ apiKey: 'your-secret-api-key' })
const basics = await sevdeskApiClient.apis.basicsApi.bookkeepingSystemVersion()

console.log(basics)

CommonJS (Legacy Node.js)

const { SevdeskApiClient } = require('@itplusx/sevdesk-api-ts-client')

const sevdeskApiClient = new SevdeskApiClient({ apiKey: 'your-secret-api-key' })
const basics = await sevdeskApiClient.apis.basicsApi.bookkeepingSystemVersion()

console.log(basics)

Development

local development
  • Clone this repository
  • Install latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Add SEVDESK_API_KEY=replace-with-your-secret-api-key to .env file in project root
  • Run playground using pnpm play
  • Run interactive tests using pnpm dev
  • Run sh generate.sh (docker required) to update client based on https://api.sevdesk.de/openapi.yaml.

License

Published under the MIT license. Made by community 💛


🤖 auto updated with automd

Readme

Keywords

Package Sidebar

Install

npm i @itplusx/sevdesk-api-ts-client

Weekly Downloads

3

Version

1.0.2

License

MIT

Unpacked Size

58.7 MB

Total Files

800

Last publish

Collaborators

  • vjanoch