adiona-api-js-client
v1.0.1
Published
JavaScript client library for the Adiona API
Downloads
4
Readme
adiona-api-js-client
Adiona - JavaScript client for adiona-api-js-client Api Documentation This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.0.0
- 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 adiona-api-js-client --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 Adiona = require('adiona-api-js-client');
var api = new Adiona.DemoControllerApi()
var body = new Adiona.TransactionAdded(); // {TransactionAdded} transactionAdded
var orgId = 789; // {Number} orgId
api.publishTransactionToIngestionQueueUsingPOST(body, orgId).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to //adiona-api-swagger.crm-nightly-new.cc.capillarytech.com/
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Adiona.DemoControllerApi | publishTransactionToIngestionQueueUsingPOST | POST /v1/demo/demo_transaction | publishTransactionToIngestionQueue Adiona.DemoControllerApi | triggerWaitSchedulerUsingPOST | POST /v1/demo/trigger_scheduler | triggerWaitScheduler Adiona.HealthCheckControllerApi | isAliveUsingGET | GET /health/isalive | isAlive Adiona.JourneyEventControllerApi | getAllSupportedEventsUsingGET | GET /v1/events/supported-events | getAllSupportedEvents Adiona.JourneyEventControllerApi | getGrammarForEventUsingGET | GET /v1/events/event-grammar/{eventName} | getGrammarForEvent Adiona.JourneyMetaControllerApi | approveJourneyMetaUsingPOST | POST /v1/journeymeta/{journeyMetaId}/approve | approveJourneyMeta Adiona.JourneyMetaControllerApi | createUsingPOST | POST /v1/journeymeta | create Adiona.JourneyMetaControllerApi | getFilteredJourneyMetasUsingPOST | POST /v1/journeymeta/fetch | getFilteredJourneyMetas Adiona.JourneyMetaControllerApi | getJourneyMetaByIdUsingGET | GET /v1/journeymeta/{journeyMetaId} | getJourneyMetaById
Documentation for Models
- Adiona.Account
- Adiona.ApiError
- Adiona.Attribution
- Adiona.CompoundExpressionReq
- Adiona.CompoundExpressionRes
- Adiona.ConditionROReq
- Adiona.ConditionRORes
- Adiona.ConditionalPathROReq
- Adiona.ConditionalPathRORes
- Adiona.Customer
- Adiona.DSTInfo
- Adiona.DSTOperandReq
- Adiona.DSTOperandRes
- Adiona.DoubleListReq
- Adiona.DoubleListRes
- Adiona.DoubleValueReq
- Adiona.DoubleValueRes
- Adiona.Ecommerce
- Adiona.EntryBlockROReq
- Adiona.EntryBlockRORes
- Adiona.EventResponse
- Adiona.ExitBlockROReq
- Adiona.ExitBlockRORes
- Adiona.Expression
- Adiona.Facebook
- Adiona.FactOperandReq
- Adiona.FactOperandRes
- Adiona.FunctionOperandReq
- Adiona.FunctionOperandRes
- Adiona.GEvent
- Adiona.GFact
- Adiona.GParameter
- Adiona.GProfile
- Adiona.GReturnType
- Adiona.GScope
- Adiona.GTypeInfo
- Adiona.Identifier
- Adiona.Instore
- Adiona.Jd
- Adiona.JourneyMetaFilter
- Adiona.JourneyMetaPerformanceMetrics
- Adiona.JourneyMetaROReq
- Adiona.JourneyMetaRORes
- Adiona.JourneySettingRO
- Adiona.JourneySummaryResponse
- Adiona.Line
- Adiona.LongListReq
- Adiona.LongListRes
- Adiona.LongValueReq
- Adiona.LongValueRes
- Adiona.Martjack
- Adiona.Operand
- Adiona.PathRO
- Adiona.ResponseWrapperGEvent
- Adiona.ResponseWrapperJourneyMetaRO
- Adiona.ResponseWrapperListEventResponse
- Adiona.ResponseWrapperListJourneySummaryResponse
- Adiona.ResponseWrapperboolean
- Adiona.SimpleExpressionReq
- Adiona.SimpleExpressionRes
- Adiona.Store
- Adiona.StringListReq
- Adiona.StringListRes
- Adiona.StringValueReq
- Adiona.StringValueRes
- Adiona.Till
- Adiona.Tmall
- Adiona.Toabao
- Adiona.TransactionAdded
- Adiona.TransactionAddedAttributes
- Adiona.User
- Adiona.UserEventConditionTriggerROReq
- Adiona.UserEventConditionTriggerRORes
- Adiona.UserEventMultiConditionTriggerROReq
- Adiona.UserEventMultiConditionTriggerRORes
- Adiona.WaitDurationRO
- Adiona.WaitForDurationBlockROReq
- Adiona.WaitForDurationBlockRORes
- Adiona.WebEngage
- Adiona.Website
- Adiona.Wechat
Documentation for Authorization
All endpoints do not require authorization.