Skip to content

Commit d055dd0

Browse files
KWojakiewKWojakiew
authored
Merge pull request #16 from messente/travis
release version 2.2.0
2 parents 292e4ae + e7b7693 commit d055dd0

92 files changed

Lines changed: 449 additions & 312 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Messente API Library
22

33
- Messente API version: 2.0.0
4-
- NPM package version: 2.1.0
4+
- NPM package version: 2.2.0
55

66
[Messente](https://messente.com) is a global provider of messaging and user verification services. * Send and receive SMS, Viber, WhatsApp and Telegram messages. * Manage contacts and groups. * Fetch detailed info about phone numbers. * Blacklist phone numbers to make sure you're not sending any unwanted messages. Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.
77

‎docs/BlacklistApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313
<a name="addToBlacklist"></a>
1414
# **addToBlacklist**
15-
> addToBlacklist(numberToBlacklist)
15+
> addToBlacklist(number_to_blacklist)
1616
1717
Adds a phone number to the blacklist
1818

@@ -27,22 +27,22 @@ basicAuth.username = 'YOUR USERNAME';
2727
basicAuth.password = 'YOUR PASSWORD';
2828

2929
var apiInstance = new MessenteApi.BlacklistApi();
30-
var numberToBlacklist = {"phoneNumber":"+37251000000"}; // NumberToBlacklist | Phone number to be blacklisted
30+
var number_to_blacklist = {"phoneNumber":"+37251000000"}; // NumberToBlacklist | Phone number to be blacklisted
3131
var callback = function(error, data, response) {
3232
if (error) {
3333
console.error(error);
3434
} else {
3535
console.log('API called successfully.');
3636
}
3737
};
38-
apiInstance.addToBlacklist(numberToBlacklist, callback);
38+
apiInstance.addToBlacklist(number_to_blacklist, callback);
3939
```
4040

4141
### Parameters
4242

4343
Name | Type | Description | Notes
4444
------------- | ------------- | ------------- | -------------
45-
**numberToBlacklist** | [**NumberToBlacklist**](NumberToBlacklist.md)| Phone number to be blacklisted |
45+
**number_to_blacklist** | [**NumberToBlacklist**](NumberToBlacklist.md)| Phone number to be blacklisted |
4646

4747
### Return type
4848

‎docs/BulkMessagingApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Method | HTTP request | Description
99

1010
<a name="sendBulkOmnimessage"></a>
1111
# **sendBulkOmnimessage**
12-
> BulkOmniMessageCreateSuccessResponse sendBulkOmnimessage(bulkOmnimessage)
12+
> BulkOmniMessageCreateSuccessResponse sendBulkOmnimessage(bulk_omnimessage)
1313
1414
Sends a bulk Omnimessage
1515

@@ -24,22 +24,22 @@ basicAuth.username = 'YOUR USERNAME';
2424
basicAuth.password = 'YOUR PASSWORD';
2525

2626
var apiInstance = new MessenteApi.BulkMessagingApi();
27-
var bulkOmnimessage = new MessenteApi.BulkOmnimessage(); // BulkOmnimessage | Bulk Omnimessage to be sent
27+
var bulk_omnimessage = new MessenteApi.BulkOmnimessage(); // BulkOmnimessage | Bulk Omnimessage to be sent
2828
var callback = function(error, data, response) {
2929
if (error) {
3030
console.error(error);
3131
} else {
3232
console.log('API called successfully. Returned data: ' + data);
3333
}
3434
};
35-
apiInstance.sendBulkOmnimessage(bulkOmnimessage, callback);
35+
apiInstance.sendBulkOmnimessage(bulk_omnimessage, callback);
3636
```
3737

3838
### Parameters
3939

4040
Name | Type | Description | Notes
4141
------------- | ------------- | ------------- | -------------
42-
**bulkOmnimessage** | [**BulkOmnimessage**](BulkOmnimessage.md)| Bulk Omnimessage to be sent |
42+
**bulk_omnimessage** | [**BulkOmnimessage**](BulkOmnimessage.md)| Bulk Omnimessage to be sent |
4343

4444
### Return type
4545

‎docs/ContactFields.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**phoneNumber** | **String** | Phone number in e.164 format |
6+
**phone_number** | **String** | Phone number in e.164 format |
77
**email** | **String** | The email of the contact | [optional]
8-
**firstName** | **String** | The first name of the contact | [optional]
9-
**lastName** | **String** | The last name of the contact | [optional]
8+
**first_name** | **String** | The first name of the contact | [optional]
9+
**last_name** | **String** | The last name of the contact | [optional]
1010
**company** | **String** | The company of the contact | [optional]
1111
**title** | **String** | The title of the contact | [optional]
1212
**custom** | **String** | The first custom field | [optional]

‎docs/ContactResponseFields.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**phoneNumber** | **String** | Phone number in e.164 format | [optional]
6+
**phone_number** | **String** | Phone number in e.164 format | [optional]
77
**email** | **String** | The email of the contact | [optional]
8-
**firstName** | **String** | The first name of the contact | [optional]
9-
**lastName** | **String** | The last name of the contact | [optional]
8+
**first_name** | **String** | The first name of the contact | [optional]
9+
**last_name** | **String** | The last name of the contact | [optional]
1010
**company** | **String** | The company of the contact | [optional]
1111
**title** | **String** | The title of the contact | [optional]
1212
**custom** | **String** | The first custom field | [optional]
1313
**custom2** | **String** | The second custom field | [optional]
1414
**custom3** | **String** | The third custom field | [optional]
1515
**custom4** | **String** | The fourth custom field | [optional]
16-
**scheduledDeletionDate** | **Date** | The date in ISO 8601 format, YYYY-MM-DD, on which the contact is going to be deleted because it has not belonged to a group for 30 days | [optional]
16+
**scheduled_deletion_date** | **Date** | The date in ISO 8601 format, YYYY-MM-DD, on which the contact is going to be deleted because it has not belonged to a group for 30 days | [optional]
1717

1818

‎docs/ContactUpdateFields.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**email** | **String** | The email of the contact | [optional]
7-
**firstName** | **String** | The first name of the contact | [optional]
8-
**lastName** | **String** | The last name of the contact | [optional]
7+
**first_name** | **String** | The first name of the contact | [optional]
8+
**last_name** | **String** | The last name of the contact | [optional]
99
**company** | **String** | The company of the contact | [optional]
1010
**title** | **String** | The title of the contact | [optional]
1111
**custom** | **String** | The first custom field | [optional]

‎docs/ContactsApi.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Method | HTTP request | Description
1616

1717
<a name="addContactToGroup"></a>
1818
# **addContactToGroup**
19-
> EmptyObject addContactToGroup(groupId, phone)
19+
> EmptyObject addContactToGroup(group_id, phone)
2020
2121
Adds a contact to a group
2222

@@ -31,7 +31,7 @@ basicAuth.username = 'YOUR USERNAME';
3131
basicAuth.password = 'YOUR PASSWORD';
3232

3333
var apiInstance = new MessenteApi.ContactsApi();
34-
var groupId = 5792a02a-e5c2-422b-a0a0-0ae65d814663; // String | String in UUID format
34+
var group_id = 5792a02a-e5c2-422b-a0a0-0ae65d814663; // String | String in UUID format
3535
var phone = +37251000000; // String | A phone number
3636
var callback = function(error, data, response) {
3737
if (error) {
@@ -40,14 +40,14 @@ var callback = function(error, data, response) {
4040
console.log('API called successfully. Returned data: ' + data);
4141
}
4242
};
43-
apiInstance.addContactToGroup(groupId, phone, callback);
43+
apiInstance.addContactToGroup(group_id, phone, callback);
4444
```
4545

4646
### Parameters
4747

4848
Name | Type | Description | Notes
4949
------------- | ------------- | ------------- | -------------
50-
**groupId** | **String**| String in UUID format |
50+
**group_id** | **String**| String in UUID format |
5151
**phone** | **String**| A phone number |
5252

5353
### Return type
@@ -65,7 +65,7 @@ Name | Type | Description | Notes
6565

6666
<a name="createContact"></a>
6767
# **createContact**
68-
> ContactEnvelope createContact(contactFields)
68+
> ContactEnvelope createContact(contact_fields)
6969
7070
Creates a new contact
7171

@@ -80,22 +80,22 @@ basicAuth.username = 'YOUR USERNAME';
8080
basicAuth.password = 'YOUR PASSWORD';
8181

8282
var apiInstance = new MessenteApi.ContactsApi();
83-
var contactFields = {"phoneNumber":"+37251000000","email":"anyone@messente.com","firstName":"Any","lastName":"One","company":"Messente","title":"Sir","custom":"Any custom","custom2":"Any custom two","custom3":"Any custom three","custom4":"Any custom four"}; // ContactFields |
83+
var contact_fields = {"phoneNumber":"+37251000000","email":"anyone@messente.com","firstName":"Any","lastName":"One","company":"Messente","title":"Sir","custom":"Any custom","custom2":"Any custom two","custom3":"Any custom three","custom4":"Any custom four"}; // ContactFields |
8484
var callback = function(error, data, response) {
8585
if (error) {
8686
console.error(error);
8787
} else {
8888
console.log('API called successfully. Returned data: ' + data);
8989
}
9090
};
91-
apiInstance.createContact(contactFields, callback);
91+
apiInstance.createContact(contact_fields, callback);
9292
```
9393

9494
### Parameters
9595

9696
Name | Type | Description | Notes
9797
------------- | ------------- | ------------- | -------------
98-
**contactFields** | [**ContactFields**](ContactFields.md)| |
98+
**contact_fields** | [**ContactFields**](ContactFields.md)| |
9999

100100
### Return type
101101

@@ -269,7 +269,7 @@ basicAuth.password = 'YOUR PASSWORD';
269269

270270
var apiInstance = new MessenteApi.ContactsApi();
271271
var opts = {
272-
'groupIds': ["5792a02a-e5c2-422b-a0a0-0ae65d814663","4792a02a-e5c2-422b-a0a0-0ae65d814662"] // [String] | Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\"
272+
'group_ids': ["5792a02a-e5c2-422b-a0a0-0ae65d814663","4792a02a-e5c2-422b-a0a0-0ae65d814662"] // [String] | Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\"
273273
};
274274
var callback = function(error, data, response) {
275275
if (error) {
@@ -285,7 +285,7 @@ apiInstance.fetchContacts(opts, callback);
285285

286286
Name | Type | Description | Notes
287287
------------- | ------------- | ------------- | -------------
288-
**groupIds** | [**[String]**](String.md)| Optional one or many group id strings in UUID format. For example: \&quot;/contacts?groupIds&#x3D;group_id_one&amp;groupIds&#x3D;group_id_two\&quot; | [optional]
288+
**group_ids** | [**[String]**](String.md)| Optional one or many group id strings in UUID format. For example: \&quot;/contacts?groupIds&#x3D;group_id_one&amp;groupIds&#x3D;group_id_two\&quot; | [optional]
289289

290290
### Return type
291291

@@ -302,7 +302,7 @@ Name | Type | Description | Notes
302302

303303
<a name="removeContactFromGroup"></a>
304304
# **removeContactFromGroup**
305-
> removeContactFromGroup(groupId, phone)
305+
> removeContactFromGroup(group_id, phone)
306306
307307
Removes a contact from a group
308308

@@ -317,7 +317,7 @@ basicAuth.username = 'YOUR USERNAME';
317317
basicAuth.password = 'YOUR PASSWORD';
318318

319319
var apiInstance = new MessenteApi.ContactsApi();
320-
var groupId = 5792a02a-e5c2-422b-a0a0-0ae65d814663; // String | String in UUID format
320+
var group_id = 5792a02a-e5c2-422b-a0a0-0ae65d814663; // String | String in UUID format
321321
var phone = +37251000000; // String | A phone number
322322
var callback = function(error, data, response) {
323323
if (error) {
@@ -326,14 +326,14 @@ var callback = function(error, data, response) {
326326
console.log('API called successfully.');
327327
}
328328
};
329-
apiInstance.removeContactFromGroup(groupId, phone, callback);
329+
apiInstance.removeContactFromGroup(group_id, phone, callback);
330330
```
331331

332332
### Parameters
333333

334334
Name | Type | Description | Notes
335335
------------- | ------------- | ------------- | -------------
336-
**groupId** | **String**| String in UUID format |
336+
**group_id** | **String**| String in UUID format |
337337
**phone** | **String**| A phone number |
338338

339339
### Return type
@@ -351,7 +351,7 @@ null (empty response body)
351351

352352
<a name="updateContact"></a>
353353
# **updateContact**
354-
> ContactEnvelope updateContact(phone, contactUpdateFields)
354+
> ContactEnvelope updateContact(phone, contact_update_fields)
355355
356356
Updates a contact
357357

@@ -367,23 +367,23 @@ basicAuth.password = 'YOUR PASSWORD';
367367

368368
var apiInstance = new MessenteApi.ContactsApi();
369369
var phone = +37251000000; // String | A phone number
370-
var contactUpdateFields = {"email":"anyone@messente.com","firstName":"Any","lastName":"One","company":"Messente","title":"Sir","custom":"Any custom","custom2":"Any custom two","custom3":"Any custom three","custom4":"Any custom four"}; // ContactUpdateFields |
370+
var contact_update_fields = {"email":"anyone@messente.com","firstName":"Any","lastName":"One","company":"Messente","title":"Sir","custom":"Any custom","custom2":"Any custom two","custom3":"Any custom three","custom4":"Any custom four"}; // ContactUpdateFields |
371371
var callback = function(error, data, response) {
372372
if (error) {
373373
console.error(error);
374374
} else {
375375
console.log('API called successfully. Returned data: ' + data);
376376
}
377377
};
378-
apiInstance.updateContact(phone, contactUpdateFields, callback);
378+
apiInstance.updateContact(phone, contact_update_fields, callback);
379379
```
380380

381381
### Parameters
382382

383383
Name | Type | Description | Notes
384384
------------- | ------------- | ------------- | -------------
385385
**phone** | **String**| A phone number |
386-
**contactUpdateFields** | [**ContactUpdateFields**](ContactUpdateFields.md)| |
386+
**contact_update_fields** | [**ContactUpdateFields**](ContactUpdateFields.md)| |
387387

388388
### Return type
389389

‎docs/DeliveryReportApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Method | HTTP request | Description
99

1010
<a name="retrieveDeliveryReport"></a>
1111
# **retrieveDeliveryReport**
12-
> DeliveryReportResponse retrieveDeliveryReport(omnimessageId)
12+
> DeliveryReportResponse retrieveDeliveryReport(omnimessage_id)
1313
1414
Retrieves the delivery report for the Omnimessage
1515

@@ -24,22 +24,22 @@ basicAuth.username = 'YOUR USERNAME';
2424
basicAuth.password = 'YOUR PASSWORD';
2525

2626
var apiInstance = new MessenteApi.DeliveryReportApi();
27-
var omnimessageId = "omnimessageId_example"; // String | UUID of the omnimessage to for which the delivery report is to be retrieved
27+
var omnimessage_id = "omnimessage_id_example"; // String | UUID of the omnimessage to for which the delivery report is to be retrieved
2828
var callback = function(error, data, response) {
2929
if (error) {
3030
console.error(error);
3131
} else {
3232
console.log('API called successfully. Returned data: ' + data);
3333
}
3434
};
35-
apiInstance.retrieveDeliveryReport(omnimessageId, callback);
35+
apiInstance.retrieveDeliveryReport(omnimessage_id, callback);
3636
```
3737

3838
### Parameters
3939

4040
Name | Type | Description | Notes
4141
------------- | ------------- | ------------- | -------------
42-
**omnimessageId** | **String**| UUID of the omnimessage to for which the delivery report is to be retrieved |
42+
**omnimessage_id** | **String**| UUID of the omnimessage to for which the delivery report is to be retrieved |
4343

4444
### Return type
4545

‎docs/DeliveryReportResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**statuses** | [**[DeliveryResult]**](DeliveryResult.md) | Contains the delivery reports for each channel, ordered by send order |
77
**to** | **String** | Phone number in e.164 format |
8-
**omnimessageId** | **String** | Unique identifier for the omnimessage |
8+
**omnimessage_id** | **String** | Unique identifier for the omnimessage |
99

1010

‎docs/DeliveryResult.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**status** | [**Status**](Status.md) | | [optional]
77
**channel** | [**Channel**](Channel.md) | | [optional]
8-
**messageId** | **String** | Unique identifier for the message | [optional]
8+
**message_id** | **String** | Unique identifier for the message | [optional]
99
**error** | **String** | Human-readable description of what went wrong, *null* in case of success or if the message has not been processed yet | [optional]
1010
**err** | [**ErrorCodeOmnichannelMachine**](ErrorCodeOmnichannelMachine.md) | | [optional]
1111
**timestamp** | **Date** | When this status was received by Omnichannel API | [optional]
12-
**priceInfo** | [**PriceInfo**](PriceInfo.md) | | [optional]
12+
**price_info** | [**PriceInfo**](PriceInfo.md) | | [optional]
1313
**sender** | **String** | the sender of the message | [optional]
1414

1515

0 commit comments

Comments
 (0)