Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiltcamp/outseta-api-client
Typed API client for Outseta.
https://github.com/tiltcamp/outseta-api-client
outseta
Last synced: about 2 months ago
JSON representation
Typed API client for Outseta.
- Host: GitHub
- URL: https://github.com/tiltcamp/outseta-api-client
- Owner: tiltcamp
- License: mit
- Created: 2020-11-16T03:06:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-07T23:01:55.000Z (almost 2 years ago)
- Last Synced: 2024-11-08T12:16:31.813Z (about 2 months ago)
- Topics: outseta
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/outseta-api-client
- Size: 1.79 MB
- Stars: 16
- Watchers: 3
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Outseta REST API Client
[](https://github.com/tiltcamp/outseta-api-client/actions?query=branch%3Amain)
[](https://app.codacy.com/gh/tiltcamp/outseta-api-client/dashboard)
[](https://app.codacy.com/gh/tiltcamp/outseta-api-client/dashboard)
[](https://www.npmjs.com/package/outseta-api-client)
[](https://www.npmjs.com/package/outseta-api-client)
[](https://github.com/tiltcamp/outseta-api-client/blob/main/LICENSE)
This is a typed API client for [Outseta](https://www.outseta.com/) written in TypeScript. The only dependency is
`fetch`, so it works in the browser and works with Node if `fetch` is [polyfilled](https://github.com/node-fetch/node-fetch).
See below for an example.
This package implements all the endpoints that are [publicly documented](https://documenter.getpostman.com/view/3613332/outseta-rest-api-v1/7TNfr6k),
and even includes a few extras. Most issues are likely to be related to incorrect types: attributes missing "optional"
flags in models, "unknown" types in the models, or missing filters that could be added. I've done my best to infer
the contents for these models, but as it was done entirely via conjecture there are bound to be some incorrect
assumptions. If you catch any of these (or anything else for that matter), please submit an issue or feel free to
submit a PR.
I am also open to adding more endpoints - there are plenty of undocumented endpoints I can see being useful. As with the
above, issues and PRs are welcome.
## Quick Start
### Installing
NPM:
```shell
npm install outseta-api-client --save
```
Yarn:
```shell
yarn add outseta-api-client
```
### Importing
ES6 import:
```typescript
import OutsetaApiClient from 'outseta-api-client';
```
CommonJS require:
```javascript
var OutsetaApiClient = require('outseta-api-client').default;
```
Additionally, NodeJS requires a polyfill for `fetch`:
```javascript
globalThis.fetch = require('node-fetch');
var OutsetaApiClient = require('outseta-api-client').default;
```
### Initialization
In the following examples, the subdomain is the beginning of your Outseta domain - so if your Outseta domain
is `test-company.outseta.com`, it would be just `test-company` as seen below.
#### Initializing without any keys:
```typescript
const client = new OutsetaApiClient({ subdomain: 'test-company' });
```
#### Initializing with server-side API keys:
```typescript
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
```
#### Initializing with a user access token:
```typescript
const client = new OutsetaApiClient({
subdomain: 'test-company',
accessToken: jwt_user_token
});
```
## Resources & Documentation
#### Billing
- [Invoices](https://tiltcamp.github.io/outseta-api-client/classes/api_billing_invoices.invoices.html#add)
- [Plans](https://tiltcamp.github.io/outseta-api-client/classes/api_billing_plans.plans.html#getall)
- [Plan Families](https://tiltcamp.github.io/outseta-api-client/classes/api_billing_plan_families.planfamilies.html#getall)
- [Subscriptions](https://tiltcamp.github.io/outseta-api-client/classes/api_billing_subscriptions.subscriptions.html#add)
- [Transactions](https://tiltcamp.github.io/outseta-api-client/classes/api_billing_transactions.transactions.html#getall)
- [Usage](https://tiltcamp.github.io/outseta-api-client/classes/api_billing_usage.usage.html#add)
#### CRM
- [Accounts](https://tiltcamp.github.io/outseta-api-client/classes/api_crm_accounts.accounts.html#add)
- [Activities](https://tiltcamp.github.io/outseta-api-client/classes/api_crm_activities.activities.html#add)
- [Deals](https://tiltcamp.github.io/outseta-api-client/classes/api_crm_deals.deals.html#add)
- [People](https://tiltcamp.github.io/outseta-api-client/classes/api_crm_people.people.html#add)
#### Marketing
- [Email List Subscriptions](https://tiltcamp.github.io/outseta-api-client/classes/api_marketing_email_list_subscriptions.emaillistsubscriptions.html#add)
#### Support
- [Cases](https://tiltcamp.github.io/outseta-api-client/classes/api_support_cases.cases.html#add)
#### User
- [Impersonate](https://tiltcamp.github.io/outseta-api-client/classes/api_user.user.html#impersonate)
- [Login](https://tiltcamp.github.io/outseta-api-client/classes/api_user.user.html#login)
- [Password](https://tiltcamp.github.io/outseta-api-client/classes/api_user_password.password.html#update)
- [Profile](https://tiltcamp.github.io/outseta-api-client/classes/api_user_profile.profile.html#get)