# track_me_api

> TrackMe_GPS_Server_API

Latest version **1.0.0** (published 2017-04-18) · Unlicense license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install track_me_api
pnpm add track_me_api
yarn add track_me_api
bun add track_me_api
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-04-18 |
| First published | 2017-04-18 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | kgrosvenor |

## Links

- npm: https://www.npmjs.com/package/track_me_api
- npm.io page: https://npm.io/package/track_me_api

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 1.7.1

## Recent versions

- 1.0.0 (latest) — 2017-04-18

## README

# track_me_api

TrackMeApi - JavaScript client for track_me_api
TrackMe GPS Server API
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install track_me_api --save
```

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/track_me_api
then install it via:

```shell
    npm install YOUR_USERNAME/track_me_api --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var TrackMeApi = require('track_me_api');

var defaultClient = TrackMeApi.ApiClient.instance;

// Configure API key authorization: TrackMe-Api-Key
var TrackMe-Api-Key = defaultClient.authentications['TrackMe-Api-Key'];
TrackMe-Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TrackMe-Api-Key.apiKeyPrefix['TrackMe-Api-Key'] = "Token"

var api = new TrackMeApi.DevicesApi()

var opts = { 
  'id': 789, // {Number} identifier of device to be deleted
  'uniqueId': "uniqueId_example" // {String} IMEI of device to be deleted
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deviceDelete(opts, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://trackme.lk/api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*TrackMeApi.DevicesApi* | [**deviceDelete**](docs/DevicesApi.md#deviceDelete) | **DELETE** /devices | 
*TrackMeApi.DevicesApi* | [**devicePost**](docs/DevicesApi.md#devicePost) | **POST** /devices | 
*TrackMeApi.DevicesApi* | [**devicePut**](docs/DevicesApi.md#devicePut) | **PUT** /devices | 
*TrackMeApi.DevicesApi* | [**deviceShare**](docs/DevicesApi.md#deviceShare) | **POST** /devices/{deviceId}/share | 
*TrackMeApi.DevicesApi* | [**deviceStopSharing**](docs/DevicesApi.md#deviceStopSharing) | **DELETE** /devices/{deviceId}/share | 
*TrackMeApi.DevicesApi* | [**devicesGet**](docs/DevicesApi.md#devicesGet) | **GET** /devices | 
*TrackMeApi.LoginApi* | [**usersPost**](docs/LoginApi.md#usersPost) | **POST** /login | 
*TrackMeApi.PositionsApi* | [**devicePositionsGet**](docs/PositionsApi.md#devicePositionsGet) | **GET** /positions/{deviceId} | 
*TrackMeApi.PositionsApi* | [**positionsGet**](docs/PositionsApi.md#positionsGet) | **GET** /positions | 
*TrackMeApi.Recover_passwordApi* | [**recoverPassword**](docs/Recover_passwordApi.md#recoverPassword) | **POST** /recover_password | 
*TrackMeApi.Recover_passwordApi* | [**usersPut**](docs/Recover_passwordApi.md#usersPut) | **PUT** /recover_password | 
*TrackMeApi.UsersApi* | [**getCurrentUser**](docs/UsersApi.md#getCurrentUser) | **GET** /users/me | 
*TrackMeApi.UsersApi* | [**registerUsers**](docs/UsersApi.md#registerUsers) | **POST** /users | 


## Documentation for Models

 - [TrackMeApi.Device](docs/Device.md)
 - [TrackMeApi.Error](docs/Error.md)
 - [TrackMeApi.LoginInfo](docs/LoginInfo.md)
 - [TrackMeApi.Position](docs/Position.md)
 - [TrackMeApi.User](docs/User.md)
 - [TrackMeApi.UserSettings](docs/UserSettings.md)


## Documentation for Authorization


### TrackMe-Api-Key

- **Type**: API key
- **API key parameter name**: TrackMe-Api-Key
- **Location**: HTTP header

---
_Source: https://npm.io/package/track_me_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._