feat: Adds getTags

src/client.test.ts

@@ -11,6 +11,7 @@ import {
   ModelDocumentFolder,
   ModelInvoice,
   ModelPaymentMethod,
+  ModelTag,
   ModelUnity,
 } from "./interfaces.js";
 
@@ -204,6 +205,12 @@ test("Get payment methods", async () => {
   paymentMethods.forEach(assertIsPaymentMethod);
 });
 
+test("Get tags", async () => {
+  const { objects: tags } = await sevDeskClient.getTags();
+
+  assert.is(tags.length > 0, true);
+  tags.forEach(assertIsTag);
+});
 const assertIsInvoice = (invoice: ModelInvoice) => {
   assert.is(invoice.objectName, "Invoice");
 };
@@ -232,4 +239,8 @@ const assertIsPaymentMethod = (paymentMethod: ModelPaymentMethod) => {
   assert.is(paymentMethod.objectName, "PaymentMethod");
 };
 
+const assertIsTag = (tag: ModelTag) => {
+  assert.is(tag.objectName, "Tag");
+};
+
 test.run();

src/client.ts

@@ -8,6 +8,7 @@ import {
   ModelDocumentFolder,
   ModelInvoice,
   ModelPaymentMethod,
+  ModelTag,
   ModelUnity,
 } from "./interfaces.js";
 import { SevDeskUrls } from "./urls.js";
@@ -261,6 +262,21 @@ export class SevDeskClient {
     });
   }
 
+  // -------------------------------------------------------
+  // Tag
+  // -------------------------------------------------------
+
+  /**
+   * Get an overview of all tags
+   */
+  async getTags(params: UrlParamsFor<"apiGetTagsUrl"> = {}) {
+    const url = this.urls.apiGetTagsUrl(params);
+
+    return this.request<{ objects: Array<Required<ModelTag>> }>(url, {
+      method: "GET",
+    });
+  }
+
   // // pending invoices from sevdesk includes also outstanding / due invoices
   // // we remove them with a filter but you could also include the if you only need everything pending
   // async getPendingInvoices(options = { includeOutstanding: false }) {

src/urls.ts

@@ -131,4 +131,15 @@ export class SevDeskUrls {
       query,
     });
   }
+
+  // -------------------------------------------------------
+  // Tag
+  // -------------------------------------------------------
+
+  apiGetTagsUrl({ ...query }: DefaultCollectionQuery & Query = {}) {
+    return this.apiUrl({
+      path: `Tag`,
+      query,
+    });
+  }
 }