Skip to content
This repository has been archived by the owner on Sep 24, 2021. It is now read-only.

Latest commit

 

History

History
119 lines (85 loc) · 4.29 KB

README.md

File metadata and controls

119 lines (85 loc) · 4.29 KB

AxxellClient

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: class io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import AxxellClient 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import AxxellClient

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import AxxellClient
from AxxellClient.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
AxxellClient.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# AxxellClient.configuration.api_key_prefix['x-api-key'] = 'Bearer'
# create an instance of the API class
api_instance = AxxellClient.DefaultApi
storeid = 'storeid_example' # str | Store identifier
event_type = 'event_type_example' # str | Valid values purchase, view or recommend
data_period = 'data_period_example' # str | Valid values are last7days, last30days, today, yesterday

try:
    api_response = api_instance.aggregate_count_events(storeid, event_type, data_period)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->aggregate_count_events: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://axxell.cinaq.com/v1/

Class Method HTTP request Description
DefaultApi aggregate_count_events GET /aggregates/countevents/{eventType}
DefaultApi aggregate_effective GET /aggregates/effective/{eventType}
DefaultApi aggregate_events GET /aggregates/events/{eventType}
DefaultApi aggregate_recent GET /aggregates/recent/{eventType}
DefaultApi aggregate_top GET /aggregates/top/{eventType}
DefaultApi auth_store POST /auth
DefaultApi delete_all_events DELETE /events
DefaultApi delete_all_items DELETE /items
DefaultApi delete_item DELETE /items/{itemid}
DefaultApi recommend_interesting GET /recommendations/interesting
DefaultApi recommend_similar GET /recommendations/similar
DefaultApi register_event POST /events
DefaultApi register_item POST /items
DefaultApi register_store POST /store
DefaultApi retrieve_events GET /events
DefaultApi retrieve_items GET /items

Documentation For Models

Documentation For Authorization

ApiKey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author

Auto generated, see https://github.com/cinaq/axxell-specifications