npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@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

  • delete - Delete Connection
  • find - Get Connection
  • list - Get All Connections

integrations

  • list - Get CRM Integrations

webhooks

accounts

calls

contacts

deals

emails

events

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

notes

passthrough

tasks

users

links

  • create - Exchange Public Token for Access Token

tokens

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();

SDK Generated by Speakeasy