Skip to content

Commit 87983b8

Browse files
author
Erik Räni
authored
1.2.0 (#5)
1 parent 0940d40 commit 87983b8

File tree

83 files changed

+3076
-116
lines changed

Some content is hidden

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

83 files changed

+3076
-116
lines changed

‎README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Messente API Library
22

3-
- Messente API version: 1.1.0
4-
- C# package version: 1.1.0
3+
- Messente API version: 1.2.0
4+
- C# package version: 1.2.0
55

6-
[Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber, WhatsApp and Telegram 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.
6+
[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

88
## Installation
99

1010
Install Messente API library via NuGet Package Manager or .NET CLI.
1111

1212
### Package Manager
1313

14-
`Install-Package com.Messente.Api -Version 1.1.0`
14+
`Install-Package com.Messente.Api -Version 1.2.0`
1515

1616
### .NET CLI
1717

18-
`dotnet add package com.Messente.Api --version 1.1.0`
18+
`dotnet add package com.Messente.Api --version 1.2.0`
1919

2020
## Features
2121

@@ -56,11 +56,19 @@ Messente API Library provides the operations described below to access the featu
5656
1. Returns all groups [`FetchGroups`](docs/GroupsApi.md#fetchgroups)
5757
1. Updates a group with the provided name [`UpdateGroup`](docs/GroupsApi.md#updategroup)
5858

59+
### NumberLookupApi
60+
61+
1. Requests info about phone numbers [`FetchInfo`](docs/NumberLookupApi.md#fetchinfo)
62+
5963
### OmnimessageApi
6064

6165
1. Cancels a scheduled Omnimessage [`CancelScheduledMessage`](docs/OmnimessageApi.md#cancelscheduledmessage)
6266
1. Sends an Omnimessage [`SendOmnimessage`](docs/OmnimessageApi.md#sendomnimessage)
6367

68+
### StatisticsApi
69+
70+
1. Requests statistics reports for each country [`CreateStatisticsReport`](docs/StatisticsApi.md#createstatisticsreport)
71+
6472
## Auth
6573

6674
**Type**: HTTP basic authentication

‎docs/ErrorCodeStatistics.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# com.Messente.Api.Model.ErrorCodeStatistics
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+

‎docs/ErrorItemNumberLookup.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# com.Messente.Api.Model.ErrorItemNumberLookup
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Error** | [**ErrorItemNumberLookupError**](ErrorItemNumberLookupError.md) | |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+

‎docs/ErrorItemNumberLookupError.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# com.Messente.Api.Model.ErrorItemNumberLookupError
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Description** | **string** | Error description |
7+
**Code** | **int?** | Matches the following error title. This field is a constant * 101 - Unauthorized * 102 - Invalid arguments or parameters * 103 - Server error * 104 - Crediting error #1 * 105 - Crediting error #2 * 106 - Client error |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

‎docs/ErrorItemStatistics.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# com.Messente.Api.Model.ErrorItemStatistics
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Title** | **string** | Error title |
7+
**Details** | **string** | Error details |
8+
**Code** | **ErrorCodeStatistics** | |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

‎docs/ErrorNumberLookup.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# com.Messente.Api.Model.ErrorNumberLookup
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Errors** | [**List<ErrorItemNumberLookup>**](ErrorItemNumberLookup.md) | An array of errors |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+

‎docs/ErrorStatistics.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# com.Messente.Api.Model.ErrorStatistics
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Errors** | [**List<ErrorItemStatistics>**](ErrorItemStatistics.md) | An array of errors |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+

‎docs/MobileNetwork.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# com.Messente.Api.Model.MobileNetwork
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Mccmnc** | **string** | Mobile country and mobile network code | [optional]
7+
**NetworkName** | **string** | Mobile network name | [optional]
8+
**CountryName** | **string** | Country name | [optional]
9+
**CountryPrefix** | **string** | Country prefix | [optional]
10+
**CountryCode** | **string** | Country code | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+

‎docs/NumberLookupApi.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# com.Messente.Api.Api.NumberLookupApi
2+
3+
All URIs are relative to *https://api.messente.com/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**FetchInfo**](NumberLookupApi.md#fetchinfo) | **POST** /hlr/sync | Requests info about phone numbers
8+
9+
10+
<a name="fetchinfo"></a>
11+
# **FetchInfo**
12+
> SyncNumberLookupSuccess FetchInfo (NumbersToInvestigate numbersToInvestigate)
13+
14+
Requests info about phone numbers
15+
16+
### Example
17+
```csharp
18+
using System;
19+
using System.Diagnostics;
20+
using com.Messente.Api.Api;
21+
using com.Messente.Api.Client;
22+
using com.Messente.Api.Model;
23+
24+
namespace Example
25+
{
26+
public class FetchInfoExample
27+
{
28+
public static void Main()
29+
{
30+
// Configure HTTP basic authorization: basicAuth
31+
Configuration.Default.Username = "YOUR_USERNAME";
32+
Configuration.Default.Password = "YOUR_PASSWORD";
33+
34+
var apiInstance = new NumberLookupApi();
35+
var numbersToInvestigate = new NumbersToInvestigate(); // NumbersToInvestigate | Numbers for lookup
36+
37+
try
38+
{
39+
// Requests info about phone numbers
40+
SyncNumberLookupSuccess result = apiInstance.FetchInfo(numbersToInvestigate);
41+
Debug.WriteLine(result);
42+
}
43+
catch (Exception e)
44+
{
45+
Debug.Print("Exception when calling NumberLookupApi.FetchInfo: " + e.Message );
46+
}
47+
}
48+
}
49+
}
50+
```
51+
52+
### Parameters
53+
54+
Name | Type | Description | Notes
55+
------------- | ------------- | ------------- | -------------
56+
**numbersToInvestigate** | [**NumbersToInvestigate**](NumbersToInvestigate.md)| Numbers for lookup |
57+
58+
### Return type
59+
60+
[**SyncNumberLookupSuccess**](SyncNumberLookupSuccess.md)
61+
62+
### Authorization
63+
64+
[basicAuth](../README.md#basicAuth)
65+
66+
### HTTP request headers
67+
68+
- **Content-Type**: application/json
69+
- **Accept**: application/json
70+
71+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
72+

‎docs/NumbersToInvestigate.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# com.Messente.Api.Model.NumbersToInvestigate
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Numbers** | **List&lt;string&gt;** | Array of phone numbers |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+

‎docs/StatisticsApi.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# com.Messente.Api.Api.StatisticsApi
2+
3+
All URIs are relative to *https://api.messente.com/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**CreateStatisticsReport**](StatisticsApi.md#createstatisticsreport) | **POST** /statistics/reports | Requests statistics reports for each country
8+
9+
10+
<a name="createstatisticsreport"></a>
11+
# **CreateStatisticsReport**
12+
> StatisticsReportSuccess CreateStatisticsReport (StatisticsReportSettings statisticsReportSettings)
13+
14+
Requests statistics reports for each country
15+
16+
### Example
17+
```csharp
18+
using System;
19+
using System.Diagnostics;
20+
using com.Messente.Api.Api;
21+
using com.Messente.Api.Client;
22+
using com.Messente.Api.Model;
23+
24+
namespace Example
25+
{
26+
public class CreateStatisticsReportExample
27+
{
28+
public static void Main()
29+
{
30+
// Configure HTTP basic authorization: basicAuth
31+
Configuration.Default.Username = "YOUR_USERNAME";
32+
Configuration.Default.Password = "YOUR_PASSWORD";
33+
34+
var apiInstance = new StatisticsApi();
35+
var statisticsReportSettings = new StatisticsReportSettings(); // StatisticsReportSettings | Settings for statistics report
36+
37+
try
38+
{
39+
// Requests statistics reports for each country
40+
StatisticsReportSuccess result = apiInstance.CreateStatisticsReport(statisticsReportSettings);
41+
Debug.WriteLine(result);
42+
}
43+
catch (Exception e)
44+
{
45+
Debug.Print("Exception when calling StatisticsApi.CreateStatisticsReport: " + e.Message );
46+
}
47+
}
48+
}
49+
}
50+
```
51+
52+
### Parameters
53+
54+
Name | Type | Description | Notes
55+
------------- | ------------- | ------------- | -------------
56+
**statisticsReportSettings** | [**StatisticsReportSettings**](StatisticsReportSettings.md)| Settings for statistics report |
57+
58+
### Return type
59+
60+
[**StatisticsReportSuccess**](StatisticsReportSuccess.md)
61+
62+
### Authorization
63+
64+
[basicAuth](../README.md#basicAuth)
65+
66+
### HTTP request headers
67+
68+
- **Content-Type**: application/json
69+
- **Accept**: application/json
70+
71+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
72+

‎docs/StatisticsReport.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# com.Messente.Api.Model.StatisticsReport
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**TotalMessages** | **int?** | Sum of all messages |
7+
**TotalPrice** | **string** | Price for all messages |
8+
**Country** | **string** | Target country of all messages |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

‎docs/StatisticsReportSettings.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# com.Messente.Api.Model.StatisticsReportSettings
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**StartDate** | **DateTime?** | Start date for the report |
7+
**EndDate** | **DateTime?** | End date for the report |
8+
**MessageTypes** | **List&lt;string&gt;** | Optional list of message types (sms, viber, whatsapp, hlr) | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

‎docs/StatisticsReportSuccess.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# com.Messente.Api.Model.StatisticsReportSuccess
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Reports** | [**List&lt;StatisticsReport&gt;**](StatisticsReport.md) | Array of report objects |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+

‎docs/SyncNumberLookupResult.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# com.Messente.Api.Model.SyncNumberLookupResult
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Number** | **string** | Phone number in e.164 format |
7+
**Roaming** | **bool?** | Indicates if a number is roaming | [optional]
8+
**Ported** | **bool?** | Indicates if a number is ported | [optional]
9+
**RoamingNetwork** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
10+
**CurrentNetwork** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
11+
**OriginalNetwork** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
12+
**PortedNetwork** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
13+
**Status** | **string** | Status of the phone number | [optional]
14+
**Error** | **Object** | Indicates if any error occurred while handling the request | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+

‎docs/SyncNumberLookupSuccess.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# com.Messente.Api.Model.SyncNumberLookupSuccess
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**RequestId** | **string** | ID of the request |
7+
**Result** | [**List&lt;SyncNumberLookupResult&gt;**](SyncNumberLookupResult.md) | A container for phone number info objects |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

‎src/com.Messente.Api/Api/BlacklistApi.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/*
22
* Messente API
33
*
4-
* [Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber, WhatsApp and Telegram 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.
4+
* [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.
55
*
6-
* OpenAPI spec version: 1.1.0
6+
* OpenAPI spec version: 1.2.0
77
* Contact: [email protected]
88
* Generated by: https://github.com/openapitools/openapi-generator.git
99
*/

‎src/com.Messente.Api/Api/ContactsApi.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/*
22
* Messente API
33
*
4-
* [Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber, WhatsApp and Telegram 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.
4+
* [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.
55
*
6-
* OpenAPI spec version: 1.1.0
6+
* OpenAPI spec version: 1.2.0
77
* Contact: [email protected]
88
* Generated by: https://github.com/openapitools/openapi-generator.git
99
*/

‎src/com.Messente.Api/Api/DeliveryReportApi.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/*
22
* Messente API
33
*
4-
* [Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber, WhatsApp and Telegram 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.
4+
* [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.
55
*
6-
* OpenAPI spec version: 1.1.0
6+
* OpenAPI spec version: 1.2.0
77
* Contact: [email protected]
88
* Generated by: https://github.com/openapitools/openapi-generator.git
99
*/

‎src/com.Messente.Api/Api/GroupsApi.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/*
22
* Messente API
33
*
4-
* [Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber, WhatsApp and Telegram 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.
4+
* [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.
55
*
6-
* OpenAPI spec version: 1.1.0
6+
* OpenAPI spec version: 1.2.0
77
* Contact: [email protected]
88
* Generated by: https://github.com/openapitools/openapi-generator.git
99
*/

0 commit comments

Comments
 (0)