@openpets/quo 1.0.0

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/.env.example ADDED
@@ -0,0 +1,7 @@
1
+ # Authentication
2
+ # Credentials: https://my.quo.com/settings/api - Quo expects the raw API key in the Authorization header, without a Bearer prefix.
3
+ QUO_API_KEY=
4
+
5
+ # Optional host override
6
+ # Defaults to https://api.openphone.com
7
+ QUO_HOST=
package/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ # Changelog
2
+
3
+ ## 1.0.0
4
+
5
+ - Initial Quo pet generated from the official Quo OpenAPI specification.
package/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # Quo
2
+
3
+ OpenPets plugin for the [Quo API](https://www.quo.com/docs/mdx/api-reference/introduction). It is generated from Quo's official OpenAPI spec and exposes tools for calls, contacts, conversations, messages, phone numbers, users, and webhooks.
4
+
5
+ ## Quick Start
6
+
7
+ 1. Generate a Quo API key from the API tab in workspace settings.
8
+ 2. Add the key to your environment:
9
+
10
+ ```bash
11
+ export QUO_API_KEY="your-api-key"
12
+ ```
13
+
14
+ 3. Test the plugin:
15
+
16
+ ```bash
17
+ pets exec quo-test-connection --plugin ./index.ts --args '{}' --json
18
+ ```
19
+
20
+ ## Available Tools
21
+
22
+ The generated tools cover:
23
+
24
+ - Calls and call recordings, summaries, transcripts, and voicemails
25
+ - Contacts and contact custom fields
26
+ - Conversations and messages
27
+ - Phone numbers and users
28
+ - Webhooks for messages, calls, call summaries, and call transcripts
29
+
30
+ Write tools such as contact creation, message sending, webhook creation, updates, and deletes are filtered when Quo read-only mode is enabled.
31
+
32
+ ## Authentication
33
+
34
+ Quo uses API-key authentication in the `Authorization` header. Use the raw API key value; Quo does not use a Bearer token prefix.
35
+
36
+ Optional host override:
37
+
38
+ ```bash
39
+ export QUO_HOST="https://api.openphone.com"
40
+ ```
41
+
42
+ ## Regenerating
43
+
44
+ This pet uses Quo's hosted OpenAPI document:
45
+
46
+ ```bash
47
+ pets generate-openapi
48
+ ```
49
+
50
+ Generated OpenAPI files are split into `openapi-client.ts` for reusable client helpers and `openapi-tools.ts` for tool definitions.