# flatties_api

> Flatties_services_

Latest version **1.0.0** (published 2016-10-21) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-10-21 |
| First published | 2016-10-21 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | dermot.apptanknz |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.0.0 (latest) — 2016-10-21
- 1.0.0-rc1 — 2016-10-21

## README

# flatties_api

FlattiesApi - JavaScript client for flatties_api
Flatties services.
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0-rc1
- Package version: 1.0.0-rc1
- Build date: 2016-10-21T22:51:39.468Z
- Build package: class 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 flatties_api --save
```

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

```shell
    npm install YOUR_USERNAME/flatties_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 FlattiesApi = require('flatties_api');

var defaultClient = FlattiesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: flatties_auth
var flatties_auth = defaultClient.authentications['flatties_auth'];
flatties_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new FlattiesApi.ListingApi()

var opts = { 
  'limit': 56, // {Integer} An optional number listings that are returned in each page. If zero or less, a default limit is used. Note that this is an upper limit. If there are not enough listings remaining in the list, then fewer will be returned.
  'start': "start_example" // {String} An optional cursor that points to the starting page of data. Typically obtained from a previous call.
};

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

```

## Documentation for API Endpoints

All URIs are relative to *https://endpoints-dot-flatties-test01.appspot.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FlattiesApi.ListingApi* | [**getAllListings**](docs/ListingApi.md#getAllListings) | **GET** /listings/all | Get all listings.
*FlattiesApi.ListingApi* | [**getListing**](docs/ListingApi.md#getListing) | **GET** /listings/{listingId} | Get listing details.
*FlattiesApi.ListingApi* | [**getListings**](docs/ListingApi.md#getListings) | **GET** /listings | Get listings in the vicinity of the specified location.
*FlattiesApi.ListingApi* | [**getListingsByTileKey**](docs/ListingApi.md#getListingsByTileKey) | **GET** /listings/byTileKey | Get listings in the tile represented by the specified tile key.
*FlattiesApi.ListingApi* | [**removeListing**](docs/ListingApi.md#removeListing) | **DELETE** /listings/{listingId} | Delete a listing.
*FlattiesApi.ListingApi* | [**updateListing**](docs/ListingApi.md#updateListing) | **PUT** /listings/{listingId} | Update an existing listing.
*FlattiesApi.UserApi* | [**addListing**](docs/UserApi.md#addListing) | **POST** /user/{userId}/listings | Add a new listing to the user's listings.
*FlattiesApi.UserApi* | [**getTestUsers**](docs/UserApi.md#getTestUsers) | **GET** /users/test | Get a list of test users.
*FlattiesApi.UserApi* | [**getUser**](docs/UserApi.md#getUser) | **GET** /user/me | User profile
*FlattiesApi.UserApi* | [**getUserListings**](docs/UserApi.md#getUserListings) | **GET** /user/{userId}/listings | Get a user's listings.
*FlattiesApi.UserApi* | [**loginUser**](docs/UserApi.md#loginUser) | **POST** /user/login | Login a user and add the user if new.


## Documentation for Models

 - [FlattiesApi.Address](docs/Address.md)
 - [FlattiesApi.DomainElement](docs/DomainElement.md)
 - [FlattiesApi.Error](docs/Error.md)
 - [FlattiesApi.FacebookTestUser](docs/FacebookTestUser.md)
 - [FlattiesApi.FacebookTestUsers](docs/FacebookTestUsers.md)
 - [FlattiesApi.FacebookTestUsersPaging](docs/FacebookTestUsersPaging.md)
 - [FlattiesApi.FacebookTestUsersPagingCursors](docs/FacebookTestUsersPagingCursors.md)
 - [FlattiesApi.HasLongId](docs/HasLongId.md)
 - [FlattiesApi.Listing](docs/Listing.md)
 - [FlattiesApi.ListingLocation](docs/ListingLocation.md)
 - [FlattiesApi.ListingLocations](docs/ListingLocations.md)
 - [FlattiesApi.Listings](docs/Listings.md)
 - [FlattiesApi.ListingsPaging](docs/ListingsPaging.md)
 - [FlattiesApi.Place](docs/Place.md)
 - [FlattiesApi.RealEstate](docs/RealEstate.md)
 - [FlattiesApi.Residence](docs/Residence.md)
 - [FlattiesApi.ResidentialRealEstate](docs/ResidentialRealEstate.md)
 - [FlattiesApi.User](docs/User.md)


## Documentation for Authorization


### flatties_auth

- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: Not used
- **Scopes**: 
  - apptank: Perform actions on behalf of the Apptank organization.
  - user: Perform actions on behalf of an individual user.

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