<commit_before>Fuel REST Client (for Node.js)
=============

Coming soon...
<commit_msg>A better start to a README.md<commit_after>Fuel SOAP Client (for Node.js)
=============

This library allows users access to ExactTarget's SOAP API at a low level.

## API

**new FuelSoap( authOptions, soapEndpoint )** - Initialization

* *authOptions*
    * required: yes
    * type: `Object`
    * properties need to match [FuelAuth Initialization][1]
* *soapEndpoint*
    * required: no
    * type: `String`
    * default: https://webservice.exacttarget.com/Service.asmx
    
### SOAP Methods

#### Methods

* **create( type, props, options, callback )**
* **retrieve( type, props, filter, callback )**
* **update( type, props, options, callback )**
* **delete( type, props, options, callback )**
* **query( )**
* **describe( type, callback )**
* **execute( )**
* **perform( )**
* **configure( )**
* **schedule( )**
* **versionInfo( )**
* **extract( )**
* **getSystemStatus( )**

## Setting up the client

```js
var FuelSoap = require( 'fuel-soap' );
var alternateEndpoint;

var SoapClient = new FuelSoap({
    clientId: 'clientId'
    , clientSecret: 'clientSecret'
}, alternateEndpoint );
```


## Examples

```js
SoapClient.retrieve( 
    'Email', 
    ["ID", "Name", "Subject", "CategoryID", "EmailType"], 
    function( response ) {
        console.log( response );
    }
);
```

[1]: https://github.com/ExactTarget/Fuel-Node-Auth#api
{'fraction_non_alphanumeric': 0.1951048951048951, 'fraction_numerical': 0.0013986013986013986, 'mean_word_length': 4.092526690391459, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7160308', 'n_tokens_mistral': 486, 'n_tokens_neox': 464, 'n_words': 123}