Skip to content

Commit 0bbb2e0

Browse files
author
Dan Tolbert
committed
clarity on readme
1 parent ba3f6da commit 0bbb2e0

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed

README.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,45 @@ numbers.Site.list(function(err, sites){
5151

5252
```
5353

54+
## Async Methods
55+
56+
Each API Call also contains an async method that returns a promise for use with `.then` or `async`/`await`.
57+
58+
The async method is the original method name with `Async` added.
59+
60+
### Example for listing Available Numbers
61+
62+
```js
63+
// Callbacks
64+
numbers.AvailableNumbers.list(query, (err, availableNumbers) => {
65+
if (err) {
66+
console.log(err);
67+
}
68+
else {
69+
console.log(availableNumbers);
70+
}
71+
});
72+
73+
//Promise chaining
74+
numbers.AvailableNumbers.listAsync(query)
75+
.then(availableNumbers => {
76+
console.log(availableNumbers);
77+
})
78+
.catch(e => {
79+
console.log(e);
80+
});
81+
82+
//Async/await
83+
try {
84+
const availableNumbers = await numbers.AvailableNumbers.listAsync(query);
85+
console.log(availableNumbers);
86+
}
87+
catch (e) {
88+
console.log(e)
89+
}
90+
91+
```
92+
5493
## Examples
5594
There is an 'examples' folder in the source tree that shows how each of the API objects work with simple example code. To run the examples:
5695

@@ -743,3 +782,70 @@ numbers.TnReservation.get(id, function(err, tn){
743782
tn.delete(callback);
744783
});
745784
```
785+
786+
## Hosted Messaging
787+
788+
### Check importability
789+
790+
```js
791+
const numbers = ["1111", "2222"];
792+
793+
try {
794+
const importResults = await ImportTnChecker.checkAsync(numbers);
795+
console.log(importResults);
796+
}
797+
catch (e) {
798+
console.log(e)
799+
}
800+
```
801+
802+
### Create importTNOrder
803+
804+
```js
805+
const numbers = ["1111", "2222"];
806+
807+
const data = {
808+
customerOrderId: "1111",
809+
siteId: "222",
810+
sipPeerId: "333",
811+
loaAuthorizingPerson: "LoaAuthorizingPerson",
812+
subscriber: {
813+
name: "ABC Inc.",
814+
serviceAddress: {
815+
houseNumber: "11235",
816+
streetName: "StreetName",
817+
stateCode: "NC",
818+
city: "City",
819+
county: "county",
820+
zip: "27606"
821+
}
822+
}
823+
};
824+
825+
try {
826+
const importTnOrder = await ImportTnOrder.createAsync(numbers);
827+
console.log(importTnOrder);
828+
}
829+
catch (e) {
830+
console.log(e)
831+
}
832+
```
833+
834+
### Create removeImportedTnOrder
835+
836+
To restore the messaging functionality to the original owner, create a `removeImportedTnOrder` order to remove the numbers from your account.
837+
838+
```js
839+
const numbers = ["1111", "2222"];
840+
const customerOrderId = "customerOrderId"
841+
842+
try {
843+
const importTnOrder = await RemoveImportedTnOrder.createAsync(numbers, customerOrderId);
844+
console.log(importTnOrder);
845+
}
846+
catch (e) {
847+
console.log(e)
848+
}
849+
```
850+
851+

0 commit comments

Comments
 (0)