WithSecureSamiTikka/FuelSDK-Node-SOAP

Node SOAP Client for accessing ExactTarget's API

Fuel SOAP Client (for Node.js)

This repo used to be located at https://github.com/exacttarget/Fuel-Node-SOAP

This library allows users access to the Salesforce Marketing Cloud (formerly ExactTarget) SOAP API at a low level.

npm install fuel-soap --save

Initialization

new FuelSoap( options ) - Initialization

• options.auth
  • Required: yes
  • Type: Object or FuelAuth Instance
  • properties need to match FuelAuth
• options.soapEndpoint
  • Required: no
  • Type: String
  • Default: https://webservice.exacttarget.com/Service.asmx

API

• describe( type, callback )
  • type - object type. see object types required
  • callback - executed after task is completed. required
• retrieve( type, props, options, callback )
  • type - object type. see object types required
  • props - object properties to be returned required
  • options - options object
    • options.queryAllAccounts with a rvalue of true will include 'QueryAllAccounts' in RetrieveRequest object
    • options.filter - filter object
      • filter.leftOperand - property or filter object
      • filter.operator - Simple or Logical operator
      • filter.rightOperand - value or filter object
  • callback - executed after task is completed. required
• create | update | delete( type, props, options, callback )
  • type - object type. see object types required
  • props - object properties and values. required
  • options - options object. see method options
    • options.queryAllAccounts with a value of true will include 'QueryAllAccounts' in Options object
  • callback - executed after task is completed. required

Examples

1. Setting up the client
2. Simple Retrieve
3. Business Unit Retrieve
4. Custom Headers

Contributors

• Aydrian J. Howard - twitter, github
• Alex Vernacchia - twitter, github
• Kelly Andrews - twitter, github
• Jimmy Burgess - github
• Nathan LaFreniere - github
• Drew Simmons - github

Contributing

Please checkout our .jshintrc file and follow the linting rules when contributing. In addition, this project uses tabs not spaces.

ChangeLog

• releases after v1 will have their notes in the 'releases' section
• 1.0.0 - 2014-11-13
  • add original response to the callback - breaking
  • initial unit tests
• 0.1.0 - 2014-09-22 - 1st npm release