oppulence-backend-sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage oppulence-backend-sdk API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Table of Contents

• oppulence-backend-sdk
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add oppulence-backend-sdk

PNPM

pnpm add oppulence-backend-sdk

Bun

bun add oppulence-backend-sdk

Yarn

yarn add oppulence-backend-sdk zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server.

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "OppulenceBackendSDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "oppulence-backend-sdk",
        "--",
        "mcp", "start"
      ]
    }
  }
}

Go to Cursor Settings > Features > MCP Servers > Add new MCP server and use the following settings:

• Name: OppulenceBackendSDK
• Type: command
• Command:

npx -y --package oppulence-backend-sdk -- mcp start 

For a full list of server arguments, run:

npx -y --package oppulence-backend-sdk -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { OppulenceBackendSDK } from "oppulence-backend-sdk";

const oppulenceBackendSDK = new OppulenceBackendSDK();

async function run() {
  const result = await oppulenceBackendSDK.accounts.register({});

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

accounts

• register - Create a new account
• list - List all accounts
• updateSettings - Update account settings
• modifyDetails - Update account details
• fetchById - Get account details
• removeById - Delete account
• getUsage - Get account usage
• create - Create a new account
• update - Update account details
• get - Get account details
• delete - Delete account

apiKeys

• create - Create a new API key
• update - Update API key
• list - List API keys
• rotate - Rotate API key
• get - Get API key details
• delete - Delete API key
• getTenantDetails - Get tenant API key details

jobs

• getAll - Get all jobs
• create - Create a new job scraping task
• get - Get a specific job
• delete - Delete a specific job
• download - Download job results as CSV

leads

• list - List leads
• get - Get lead details

organizations

• list - List all organizations
• create - Create a new organization
• update - Update organization details
• get - Get organization details
• delete - Delete an organization

tenantApiKeys

• create - Create a new tenant API key
• update - Update tenant API key

tenants

• list - List all tenants
• delete - Delete a tenant
• update - Update tenant details
• listApiKeys - List tenant API keys
• rotateApiKey - Rotate tenant API key
• deleteApiKey - Delete tenant API key
• get - Get tenant details
• create - Create a new tenant

webhooks

• list - List webhooks
• create - Create webhook
• update - Update webhook
• get - Get webhook
• delete - Delete webhook

workflows

• update - Update workflow details
• get - Get workflow details
• delete - Delete workflow
• pause - Pause workflow execution
• trigger - Trigger workflow execution

workspaces

• update - Update workspace details
• fetchById - Get workspace details
• removeById - Delete a workspace
• list - List workspaces
• create - Create a new workspace
• fetchAnalytics - Get workspace analytics
• listWorkflows - List workflows
• createWorkflow - Create a new workflow
• generate - Create workspace
• modify - Update workspace
• getAnalytics - Get workspace analytics
• getComplianceReport - Get compliance report
• retrieveList - List workspaces
• listSharings - List workspace sharings
• getStorageStats - Get storage statistics
• get - Get workspace details
• delete - Delete workspace
• share - Share workspace

workspaceSharings

• update - Update workspace sharing
• delete - Remove workspace sharing

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• accountsCreate - Create a new account
• accountsDelete - Delete account
• accountsFetchById - Get account details
• accountsGet - Get account details
• accountsGetUsage - Get account usage
• accountsList - List all accounts
• accountsModifyDetails - Update account details
• accountsRegister - Create a new account
• accountsRemoveById - Delete account
• accountsUpdate - Update account details
• accountsUpdateSettings - Update account settings
• apiKeysCreate - Create a new API key
• apiKeysDelete - Delete API key
• apiKeysGet - Get API key details
• apiKeysGetTenantDetails - Get tenant API key details
• apiKeysList - List API keys
• apiKeysRotate - Rotate API key
• apiKeysUpdate - Update API key
• jobsCreate - Create a new job scraping task
• jobsDelete - Delete a specific job
• jobsDownload - Download job results as CSV
• jobsGet - Get a specific job
• jobsGetAll - Get all jobs
• leadsGet - Get lead details
• leadsList - List leads
• organizationsCreate - Create a new organization
• organizationsDelete - Delete an organization
• organizationsGet - Get organization details
• organizationsList - List all organizations
• organizationsUpdate - Update organization details
• tenantApiKeysCreate - Create a new tenant API key
• tenantApiKeysUpdate - Update tenant API key
• tenantsCreate - Create a new tenant
• tenantsDelete - Delete a tenant
• tenantsDeleteApiKey - Delete tenant API key
• tenantsGet - Get tenant details
• tenantsList - List all tenants
• tenantsListApiKeys - List tenant API keys
• tenantsRotateApiKey - Rotate tenant API key
• tenantsUpdate - Update tenant details
• webhooksCreate - Create webhook
• webhooksDelete - Delete webhook
• webhooksGet - Get webhook
• webhooksList - List webhooks
• webhooksUpdate - Update webhook
• workflowsDelete - Delete workflow
• workflowsGet - Get workflow details
• workflowsPause - Pause workflow execution
• workflowsTrigger - Trigger workflow execution
• workflowsUpdate - Update workflow details
• workspacesCreate - Create a new workspace
• workspacesCreateWorkflow - Create a new workflow
• workspacesDelete - Delete workspace
• workspacesFetchAnalytics - Get workspace analytics
• workspacesFetchById - Get workspace details
• workspacesGenerate - Create workspace
• workspacesGet - Get workspace details
• workspacesGetAnalytics - Get workspace analytics
• workspacesGetComplianceReport - Get compliance report
• workspacesGetStorageStats - Get storage statistics
• workspaceSharingsDelete - Remove workspace sharing
• workspaceSharingsUpdate - Update workspace sharing
• workspacesList - List workspaces
• workspacesListSharings - List workspace sharings
• workspacesListWorkflows - List workflows
• workspacesModify - Update workspace
• workspacesRemoveById - Delete a workspace
• workspacesRetrieveList - List workspaces
• workspacesShare - Share workspace
• workspacesUpdate - Update workspace details

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { OppulenceBackendSDK } from "oppulence-backend-sdk";

const oppulenceBackendSDK = new OppulenceBackendSDK();

async function run() {
  const result = await oppulenceBackendSDK.accounts.register({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { OppulenceBackendSDK } from "oppulence-backend-sdk";

const oppulenceBackendSDK = new OppulenceBackendSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await oppulenceBackendSDK.accounts.register({});

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the register method may throw the following errors:

| Error Type | Status Code | Content Type | | --------------------------------------------------------------- | ----------- | ---------------- | | errors.PostApiLeadScraperMicroserviceApiV1AccountsErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | */* |

If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.

import { OppulenceBackendSDK } from "oppulence-backend-sdk";
import {
  PostApiLeadScraperMicroserviceApiV1AccountsErrorResponse,
  SDKValidationError,
} from "oppulence-backend-sdk/models/errors";

const oppulenceBackendSDK = new OppulenceBackendSDK();

async function run() {
  let result;
  try {
    result = await oppulenceBackendSDK.accounts.register({});

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err
        instanceof PostApiLeadScraperMicroserviceApiV1AccountsErrorResponse): {
        // Handle err.data$: PostApiLeadScraperMicroserviceApiV1AccountsErrorResponseData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { OppulenceBackendSDK } from "oppulence-backend-sdk";

const oppulenceBackendSDK = new OppulenceBackendSDK({
  serverURL: "https://159.89.234.169/v1/gateway",
});

async function run() {
  const result = await oppulenceBackendSDK.accounts.register({});

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { OppulenceBackendSDK } from "oppulence-backend-sdk";
import { HTTPClient } from "oppulence-backend-sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new OppulenceBackendSDK({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { OppulenceBackendSDK } from "oppulence-backend-sdk";

const sdk = new OppulenceBackendSDK({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable OPPULENCEBACKENDSDK_DEBUG to true.

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. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy