Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/speakeasy-sdks/smartcar-ts

A typescript SDK for accessing the smartcar-ts API.
https://github.com/speakeasy-sdks/smartcar-ts

api sdk smart-car typescript

Last synced: about 2 months ago
JSON representation

A typescript SDK for accessing the smartcar-ts API.

Host: GitHub
URL: https://github.com/speakeasy-sdks/smartcar-ts
Owner: speakeasy-sdks
License: mit
Created: 2023-04-18T11:04:43.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-02T21:20:19.000Z (9 months ago)
Last Synced: 2024-04-28T05:14:51.376Z (8 months ago)
Topics: api, sdk, smart-car, typescript
Language: TypeScript
Homepage: https://smartcar.com/docs/api/
Size: 416 KB
Stars: 0
Watchers: 5
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        


    

    Typescript SDK

   Build and scale your mobility business

   

   

  

  



## SDK Installation

### NPM

```bash

npm add https://github.com/speakeasy-sdks/smartcar-ts

```

### Yarn

```bash

yarn add https://github.com/speakeasy-sdks/smartcar-ts

```

## SDK Example Usage

```typescript

import { Smartcar } from "smartcar";

import { GetLocationResponse } from "smartcar/dist/sdk/models/operations";

const sdk = new Smartcar({

  security: {

    bearerAuth: "YOUR_BEARER_TOKEN_HERE",

  },

});

sdk.vehicles.getLocation("36ab27d0-fd9d-4455-823a-ce30af709ffc").then((res: GetLocationResponse) => {

  if (res.statusCode == 200) {

    // handle response

  }

});

```

## Available Resources and Operations

### [cadillac](docs/cadillac/README.md)

* [getChargeTime](docs/cadillac/README.md#getchargetime) - Retrieve charging completion time for a Cadillac.

* [getVoltage](docs/cadillac/README.md#getvoltage) - Retrieve charging voltmeter time for a Cadillac.

### [chevrolet](docs/chevrolet/README.md)

* [getChargeTime](docs/chevrolet/README.md#getchargetime) - Retrieve charging completion time for a Chevrolet.

* [getVoltage](docs/chevrolet/README.md#getvoltage) - Retrieve charging voltmeter time for a Chevrolet.

### [compatibility](docs/compatibility/README.md)

* [listCompatibility](docs/compatibility/README.md#listcompatibility) - Compatibility

### [evs](docs/evs/README.md)

* [getBatteryCapacity](docs/evs/README.md#getbatterycapacity) - EV Battery Capacity

* [getBatteryLevel](docs/evs/README.md#getbatterylevel) - EV Battery Level

* [getChargingLimit](docs/evs/README.md#getcharginglimit) - EV Charging Limit

* [getChargingStatus](docs/evs/README.md#getchargingstatus) - EV Charging Status

* [setChargingLimit](docs/evs/README.md#setcharginglimit) - Set EV Charging Limit

* [startStopCharge](docs/evs/README.md#startstopcharge) - Start or stop charging an electric vehicle. Please contact us to request early access.

### [user](docs/user/README.md)

* [getInfo](docs/user/README.md#getinfo) - User Info

### [vehicles](docs/vehicles/README.md)

* [batch](docs/vehicles/README.md#batch) - Batch

* [disconnect](docs/vehicles/README.md#disconnect) - Revoke Access

* [get](docs/vehicles/README.md#get) - Vehicle Info

* [getEngineOil](docs/vehicles/README.md#getengineoil) - Engine Oil Life

* [getFuelTank](docs/vehicles/README.md#getfueltank) - Fuel Tank (US Only)

* [getLocation](docs/vehicles/README.md#getlocation) - Location

* [getOdometer](docs/vehicles/README.md#getodometer) - Odometer

* [getPermissions](docs/vehicles/README.md#getpermissions) - Application Permissions

* [getTirePressure](docs/vehicles/README.md#gettirepressure) - Tire pressure

* [getVin](docs/vehicles/README.md#getvin) - Returns the vehicle’s manufacturer identifier.

* [listVehicles](docs/vehicles/README.md#listvehicles) - All Vehicles

* [lockUnlock](docs/vehicles/README.md#lockunlock) - Lock/Unlock Vehicle

### 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)