@wingspan/integrations

SDK Installation

NPM

npm add @wingspan/integrations

Yarn

yarn add @wingspan/integrations

SDK Example Usage

import { Integrations } from "@wingspan/integrations";

(async () => {
    const sdk = new Integrations();

    const res = await sdk.integrations.deleteIntegrationsQuickbooksAccountAssetId({
        id: "<ID>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

Available Resources and Operations

Integrations SDK

• deleteIntegrationsQuickbooksAccountAssetId - Delete Quickbooks Account details
• deleteIntegrationsQuickbooksAccountEquityId - Delete Quickbooks Account details
• deleteIntegrationsQuickbooksAccountExpenseId - Delete Quickbooks Account details
• deleteIntegrationsQuickbooksAccountLiabilityId - Delete Quickbooks Account details
• deleteIntegrationsQuickbooksAccountRevenueId - Delete Quickbooks Account details
• deleteIntegrationsQuickbooksCustomerId - Delete Quickbooks Customer details
• deleteIntegrationsQuickbooksItemId - Delete Quickbooks Item details
• deleteIntegrationsQuickbooksService - Delete Quickbooks Integration
• deleteIntegrationsQuickbooksVendorId - Delete Quickbooks Vendor details
• deleteIntegrationsWebhooksPreferenceId - Delete Webhooks Preference
• getIntegrationsQuickbooksAccountAsset - List Quickbooks Account details
• getIntegrationsQuickbooksAccountAssetId - Get Quickbooks Account details
• getIntegrationsQuickbooksAccountEquity - List Quickbooks Account details
• getIntegrationsQuickbooksAccountEquityId - Get Quickbooks Account details
• getIntegrationsQuickbooksAccountExpense - List Quickbooks Account details
• getIntegrationsQuickbooksAccountExpenseId - Get Quickbooks Account details
• getIntegrationsQuickbooksAccountLiability - List Quickbooks Account details
• getIntegrationsQuickbooksAccountLiabilityId - Get Quickbooks Account details
• getIntegrationsQuickbooksAccountRevenue - List Quickbooks Account details
• getIntegrationsQuickbooksAccountRevenueId - Get Quickbooks Account details
• getIntegrationsQuickbooksCustomer - List Quickbooks Customer details
• getIntegrationsQuickbooksCustomerId - Get Quickbooks Customer details
• getIntegrationsQuickbooksItem - List Quickbooks Item details
• getIntegrationsQuickbooksItemId - Get Quickbooks Item details
• getIntegrationsQuickbooksService - Get Quickbooks Integration
• getIntegrationsQuickbooksServiceSyncActivity - Get Quickbooks Integration Sync Activities
• getIntegrationsQuickbooksServiceSyncActivityId - Get Quickbooks Integration Sync Activity
• getIntegrationsQuickbooksVendor - List Quickbooks Vendor details
• getIntegrationsQuickbooksVendorId - Get Quickbooks Vendor details
• getIntegrationsWebhooksEventnames - List Webhooks Event Names
• getIntegrationsWebhooksPreference - List Webhooks Preferences
• getIntegrationsWebhooksPreferenceId - Get Webhooks Preference
• patchIntegrationsQuickbooksAccountAssetId - Updaet Quickbooks Account details
• patchIntegrationsQuickbooksAccountEquityId - Updaet Quickbooks Account details
• patchIntegrationsQuickbooksAccountExpenseId - Updaet Quickbooks Account details
• patchIntegrationsQuickbooksAccountLiabilityId - Updaet Quickbooks Account details
• patchIntegrationsQuickbooksAccountRevenueId - Updaet Quickbooks Account details
• patchIntegrationsQuickbooksCustomerId - Updaet Quickbooks Customer details
• patchIntegrationsQuickbooksItemId - Updaet Quickbooks Item details
• patchIntegrationsQuickbooksService - Update Quickbooks Integration Status
• patchIntegrationsQuickbooksServiceSyncActivityId - Update Quickbooks Integration Sync Activity
• patchIntegrationsQuickbooksVendorId - Updaet Quickbooks Vendor details
• patchIntegrationsWebhooksPreferenceId - Update Webhooks Preference
• postIntegrationsQuickbooksAccountAsset - Retrieve Account from Quickbooks
• postIntegrationsQuickbooksAccountEquity - Retrieve Account from Quickbooks
• postIntegrationsQuickbooksAccountExpense - Retrieve Account from Quickbooks
• postIntegrationsQuickbooksAccountLiability - Retrieve Account from Quickbooks
• postIntegrationsQuickbooksAccountRevenue - Retrieve Account from Quickbooks
• postIntegrationsQuickbooksCustomer - Retrieve Customer from Quickbooks
• postIntegrationsQuickbooksItem - Retrieve Item from Quickbooks
• postIntegrationsQuickbooksService - Create Quickbooks Integration
• postIntegrationsQuickbooksServiceSyncActivityIdForceSync - Forces a Sync of Object Represented by Quickbooks Integration Sync Activity
• postIntegrationsQuickbooksVendor - Retrieve Vendor from Quickbooks
• postIntegrationsWebhooksPreference - Create Webhooks Preference

Error Handling

Handling errors in your 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.

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.wingspan.app | None | | 1 | https://stagingapi.wingspan.app | None |

For example:

import { Integrations } from "@wingspan/integrations";

(async () => {
    const sdk = new Integrations({
        serverIdx: 1,
    });

    const res = await sdk.integrations.deleteIntegrationsQuickbooksAccountAssetId({
        id: "<ID>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

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 { Integrations } from "@wingspan/integrations";

(async () => {
    const sdk = new Integrations({
        serverURL: "https://api.wingspan.app",
    });

    const res = await sdk.integrations.deleteIntegrationsQuickbooksAccountAssetId({
        id: "<ID>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

Custom HTTP Client

The Typescript SDK makes API calls using the (axios)[https://axios-http.com/docs/intro] 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:

from @wingspan/integrations import Integrations;
import axios;

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})


const sdk = new Integrations({defaultClient: httpClient});

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy