@robinpath/apollo - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

README.md

+# @robinpath/apollo
+
+> Apollo module for RobinPath.
+
+![Category](https://img.shields.io/badge/category-Utility-blue) ![Functions](https://img.shields.io/badge/functions-19-green) ![Auth](https://img.shields.io/badge/auth-API%20Key-orange) ![License](https://img.shields.io/badge/license-MIT-brightgreen)
+
+## Why use this module?
+
+The `apollo` module lets you:
+
+- searchPeople
+- getPerson
+- enrichPerson
+- searchOrganizations
+- getOrganization
+
+All functions are callable directly from RobinPath scripts with a simple, consistent API.
+
+## Installation
+
+```bash
+npm install @robinpath/apollo
+```
+
+## Quick Start
+
+**1. Set up credentials**
+
+```robinpath
+apollo.setCredentials "your-credentials"
+```
+
+**2. searchPeople**
+
+```robinpath
+apollo.searchPeople
+```
+
+## Available Functions
+
+| Function | Description |
+|----------|-------------|
+| `apollo.setCredentials` | Configure apollo credentials. |
+| `apollo.searchPeople` | searchPeople |
+| `apollo.getPerson` | getPerson |
+| `apollo.enrichPerson` | enrichPerson |
+| `apollo.searchOrganizations` | searchOrganizations |
+| `apollo.getOrganization` | getOrganization |
+| `apollo.enrichOrganization` | enrichOrganization |
+| `apollo.listSequences` | listSequences |
+| `apollo.getSequence` | getSequence |
+| `apollo.addToSequence` | addToSequence |
+| `apollo.listEmailAccounts` | listEmailAccounts |
+| `apollo.searchContacts` | searchContacts |
+| `apollo.createContact` | createContact |
+| `apollo.updateContact` | updateContact |
+| `apollo.listLists` | listLists |
+| `apollo.addToList` | addToList |
+| `apollo.listTasks` | listTasks |
+| `apollo.createTask` | createTask |
+| `apollo.getAccount` | getAccount |
+
+## Examples
+
+### searchPeople
+
+```robinpath
+apollo.searchPeople
+```
+
+### getPerson
+
+```robinpath
+apollo.getPerson
+```
+
+### enrichPerson
+
+```robinpath
+apollo.enrichPerson
+```
+
+## Integration with RobinPath
+
+```typescript
+import { RobinPath } from "@wiredwp/robinpath";
+import Module from "@robinpath/apollo";
+
+const rp = new RobinPath();
+rp.registerModule(Module.name, Module.functions);
+rp.registerModuleMeta(Module.name, Module.functionMetadata);
+
+const result = await rp.executeScript(`
+  apollo.setCredentials "your-credentials"
+  apollo.searchPeople
+`);
+```
+
+## Full API Reference
+
+See [MODULE.md](./MODULE.md) for complete documentation including all parameters, return types, error handling, and advanced examples.
+
+## Related Modules
+
+- [`@robinpath/json`](../json) — JSON module for complementary functionality
+
+## License
+
+MIT

package.json

 {
   "name": "@robinpath/apollo",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "publishConfig": {
@@ -5,0 +5,0 @@ "access": "public"

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Improved metrics

Total package byte prevSize

30132

9.01%

Number of package files

10

11.11%

Number of medium quality alerts

0

-100%

Number of lines in readme file

110

Infinity%

Worsened metrics

Number of medium supply chain risk alerts

2

100%

No dependency changes