paylode_perk_collections_specification

PaylodePerkCollectionsSpecification - JavaScript client for paylode_perk_collections_specification Paylode Perk Collections service provides you with endpoints for work with perk collections. Can be used to implement your own perks page. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.1.5
• Package version: 1.1.5
• Build package: io.swagger.codegen.v3.generators.javascript.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 paylode_perk_collections_specification --save

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --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.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var PaylodePerkCollectionsSpecification = require('paylode_perk_collections_specification');
var defaultClient = PaylodePerkCollectionsSpecification.ApiClient.instance;

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

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

Documentation for API Endpoints

All URIs are relative to https://perk-collections.paylode.com

Class	Method	HTTP request	Description
PaylodePerkCollectionsSpecification.CategoryApi	getCategories	GET /categories	Get a list of categories
PaylodePerkCollectionsSpecification.HealthApi	getHealth	GET /health	Health status.
PaylodePerkCollectionsSpecification.LocationApi	getLocations	GET /locations	Get a locations
PaylodePerkCollectionsSpecification.PerkCollectionApi	getPerkCollection	GET /perk-collections/{collectionId}	Get a perk collection
PaylodePerkCollectionsSpecification.PerkCollectionApi	getPerkCollections	GET /perk-collections	Get a perk collections
PaylodePerkCollectionsSpecification.VersionApi	getVersion	GET /version	API version.

Documentation for Models

• PaylodePerkCollectionsSpecification.Category
• PaylodePerkCollectionsSpecification.CategoryId
• PaylodePerkCollectionsSpecification.City
• PaylodePerkCollectionsSpecification.CityId
• PaylodePerkCollectionsSpecification.CityRelations
• PaylodePerkCollectionsSpecification.Country
• PaylodePerkCollectionsSpecification.CountryId
• PaylodePerkCollectionsSpecification.CountryRelations
• PaylodePerkCollectionsSpecification.InlineResponse200
• PaylodePerkCollectionsSpecification.InlineResponse2001
• PaylodePerkCollectionsSpecification.InternalServerError
• PaylodePerkCollectionsSpecification.Locations
• PaylodePerkCollectionsSpecification.MediaAsset
• PaylodePerkCollectionsSpecification.Partner
• PaylodePerkCollectionsSpecification.PartnerId
• PaylodePerkCollectionsSpecification.PartnerRelations
• PaylodePerkCollectionsSpecification.Perk
• PaylodePerkCollectionsSpecification.PerkCollection
• PaylodePerkCollectionsSpecification.PerkCollectionId
• PaylodePerkCollectionsSpecification.PerkCollectionMeta
• PaylodePerkCollectionsSpecification.PerkId
• PaylodePerkCollectionsSpecification.PerkRelations
• PaylodePerkCollectionsSpecification.Region
• PaylodePerkCollectionsSpecification.RegionId
• PaylodePerkCollectionsSpecification.RegionRelations

Documentation for Authorization

APIKeyHeader

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header