Created Wiki and fixed some major issues

major fixes, type definitions, and tests. Updated documentation and tests.

Author: timdev-ger

README.md

@@ -79,3 +79,9 @@ const newLead: Lead = await api.lead.create({
 - Pagination: All search/list endpoints accept `limit`/`skip` or `_limit`/`_skip` and map them to Close's `_limit`/`_skip` parameters. You can also pass `fields`/`_fields` to limit response payloads.
 - Email threads: The `email_thread` resource uses the documented `/activity/emailthread/` endpoints.
 - Rate limits: 429 retries honor `RateLimit-Reset` headers when present, otherwise fall back to `Retry-After` or the configured `retryDelay`.
+
+## Wiki
+
+This repo includes a small Wiki in the `Wiki/` folder with usage examples and a method-by-method resource overview.
+
+- Start here: `Wiki/Home.md`

Wiki/Authentication.md

@@ -0,0 +1,33 @@
+# Authentication
+
+Close API keys use **HTTP Basic Authentication**.
+
+## API base URL
+
+Default base URL:
+
+- `https://api.close.com/api/v1`
+
+This is also the default for `closecrm-node`.
+
+## How the API key is sent
+
+Per the Close docs, the API key acts as the username and the password is empty. That means the Basic Auth value is base64 of:
+
+- `YOUR_API_KEY:` (note the trailing colon)
+
+## Using this library
+
+```js
+const Closecom = require('closecrm-node');
+
+const api = new Closecom(process.env.CLOSE_API_KEY);
+
+const me = await api.user.me();
+```
+
+## OAuth?
+
+This library is primarily built around API keys. If you need to build a public app, refer to Close’s OAuth docs.
+
+Reference: https://developer.close.com/topics/authentication/

Wiki/Client-Basics.md

@@ -0,0 +1,65 @@
+# Client Basics
+
+This page explains how requests are made, how to pass query parameters, and how retries work.
+
+## Constructor
+
+```js
+const Closecom = require('closecrm-node');
+
+const api = new Closecom('your-api-key', {
+  baseUrl: 'https://api.close.com/api/v1', // optional
+  maxRetries: 3,                            // optional
+  retryDelay: 1000                          // optional (ms)
+});
+```
+
+### Options
+
+- `baseUrl`: Override Close API base URL (rarely needed)
+- `maxRetries`: How often to retry on rate limiting (HTTP 429)
+- `retryDelay`: Fallback delay (ms) if the server doesn’t provide a usable header
+
+## Passing query params
+
+Most “list/search” methods accept pagination and field selection parameters.
+
+Supported aliases:
+
+- `limit` or `_limit`
+- `skip` or `_skip`
+- `fields` or `_fields`
+
+Example:
+
+```js
+const leads = await api.lead.search({
+  query: 'status:"Potential"',
+  limit: 100,
+  skip: 0,
+  fields: 'id,name,status_label'
+});
+```
+
+## Typical method patterns
+
+Most resources follow the same pattern:
+
+- `search(options)` for collections
+- `create(data)`
+- `read(id)`
+- `update(id, data)`
+- `delete(id)`
+
+Some resources use `list(options)` instead of `search(options)`.
+
+## Retries / rate limiting
+
+If Close responds with **429 Too Many Requests**, the client retries automatically up to `maxRetries`.
+
+Close provides rate limit hints via headers (see Close docs):
+
+- `RateLimit: limit=..., remaining=..., reset=...`
+- `Retry-After: <seconds>`
+
+Reference: https://developer.close.com/topics/rate-limits/

Wiki/Errors-and-Rate-Limits.md

@@ -0,0 +1,48 @@
+# Errors and Rate Limits
+
+This page covers common HTTP errors, and what to do about them.
+
+## Common HTTP response codes
+
+Close commonly uses:
+
+- `200` — success
+- `400` — invalid request / validation
+- `401` — authentication required / invalid API key
+- `402` — plan limit reached
+- `403` — operation not allowed
+- `404` — resource not found / endpoint not found
+- `405` — method not supported
+- `415` — unsupported format
+
+Reference: https://developer.close.com/topics/http-response-codes/
+
+## Rate limiting (429)
+
+If you receive `429 Too Many Requests`, you should pause before retrying.
+
+Close provides a `RateLimit` response header:
+
+- `RateLimit: limit=100, remaining=50, reset=5`
+
+…and a `Retry-After` header (in seconds).
+
+This library automatically retries 429 responses up to the configured `maxRetries`.
+
+Reference: https://developer.close.com/topics/rate-limits/
+
+## Error messages & hints
+
+This client tries to surface helpful hints for common mistakes.
+
+Typical examples:
+
+- 400: invalid search query / missing required fields
+- 401: wrong API key, missing token
+- 429: hit rate limit; retry after reset
+
+If you need more context, log the thrown error and inspect:
+
+- `error.status`
+- `error.message`
+- (sometimes) `error.body` / `error.response`

Wiki/Getting-Started.md

@@ -0,0 +1,40 @@
+# Getting Started
+
+This guide gets you from zero to your first API call.
+
+## Requirements
+
+- Node.js 18+ (this library uses the native `fetch()`)
+
+## Install
+
+```bash
+npm install closecrm-node
+```
+
+## Create a client
+
+```js
+const Closecom = require('closecrm-node');
+
+const api = new Closecom(process.env.CLOSE_API_KEY);
+```
+
+## First call: “Who am I?”
+
+```js
+const me = await api.user.me();
+console.log(me);
+```
+
+## Project structure (what you get)
+
+- **CommonJS** entry (`require('closecrm-node')`)
+- Resources grouped by name, e.g. `api.lead`, `api.contact`, `api.activity.note`
+- Built-in retry behavior for **429 Too Many Requests** (rate limiting)
+
+## Next
+
+- [Authentication](./Authentication.md)
+- [Client Basics](./Client-Basics.md)
+- [Resources Overview](./Resources.md)

Wiki/Home.md

@@ -0,0 +1,33 @@
+# Close.com Node.js Client – Wiki
+
+Welcome to the Wiki for **`closecrm-node`** — a modern Node.js wrapper for the **Close.com REST API**.
+
+This Wiki is structured so you can quickly see:
+
+- which resources exist (Leads, Contacts, Activities, …)
+- which methods the client exposes (search/list/read/create/update/delete)
+- how pagination, rate limits, and error handling work
+
+## Quick Links
+
+- [Getting Started](./Getting-Started.md)
+- [Authentication](./Authentication.md)
+- [Client Basics (Requests, Params, Retries)](./Client-Basics.md)
+- [Pagination](./Pagination.md)
+- [Error Handling & Rate Limits](./Errors-and-Rate-Limits.md)
+- [Resources (Overview)](./Resources.md)
+
+## The basic idea
+
+Create a client once, then use the resource objects:
+
+```js
+const Closecom = require('closecrm-node');
+
+const api = new Closecom(process.env.CLOSE_API_KEY);
+
+const me = await api.user.me();
+const leads = await api.lead.search({ query: 'company:"Acme"', limit: 100 });
+```
+
+> Note: The official Close documentation is at https://developer.close.com

Wiki/Pagination.md

@@ -0,0 +1,43 @@
+# Pagination
+
+Close uses `_skip` and `_limit` to paginate list/search endpoints.
+
+## Basic pagination
+
+Example (100 per page):
+
+- Page 1: `?_skip=0&_limit=100`
+- Page 2: `?_skip=100&_limit=100`
+- Page 3: `?_skip=200&_limit=100`
+
+Responses usually look like:
+
+```json
+{
+  "data": [ /* items */ ],
+  "has_more": true
+}
+```
+
+## Using this library
+
+You can use either the Close style (`_skip`, `_limit`) or the convenience aliases (`skip`, `limit`).
+
+```js
+const res = await api.lead.search({
+  query: 'company:"Acme"',
+  limit: 100,
+  skip: 0
+});
+
+console.log(res.data.length, res.has_more);
+```
+
+## Deep pagination notes
+
+Close warns that very large `_skip` values can be inefficient or even blocked (max `_skip` varies by resource). For large exports, consider:
+
+- reducing the dataset per request (e.g. using a `date_created` range)
+- using the Export API
+
+Reference: https://developer.close.com/topics/pagination/