api-generated.md

Client

Kind: global class

• Client
  • new Client(service, account, application, password)
  • .getCountries(callback)
  • .getCountry(country_id, callback)
  • .getCarriers([country_id], callback)
  • .getCarrier(carrier_id, callback)
  • .updateChannel(name, properties, callback)
  • .createChannel(properties, callback)
  • .getChannels(callback)
  • .getChannel(name, callback)
  • .deleteChannel(name, callback)
  • .getAO(token, callback)
  • .sendAO(message, callback)
  • .getCandidateChannelsForAO(args, callback)
  • .getCustomAttributes(address, callback)
  • .setCustomAttributes(address, attributes, callback)
  • .createTwitterFriendship(args)
  • .twitterAuthorize(args, callback)
  • .xmppAddContact(args)

new Client(service, account, application, password)

Represents the Nuntium API.

Param	Type	Description
service	string	service url eg 'https://nuntium.instedd.org'
account	string	Your Nuntium account name
application	string	Name of your Nuntium application
password	string	Password for the application.

client.getCountries(callback)

Kind: instance method of Client

Param	Type
callback	requestCallback

client.getCountry(country_id, callback)

Kind: instance method of Client
Throws:

• NuntiumError On bad arguments

Param	Type
country_id	string
callback	requestCallback

client.getCarriers([country_id], callback)

Kind: instance method of Client

Param	Type
[country_id]	string
callback	requestCallback

client.getCarrier(carrier_id, callback)

Kind: instance method of Client
Throws:

• NuntiumError On bad arguments

Param	Type
carrier_id	string
callback	requestCallback

client.updateChannel(name, properties, callback)

Kind: instance method of Client
Throws:

• NuntiumError On bad arguments

Param	Type	Description
name	string	of the channel to update
properties	Object	to update
callback	requestCallback

client.createChannel(properties, callback)

Kind: instance method of Client

Param	Type	Description
properties	Object	of the new channel
callback	requestCallback

client.getChannels(callback)

Kind: instance method of Client

Param	Type
callback	requestCallback

client.getChannel(name, callback)

Kind: instance method of Client
Throws:

• NuntiumError On bad arguments

Param	Type	Description
name	string	of the channel to get
callback	requestCallback

client.deleteChannel(name, callback)

Kind: instance method of Client
Throws:

• NuntiumError On bad arguments

Param	Type
name
callback	requestCallback

client.getAO(token, callback)

Kind: instance method of Client

Param	Type
token	string
callback	requestCallback

client.sendAO(message, callback)

Kind: instance method of Client

Param	Type
message	Object | Array
message.from	string
message.body	string
callback	requestCallback

client.getCandidateChannelsForAO(args, callback)

Kind: instance method of Client

Param	Type	Description
args	Object	eg {'from':'sms://1234','body':'Hello'},
args.from	string	sender (include sms:// prefix)
args.body	string
callback	requestCallback

client.getCustomAttributes(address, callback)

Kind: instance method of Client

Param	Type
address	string
callback	requestCallback

client.setCustomAttributes(address, attributes, callback)

Kind: instance method of Client

Param	Type
address	string
attributes	Object
callback	requestCallback

client.createTwitterFriendship(args)

Kind: instance method of Client

Param	Type
args	Object
args.channel	string
args.user	string
args.follow	bool

client.twitterAuthorize(args, callback)

Kind: instance method of Client

Param	Type
args	Object
args.channel	string
callback	requestCallback

client.xmppAddContact(args)

Kind: instance method of Client

Param	Type
args	Object
args.channel	string