@getyetty-sdk/sellsy 2026.1.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +107 -0
- package/dist/index.d.mts +105418 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +53465 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +53 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 GetYetty
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# @getyetty-sdk/sellsy
|
|
2
|
+
|
|
3
|
+
TypeScript client for the [Sellsy API](https://docs.sellsy.com/api/v2/), auto-generated from the official OpenAPI specification.
|
|
4
|
+
|
|
5
|
+
## ⚠️ Disclaimer
|
|
6
|
+
|
|
7
|
+
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.
|
|
8
|
+
|
|
9
|
+
Use at your own risk. For production applications, always test thoroughly and consider the official Sellsy documentation as the source of truth.
|
|
10
|
+
|
|
11
|
+
## ⚠️ Known Limitations
|
|
12
|
+
|
|
13
|
+
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.
|
|
14
|
+
|
|
15
|
+
## ✨ Features
|
|
16
|
+
|
|
17
|
+
- 🔒 Fully typed TypeScript client
|
|
18
|
+
- 🤖 Auto-generated from the official Sellsy OpenAPI spec
|
|
19
|
+
- 🔄 Daily automated updates to stay in sync with API changes
|
|
20
|
+
- 📦 Tree-shakable, zero runtime dependencies (standalone bundle)
|
|
21
|
+
- 🚀 ESM module
|
|
22
|
+
|
|
23
|
+
## 📋 Requirements
|
|
24
|
+
|
|
25
|
+
- Node.js >= 24.0.0
|
|
26
|
+
|
|
27
|
+
## 📥 Installation
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
npm install @getyetty-sdk/sellsy
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## 🛠️ Usage
|
|
34
|
+
|
|
35
|
+
### Basic Setup
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { client } from '@getyetty-sdk/sellsy';
|
|
39
|
+
|
|
40
|
+
// Configure the default client with your API key
|
|
41
|
+
client.setConfig({
|
|
42
|
+
baseUrl: 'https://api.sellsy.com/',
|
|
43
|
+
headers: {
|
|
44
|
+
Authorization: `Bearer ${process.env.SELLSY_API_KEY}`,
|
|
45
|
+
},
|
|
46
|
+
});
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Making API Calls
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import { getContacts, getContact, createContact } from '@getyetty-sdk/sellsy';
|
|
53
|
+
|
|
54
|
+
// List contacts
|
|
55
|
+
const contacts = await getContacts({
|
|
56
|
+
query: {
|
|
57
|
+
limit: 20,
|
|
58
|
+
offset: 0,
|
|
59
|
+
},
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
// Get a specific contact
|
|
63
|
+
const contact = await getContact({
|
|
64
|
+
path: {
|
|
65
|
+
id: 'contact-id',
|
|
66
|
+
},
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
// Create a new contact
|
|
70
|
+
const newContact = await createContact({
|
|
71
|
+
body: {
|
|
72
|
+
// contact data
|
|
73
|
+
},
|
|
74
|
+
});
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Creating a Custom Client Instance
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
import { createClient, createClientWithApiKey, createConfig, getContacts } from '@getyetty-sdk/sellsy';
|
|
81
|
+
|
|
82
|
+
const sellsy = createClient(
|
|
83
|
+
createConfig({
|
|
84
|
+
baseUrl: 'https://api.sellsy.com/',
|
|
85
|
+
headers: {
|
|
86
|
+
Authorization: `Bearer ${process.env.SELLSY_API_KEY}`,
|
|
87
|
+
},
|
|
88
|
+
})
|
|
89
|
+
);
|
|
90
|
+
|
|
91
|
+
// Or alternatively if you just have to provide an API key
|
|
92
|
+
const sellsy = createClientWithApiKey(process.env.SELLSY_API_KEY)
|
|
93
|
+
|
|
94
|
+
// Use the custom client
|
|
95
|
+
const contacts = await getContacts({
|
|
96
|
+
client: sellsy,
|
|
97
|
+
query: { limit: 10 },
|
|
98
|
+
});
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## 📚 API Documentation
|
|
102
|
+
|
|
103
|
+
For detailed API documentation, please refer to the [official Sellsy API docs](https://docs.sellsy.com/api/v2/).
|
|
104
|
+
|
|
105
|
+
## 📄 License
|
|
106
|
+
|
|
107
|
+
MIT
|