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

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 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

• Dynamix.AccountRegistrationRequest
• Dynamix.Ad
• Dynamix.AdMetadata
• Dynamix.AdRequestVector
• Dynamix.AdRequestWeights
• Dynamix.AdResolutionInfo
• Dynamix.AdRestrictions
• Dynamix.AdSourceRestriction
• Dynamix.AdWithProbability
• Dynamix.Address
• Dynamix.AotCreditCharge
• Dynamix.AotCreditGrant
• Dynamix.AotCreditVault
• Dynamix.AotFile
• Dynamix.AspectRatio
• Dynamix.BearerToken
• Dynamix.CatalogItem
• Dynamix.CatalogItemPagedRequest
• Dynamix.ContentProviderRegistration
• Dynamix.ContentRequest
• Dynamix.Currency
• Dynamix.DateBoundedTimeRange
• Dynamix.DayBoundedTimeRange
• Dynamix.DemographicVector
• Dynamix.FileMetadata
• Dynamix.ImpressionInfo
• Dynamix.ImpressionsValidationData
• Dynamix.InputStream
• Dynamix.KeyedAd
• Dynamix.KeyedItem
• Dynamix.KeyedItemObject
• Dynamix.MonetaryRequirementInfo
• Dynamix.ObjectNode
• Dynamix.PagedRequest
• Dynamix.PagedResponse
• Dynamix.PagedResponseContentRequest
• Dynamix.PagedResponsePublisher
• Dynamix.PagedSearchQuery
• Dynamix.PopRequest
• Dynamix.Publisher
• Dynamix.PublisherHistoryInfo
• Dynamix.PublisherLocationInfo
• Dynamix.ReleasedAd
• Dynamix.Resolution
• Dynamix.ResourceIdentifier
• Dynamix.ScreenDimensions
• Dynamix.SoftConstraintRequest
• Dynamix.TimeInfo
• Dynamix.TimeRange
• Dynamix.User

Documentation for Authorization

Contact Ads on Top to get a Token