Skip to content

Commit 90deaee

Browse files
author
Erik Räni
authored
1.0.2 (#3)
- Fix some URLs where "/phonebook/" was missing - Improve documentation
1 parent 8073291 commit 90deaee

File tree

77 files changed

+661
-628
lines changed

Some content is hidden

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

77 files changed

+661
-628
lines changed

‎README.md

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

3-
- Messente API version: 1.0.1
4-
- C# package version: 1.0.1
3+
- Messente API version: 1.0.2
4+
- C# package version: 1.0.2
55

66
[Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber and WhatsApp messages, blacklist phone numbers to make sure you're not sending any unwanted messages, manage contacts and groups. Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.
77

@@ -11,11 +11,11 @@ Install Messente API library via NuGet Package Manager or .NET CLI.
1111

1212
### Package Manager
1313

14-
`Install-Package com.Messente.Api -Version 1.0.1`
14+
`Install-Package com.Messente.Api -Version 1.0.2`
1515

1616
### .NET CLI
1717

18-
`dotnet add package com.Messente.Api --version 1.0.1`
18+
`dotnet add package com.Messente.Api --version 1.0.2`
1919

2020
## Features
2121

@@ -28,38 +28,38 @@ Messente API Library provides the operations described below to access the featu
2828

2929
### BlacklistApi
3030

31-
1. Adds a phone number to the blacklist. [`AddToBlacklist`](docs/BlacklistApi.md#addtoblacklist)
32-
1. Deletes a phone number from the blacklist. [`DeleteFromBlacklist`](docs/BlacklistApi.md#deletefromblacklist)
33-
1. Returns all blacklisted phone numbers. [`FetchBlacklist`](docs/BlacklistApi.md#fetchblacklist)
34-
1. Checks if a phone number is blacklisted. [`IsBlacklisted`](docs/BlacklistApi.md#isblacklisted)
31+
1. Adds a phone number to the blacklist [`AddToBlacklist`](docs/BlacklistApi.md#addtoblacklist)
32+
1. Deletes a phone number from the blacklist [`DeleteFromBlacklist`](docs/BlacklistApi.md#deletefromblacklist)
33+
1. Returns all blacklisted phone numbers [`FetchBlacklist`](docs/BlacklistApi.md#fetchblacklist)
34+
1. Checks if a phone number is blacklisted [`IsBlacklisted`](docs/BlacklistApi.md#isblacklisted)
3535

3636
### ContactsApi
3737

38-
1. Adds a contact to a group. [`AddContactToGroup`](docs/ContactsApi.md#addcontacttogroup)
39-
1. Creates a new contact. [`CreateContact`](docs/ContactsApi.md#createcontact)
40-
1. Deletes a contact. [`DeleteContact`](docs/ContactsApi.md#deletecontact)
41-
1. Lists a contact. [`FetchContact`](docs/ContactsApi.md#fetchcontact)
42-
1. Lists groups of a contact. [`FetchContactGroups`](docs/ContactsApi.md#fetchcontactgroups)
43-
1. Returns all contacts. [`FetchContacts`](docs/ContactsApi.md#fetchcontacts)
44-
1. Removes a contact from a group. [`RemoveContactFromGroup`](docs/ContactsApi.md#removecontactfromgroup)
45-
1. Updates a contact. [`UpdateContact`](docs/ContactsApi.md#updatecontact)
38+
1. Adds a contact to a group [`AddContactToGroup`](docs/ContactsApi.md#addcontacttogroup)
39+
1. Creates a new contact [`CreateContact`](docs/ContactsApi.md#createcontact)
40+
1. Deletes a contact [`DeleteContact`](docs/ContactsApi.md#deletecontact)
41+
1. Lists a contact [`FetchContact`](docs/ContactsApi.md#fetchcontact)
42+
1. Lists groups of a contact [`FetchContactGroups`](docs/ContactsApi.md#fetchcontactgroups)
43+
1. Returns all contacts [`FetchContacts`](docs/ContactsApi.md#fetchcontacts)
44+
1. Removes a contact from a group [`RemoveContactFromGroup`](docs/ContactsApi.md#removecontactfromgroup)
45+
1. Updates a contact [`UpdateContact`](docs/ContactsApi.md#updatecontact)
4646

4747
### DeliveryReportApi
4848

49-
1. Retrieves the delivery report for the Omnimessage. [`RetrieveDeliveryReport`](docs/DeliveryReportApi.md#retrievedeliveryreport)
49+
1. Retrieves the delivery report for the Omnimessage [`RetrieveDeliveryReport`](docs/DeliveryReportApi.md#retrievedeliveryreport)
5050

5151
### GroupsApi
5252

53-
1. Creates a new group with the provided name. [`CreateGroup`](docs/GroupsApi.md#creategroup)
54-
1. Deletes a group. [`DeleteGroup`](docs/GroupsApi.md#deletegroup)
55-
1. Lists a group. [`FetchGroup`](docs/GroupsApi.md#fetchgroup)
56-
1. Returns all groups. [`FetchGroups`](docs/GroupsApi.md#fetchgroups)
57-
1. Updates a group with the provided name. [`UpdateGroup`](docs/GroupsApi.md#updategroup)
53+
1. Creates a new group with the provided name [`CreateGroup`](docs/GroupsApi.md#creategroup)
54+
1. Deletes a group [`DeleteGroup`](docs/GroupsApi.md#deletegroup)
55+
1. Lists a group [`FetchGroup`](docs/GroupsApi.md#fetchgroup)
56+
1. Returns all groups [`FetchGroups`](docs/GroupsApi.md#fetchgroups)
57+
1. Updates a group with the provided name [`UpdateGroup`](docs/GroupsApi.md#updategroup)
5858

5959
### OmnimessageApi
6060

61-
1. Cancels a scheduled Omnimessage. [`CancelScheduledMessage`](docs/OmnimessageApi.md#cancelscheduledmessage)
62-
1. Sends an Omnimessage. [`SendOmnimessage`](docs/OmnimessageApi.md#sendomnimessage)
61+
1. Cancels a scheduled Omnimessage [`CancelScheduledMessage`](docs/OmnimessageApi.md#cancelscheduledmessage)
62+
1. Sends an Omnimessage [`SendOmnimessage`](docs/OmnimessageApi.md#sendomnimessage)
6363

6464
## Auth
6565

‎docs/BlacklistApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ All URIs are relative to *https://api.messente.com/v1*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**AddToBlacklist**](BlacklistApi.md#addtoblacklist) | **POST** /phonebook/blacklist | Adds a phone number to the blacklist.
8-
[**DeleteFromBlacklist**](BlacklistApi.md#deletefromblacklist) | **DELETE** /blacklist/{phone} | Deletes a phone number from the blacklist.
9-
[**FetchBlacklist**](BlacklistApi.md#fetchblacklist) | **GET** /phonebook/blacklist | Returns all blacklisted phone numbers.
10-
[**IsBlacklisted**](BlacklistApi.md#isblacklisted) | **GET** /blacklist/{phone} | Checks if a phone number is blacklisted.
7+
[**AddToBlacklist**](BlacklistApi.md#addtoblacklist) | **POST** /phonebook/blacklist | Adds a phone number to the blacklist
8+
[**DeleteFromBlacklist**](BlacklistApi.md#deletefromblacklist) | **DELETE** /phonebook/blacklist/{phone} | Deletes a phone number from the blacklist
9+
[**FetchBlacklist**](BlacklistApi.md#fetchblacklist) | **GET** /phonebook/blacklist | Returns all blacklisted phone numbers
10+
[**IsBlacklisted**](BlacklistApi.md#isblacklisted) | **GET** /phonebook/blacklist/{phone} | Checks if a phone number is blacklisted
1111

1212

1313
<a name="addtoblacklist"></a>
1414
# **AddToBlacklist**
1515
> void AddToBlacklist (NumberToBlacklist numberToBlacklist)
1616
17-
Adds a phone number to the blacklist.
17+
Adds a phone number to the blacklist
1818

1919
### Example
2020
```csharp
@@ -39,7 +39,7 @@ namespace Example
3939
4040
try
4141
{
42-
// Adds a phone number to the blacklist.
42+
// Adds a phone number to the blacklist
4343
apiInstance.AddToBlacklist(numberToBlacklist);
4444
}
4545
catch (Exception e)
@@ -76,7 +76,7 @@ void (empty response body)
7676
# **DeleteFromBlacklist**
7777
> void DeleteFromBlacklist (string phone)
7878
79-
Deletes a phone number from the blacklist.
79+
Deletes a phone number from the blacklist
8080

8181
### Example
8282
```csharp
@@ -101,7 +101,7 @@ namespace Example
101101
102102
try
103103
{
104-
// Deletes a phone number from the blacklist.
104+
// Deletes a phone number from the blacklist
105105
apiInstance.DeleteFromBlacklist(phone);
106106
}
107107
catch (Exception e)
@@ -138,7 +138,7 @@ void (empty response body)
138138
# **FetchBlacklist**
139139
> FetchBlacklistSuccess FetchBlacklist ()
140140
141-
Returns all blacklisted phone numbers.
141+
Returns all blacklisted phone numbers
142142

143143
### Example
144144
```csharp
@@ -162,7 +162,7 @@ namespace Example
162162

163163
try
164164
{
165-
// Returns all blacklisted phone numbers.
165+
// Returns all blacklisted phone numbers
166166
FetchBlacklistSuccess result = apiInstance.FetchBlacklist();
167167
Debug.WriteLine(result);
168168
}
@@ -197,7 +197,7 @@ This endpoint does not need any parameter.
197197
# **IsBlacklisted**
198198
> void IsBlacklisted (string phone)
199199
200-
Checks if a phone number is blacklisted.
200+
Checks if a phone number is blacklisted
201201

202202
### Example
203203
```csharp
@@ -222,7 +222,7 @@ namespace Example
222222
223223
try
224224
{
225-
// Checks if a phone number is blacklisted.
225+
// Checks if a phone number is blacklisted
226226
apiInstance.IsBlacklisted(phone);
227227
}
228228
catch (Exception e)

‎docs/ContactFields.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**PhoneNumber** | **string** | Phone number in e.164 format |
7-
**Email** | **string** | | [optional]
8-
**FirstName** | **string** | | [optional]
9-
**LastName** | **string** | | [optional]
10-
**Company** | **string** | | [optional]
11-
**Title** | **string** | | [optional]
12-
**Custom** | **string** | | [optional]
13-
**Custom2** | **string** | | [optional]
14-
**Custom3** | **string** | | [optional]
15-
**Custom4** | **string** | | [optional]
7+
**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]
10+
**Company** | **string** | The company of the contact | [optional]
11+
**Title** | **string** | The title of the contact | [optional]
12+
**Custom** | **string** | The first custom field | [optional]
13+
**Custom2** | **string** | The second custom field | [optional]
14+
**Custom3** | **string** | The third custom field | [optional]
15+
**Custom4** | **string** | The fourth custom field | [optional]
1616

1717
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1818

‎docs/ContactListEnvelope.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**Contacts** | [**List&lt;ContactFields&gt;**](ContactFields.md) | | [optional]
6+
**Contacts** | [**List&lt;ContactFields&gt;**](ContactFields.md) | An array of contacts | [optional]
77

88
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
99

‎docs/ContactUpdateFields.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33

44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**Email** | **string** | | [optional]
7-
**FirstName** | **string** | | [optional]
8-
**LastName** | **string** | | [optional]
9-
**Company** | **string** | | [optional]
10-
**Title** | **string** | | [optional]
11-
**Custom** | **string** | | [optional]
12-
**Custom2** | **string** | | [optional]
13-
**Custom3** | **string** | | [optional]
14-
**Custom4** | **string** | | [optional]
6+
**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]
9+
**Company** | **string** | The company of the contact | [optional]
10+
**Title** | **string** | The title of the contact | [optional]
11+
**Custom** | **string** | The first custom field | [optional]
12+
**Custom2** | **string** | The second custom field | [optional]
13+
**Custom3** | **string** | The third custom field | [optional]
14+
**Custom4** | **string** | The fourth custom field | [optional]
1515

1616
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1717

0 commit comments

Comments
 (0)