Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/typescript
A typescript SDK for accessing the typescript API.
https://github.com/speakeasy-sdks/typescript
Last synced: 2 days ago
JSON representation
A typescript SDK for accessing the typescript API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/typescript
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-07-03T08:41:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:22:39.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:54.858Z (6 months ago)
- Language: TypeScript
- Size: 1.55 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Petstore
## SDK Installation
### NPM
```bash
npm add https://github.com/speakeasy-sdks/typescript
```
### Yarn
```bash
yarn add https://github.com/speakeasy-sdks/typescript
```
## SDK Example Usage
### Example
```typescript
import { Petstore } from "Petstore";
async function run() {
const sdk = new Petstore();
const res = await sdk.addPet({
name: "",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
```
## Available Resources and Operations
### [Petstore SDK](docs/sdks/petstore/README.md)
* [addPet](docs/sdks/petstore/README.md#addpet) - Creates a new pet in the store. Duplicates are allowed
* [deletePet](docs/sdks/petstore/README.md#deletepet) - deletes a single pet based on the ID supplied
* [findPetById](docs/sdks/petstore/README.md#findpetbyid) - Returns a user based on a single ID, if the user does not have access to the pet
* [findPets](docs/sdks/petstore/README.md#findpets) - Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
## 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
```typescript
import { Petstore } from "Petstore";
async function run() {
const sdk = new Petstore();
let res;
try {
res = await sdk.addPet({
name: "",
});
} 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://petstore.swagger.io/v2` | None |
#### Example
```typescript
import { Petstore } from "Petstore";
async function run() {
const sdk = new Petstore({
serverIdx: 0,
});
const res = await sdk.addPet({
name: "",
});
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:
```typescript
import { Petstore } from "Petstore";
async function run() {
const sdk = new Petstore({
serverURL: "https://petstore.swagger.io/v2",
});
const res = await sdk.addPet({
name: "",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
```
## Custom HTTP Client
The Typescript SDK makes API calls using the [axios](https://axios-http.com/docs/intro) 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:
```typescript
import { Petstore } from "Petstore";
import axios from "axios";
const httpClient = axios.create({
headers: {'x-custom-header': 'someValue'}
})
const sdk = new Petstore({defaultClient: httpClient});
```
### 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)