petstore

🏗 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

Summary

Petstore - OpenAPI 3.1: This is a sample Pet Store Server based on the OpenAPI 3.1 specification.

Some useful links:

• OpenAPI Reference
• The Pet Store repository
• The source API definition for the Pet Store

For more information about the API: Find out more about Swagger

Table of Contents

• petstore
  • 🏗 Welcome to your new SDK! 🏗
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

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

NPM

npm add meep-moop

PNPM

pnpm add meep-moop

Bun

bun add meep-moop

Yarn

yarn add meep-moop zod

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

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Petstore } from "meep-moop";

const petstore = new Petstore({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await petstore.pet.findPetsByTags({});

  console.log(result);
}

run();

Available Resources and Operations

Available methods

pet

• findPetsByTags - Finds Pets by tags
• getPetByIDS - Find pet by ID
• deletePet - Deletes a pet

user

• getUserByName - Get user by user name
• updateUser - Update user
• deleteUser - Delete user

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.

Available standalone functions

• petDeletePet - Deletes a pet
• petFindPetsByTags - Finds Pets by tags
• petGetPetByIDS - Find pet by ID
• userDeleteUser - Delete user
• userGetUserByName - Get user by user name
• userUpdateUser - Update user

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 { Petstore } from "meep-moop";

const petstore = new Petstore({
  apiKey: "<YOUR_API_KEY_HERE>",
});

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

  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 { Petstore } from "meep-moop";

const petstore = new Petstore({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await petstore.pet.findPetsByTags({});

  console.log(result);
}

run();

Error Handling

PetstoreError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
error.message	string	Error message
error.statusCode	number	HTTP response status code eg 404
error.headers	Headers	HTTP response headers
error.body	string	HTTP body. Can be empty string if no body is returned.
error.rawResponse	Response	Raw HTTP response
error.data$		Optional. Some errors may contain structured data. See Error Classes.

Example

import { Petstore } from "meep-moop";
import * as errors from "meep-moop/models/errors";

const petstore = new Petstore({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  try {
    const result = await petstore.pet.findPetsByTags({});

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.PetstoreError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ApiErrorInvalidInput) {
        console.log(error.data$.status); // number
        console.log(error.data$.error); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

• PetstoreError: The base class for HTTP error responses.
  • ApiErrorInvalidInput: . Status code 400. *
  • ApiErrorUnauthorized: Unauthorized error. Status code 401. *
  • ApiErrorNotFound: Not Found error. Status code 404. *

Less common errors (6)

Network errors:

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

Inherit from PetstoreError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Server Variables

The default server https://{environment}.petstore.io contains variables and is set to https://prod.petstore.io by default. To override default values, the following parameters are available when initializing the SDK client instance:

Variable	Parameter	Supported Values	Default	Description
environment	environment: models.ServerEnvironment	- "prod" - "staging" - "dev"	"prod"	The environment name. Defaults to the production environment.

Example

import { Petstore } from "meep-moop";

const petstore = new Petstore({
  environment: "dev",
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await petstore.pet.findPetsByTags({});

  console.log(result);
}

run();

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 { Petstore } from "meep-moop";

const petstore = new Petstore({
  serverURL: "https://prod.petstore.io",
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await petstore.pet.findPetsByTags({});

  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 { Petstore } from "meep-moop";
import { HTTPClient } from "meep-moop/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 Petstore({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
apiKey	apiKey	API key

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

import { Petstore } from "meep-moop";

const petstore = new Petstore({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await petstore.pet.findPetsByTags({});

  console.log(result);
}

run();

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 { Petstore } from "meep-moop";

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

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