se-spacetraders-typescript-sdk

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• 🛠 Make your SDK feel handcrafted by customizing it
• ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• 🎁 Publish your SDK to package managers by configuring automatic publishing
• ✨ When ready to productionize, delete this section from the README

SDK Installation

NPM

npm add <UNSET>

Yarn

yarn add <UNSET>

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SeTypescriptSDK } from "se-spacetraders-typescript-sdk";

async function run() {
    const sdk = new SeTypescriptSDK();

    const result = await sdk.getStatus();

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

run();

Available Resources and Operations

SeTypescriptSDK

• getStatus - Get Status
• register - Register New Agent

systems

• getSystems - List Systems
• getSystem - Get System
• getSystemWaypoints - List Waypoints in System
• getWaypoint - Get Waypoint
• getMarket - Get Market
• getShipyard - Get Shipyard
• getJumpGate - Get Jump Gate
• getConstruction - Get Construction Site
• supplyConstruction - Supply Construction Site

factions

• getFactions - List Factions
• getFaction - Get Faction

agents

• getMyAgent - Get Agent
• getAgents - List Agents
• getAgent - Get Public Agent

contracts

• getContracts - List Contracts
• getContract - Get Contract
• acceptContract - Accept Contract
• deliverContract - Deliver Cargo to Contract
• fulfillContract - Fulfill Contract

fleet

• getMyShips - List Ships
• purchaseShip - Purchase Ship
• getMyShip - Get Ship
• getMyShipCargo - Get Ship Cargo
• orbitShip - Orbit Ship
• shipRefine - Ship Refine
• createChart - Create Chart
• getShipCooldown - Get Ship Cooldown
• dockShip - Dock Ship
• createSurvey - Create Survey
• extractResources - Extract Resources
• siphonResources - Siphon Resources
• extractResourcesWithSurvey - Extract Resources with Survey
• jettison - Jettison Cargo
• jumpShip - Jump Ship
• navigateShip - Navigate Ship
• patchShipNav - Patch Ship Nav
• getShipNav - Get Ship Nav
• warpShip - Warp Ship
• sellCargo - Sell Cargo
• createShipSystemScan - Scan Systems
• createShipWaypointScan - Scan Waypoints
• createShipShipScan - Scan Ships
• refuelShip - Refuel Ship
• purchaseCargo - Purchase Cargo
• transferCargo - Transfer Cargo
• negotiateContract - Negotiate Contract
• getMounts - Get Mounts
• installMount - Install Mount
• removeMount - Remove Mount
• getScrapShip - Get Scrap Ship
• scrapShip - Scrap Ship
• getRepairShip - Get Repair Ship
• repairShip - Repair Ship

Error Handling

All SDK methods 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	/

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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { SeTypescriptSDK } from "se-spacetraders-typescript-sdk";
import * as errors from "se-spacetraders-typescript-sdk/models/errors";

async function run() {
    const sdk = new SeTypescriptSDK();

    let result;
    try {
        result = await sdk.getStatus();
    } catch (err) {
        switch (true) {
            case err instanceof errors.SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            default: {
                throw err;
            }
        }
    }

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

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx 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.spacetraders.io/v2	None

import { SeTypescriptSDK } from "se-spacetraders-typescript-sdk";

async function run() {
    const sdk = new SeTypescriptSDK({
        serverIdx: 0,
    });

    const result = await sdk.getStatus();

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

run();

Override Server URL Per-Client

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

import { SeTypescriptSDK } from "se-spacetraders-typescript-sdk";

async function run() {
    const sdk = new SeTypescriptSDK({
        serverURL: "https://api.spacetraders.io/v2",
    });

    const result = await sdk.getStatus();

    // 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 { SeTypescriptSDK } from "se-spacetraders-typescript-sdk";
import { HTTPClient } from "se-spacetraders-typescript-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 SeTypescriptSDK({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
agentToken	http	HTTP Bearer

To authenticate with the API the agentToken parameter must be set when initializing the SDK client instance. For example:

import { SeTypescriptSDK } from "se-spacetraders-typescript-sdk";

async function run() {
    const sdk = new SeTypescriptSDK({
        agentToken: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const result = await sdk.getStatus();

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

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { SeTypescriptSDK } from "se-spacetraders-typescript-sdk";

async function run() {
    const sdk = new SeTypescriptSDK();

    const systemSymbol = "<value>";
    const waypointSymbol = "<value>";
    const requestBody = {
        shipSymbol: "<value>",
        tradeSymbol: "<value>",
        units: 110828,
    };
    const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";

    const result = await sdk.systems.supplyConstruction(
        operationSecurity,
        systemSymbol,
        waypointSymbol,
        requestBody
    );

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

run();

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