petstore_client
v1.0.0
Published
Welcome to the PetstoreClient SDK documentation. This guide will help you get started with integrating and using the PetstoreClient SDK in your project.
Downloads
1
Readme
PetstoreClient TypeScript SDK 1.0.0
Welcome to the PetstoreClient SDK documentation. This guide will help you get started with integrating and using the PetstoreClient SDK in your project.
Versions
- API version:
1.0.0
- SDK version:
1.0.0
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: TypeScript >= 4.8.4
Installation
To get started with the SDK, we recommend installing using npm
:
npm install petstore_client
Authentication
Access Token Authentication
The PetstoreClient API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
Setting the Access Token
When you initialize the SDK, you can set the access token as follows:
const sdk = new PetstoreClient({ token: 'YOUR_TOKEN' });
If you need to set or update the access token after initializing the SDK, you can use:
const sdk = new PetstoreClient();
sdk.token = 'YOUR_TOKEN';
Services
The SDK provides various services to interact with the API.
| Name | | :--------------------------------------------------- | | PetsService |
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
| Name | Description | | :--------------------------------- | :---------- | | Pet | |
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.