speakeasy-sdks / test

A typescript SDK for accessing the test API.

Test

SDK Installation

NPM

npm add https://github.com/speakeasy-sdks/test

Yarn

yarn add https://github.com/speakeasy-sdks/test

SDK Example Usage

Example

import { Test } from "Test";
import { PetStatus } from "Test/dist/sdk/models/shared";

async function run() {
    const sdk = new Test({
        security: {
            petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
        },
    });

    const res = await sdk.pet.addPetForm({
        category: {
            id: 1,
            name: "Dogs",
        },
        id: 10,
        name: "doggie",
        photoUrls: ["<value>"],
        tags: [{}],
    });

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

run();

Available Resources and Operations

pet

• addPetForm - Add a new pet to the store
• addPetJson - Add a new pet to the store
• addPetRaw - Add a new pet to the store
• deletePet - Deletes a pet
• findPetsByStatus - Finds Pets by status
• findPetsByTags - Finds Pets by tags
• getPetById - Find pet by ID
• updatePetWithForm - Updates a pet in the store with form data
• updatePetForm - Update an existing pet
• updatePetJson - Update an existing pet
• updatePetRaw - Update an existing pet
• uploadFile - uploads an image

store

• deleteOrder - Delete purchase order by ID
• getInventory - Returns pet inventories by status
• getOrderById - Find purchase order by ID
• placeOrderForm - Place an order for a pet
• placeOrderJson - Place an order for a pet
• placeOrderRaw - Place an order for a pet

user

• createUserForm - Create user
• createUserJson - Create user
• createUserRaw - Create user
• createUsersWithListInput - Creates list of users with given input array
• deleteUser - Delete user
• getUserByName - Get user by user name
• loginUser - Logs user into the system
• logoutUser - Logs out current logged in user session
• updateUserForm - Update user
• updateUserJson - Update user
• updateUserRaw - Update user

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 { Test } from "Test";
import { PetStatus } from "Test/dist/sdk/models/shared";

async function run() {
    const sdk = new Test({
        security: {
            petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
        },
    });

    let res;
    try {
        res = await sdk.pet.addPetForm({
            category: {
                id: 1,
                name: "Dogs",
            },
            id: 10,
            name: "doggie",
            photoUrls: ["<value>"],
            tags: [{}],
        });
    } 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/v3	None

Example

import { Test } from "Test";
import { PetStatus } from "Test/dist/sdk/models/shared";

async function run() {
    const sdk = new Test({
        serverIdx: 0,
        security: {
            petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
        },
    });

    const res = await sdk.pet.addPetForm({
        category: {
            id: 1,
            name: "Dogs",
        },
        id: 10,
        name: "doggie",
        photoUrls: ["<value>"],
        tags: [{}],
    });

    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 { Test } from "Test";
import { PetStatus } from "Test/dist/sdk/models/shared";

async function run() {
    const sdk = new Test({
        serverURL: "https:///api/v3",
        security: {
            petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
        },
    });

    const res = await sdk.pet.addPetForm({
        category: {
            id: 1,
            name: "Dogs",
        },
        id: 10,
        name: "doggie",
        photoUrls: ["<value>"],
        tags: [{}],
    });

    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 { Test } from "Test";
import axios from "axios";

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

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

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
petstoreAuth	oauth2	OAuth2 token

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { Test } from "Test";
import { PetStatus } from "Test/dist/sdk/models/shared";

async function run() {
    const sdk = new Test({
        security: {
            petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
        },
    });

    const res = await sdk.pet.addPetForm({
        category: {
            id: 1,
            name: "Dogs",
        },
        id: 10,
        name: "doggie",
        photoUrls: ["<value>"],
        tags: [{}],
    });

    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 { Test } from "Test";
import { GetPetByIdSecurity } from "Test/dist/sdk/models/operations";

async function run() {
    const sdk = new Test();
    const operationSecurity: GetPetByIdSecurity = {
        apiKey: "<YOUR_API_KEY_HERE>",
    };

    const res = await sdk.pet.getPetById(
        {
            petId: 504151,
        },
        operationSecurity
    );

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

run();

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