Giter VIP home page Giter VIP logo

dynamix-js-client's Introduction

dynamix

Dynamix - JavaScript client for dynamix Sign up for Dynamix & grab your token.

  • API version: v0.1.0
  • Package version: v0.1.0

For more information, please visit http://theadsontop.com

Installation

npm

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

Then install it via:

npm install dynamix --save

or with yarn:

yarn add dynamix

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 Dynamix = require('dynamix');

var api = new Dynamix.APITokenApi()

var namespace = "namespace_example"; // {String} 

var body = new Dynamix.AccountRegistrationRequest(); // {AccountRegistrationRequest} 


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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
Dynamix.APITokenApi createAccount POST /api/token Creates an Ads on Top Dynamix account
Dynamix.AdConstraintApi getConstraints PUT /constraints AdConstraintResource - GetVector
Dynamix.AdRankerApi attachProbabilities POST /ranker AdConstraintResource - Apply Soft Constraints
Dynamix.AdSourceAdapterApi pop PUT /api/source/engine/pop AdSourceAdapterResource - pop
Dynamix.AdSourceAdapterApi produceAd POST /api/source/engine/ad AdSourceAdapterResource - produceAd
Dynamix.CatalogApi createCatalogItem POST /api/catalog/item Create a catalog item
Dynamix.CatalogApi deleteCatalogItem DELETE /api/catalog/item Delete a Catalog entry
Dynamix.CatalogApi getCatalogItem GET /api/catalog/item Get a single Catalog Item
Dynamix.CatalogApi getCatalogItems PUT /api/catalog/item/bulk/get Get Catalog Items Paged
Dynamix.CatalogApi listCatalog PUT /api/catalog/list/search List the Catalog entries
Dynamix.CatalogApi listCatalog_0 PUT /api/catalog/list/type List the Catalog entries
Dynamix.CatalogApi updateCatalogItem PUT /api/catalog/item Update a Catalog entry
Dynamix.ContentProviderRegistrationApi bulkGetAuthorizedRegistrations GET /api/source/bulk/auth bulkGetAuthorizedRegistrations
Dynamix.ContentProviderRegistrationApi bulkResolveContentProviderRegistrations POST /api/source/bulk/resolve bulkResolveContentProviderRegistrations
Dynamix.ContentProviderRegistrationApi createContentProviderRegistration POST /api/source createContentProviderRegistration
Dynamix.ContentProviderRegistrationApi deleteContentProviderRegistration DELETE /api/source deleteContentProviderRegistration
Dynamix.ContentProviderRegistrationApi getAllContentProviderRegistrations POST /api/source/paged/auth getAllContentProviderRegistrations
Dynamix.ContentProviderRegistrationApi updateContentProviderRegistration PUT /api/source updateContentProviderRegistration
Dynamix.DefaultSourceContentApi deleteContent DELETE /api/source-engine/default/register DefaultSourceContentResource - deleteContent
Dynamix.DefaultSourceContentApi getAllAuthorizedContentPaged POST /api/source-engine/default/register/paged
Dynamix.DefaultSourceContentApi getContentRequest GET /api/source-engine/default/register
Dynamix.DefaultSourceContentApi registerNewContent POST /api/source-engine/default/register DefaultSourceContentResource - registerNewContent
Dynamix.DefaultSourceContentApi updateContent PUT /api/source-engine/default/register DefaultSourceContentResource - updateContent
Dynamix.DefaultSourceContentApi uploadFile POST /api/source-engine/default/register/upload DefaultSourceContentResource - uploadFile
Dynamix.DeliveryApi getNextAd GET /api/delivery Get next Ad
Dynamix.DeliveryApi popAd POST /api/delivery Trigger Proof of Play on Ad
Dynamix.DynamixCreditApi addCredits POST /api/credit/add Add credits to a vault.
Dynamix.DynamixCreditApi checkBalance GET /api/credit/balance Checks the balance of a given vault.
Dynamix.PublisherApi bulkResolvePublishers POST /api/publisher/bulk/resolve PublisherResource - bulkResolvePublishers
Dynamix.PublisherApi deletePublisher DELETE /api/publisher PublisherResource - deletePublisher
Dynamix.PublisherApi getAllAuthorizedPublishers POST /api/publisher/authorized PublisherResource - getAllAuthorizedPublishers
Dynamix.PublisherApi registerPublisher POST /api/publisher PublisherResource - registerPublisher
Dynamix.PublisherApi updatePublisher PUT /api/publisher PublisherResource - updatePublisher

Documentation for Models

Documentation for Authorization

Contact Ads on Top to get a Token

dynamix-js-client's People

Watchers

Abhinav Khanna avatar James Cloos avatar k avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.