1.4.1 • Published 7 years ago

growth_mapper_api v1.4.1

Weekly downloads
2
License
Apache-2.0
Repository
-
Last release
7 years ago

growth_mapper_api

GrowthMapperApi - JavaScript client for growth_mapper_api Growth Mapper API This SDK is automatically generated by the 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

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

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:

    npm install YOUR_USERNAME/growth_mapper_api --save

For browser

The library also works in the browser environment via npm and browserify. 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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

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

ClassMethodHTTP requestDescription
GrowthMapperApi.ServiceabilityApicheckServiceablityGET /serviceability/v1.4.0/checkfetches the store id

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.