Petstoresdk Typescript SDK 1.0.0

The Typescript SDK for Petstoresdk.

• API version: 1.0.0
• SDK version: 1.0.0

Table of Contents

• Installation
• Authentication
  • Access Token
• API Endpoint Services
• API Models
• Sample Usage
• Petstoresdk Services
• License

Installation

npm install dwjs

Authentication

To see whether an endpoint needs a specific type of authentication check the endpoint's documentation.

Access Token

The Petstoresdk API uses access tokens as a form of authentication. You can set the access token when initializing the SDK through the constructor:

const sdk = new Petstoresdk('YOUR_ACCESS_TOKEN')

Or through the setAccessToken method:

const sdk = new Petstoresdk()
sdk.setAccessToken('YOUR_ACCESS_TOKEN')

You can also set it for each service individually:

const sdk = new Petstoresdk()
sdk.pets.setAccessToken('YOUR_ACCESS_TOKEN')

Sample Usage

Here is a simple program demonstrating usage of this SDK. It can also be found in the examples/src/index.ts file in this directory.

When running the sample make sure to use npm install to install all the dependencies.

import { Petstoresdk } from '@dworg/dwjs';


const sdk = new Petstoresdk({ accessToken: process.env.PETSTORESDK_ACCESS_TOKEN });

(async () => {
  try {
    const result = await sdk.pets
      .listPets();
    console.log(result);
  } catch (err) {
    const error = err as Error;
    console.error(error.message);
  }
})();

Petstoresdk Services

A list of all services and services methods.

• Services

  • Pets

• All Methods

Pets

| Method | Description | | :-------------------------- | :---------------------- | | createPets | Create a pet | | listPets | List all pets | | showPetById | Info for a specific pet |

All Methods

createPets

Create a pet

• HTTP Method: POST
• Endpoint: /pets

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Petstoresdk } from '@dworg/dwjs';


const sdk = new Petstoresdk({ accessToken: process.env.PETSTORESDK_ACCESS_TOKEN });

(async () => {
  const input = {"id":-67521967,"name":"name","tag":"tag"};
  const result = await sdk.pets
    .createPets(input);
  console.log(result);
})();

listPets

List all pets

• HTTP Method: GET
• Endpoint: /pets

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

| Name | Type | Description | | :---- | :----- | :--------------------------------------------- | | limit | number | How many items to return at one time (max 100) |

Return Type

Pets

Example Usage Code Snippet

import { Petstoresdk } from '@dworg/dwjs';


const sdk = new Petstoresdk({ accessToken: process.env.PETSTORESDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.pets
    .listPets({ limit: -47508293 });
  console.log(result);
})();

showPetById

Info for a specific pet

• HTTP Method: GET
• Endpoint: /pets/{petId}

Required Parameters

| Name | Type | Description | | :---- | :----- | :---------------------------- | | petId | string | The id of the pet to retrieve |

Return Type

Pet

Example Usage Code Snippet

import { Petstoresdk } from '@dworg/dwjs';


const sdk = new Petstoresdk({ accessToken: process.env.PETSTORESDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.pets
    .showPetById('petId');
  console.log(result);
})();

License

License: MIT. See license in LICENSE.