@genz-its/sevdesk-cli 0.0.0 → 0.1.1

package/README.md

@@ -88,6 +88,9 @@ sevdesk transactions:list --unbooked --json | jq -r '.[].id'
 - [`accounts:create-file-import`](#accountscreate-file-import)
 - [`accounts:get`](#accountsget)
 - [`accounts:list`](#accountslist)
+- [`contacts:add-address`](#contactsadd-address)
+- [`contacts:add-email`](#contactsadd-email)
+- [`contacts:add-phone`](#contactsadd-phone)
 - [`contacts:create`](#contactscreate)
 - [`contacts:delete`](#contactsdelete)
 - [`contacts:get`](#contactsget)
@@ -121,6 +124,7 @@ sevdesk transactions:list --unbooked --json | jq -r '.[].id'
 - [`vouchers:enshrine`](#vouchersenshrine)
 - [`vouchers:get`](#vouchersget)
 - [`vouchers:list`](#voucherslist)
+- [`vouchers:positions`](#voucherspositions)
 - [`vouchers:reset-to-draft`](#vouchersreset-to-draft)
 - [`vouchers:reset-to-open`](#vouchersreset-to-open)
 
@@ -227,6 +231,56 @@ sevdesk accounts:list [options]
 - `--offset`: The number of check accounts to skip.
 - `--json`: Output in JSON format.
 
+### `contacts:add-address`
+
+Add an address to a contact.
+
+```bash
+sevdesk contacts:add-address [options]
+```
+
+**Options:**
+
+- `--contact`: The contact ID. If omitted, you will be prompted.
+- `--street`: Street and house number.
+- `--zip`: Zip code.
+- `--city`: City name.
+- `--country`: ID of the country as a StaticCountry ID, for example `1` for Germany. There is no lookup endpoint in this CLI, but an existing address of a contact reveals the IDs of other countries. If omitted, you will be prompted.
+- `--category`: ID of the address category. The sevdesk API does not document the IDs, they are listed by a `GET` to `/Category?objectType=ContactAddress` and an existing address of a contact reveals the ones in use. If omitted, you will be prompted.
+- `--json`: Output in JSON format.
+
+### `contacts:add-email`
+
+Add an e-mail address to a contact.
+
+```bash
+sevdesk contacts:add-email [options]
+```
+
+**Options:**
+
+- `--contact`: The contact ID. If omitted, you will be prompted.
+- `--email`: The e-mail address. If omitted, you will be prompted.
+- `--key`: ID of the communication way key: `1` private, `2` work, `7` newsletter, `8` invoicing. Defaults to `2`.
+- `--main`: Mark the e-mail address as the main one of the contact. Defaults to `false`.
+- `--json`: Output in JSON format.
+
+### `contacts:add-phone`
+
+Add a phone number to a contact.
+
+```bash
+sevdesk contacts:add-phone [options]
+```
+
+**Options:**
+
+- `--contact`: The contact ID. If omitted, you will be prompted.
+- `--phone`: The phone number. If omitted, you will be prompted.
+- `--key`: ID of the communication way key: `1` private, `2` work, `3` fax, `4` mobile. Defaults to `2`.
+- `--main`: Mark the phone number as the main one of the contact. Defaults to `false`.
+- `--json`: Output in JSON format.
+
 ### `contacts:create`
 
 Create a contact. Use `--name` for organizations and `--surename` together with `--familyname` for persons.
@@ -263,7 +317,7 @@ sevdesk contacts:delete [options]
 
 ### `contacts:get`
 
-Show a single contact.
+Show a single contact with its addresses and communication ways.
 
 ```bash
 sevdesk contacts:get [options]
@@ -272,7 +326,7 @@ sevdesk contacts:get [options]
 **Options:**
 
 - `--id`: The contact ID. If omitted, you will be prompted.
-- `--json`: Output in JSON format.
+- `--json`: Output in JSON format. Prints an object with the keys `contact`, `addresses` and `communicationWays`.
 
 ### `contacts:list`
 
@@ -286,6 +340,8 @@ sevdesk contacts:list [options]
 
 - `--name`: Filter by organization, first or last name.
 - `--customer-number`: Filter by customer number.
+- `--depth`: Contact depth: `0` returns only organizations, `1` organizations and persons. Defaults to `0`.
+- `--category`: ID of the contact category to filter by: `2` supplier, `3` customer, `4` partner.
 - `--limit`: Maximum number of contacts to return.
 - `--offset`: Number of contacts to skip.
 - `--json`: Output in JSON format.
@@ -765,6 +821,21 @@ sevdesk vouchers:list [options]
 - `--offset`: Number of vouchers to skip.
 - `--json`: Output in JSON format.
 
+### `vouchers:positions`
+
+List voucher positions.
+
+```bash
+sevdesk vouchers:positions [options]
+```
+
+**Options:**
+
+- `--voucher`: ID of the voucher whose positions to list.
+- `--limit`: Maximum number of positions to return.
+- `--offset`: Number of positions to skip.
+- `--json`: Output in JSON format.
+
 ### `vouchers:reset-to-draft`
 
 Reset a voucher to the draft status. This unlinks existing payments.
@@ -795,6 +866,6 @@ sevdesk vouchers:reset-to-open [options]
 
 ## License
 
-[MIT](../../LICENSE)
+See [LICENSE](https://github.com/genz-its/sevdesk/blob/main/LICENSE).
 
 [^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by sevDesk GmbH or any of their affiliates or subsidiaries.

package/dist/index.js

@@ -142,6 +142,12 @@ function requireInteractive(requirement) {
 }
 //#endregion
 //#region src/output.ts
+/** Formats a contact reference as its organization or person name. */
+function contactLabel(ref) {
+	if (!ref) return "-";
+	const personName = [ref.surename, ref.familyname].filter((part) => part).join(" ");
+	return ref.name || personName || ref.id || "-";
+}
 function printJson(value) {
 	console.log(JSON.stringify(value, null, 2));
 }
@@ -308,6 +314,129 @@ var list_default$8 = defineCommand({
 	}
 });
 //#endregion
+//#region src/commands/contacts/add-address.ts
+var add_address_default = defineCommand({
+	description: "Add an address to a contact.",
+	options: defineOptions(z.object({
+		contact: z.coerce.number().optional().describe("The contact ID. If omitted, you will be prompted."),
+		street: z.string().optional().describe("Street and house number."),
+		zip: z.string().optional().describe("Zip code."),
+		city: z.string().optional().describe("City name."),
+		country: z.coerce.number().optional().describe("ID of the country as a StaticCountry ID, for example 1 for Germany. There is no lookup endpoint in this CLI, but an existing address of a contact reveals the IDs of other countries. If omitted, you will be prompted."),
+		category: z.coerce.number().optional().describe("ID of the address category. The sevdesk API does not document the IDs, they are listed by a GET to /Category?objectType=ContactAddress and an existing address of a contact reveals the ones in use. If omitted, you will be prompted."),
+		json: z.boolean().default(false).describe("Output in JSON format.")
+	})),
+	action: async (options) => {
+		const client = await requireClient();
+		const contactId = await requireNumberOption({
+			value: options.contact,
+			requirement: "a contact ID via --contact",
+			question: "Enter the contact ID:"
+		});
+		const countryId = await requireNumberOption({
+			value: options.country,
+			requirement: "a country ID via --country",
+			question: "Enter the country ID, for example 1 for Germany:"
+		});
+		const categoryId = await requireNumberOption({
+			value: options.category,
+			requirement: "an address category ID via --category",
+			question: "Enter the address category ID:"
+		});
+		const address = await client.contactAddresses.create({
+			contactId,
+			countryId,
+			categoryId,
+			street: options.street,
+			zip: options.zip,
+			city: options.city
+		});
+		if (options.json) {
+			printJson(address);
+			return;
+		}
+		consola.success(`Created contact address ${address.id}.`);
+	}
+});
+//#endregion
+//#region src/commands/contacts/add-email.ts
+var add_email_default = defineCommand({
+	description: "Add an e-mail address to a contact.",
+	options: defineOptions(z.object({
+		contact: z.coerce.number().optional().describe("The contact ID. If omitted, you will be prompted."),
+		email: z.string().optional().describe("The e-mail address. If omitted, you will be prompted."),
+		key: z.coerce.number().default(2).describe("ID of the communication way key: 1 private, 2 work, 7 newsletter, 8 invoicing."),
+		main: z.boolean().default(false).describe("Mark the e-mail address as the main one of the contact."),
+		json: z.boolean().default(false).describe("Output in JSON format.")
+	})),
+	action: async (options) => {
+		const client = await requireClient();
+		const contactId = await requireNumberOption({
+			value: options.contact,
+			requirement: "a contact ID via --contact",
+			question: "Enter the contact ID:"
+		});
+		const email = await requireStringOption({
+			value: options.email,
+			requirement: "an e-mail address via --email",
+			question: "Enter the e-mail address:"
+		});
+		if (!email.includes("@")) {
+			consola.error("The e-mail address must contain an \"@\".");
+			process.exit(1);
+		}
+		const communicationWay = await client.communicationWays.create({
+			contactId,
+			type: "EMAIL",
+			value: email,
+			keyId: options.key,
+			main: options.main
+		});
+		if (options.json) {
+			printJson(communicationWay);
+			return;
+		}
+		consola.success(`Created e-mail communication way ${communicationWay.id}.`);
+	}
+});
+//#endregion
+//#region src/commands/contacts/add-phone.ts
+var add_phone_default = defineCommand({
+	description: "Add a phone number to a contact.",
+	options: defineOptions(z.object({
+		contact: z.coerce.number().optional().describe("The contact ID. If omitted, you will be prompted."),
+		phone: z.string().optional().describe("The phone number. If omitted, you will be prompted."),
+		key: z.coerce.number().default(2).describe("ID of the communication way key: 1 private, 2 work, 3 fax, 4 mobile."),
+		main: z.boolean().default(false).describe("Mark the phone number as the main one of the contact."),
+		json: z.boolean().default(false).describe("Output in JSON format.")
+	})),
+	action: async (options) => {
+		const client = await requireClient();
+		const contactId = await requireNumberOption({
+			value: options.contact,
+			requirement: "a contact ID via --contact",
+			question: "Enter the contact ID:"
+		});
+		const phone = await requireStringOption({
+			value: options.phone,
+			requirement: "a phone number via --phone",
+			question: "Enter the phone number:"
+		});
+		const communicationWay = await client.communicationWays.create({
+			contactId,
+			type: "PHONE",
+			value: phone,
+			keyId: options.key,
+			main: options.main
+		});
+		if (options.json) {
+			printJson(communicationWay);
+			return;
+		}
+		consola.success(`Created phone communication way ${communicationWay.id}.`);
+	}
+});
+//#endregion
 //#region src/commands/contacts/create.ts
 var create_default$3 = defineCommand({
 	description: "Create a contact.",
@@ -377,8 +506,10 @@ var delete_default$1 = defineCommand({
 });
 //#endregion
 //#region src/commands/contacts/get.ts
+/** The `/ContactAddress` endpoint cannot filter by contact, so we filter here. */
+const ADDRESS_LOOKUP_LIMIT = 100;
 var get_default$6 = defineCommand({
-	description: "Show a single contact.",
+	description: "Show a single contact with its addresses and communication ways.",
 	options: defineOptions(z.object({
 		id: z.coerce.number().optional().describe("The contact ID. If omitted, you will be prompted."),
 		json: z.boolean().default(false).describe("Output in JSON format.")
@@ -391,8 +522,14 @@ var get_default$6 = defineCommand({
 			question: "Enter the contact ID:"
 		});
 		const contact = await client.contacts.get({ contactId });
+		const addresses = (await client.contactAddresses.list({ limit: ADDRESS_LOOKUP_LIMIT })).filter((address) => address.contact.id === String(contactId));
+		const communicationWays = await client.communicationWays.list({ contactId });
 		if (options.json) {
-			printJson(contact);
+			printJson({
+				contact,
+				addresses,
+				communicationWays
+			});
 			return;
 		}
 		consola.info(`ID: ${contact.id}`);
@@ -405,8 +542,25 @@ var get_default$6 = defineCommand({
 		consola.info(`Description: ${contact.description ?? "-"}`);
 		consola.info(`VAT number: ${contact.vatNumber ?? "-"}`);
 		consola.info(`Tax number: ${contact.taxNumber ?? "-"}`);
+		printSection("Addresses:", addresses.map(formatAddress));
+		printSection("Communication ways:", communicationWays.map(formatCommunicationWay));
 	}
 });
+function printSection(title, lines) {
+	consola.info(title);
+	for (const line of lines.length === 0 ? ["-"] : lines) consola.info(`  ${line}`);
+}
+function formatAddress(address) {
+	return [
+		address.street,
+		[address.zip, address.city].filter((part) => part).join(" "),
+		`country ${address.country.id}`
+	].filter((part) => part).join(", ");
+}
+function formatCommunicationWay(communicationWay) {
+	const main = communicationWay.main === "1" ? " (main)" : "";
+	return `${communicationWay.type}: ${communicationWay.value}${main}`;
+}
 //#endregion
 //#region src/commands/contacts/list.ts
 var list_default$7 = defineCommand({
@@ -414,6 +568,8 @@ var list_default$7 = defineCommand({
 	options: defineOptions(z.object({
 		name: z.string().optional().describe("Filter by organization, first or last name."),
 		customerNumber: z.string().optional().describe("Filter by customer number."),
+		depth: z.coerce.number().optional().describe("Contact depth: 0 returns only organizations, 1 organizations and persons. Defaults to 0."),
+		category: z.coerce.number().optional().describe("ID of the contact category to filter by: 2 supplier, 3 customer, 4 partner."),
 		limit: z.coerce.number().optional().describe("Maximum number of contacts to return."),
 		offset: z.coerce.number().optional().describe("Number of contacts to skip."),
 		json: z.boolean().default(false).describe("Output in JSON format.")
@@ -422,6 +578,8 @@ var list_default$7 = defineCommand({
 		const contacts = await (await requireClient()).contacts.list({
 			name: options.name,
 			customerNumber: options.customerNumber,
+			depth: toDepth(options.depth),
+			categoryId: options.category,
 			limit: options.limit,
 			offset: options.offset
 		});
@@ -442,6 +600,10 @@ var list_default$7 = defineCommand({
 		})));
 	}
 });
+function toDepth(depth) {
+	if (depth === void 0) return;
+	return depth === 0 ? "0" : "1";
+}
 function formatContactName(contact) {
 	return contact.name ?? [contact.surename, contact.familyname].filter(Boolean).join(" ");
 }
@@ -501,7 +663,10 @@ var get_default$5 = defineCommand({
 			requirement: "a credit note ID via --id",
 			question: "Enter the credit note ID:"
 		});
-		const creditNote = await client.creditNotes.get({ creditNoteId });
+		const creditNote = await client.creditNotes.get({
+			creditNoteId,
+			embed: ["contact"]
+		});
 		if (options.json) {
 			printJson(creditNote);
 			return;
@@ -510,7 +675,7 @@ var get_default$5 = defineCommand({
 		consola.info(`Number: ${creditNote.creditNoteNumber ?? "-"}`);
 		consola.info(`Date: ${creditNote.creditNoteDate}`);
 		consola.info(`Status: ${creditNote.status}`);
-		consola.info(`Contact: ${creditNote.contact?.id ?? "-"}`);
+		consola.info(`Contact: ${contactLabel(creditNote.contact)}`);
 		consola.info(`Net: ${creditNote.sumNet}`);
 		consola.info(`Tax: ${creditNote.sumTax}`);
 		consola.info(`Gross: ${creditNote.sumGross}`);
@@ -539,7 +704,8 @@ var list_default$6 = defineCommand({
 			endDate: options.endDate,
 			contactId: options.contact,
 			limit: options.limit,
-			offset: options.offset
+			offset: options.offset,
+			embed: ["contact"]
 		});
 		if (options.json) {
 			printJson(creditNotes);
@@ -553,7 +719,7 @@ var list_default$6 = defineCommand({
 			id: creditNote.id,
 			number: creditNote.creditNoteNumber ?? "",
 			date: creditNote.creditNoteDate,
-			contact: creditNote.contact?.id ?? "",
+			contact: contactLabel(creditNote.contact),
 			gross: creditNote.sumGross,
 			status: creditNote.status
 		})));
@@ -884,7 +1050,10 @@ var get_default$4 = defineCommand({
 			requirement: "an invoice ID via --id",
 			question: "Enter the invoice ID:"
 		});
-		const invoice = await client.invoices.get({ invoiceId });
+		const invoice = await client.invoices.get({
+			invoiceId,
+			embed: ["contact"]
+		});
 		if (options.json) {
 			printJson(invoice);
 			return;
@@ -893,7 +1062,7 @@ var get_default$4 = defineCommand({
 		consola.info(`Number: ${invoice.invoiceNumber ?? "-"}`);
 		consola.info(`Date: ${invoice.invoiceDate}`);
 		consola.info(`Status: ${invoice.status}`);
-		consola.info(`Contact: ${invoice.contact?.id ?? "-"}`);
+		consola.info(`Contact: ${contactLabel(invoice.contact)}`);
 		consola.info(`Net: ${invoice.sumNet}`);
 		consola.info(`Tax: ${invoice.sumTax}`);
 		consola.info(`Gross: ${invoice.sumGross}`);
@@ -922,7 +1091,8 @@ var list_default$5 = defineCommand({
 			endDate: options.endDate,
 			contactId: options.contact,
 			limit: options.limit,
-			offset: options.offset
+			offset: options.offset,
+			embed: ["contact"]
 		});
 		if (options.json) {
 			printJson(invoices);
@@ -936,7 +1106,7 @@ var list_default$5 = defineCommand({
 			id: invoice.id,
 			number: invoice.invoiceNumber ?? "",
 			date: invoice.invoiceDate,
-			contact: invoice.contact?.id ?? "",
+			contact: contactLabel(invoice.contact),
 			gross: invoice.sumGross,
 			status: invoice.status
 		})));
@@ -1030,7 +1200,10 @@ var get_default$3 = defineCommand({
 			requirement: "an order ID via --id",
 			question: "Enter the order ID:"
 		});
-		const order = await client.orders.get({ orderId });
+		const order = await client.orders.get({
+			orderId,
+			embed: ["contact"]
+		});
 		if (options.json) {
 			printJson(order);
 			return;
@@ -1039,7 +1212,7 @@ var get_default$3 = defineCommand({
 		consola.info(`Number: ${order.orderNumber}`);
 		consola.info(`Date: ${order.orderDate}`);
 		consola.info(`Status: ${order.status}`);
-		consola.info(`Contact: ${order.contact?.id ?? "-"}`);
+		consola.info(`Contact: ${contactLabel(order.contact)}`);
 		consola.info(`Net: ${order.sumNet}`);
 		consola.info(`Tax: ${order.sumTax}`);
 		consola.info(`Gross: ${order.sumGross}`);
@@ -1068,7 +1241,8 @@ var list_default$4 = defineCommand({
 			endDate: options.endDate,
 			contactId: options.contact,
 			limit: options.limit,
-			offset: options.offset
+			offset: options.offset,
+			embed: ["contact"]
 		});
 		if (options.json) {
 			printJson(orders);
@@ -1082,7 +1256,7 @@ var list_default$4 = defineCommand({
 			id: order.id,
 			number: order.orderNumber,
 			date: order.orderDate,
-			contact: order.contact?.id ?? "",
+			contact: contactLabel(order.contact),
 			gross: order.sumGross,
 			status: order.status
 		})));
@@ -1608,7 +1782,10 @@ var get_default = defineCommand({
 			requirement: "a voucher ID via --id",
 			question: "Enter the voucher ID:"
 		});
-		const voucher = await client.vouchers.get({ voucherId });
+		const voucher = await client.vouchers.get({
+			voucherId,
+			embed: ["supplier"]
+		});
 		if (options.json) {
 			printJson(voucher);
 			return;
@@ -1616,7 +1793,7 @@ var get_default = defineCommand({
 		consola.info(`ID: ${voucher.id}`);
 		consola.info(`Status: ${voucher.status ?? "-"}`);
 		consola.info(`Date: ${voucher.voucherDate ?? "-"}`);
-		consola.info(`Supplier: ${voucher.supplierName ?? voucher.supplier?.id ?? "-"}`);
+		consola.info(`Supplier: ${voucher.supplierName ?? contactLabel(voucher.supplier)}`);
 		consola.info(`Description: ${voucher.description ?? "-"}`);
 		consola.info(`Net: ${voucher.sumNet}`);
 		consola.info(`Tax: ${voucher.sumTax}`);
@@ -1649,7 +1826,8 @@ var list_default = defineCommand({
 			endDate: options.endDate,
 			contactId: options.contact,
 			limit: options.limit,
-			offset: options.offset
+			offset: options.offset,
+			embed: ["supplier"]
 		});
 		if (options.json) {
 			printJson(vouchers);
@@ -1662,7 +1840,7 @@ var list_default = defineCommand({
 		printTable(vouchers.map((voucher) => ({
 			id: voucher.id,
 			date: voucher.voucherDate ?? "",
-			supplier: voucher.supplierName ?? voucher.supplier?.id ?? "",
+			supplier: voucher.supplierName ?? contactLabel(voucher.supplier),
 			description: voucher.description ?? "",
 			gross: voucher.sumGross,
 			status: voucher.status ?? ""
@@ -1670,6 +1848,46 @@ var list_default = defineCommand({
 	}
 });
 //#endregion
+//#region src/commands/vouchers/positions.ts
+var positions_default = defineCommand({
+	description: "List voucher positions.",
+	options: defineOptions(z.object({
+		voucher: z.coerce.number().optional().describe("ID of the voucher whose positions to list."),
+		limit: z.coerce.number().optional().describe("Maximum number of positions to return."),
+		offset: z.coerce.number().optional().describe("Number of positions to skip."),
+		json: z.boolean().default(false).describe("Output in JSON format.")
+	})),
+	action: async (options) => {
+		const positions = await (await requireClient()).vouchers.listPositions({
+			voucherId: options.voucher,
+			limit: options.limit,
+			offset: options.offset,
+			embed: ["accountDatev"]
+		});
+		if (options.json) {
+			printJson(positions);
+			return;
+		}
+		if (positions.length === 0) {
+			consola.info("No voucher positions found.");
+			return;
+		}
+		printTable(positions.map((position) => ({
+			id: position.id,
+			voucher: position.voucher.id,
+			account: accountLabel(position.accountDatev),
+			taxRate: position.taxRate,
+			net: String(position.net),
+			sumNet: position.sumNet,
+			sumGross: position.sumGross
+		})));
+	}
+});
+function accountLabel(account) {
+	const parts = [account.number ?? account.accountNumber, account.name ?? account.accountName].filter((part) => part !== void 0 && part !== null && part !== "");
+	return parts.length === 0 ? account.id : parts.join(" ");
+}
+//#endregion
 //#region src/commands/vouchers/reset-to-draft.ts
 var reset_to_draft_default = defineCommand({
 	description: "Reset a voucher to the draft status.",
@@ -1744,6 +1962,9 @@ const config = defineConfig({
 		"accounts:create-file-import": create_file_import_default,
 		"accounts:get": get_default$7,
 		"accounts:list": list_default$8,
+		"contacts:add-address": add_address_default,
+		"contacts:add-email": add_email_default,
+		"contacts:add-phone": add_phone_default,
 		"contacts:create": create_default$3,
 		"contacts:delete": delete_default$1,
 		"contacts:get": get_default$6,
@@ -1777,6 +1998,7 @@ const config = defineConfig({
 		"vouchers:enshrine": enshrine_default,
 		"vouchers:get": get_default,
 		"vouchers:list": list_default,
+		"vouchers:positions": positions_default,
 		"vouchers:reset-to-draft": reset_to_draft_default,
 		"vouchers:reset-to-open": reset_to_open_default
 	}