@vesselapi/nodesdk
v4.1.3
Published
The Vessel API Node SDK is a NPM library for accessing the Vessel API, a Unified CRM API that provides standardized endpoints for performing operations on common CRM Objects.
Downloads
178
Readme
Vessel API Node SDK
The Vessel API Node SDK is a NPM library for accessing the Vessel API, a Unified CRM API that provides standardized endpoints for performing operations on common CRM Objects.
SDK Installation
NPM
npm add @vesselapi/nodesdk
Yarn
yarn add @vesselapi/nodesdk
SDK Example Usage
Example
import { VesselAPI } from "@vesselapi/nodesdk";
import { DeleteConnectionSecurity } from "@vesselapi/nodesdk/dist/sdk/models/operations";
async function run() {
const sdk = new VesselAPI();
const operationSecurity: DeleteConnectionSecurity = {
vesselAPIToken: "<YOUR_API_KEY_HERE>",
};
const res = await sdk.connections.delete(
{
connectionId: "string",
},
operationSecurity
);
if (res.statusCode == 200) {
// handle response
}
}
run();
Available Resources and Operations
connections
integrations
- list - Get CRM Integrations
webhooks
accounts
- batch - Get Batch Accounts
- create - Create Account
- details - Get Account Details
- find - Get Account
- list - Get All Accounts
- search - Search Accounts
- update - Update Account
calls
- batch - Batch Calls
- create - Create Call
- details - Get Call Details
- find - Get Call
- list - Get All Calls
- search - Search Calls
- update - Update Call
contacts
- batch - Get Batch Contacts
- create - Create Contact
- details - Get Contact Details
- find - Get Contact
- list - Get All Contacts
- search - Search Contacts
- update - Update Contact
deals
- batch - Get Batch Deals
- create - Create Deal
- details - Get Deal Details
- find - Get Deal
- list - Get All Deals
- search - Search Deals
- update - Update Deal
emails
- batch - Get Batch Emails
- create - Create Email
- details - Get Email Details
- find - Get Email
- list - Get All Emails
- search - Search Emails
- update - Update Email
events
- batch - Get Batch Events
- create - Create Event
- details - Get Event Details
- find - Get Event
- list - Get All Events
- search - Search Events
- update - Update Event
attendees
- batch - Get Batch Event Attendees
- create - Create Event Attendee
- details - Get Event Attendee Details
- find - Get Event Attendee
- list - Get All Event Attendees
- search - Search Event Attendees
- update - Update Event Attendee
leads
- batch - Get Batch Leads
- create - Create Lead
- details - Get Lead Details
- find - Get Lead
- list - Get All Leads
- search - Search Leads
- update - Update Lead
notes
- batch - Get Batch Notes
- create - Create Note
- details - Get Note Details
- find - Get Note
- list - Get All Notes
- search - Search Notes
- update - Update Note
passthrough
- create - Passthrough Request
tasks
- batch - Get Batch Tasks
- create - Create Task
- details - Get Task Details
- find - Get Task
- list - Get All Tasks
- search - Search Tasks
- update - Update Task
users
- batch - Get Batch Users
- details - Get User Details
- find - Get User
- list - Get All Users
- search - Search Users
links
- create - Exchange Public Token for Access Token
tokens
- create - Create Link Token
Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | / |
Example
import { VesselAPI } from "@vesselapi/nodesdk";
import { DeleteConnectionSecurity } from "@vesselapi/nodesdk/dist/sdk/models/operations";
async function run() {
const sdk = new VesselAPI();
const operationSecurity: DeleteConnectionSecurity = {
vesselAPIToken: "<YOUR_API_KEY_HERE>",
};
let res;
try {
res = await sdk.connections.delete(
{
connectionId: "string",
},
operationSecurity
);
} catch (err) {
if (err instanceof errors.SDKError) {
console.error(err); // handle exception
throw err;
}
}
if (res.statusCode == 200) {
// handle response
}
}
run();
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx: number
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | https://api.vessel.land
| None |
Example
import { VesselAPI } from "@vesselapi/nodesdk";
import { DeleteConnectionSecurity } from "@vesselapi/nodesdk/dist/sdk/models/operations";
async function run() {
const sdk = new VesselAPI({
serverIdx: 0,
});
const operationSecurity: DeleteConnectionSecurity = {
vesselAPIToken: "<YOUR_API_KEY_HERE>",
};
const res = await sdk.connections.delete(
{
connectionId: "string",
},
operationSecurity
);
if (res.statusCode == 200) {
// handle response
}
}
run();
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL: str
optional parameter when initializing the SDK client instance. For example:
import { VesselAPI } from "@vesselapi/nodesdk";
import { DeleteConnectionSecurity } from "@vesselapi/nodesdk/dist/sdk/models/operations";
async function run() {
const sdk = new VesselAPI({
serverURL: "https://api.vessel.land",
});
const operationSecurity: DeleteConnectionSecurity = {
vesselAPIToken: "<YOUR_API_KEY_HERE>",
};
const res = await sdk.connections.delete(
{
connectionId: "string",
},
operationSecurity
);
if (res.statusCode == 200) {
// handle response
}
}
run();
Custom HTTP Client
The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance
object.
For example, you could specify a header for every request that your sdk makes as follows:
import { @vesselapi/nodesdk } from "VesselAPI";
import axios from "axios";
const httpClient = axios.create({
headers: {'x-custom-header': 'someValue'}
})
const sdk = new VesselAPI({defaultClient: httpClient});
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ---------------- | ---------------- | ---------------- |
| vesselAPIToken
| apiKey | API key |
You can set the security parameters through the security
optional parameter when initializing the SDK client instance. For example:
import { VesselAPI } from "@vesselapi/nodesdk";
async function run() {
const sdk = new VesselAPI({
security: {
vesselAPIToken: "<YOUR_API_KEY_HERE>",
},
});
const res = await sdk.connections.find({
connectionId: "string",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
import { VesselAPI } from "@vesselapi/nodesdk";
import { DeleteConnectionSecurity } from "@vesselapi/nodesdk/dist/sdk/models/operations";
async function run() {
const sdk = new VesselAPI();
const operationSecurity: DeleteConnectionSecurity = {
vesselAPIToken: "<YOUR_API_KEY_HERE>",
};
const res = await sdk.connections.delete(
{
connectionId: "string",
},
operationSecurity
);
if (res.statusCode == 200) {
// handle response
}
}
run();