# growth_mapper_api

> Growth_Mapper_API

Latest version **1.4.1** (published 2017-08-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install growth_mapper_api
pnpm add growth_mapper_api
yarn add growth_mapper_api
bun add growth_mapper_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.4.1 |
| Published | 2017-08-29 |
| First published | 2017-08-29 |
| 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 | npm.mayank |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.4.1 (latest) — 2017-08-29
- 1.4.0 — 2017-08-29

## README

# growth_mapper_api

GrowthMapperApi - JavaScript client for growth_mapper_api
Growth Mapper API
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.4.0
- Package version: 1.4.0
- 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 growth_mapper_api --save
```

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

```shell
    npm install YOUR_USERNAME/growth_mapper_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 GrowthMapperApi = require('growth_mapper_api');

var api = new GrowthMapperApi.ServiceabilityApi()

var CLIENT_ID = "CLIENT_ID_example"; // {String} SDK Client Id

var CLIENT_SECRET = "CLIENT_SECRET_example"; // {String} SDK Client Secret

var opts = { 
  'latitude': "latitude_example", // {String} latitude of user's location. Must be used together with `longitude`.This parameter is incompatible with `address`. 
  'longitude': "longitude_example", // {String} longitude of user's location Must be used together with `latitude`.This parameter is incompatible with `address`. 
  'address': "address_example" // {String} User's address. For an exact result, use `latitude` and `longitude` instead. 
};

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

```

## Documentation for API Endpoints

All URIs are relative to *https://growthmapper-dev.appspot.com/_ah/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GrowthMapperApi.ServiceabilityApi* | [**checkServiceablity**](docs/ServiceabilityApi.md#checkServiceablity) | **GET** /serviceability/v1.4.0/check | fetches the store id


## Documentation for Models

 - [GrowthMapperApi.InlineResponse200](docs/InlineResponse200.md)
 - [GrowthMapperApi.Store](docs/Store.md)
 - [GrowthMapperApi.StoreAddress](docs/StoreAddress.md)


## Documentation for Authorization

 All endpoints do not require authorization.

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