peerigon / sevdesk / 31315498477

73%

push

github

feat: rewrite as a generated, modular SDK for the whole sevDesk API

Generate the client from sevDesk's OpenAPI spec instead of hand-maintaining it: 154 operations
across 22 modules, each a tree-shakeable function taking the client as its first argument, with
request and response types derived from the spec. Adds namespaced errors, pagination helpers, a
module for endpoints sevDesk serves but does not document, and a read-only smoke suite against the
live API.

BREAKING CHANGE: v3 is a full rewrite of @peerigon/sevdesk with no compatibility layer.

The client is now the first argument rather than the receiver, and operations are imported from
per-resource subpaths of `@peerigon/sevdesk` (given in parentheses below). Whatever you passed to a
v2 method now goes in `{ query }`, or in `{ path }` / `{ body }` where the endpoint needs it.

Old -> new:

- `new SevDeskClient({ apiKey })` -> `createClient({ apiToken })`
- `SevDeskClientConfig` -> `ClientConfig`
- `SevDeskUrls` -> removed, no replacement
- `client.request(url, options)` -> removed; declare the endpoint with `defineUndocumentedOperation`
- `UnknownApiError` -> `SevDeskError` and its subclasses
- `client.getContacts()` -> `getContacts(client)` (`/contact`)
- `client.getContactAddresses()` -> `getContactAddresses(client)` (`/contact-address`)
- `client.getCommunicationWays()` -> `getCommunicationWays(client)` (`/communication-way`)
- `client.getInvoices()` -> `getInvoices(client)` (`/invoice`)
- `client.getInvoice({ id })` -> `getInvoiceById(client, { path: { invoiceId: id } })` (`/invoice`)
- `client.saveInvoice(body)` -> `createInvoiceByFactory(client, { body })` (`/invoice`)
- `client.getParts()` -> `getParts(client)` (`/part`)
- `client.getTags()` -> `getTags(client)` (`/tag`)
- `client.getPaymentMethods()` -> `getPaymentMethods(client)` (`/undocumented`)
- `client.getSevUsers()` -> `getSevUsers(client)` (`/undocumented`)
- `client.getStaticCountries()` -> `getStaticCountries(client)` (`/undoc... (continued)

99 of 110 branches covered (90.0%)

Branch coverage included in aggregate %.

210 of 313 new or added lines in 28 files covered. (67.09%)

210 of 313 relevant lines covered (67.09%)

6.88 hits per line