osc_node v0.0.3

OSCNode

An (under development) Node library for using the Oracle Service Cloud REST API influenced by the ConnectPHP API

Todo

I am looking to implement the following items soon: 1. OSCNode.AnalyticsReportResults, an object for running Analytics Reports 2. Convenience Methods for Analytics Filters and Date Time 3. Test suite (in progress) 4. Documentation

Compatibility

The library is being tested against Oracle Service Cloud May 2017 using Node v8.2.1

TravisCI to be set up soon!

All of the HTTP methods should work on any version of Oracle Service Cloud since version May 2015; however, there maybe some issues with querying items on any version before May 2016. This is because ROQL queries were not exposed via the REST API until May 2016.

Use Cases

You can use this Node Library for basic scripting and microservices.

The main features that work to date are as follows:

1. Simple configuration
2. Basic CRUD Operations via HTTP Methods
   1. Create => Post
   2. Read => Get
   3. Update => Patch
   4. Destroy => Delete

Installing Node (for Windows)

This link has installation downloads for both Node and NPM.

This link has instructions for adding Node to your PATH.

Make sure to install Windows Build Tools if you are using Windows 10. This is not something necessarily needed to run this package, but it will help with Node development on Windows in general.

Installation

Install with npm:

$ npm install osc_node -g

Client Configuration

An OSCNodeClient class lets the library know which credentials and interface to use for interacting with the Oracle Service Cloud REST API. This is helpful if you need to interact with multiple interfaces or set different headers for different objects.

// Configuration is as simple as requiring the package
// and passing in an object

const OSCNode = require('osc_node');

# Configuration Client
var rn_client = OSCNode.Client({
	username: env['OSC_ADMIN'],
	password: env['OSC_PASSWORD'],
	interface: env['OSC_SITE'],

	// Optional Configuration Settings
	demo_site: true,			// Changes domain from 'custhelp' to 'rightnowdemo'

	// STILL TO BE IMPLEMENTED
	// change_version: 'v1.4', 		// Changes REST API version, default is 'v1.3'
	// ssl_off: true,			// Turns off SSL verification
	// suppress_rules: true			// Supresses Business Rules
});

OSCNodeQueryResults example

This is for running one ROQL query. Whatever is allowed by the REST API (limits and sorting) is allowed with this library.

OSCNodeQueryResults only has one function: 'query', which takes an OSCNodeClient object and string query (example below).

const OSCNode = require('osc_node');
const env = process.env;

var rn_client = OSCNode.Client({
	username: env['OSC_ADMIN'],
	password: env['OSC_PASSWORD'],
	interface: env['OSC_SITE'],
	demo_site:true
});

var contactsQuery = `DESCRIBE`

var options = {
	client: rn_client,
	query: contactsQuery
}

OSCNode.QueryResults.query(options,(err,results) =>{
	results.map(function(result){
		console.log(result);
	})
});

Basic CRUD operations

CREATE

//// OSCNode.Connect.post(options, callback)
//// returns callback function

// Here's how you could create a new ServiceProduct object
// using Node variables and objects (sort of like JSON)

const OSCNode = require('osc_node');
const env = process.env;

// Create an OSCNode.Client object
var rn_client = OSCNode.Client({
	username: env['OSC_ADMIN'],
	password: env['OSC_PASSWORD'],
	interface: env['OSC_SITE'],
	demo_site: true
});


// JSON object
// containing data
// for creating
// a new product 

var newProduct = {
  'names': [{
    'labelText': 'newProduct',
    'language': {
      'id': 1
    }
  }],
  'displayOrder': 4,
  'adminVisibleInterfaces': [{
    'id': 1
  }],
  'endUserVisibleInterfaces': [{
    'id': 1
  }]
};

var options = {
	client: rn_client,
	    url:'serviceProducts',
	json: newProduct
}

OSCNode.Connect.post(options,(err,body,response) => {
	if(err){
		console.log(err);
	}else{
		console.log(response.statusCode); // 201
		console.log(JSON.stringify(body, null, 4)); // JSON representation
		// Do something here
		return body; // Callback
	}
});

READ

//// OSCNode.Connect.get(options, callback)
//// returns callback function
// Here's how you could get an instance of ServiceProducts

const OSCNode = require('osc_node');
const env = process.env;

// Create an OSCNode.Client object
var rn_client = OSCNode.Client({
	username: env['OSC_ADMIN'],
	password: env['OSC_PASSWORD'],
	interface: env['OSC_SITE'],
	demo_site: true
});

var options = {
	client: rn_client,
	url:'serviceProducts/168'
};

OSCNode.Connect.get(options,(err,body,response) => {
	if(err){
		console.log(err);
	}else{
		console.log(response.statusCode); // 201
		console.log(JSON.stringify(body, null, 4)); // JSON representation
		return body;
	}
});

UPDATE

//// OSCNode.Connect.patch(options, callback)
//// returns callback
// Here's how you could update an Answer object
// using JSON objects
// to set field information

// JSON Object
// With data for updating
var productUpdated = {
  'name': [{
    'labelText': 'newProduct UPDATED',
    'language': {
      'id': 1
    }
  }]
};


var options = {
	client: rn_client,
	url:'serviceProducts/170',
	json: productUpdated
}

OSCNode.Connect.patch(options,(err,body,response) => {
	if(err){
		console.log(err);
	}else{
		console.log(response.statusCode); // 201
		console.log(body); // empty
		return body;
	}
});

DELETE

//// OSCNode.Connect.delete(options, callback)
//// returns callback
// Here's how you could delete a serviceProduct object

 	var options = { 
		client: rn_client,
 	 	url:'serviceProducts/169'
 	}
  
	OSCNode.Connect.delete(options,(err,body,response) => {
		if(err){
			console.log(err);
		}else{
			console.log(response.statusCode); // 200
			console.log(body); // Empty
			return body;
		}
	});