proxima_core_engine v2.0.2

Proxima Ai Core Engine -SDK

Installation Guide

Clone this repo Git clone https://github.com/<link_to_this_repo>

Copy path to the .tgz file in this repo : Version 2.0.2

In your project run Npm Install <paste_path_to_.tgz_file>

OR

Npm Install proxima_core_engine this might be the previous version, check for updates

To deploy your App, copy the packed file to your project and run Npm Install <paste/path/to/.tgz/file>

Navigate to your

ProximaCoreEngine - JavaScript client for proxima_core_engine No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.0.1
• Package version: 2.0.1
• Build package: org.openapitools.codegen.languages.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 proxima_core_engine --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your proxima_core_engine from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 ProximaCoreEngine = require('proxima_core_engine');


var api = new ProximaCoreEngine.AnalyticsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.analyticsAnnualGrothRateRetrieve(callback);

Documentation for API Endpoints

All URIs are relative to https://core.proximaai.co

Documentation for Models

• ProximaCoreEngine.Address
• ProximaCoreEngine.Admin
• ProximaCoreEngine.AdminProfile
• ProximaCoreEngine.AdminUser
• ProximaCoreEngine.AnonymousUser
• ProximaCoreEngine.BlankEnum
• ProximaCoreEngine.Category
• ProximaCoreEngine.ChannelEnum
• ProximaCoreEngine.Chat
• ProximaCoreEngine.Client
• ProximaCoreEngine.ClientCommunity
• ProximaCoreEngine.ClientInfo
• ProximaCoreEngine.ClientLikes
• ProximaCoreEngine.ClientProfile
• ProximaCoreEngine.ClientUser
• ProximaCoreEngine.Comment
• ProximaCoreEngine.Community
• ProximaCoreEngine.CommunityFeed
• ProximaCoreEngine.CommunityTag
• ProximaCoreEngine.CommunityTenant
• ProximaCoreEngine.EmailVerification
• ProximaCoreEngine.Employee
• ProximaCoreEngine.EmployeeProfile
• ProximaCoreEngine.EmployeeUser
• ProximaCoreEngine.Event
• ProximaCoreEngine.EventTypeEnum
• ProximaCoreEngine.FavoriteCommunitiesClient
• ProximaCoreEngine.FavoriteCommunity
• ProximaCoreEngine.Feature
• ProximaCoreEngine.FreeTrialEnroll
• ProximaCoreEngine.GenderEnum
• ProximaCoreEngine.IndustryEnum
• ProximaCoreEngine.InteractionTopics
• ProximaCoreEngine.Issue
• ProximaCoreEngine.JoinCommunity
• ProximaCoreEngine.LeaveCommunity
• ProximaCoreEngine.Member
• ProximaCoreEngine.Message
• ProximaCoreEngine.MessageSenderEnum
• ProximaCoreEngine.Metadata
• ProximaCoreEngine.Nested
• ProximaCoreEngine.NullEnum
• ProximaCoreEngine.PaginatedTierList
• ProximaCoreEngine.PatchedAdminUser
• ProximaCoreEngine.PatchedChat
• ProximaCoreEngine.PatchedClientUser
• ProximaCoreEngine.PatchedEmployeeUser
• ProximaCoreEngine.PatchedIssue
• ProximaCoreEngine.PatchedMessage
• ProximaCoreEngine.PatchedService
• ProximaCoreEngine.PatchedServiceForms
• ProximaCoreEngine.PatchedServiceFormsResponse
• ProximaCoreEngine.PatchedServiceRequest
• ProximaCoreEngine.PatchedSetNewPassword
• ProximaCoreEngine.PatchedTokenSetNewPassword
• ProximaCoreEngine.PatchedVerifyUsersToken
• ProximaCoreEngine.Payment
• ProximaCoreEngine.PaymentsTenant
• ProximaCoreEngine.Price
• ProximaCoreEngine.Product
• ProximaCoreEngine.PromptSurvey
• ProximaCoreEngine.PromptSurveySurveyType
• ProximaCoreEngine.QuestionInducedSurvey
• ProximaCoreEngine.Quota
• ProximaCoreEngine.ResetPasswordEmailRequest
• ProximaCoreEngine.Response
• ProximaCoreEngine.Service
• ProximaCoreEngine.ServiceAvailabilityEnum
• ProximaCoreEngine.ServiceForms
• ProximaCoreEngine.ServiceFormsResponse
• ProximaCoreEngine.ServiceRequest
• ProximaCoreEngine.ServiceType
• ProximaCoreEngine.ServiceTypeTypeEnum
• ProximaCoreEngine.SetNewPassword
• ProximaCoreEngine.StatusEnum
• ProximaCoreEngine.Subscription
• ProximaCoreEngine.Survey
• ProximaCoreEngine.SurveyReport
• ProximaCoreEngine.SurveySubGroups
• ProximaCoreEngine.SurveyTypeEnum
• ProximaCoreEngine.TargetAudience
• ProximaCoreEngine.Tenant
• ProximaCoreEngine.TenantInfo
• ProximaCoreEngine.Thread
• ProximaCoreEngine.Tier
• ProximaCoreEngine.TokenLogin
• ProximaCoreEngine.TokenSetNewPassword
• ProximaCoreEngine.TopicEnum
• ProximaCoreEngine.UserLogin
• ProximaCoreEngine.UserType85bEnum
• ProximaCoreEngine.UserTypeD3bEnum
• ProximaCoreEngine.VerifyUsersToken
• ProximaCoreEngine.VirtualAssistant
• ProximaCoreEngine.VirtualAssistantDocuments

Documentation for Authorization

Endpoints do not require authorization.