Retrieve and manage your ePost/klara snail mail with ease.
klara-js allows you to easily fetch physical snail mail from your ePost/Klara account. Additionally, you can also manage your snail mail by creating, updating and deleting it.
This project is not affiliated with Swiss Post or Klara in any way. It is an unofficial API wrapper for the Klara API. Use at your own risk. We are not responsible for any damage caused by the use of this library.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Please make sure you have installed the following tools:
And a package manager of your choice:
Install the package via npm:
npm install klara-js --save
or via yarn:
yarn add klara-js
import Klara from 'klara-js';
// Create a new instance
const klara = new Klara('username', 'password');
// Fetch tenants (optional, defaults to first tenant)
const tenants = await klara.user.tenants();
klara.use(tenants[0]);
// Login
await klara.login();
// Fetch all letters
await klara.letterbox.find();
// Fetch a specific letter
await klara.letterbox.findOne("letter-id");
// Remove a letter
await klara.letterbox.delete("letter-id");
// Download a letter
await klara.letterbox.download("letter-id", "./letter.pdf");
In the vast realm of code, where ideas intertwine and innovation knows no bounds, I find myself continually amazed by the unwavering spirit of collaboration that defines the open source community. It's a world where developers, like you and me, share their creations, their insights, and their expertise with an unparalleled generosity. Countless times, whether through serendipitous discovery or through meticulous research, I've stumbled upon remarkable projects that have enriched my own journey as a developer.
Recognizing the profound impact that the open source community has had on my own growth, I've made a personal commitment to give back to this tapestry of ingenuity. The code is licensed under the APGL license, which means that you're free to use, remix, and build upon it. It's my way of extending the thread of collaboration that binds us as developers.
However, I also understand the diverse needs that drive us in this community. If you're considering utilizing this project for commercial purposes in which copyleft is no option, I invite you to reach out. While there isn't a fixed license model in place, I believe in the power of optimism and negotiation. Let's work together to find a solution that aligns with your goals while respecting the effort and intent behind this work.
Tests are written with jest. You can run them with the following command:
npm run test
FAQs
Klara API Wrapper for NodeJS
We found that klara-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.