Socket
Socket
Sign inDemoInstall

agilite

Package Overview
Dependencies
1
Maintainers
1
Versions
66
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

agilite

A NodeJS module that provides seamless interactions with Agilit-e APIs


Version published
Maintainers
1
Weekly downloads
33
increased by17.86%

Weekly downloads

Readme

Source

agilite

A NodeJS module that provides seamless interactions with Agilit-e APIs.

Created by Agilit-e

Installation

Using npm:

npm install agilite

In Node.js:

const Agilite = require('agilite')

const agilite = new Agilite({
  apiServerUrl: '{api_server_url}',
  apiKey: '{agilite_api_key}'
})

agilite.Keywords.getData()
  .then((response) => {
    console.log(response.data)
  })
  .catch((err) => {
    console.log(err.response.data)
  })

To Run Unit Tests

npm run test

APIs

Every API returns a promise

Each of App APIs except the Utility APIs contain a postData, getData, putData and deleteData function that can be used for CRUD requests. e.g

postData

  • data - The request body data to post
agilite.Keywords.postData(data)

getData

  • profileKeys - Array of Profile Keys to return
  • recordIds - Array of Record Ids to return
  • slimResult - Default: true, Only return data
agilite.Keywords.getData(profileKeys, recordIds, slimResult)

putData

  • recordId - The Id of the record to PUT / Update
  • data - The request body data to put
agilite.Keywords.putData(recordId, data)

deleteData

  • recordId - The Id of the record to DELETE / Remove
agilite.Keywords.deleteData(recordId)

executeCRUDRequest - Executes a CRUD request relative to any Agilit-e App

  • appName - The App Name relative to the Request. e.g. "keywords" or "numbering"
  • reqType - The Request Type. e.g. "GET", "PUT"
  • data - Optional request body data
  • headers - Request Headers
agilite.executeCRUDRequest(appName, reqType, data, headers)

App APIs

Keywords

FAQs

Last updated on 13 Jan 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc