@getyetty-sdk/sellsy

TypeScript client for the Sellsy API, auto-generated from the official OpenAPI specification.

⚠️ Disclaimer

This package is not officially maintained by Sellsy. It is auto-generated from the publicly available OpenAPI specification. While we strive to keep it up-to-date through daily automated updates, there may be occasional discrepancies or delays.

Use at your own risk. For production applications, always test thoroughly and consider the official Sellsy documentation as the source of truth.

⚠️ Known Limitations

Due to the complexity of the Sellsy OpenAPI specification, some generated TypeScript types may have incomplete type definitions. The SDK functions work correctly at runtime, but TypeScript may report type errors for some advanced use cases. This is a known issue with the upstream code generator when handling complex nested schemas.

✨ Features

• 🔒 Fully typed TypeScript client
• 🤖 Auto-generated from the official Sellsy OpenAPI spec
• 🔄 Daily automated updates to stay in sync with API changes
• 📦 Tree-shakable, zero runtime dependencies (standalone bundle)
• 🚀 ESM module

📋 Requirements

• Node.js >= 24.0.0

📥 Installation

npm install @getyetty-sdk/sellsy

🛠️ Usage

Basic Setup

import { client } from '@getyetty-sdk/sellsy';

// Configure the default client with your API key
client.setConfig({
  baseUrl: 'https://api.sellsy.com/',
  headers: {
    Authorization: `Bearer ${process.env.SELLSY_API_KEY}`,
  },
});

Making API Calls

import { getContacts, getContact, createContact } from '@getyetty-sdk/sellsy';

// List contacts
const contacts = await getContacts({
  query: {
    limit: 20,
    offset: 0,
  },
});

// Get a specific contact
const contact = await getContact({
  path: {
    id: 'contact-id',
  },
});

// Create a new contact
const newContact = await createContact({
  body: {
    // contact data
  },
});

Creating a Custom Client Instance

import {
  createClient,
  createClientWithApiKey,
  createConfig,
  getContacts,
} from '@getyetty-sdk/sellsy';

const sellsy = createClient(
  createConfig({
    baseUrl: 'https://api.sellsy.com/',
    headers: {
      Authorization: `Bearer ${process.env.SELLSY_API_KEY}`,
    },
  }),
);

// Or alternatively if you just have to provide an API key
const sellsy = createClientWithApiKey(process.env.SELLSY_API_KEY);

// Use the custom client
const contacts = await getContacts({
  client: sellsy,
  query: { limit: 10 },
});

📚 API Documentation

For detailed API documentation, please refer to the official Sellsy API docs.

📄 License

MIT