messente_api 1.4.0 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +33 -30
- data/docs/BlacklistApi.md +105 -37
- data/docs/BulkMessagingApi.md +76 -0
- data/docs/BulkOmniMessageCreateSuccessResponse.md +18 -0
- data/docs/BulkOmniMessageCreateSuccessResponseMessagesInner.md +49 -0
- data/docs/BulkOmnimessage.md +18 -0
- data/docs/Channel.md +4 -5
- data/docs/ContactEnvelope.md +8 -7
- data/docs/ContactFields.md +26 -25
- data/docs/ContactListEnvelope.md +8 -7
- data/docs/ContactResponseFields.md +28 -27
- data/docs/ContactUpdateFields.md +24 -23
- data/docs/ContactsApi.md +221 -86
- data/docs/DeliveryReportApi.md +29 -13
- data/docs/DeliveryReportResponse.md +12 -11
- data/docs/DeliveryResult.md +22 -17
- data/docs/ErrorCodeOmnichannel.md +4 -5
- data/docs/ErrorCodeOmnichannelMachine.md +4 -5
- data/docs/ErrorCodePhonebook.md +4 -5
- data/docs/ErrorCodeStatistics.md +4 -5
- data/docs/ErrorItemNumberLookup.md +8 -7
- data/docs/ErrorItemNumberLookupError.md +10 -9
- data/docs/ErrorItemOmnichannel.md +14 -13
- data/docs/ErrorItemPhonebook.md +12 -11
- data/docs/ErrorItemStatistics.md +12 -11
- data/docs/ErrorNumberLookup.md +8 -7
- data/docs/ErrorOmnichannel.md +8 -7
- data/docs/ErrorPhonebook.md +8 -7
- data/docs/ErrorStatistics.md +8 -7
- data/docs/ErrorTitleOmnichannel.md +4 -5
- data/docs/ErrorTitlePhonebook.md +4 -5
- data/docs/FetchBlacklistSuccess.md +8 -7
- data/docs/GroupEnvelope.md +8 -7
- data/docs/GroupListEnvelope.md +8 -7
- data/docs/GroupName.md +8 -7
- data/docs/GroupResponseFields.md +14 -13
- data/docs/GroupsApi.md +136 -51
- data/docs/MessageResult.md +12 -11
- data/docs/MobileNetwork.md +16 -15
- data/docs/NumberLookupApi.md +30 -14
- data/docs/NumberToBlacklist.md +8 -7
- data/docs/NumbersToInvestigate.md +8 -7
- data/docs/OmniMessageCreateSuccessResponse.md +12 -11
- data/docs/Omnimessage.md +18 -17
- data/docs/OmnimessageApi.md +56 -23
- data/docs/OmnimessageMessagesInner.md +53 -0
- data/docs/PriceInfo.md +22 -0
- data/docs/Priority.md +4 -5
- data/docs/SMS.md +20 -17
- data/docs/StatisticsApi.md +30 -14
- data/docs/StatisticsReport.md +12 -11
- data/docs/StatisticsReportSettings.md +12 -11
- data/docs/StatisticsReportSuccess.md +8 -7
- data/docs/Status.md +4 -5
- data/docs/SyncNumberLookupResult.md +24 -23
- data/docs/SyncNumberLookupSuccess.md +10 -9
- data/docs/Telegram.md +20 -19
- data/docs/TextStore.md +4 -5
- data/docs/Viber.md +22 -19
- data/docs/WhatsApp.md +16 -19
- data/docs/WhatsAppComponent.md +24 -0
- data/docs/WhatsAppCurrency.md +22 -0
- data/docs/WhatsAppDatetime.md +18 -0
- data/docs/WhatsAppLanguage.md +20 -0
- data/docs/WhatsAppMedia.md +24 -0
- data/docs/WhatsAppParameter.md +30 -0
- data/docs/WhatsAppTemplate.md +22 -0
- data/git_push.sh +3 -4
- data/lib/messente_api/api/blacklist_api.rb +22 -15
- data/lib/messente_api/api/bulk_messaging_api.rb +88 -0
- data/lib/messente_api/api/contacts_api.rb +42 -28
- data/lib/messente_api/api/delivery_report_api.rb +6 -5
- data/lib/messente_api/api/groups_api.rb +30 -19
- data/lib/messente_api/api/number_lookup_api.rb +10 -6
- data/lib/messente_api/api/omnimessage_api.rb +14 -9
- data/lib/messente_api/api/statistics_api.rb +10 -6
- data/lib/messente_api/api_client.rb +72 -66
- data/lib/messente_api/api_error.rb +3 -2
- data/lib/messente_api/configuration.rb +64 -14
- data/lib/messente_api/models/{whats_app_audio.rb → bulk_omni_message_create_success_response.rb} +50 -38
- data/lib/messente_api/models/bulk_omni_message_create_success_response_messages_inner.rb +105 -0
- data/lib/messente_api/models/{whats_app_text.rb → bulk_omnimessage.rb} +49 -49
- data/lib/messente_api/models/channel.rb +9 -5
- data/lib/messente_api/models/contact_envelope.rb +31 -23
- data/lib/messente_api/models/contact_fields.rb +33 -23
- data/lib/messente_api/models/contact_list_envelope.rb +41 -23
- data/lib/messente_api/models/contact_response_fields.rb +31 -23
- data/lib/messente_api/models/contact_update_fields.rb +31 -23
- data/lib/messente_api/models/delivery_report_response.rb +37 -23
- data/lib/messente_api/models/delivery_result.rb +77 -27
- data/lib/messente_api/models/error_code_omnichannel.rb +9 -5
- data/lib/messente_api/models/error_code_omnichannel_machine.rb +9 -5
- data/lib/messente_api/models/error_code_phonebook.rb +9 -5
- data/lib/messente_api/models/error_code_statistics.rb +9 -5
- data/lib/messente_api/models/error_item_number_lookup.rb +33 -23
- data/lib/messente_api/models/error_item_number_lookup_error.rb +35 -23
- data/lib/messente_api/models/error_item_omnichannel.rb +61 -23
- data/lib/messente_api/models/error_item_phonebook.rb +59 -23
- data/lib/messente_api/models/error_item_statistics.rb +59 -23
- data/lib/messente_api/models/error_number_lookup.rb +33 -23
- data/lib/messente_api/models/error_omnichannel.rb +33 -23
- data/lib/messente_api/models/error_phonebook.rb +33 -23
- data/lib/messente_api/models/error_statistics.rb +33 -23
- data/lib/messente_api/models/error_title_omnichannel.rb +9 -5
- data/lib/messente_api/models/error_title_phonebook.rb +9 -5
- data/lib/messente_api/models/fetch_blacklist_success.rb +41 -23
- data/lib/messente_api/models/group_envelope.rb +31 -23
- data/lib/messente_api/models/group_list_envelope.rb +41 -23
- data/lib/messente_api/models/group_name.rb +33 -23
- data/lib/messente_api/models/group_response_fields.rb +37 -23
- data/lib/messente_api/models/message_result.rb +59 -23
- data/lib/messente_api/models/mobile_network.rb +31 -23
- data/lib/messente_api/models/number_to_blacklist.rb +33 -23
- data/lib/messente_api/models/numbers_to_investigate.rb +62 -24
- data/lib/messente_api/models/omni_message_create_success_response.rb +37 -23
- data/lib/messente_api/models/omnimessage.rb +59 -25
- data/lib/messente_api/models/omnimessage_messages_inner.rb +107 -0
- data/lib/messente_api/models/price_info.rb +257 -0
- data/lib/messente_api/models/priority.rb +9 -5
- data/lib/messente_api/models/sms.rb +45 -25
- data/lib/messente_api/models/statistics_report.rb +37 -23
- data/lib/messente_api/models/statistics_report_settings.rb +35 -23
- data/lib/messente_api/models/statistics_report_success.rb +33 -23
- data/lib/messente_api/models/status.rb +9 -5
- data/lib/messente_api/models/sync_number_lookup_result.rb +35 -24
- data/lib/messente_api/models/sync_number_lookup_success.rb +35 -23
- data/lib/messente_api/models/telegram.rb +31 -23
- data/lib/messente_api/models/text_store.rb +9 -5
- data/lib/messente_api/models/viber.rb +43 -25
- data/lib/messente_api/models/whats_app.rb +45 -54
- data/lib/messente_api/models/whats_app_component.rb +255 -0
- data/lib/messente_api/models/whats_app_currency.rb +257 -0
- data/lib/messente_api/models/{whats_app_document.rb → whats_app_datetime.rb} +48 -48
- data/lib/messente_api/models/{whats_app_image.rb → whats_app_language.rb} +55 -45
- data/lib/messente_api/models/whats_app_media.rb +246 -0
- data/lib/messente_api/models/whats_app_parameter.rb +278 -0
- data/lib/messente_api/models/whats_app_template.rb +251 -0
- data/lib/messente_api/version.rb +3 -3
- data/lib/messente_api.rb +15 -6
- data/messente_api.gemspec +5 -5
- data/spec/spec_helper.rb +2 -2
- metadata +33 -39
- data/docs/WhatsAppAudio.md +0 -17
- data/docs/WhatsAppDocument.md +0 -19
- data/docs/WhatsAppImage.md +0 -19
- data/docs/WhatsAppText.md +0 -19
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
data/docs/OmnimessageApi.md
CHANGED
@@ -2,11 +2,10 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.messente.com/v1*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**cancel_scheduled_message**](OmnimessageApi.md#cancel_scheduled_message) | **DELETE** /omnimessage/{omnimessageId} | Cancels a scheduled Omnimessage
|
8
|
-
[**send_omnimessage**](OmnimessageApi.md#send_omnimessage) | **POST** /omnimessage | Sends an Omnimessage
|
9
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**cancel_scheduled_message**](OmnimessageApi.md#cancel_scheduled_message) | **DELETE** /omnimessage/{omnimessageId} | Cancels a scheduled Omnimessage |
|
8
|
+
| [**send_omnimessage**](OmnimessageApi.md#send_omnimessage) | **POST** /omnimessage | Sends an Omnimessage |
|
10
9
|
|
11
10
|
|
12
11
|
## cancel_scheduled_message
|
@@ -15,10 +14,10 @@ Method | HTTP request | Description
|
|
15
14
|
|
16
15
|
Cancels a scheduled Omnimessage
|
17
16
|
|
18
|
-
###
|
17
|
+
### Examples
|
19
18
|
|
20
19
|
```ruby
|
21
|
-
|
20
|
+
require 'time'
|
22
21
|
require 'messente_api'
|
23
22
|
# setup authorization
|
24
23
|
MessenteApi.configure do |config|
|
@@ -31,20 +30,37 @@ api_instance = MessenteApi::OmnimessageApi.new
|
|
31
30
|
omnimessage_id = 'omnimessage_id_example' # String | UUID of the scheduled omnimessage to be cancelled
|
32
31
|
|
33
32
|
begin
|
34
|
-
#Cancels a scheduled Omnimessage
|
33
|
+
# Cancels a scheduled Omnimessage
|
35
34
|
result = api_instance.cancel_scheduled_message(omnimessage_id)
|
36
35
|
p result
|
37
36
|
rescue MessenteApi::ApiError => e
|
38
|
-
puts "
|
37
|
+
puts "Error when calling OmnimessageApi->cancel_scheduled_message: #{e}"
|
39
38
|
end
|
40
39
|
```
|
41
40
|
|
42
|
-
|
41
|
+
#### Using the cancel_scheduled_message_with_http_info variant
|
42
|
+
|
43
|
+
This returns an Array which contains the response data, status code and headers.
|
43
44
|
|
45
|
+
> <Array(Object, Integer, Hash)> cancel_scheduled_message_with_http_info(omnimessage_id)
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
begin
|
49
|
+
# Cancels a scheduled Omnimessage
|
50
|
+
data, status_code, headers = api_instance.cancel_scheduled_message_with_http_info(omnimessage_id)
|
51
|
+
p status_code # => 2xx
|
52
|
+
p headers # => { ... }
|
53
|
+
p data # => Object
|
54
|
+
rescue MessenteApi::ApiError => e
|
55
|
+
puts "Error when calling OmnimessageApi->cancel_scheduled_message_with_http_info: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
### Parameters
|
44
60
|
|
45
|
-
Name | Type | Description
|
46
|
-
|
47
|
-
**omnimessage_id** | **String
|
61
|
+
| Name | Type | Description | Notes |
|
62
|
+
| ---- | ---- | ----------- | ----- |
|
63
|
+
| **omnimessage_id** | **String** | UUID of the scheduled omnimessage to be cancelled | |
|
48
64
|
|
49
65
|
### Return type
|
50
66
|
|
@@ -62,14 +78,14 @@ Name | Type | Description | Notes
|
|
62
78
|
|
63
79
|
## send_omnimessage
|
64
80
|
|
65
|
-
> OmniMessageCreateSuccessResponse send_omnimessage(omnimessage)
|
81
|
+
> <OmniMessageCreateSuccessResponse> send_omnimessage(omnimessage)
|
66
82
|
|
67
83
|
Sends an Omnimessage
|
68
84
|
|
69
|
-
###
|
85
|
+
### Examples
|
70
86
|
|
71
87
|
```ruby
|
72
|
-
|
88
|
+
require 'time'
|
73
89
|
require 'messente_api'
|
74
90
|
# setup authorization
|
75
91
|
MessenteApi.configure do |config|
|
@@ -79,23 +95,40 @@ MessenteApi.configure do |config|
|
|
79
95
|
end
|
80
96
|
|
81
97
|
api_instance = MessenteApi::OmnimessageApi.new
|
82
|
-
omnimessage = MessenteApi::Omnimessage.new # Omnimessage | Omnimessage to be sent
|
98
|
+
omnimessage = MessenteApi::Omnimessage.new({to: 'to_example', messages: [MessenteApi::SMS.new({text: 'Hello world!'})]}) # Omnimessage | Omnimessage to be sent
|
83
99
|
|
84
100
|
begin
|
85
|
-
#Sends an Omnimessage
|
101
|
+
# Sends an Omnimessage
|
86
102
|
result = api_instance.send_omnimessage(omnimessage)
|
87
103
|
p result
|
88
104
|
rescue MessenteApi::ApiError => e
|
89
|
-
puts "
|
105
|
+
puts "Error when calling OmnimessageApi->send_omnimessage: #{e}"
|
90
106
|
end
|
91
107
|
```
|
92
108
|
|
93
|
-
|
109
|
+
#### Using the send_omnimessage_with_http_info variant
|
110
|
+
|
111
|
+
This returns an Array which contains the response data, status code and headers.
|
112
|
+
|
113
|
+
> <Array(<OmniMessageCreateSuccessResponse>, Integer, Hash)> send_omnimessage_with_http_info(omnimessage)
|
114
|
+
|
115
|
+
```ruby
|
116
|
+
begin
|
117
|
+
# Sends an Omnimessage
|
118
|
+
data, status_code, headers = api_instance.send_omnimessage_with_http_info(omnimessage)
|
119
|
+
p status_code # => 2xx
|
120
|
+
p headers # => { ... }
|
121
|
+
p data # => <OmniMessageCreateSuccessResponse>
|
122
|
+
rescue MessenteApi::ApiError => e
|
123
|
+
puts "Error when calling OmnimessageApi->send_omnimessage_with_http_info: #{e}"
|
124
|
+
end
|
125
|
+
```
|
94
126
|
|
127
|
+
### Parameters
|
95
128
|
|
96
|
-
Name | Type | Description
|
97
|
-
|
98
|
-
**omnimessage** | [**Omnimessage**](Omnimessage.md)| Omnimessage to be sent |
|
129
|
+
| Name | Type | Description | Notes |
|
130
|
+
| ---- | ---- | ----------- | ----- |
|
131
|
+
| **omnimessage** | [**Omnimessage**](Omnimessage.md) | Omnimessage to be sent | |
|
99
132
|
|
100
133
|
### Return type
|
101
134
|
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# MessenteApi::OmnimessageMessagesInner
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'messente_api'
|
13
|
+
|
14
|
+
MessenteApi::OmnimessageMessagesInner.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'SMS',
|
18
|
+
# :'Telegram',
|
19
|
+
# :'Viber',
|
20
|
+
# :'WhatsApp'
|
21
|
+
# ]
|
22
|
+
```
|
23
|
+
|
24
|
+
### build
|
25
|
+
|
26
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
27
|
+
|
28
|
+
#### Example
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
require 'messente_api'
|
32
|
+
|
33
|
+
MessenteApi::OmnimessageMessagesInner.build(data)
|
34
|
+
# => #<SMS:0x00007fdd4aab02a0>
|
35
|
+
|
36
|
+
MessenteApi::OmnimessageMessagesInner.build(data_that_doesnt_match)
|
37
|
+
# => nil
|
38
|
+
```
|
39
|
+
|
40
|
+
#### Parameters
|
41
|
+
|
42
|
+
| Name | Type | Description |
|
43
|
+
| ---- | ---- | ----------- |
|
44
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
45
|
+
|
46
|
+
#### Return type
|
47
|
+
|
48
|
+
- `SMS`
|
49
|
+
- `Telegram`
|
50
|
+
- `Viber`
|
51
|
+
- `WhatsApp`
|
52
|
+
- `nil` (if no type matches)
|
53
|
+
|
data/docs/PriceInfo.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# MessenteApi::PriceInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **part_price** | **String** | price per message part - relevant mostly for SMS | |
|
8
|
+
| **parts_count** | **Integer** | the number of parts the message consists of | |
|
9
|
+
| **total_price** | **String** | total price for the message | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'messente_api'
|
15
|
+
|
16
|
+
instance = MessenteApi::PriceInfo.new(
|
17
|
+
part_price: null,
|
18
|
+
parts_count: null,
|
19
|
+
total_price: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Priority.md
CHANGED
@@ -2,15 +2,14 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
7
|
|
8
|
-
##
|
8
|
+
## Example
|
9
9
|
|
10
10
|
```ruby
|
11
|
-
require '
|
11
|
+
require 'messente_api'
|
12
12
|
|
13
13
|
instance = MessenteApi::Priority.new()
|
14
14
|
```
|
15
15
|
|
16
|
-
|
data/docs/SMS.md
CHANGED
@@ -2,26 +2,29 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**text** | **String** | Text content of the SMS |
|
8
|
-
**sender** | **String** | Phone number or alphanumeric sender name | [optional]
|
9
|
-
**validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted | [optional]
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **text** | **String** | Text content of the SMS | |
|
8
|
+
| **sender** | **String** | Phone number or alphanumeric sender name | [optional] |
|
9
|
+
| **validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted. Only one of \"ttl\" and \"validity\" can be used. | [optional] |
|
10
|
+
| **ttl** | **Integer** | After how many seconds this channel is considered as failed and the next channel is attempted. Only one of \"ttl\" and \"validity\" can be used. | [optional] |
|
11
|
+
| **autoconvert** | **String** | Defines how non-GSM characters will be treated: - \"on\" Use replacement settings from the account's [API Auto Replace settings page](https://dashboard.messente.com/api-settings/auto-replace) (default) - \"full\" All non GSM 03.38 characters will be replaced with suitable alternatives - \"off\" Message content is not modified in any way | [optional] |
|
12
|
+
| **udh** | **String** | hex-encoded string containing SMS UDH | [optional] |
|
13
|
+
| **channel** | **String** | The channel used to deliver the message | [optional][default to 'sms'] |
|
13
14
|
|
14
|
-
##
|
15
|
+
## Example
|
15
16
|
|
16
17
|
```ruby
|
17
|
-
require '
|
18
|
+
require 'messente_api'
|
18
19
|
|
19
|
-
instance = MessenteApi::SMS.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
20
|
+
instance = MessenteApi::SMS.new(
|
21
|
+
text: Hello world!,
|
22
|
+
sender: null,
|
23
|
+
validity: 360,
|
24
|
+
ttl: 21600,
|
25
|
+
autoconvert: null,
|
26
|
+
udh: null,
|
27
|
+
channel: null
|
28
|
+
)
|
25
29
|
```
|
26
30
|
|
27
|
-
|
data/docs/StatisticsApi.md
CHANGED
@@ -2,22 +2,21 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.messente.com/v1*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**create_statistics_report**](StatisticsApi.md#create_statistics_report) | **POST** /statistics/reports | Requests statistics reports for each country
|
8
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_statistics_report**](StatisticsApi.md#create_statistics_report) | **POST** /statistics/reports | Requests statistics reports for each country |
|
9
8
|
|
10
9
|
|
11
10
|
## create_statistics_report
|
12
11
|
|
13
|
-
> StatisticsReportSuccess create_statistics_report(statistics_report_settings)
|
12
|
+
> <StatisticsReportSuccess> create_statistics_report(statistics_report_settings)
|
14
13
|
|
15
14
|
Requests statistics reports for each country
|
16
15
|
|
17
|
-
###
|
16
|
+
### Examples
|
18
17
|
|
19
18
|
```ruby
|
20
|
-
|
19
|
+
require 'time'
|
21
20
|
require 'messente_api'
|
22
21
|
# setup authorization
|
23
22
|
MessenteApi.configure do |config|
|
@@ -27,23 +26,40 @@ MessenteApi.configure do |config|
|
|
27
26
|
end
|
28
27
|
|
29
28
|
api_instance = MessenteApi::StatisticsApi.new
|
30
|
-
statistics_report_settings = {
|
29
|
+
statistics_report_settings = MessenteApi::StatisticsReportSettings.new({start_date: Date.today, end_date: Date.today}) # StatisticsReportSettings | Settings for statistics report
|
31
30
|
|
32
31
|
begin
|
33
|
-
#Requests statistics reports for each country
|
32
|
+
# Requests statistics reports for each country
|
34
33
|
result = api_instance.create_statistics_report(statistics_report_settings)
|
35
34
|
p result
|
36
35
|
rescue MessenteApi::ApiError => e
|
37
|
-
puts "
|
36
|
+
puts "Error when calling StatisticsApi->create_statistics_report: #{e}"
|
38
37
|
end
|
39
38
|
```
|
40
39
|
|
41
|
-
|
40
|
+
#### Using the create_statistics_report_with_http_info variant
|
41
|
+
|
42
|
+
This returns an Array which contains the response data, status code and headers.
|
42
43
|
|
44
|
+
> <Array(<StatisticsReportSuccess>, Integer, Hash)> create_statistics_report_with_http_info(statistics_report_settings)
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
begin
|
48
|
+
# Requests statistics reports for each country
|
49
|
+
data, status_code, headers = api_instance.create_statistics_report_with_http_info(statistics_report_settings)
|
50
|
+
p status_code # => 2xx
|
51
|
+
p headers # => { ... }
|
52
|
+
p data # => <StatisticsReportSuccess>
|
53
|
+
rescue MessenteApi::ApiError => e
|
54
|
+
puts "Error when calling StatisticsApi->create_statistics_report_with_http_info: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
### Parameters
|
43
59
|
|
44
|
-
Name | Type | Description
|
45
|
-
|
46
|
-
**statistics_report_settings** | [**StatisticsReportSettings**](StatisticsReportSettings.md)| Settings for statistics report |
|
60
|
+
| Name | Type | Description | Notes |
|
61
|
+
| ---- | ---- | ----------- | ----- |
|
62
|
+
| **statistics_report_settings** | [**StatisticsReportSettings**](StatisticsReportSettings.md) | Settings for statistics report | |
|
47
63
|
|
48
64
|
### Return type
|
49
65
|
|
data/docs/StatisticsReport.md
CHANGED
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**total_messages** | **Integer** | Sum of all messages |
|
8
|
-
**total_price** | **String** | Price for all messages |
|
9
|
-
**country** | **String** | Target country of all messages |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **total_messages** | **Integer** | Sum of all messages | |
|
8
|
+
| **total_price** | **String** | Price for all messages | |
|
9
|
+
| **country** | **String** | Target country of all messages | |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
|
-
require '
|
14
|
+
require 'messente_api'
|
15
15
|
|
16
|
-
instance = MessenteApi::StatisticsReport.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = MessenteApi::StatisticsReport.new(
|
17
|
+
total_messages: null,
|
18
|
+
total_price: null,
|
19
|
+
country: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**start_date** | **Date** | Start date for the report |
|
8
|
-
**end_date** | **Date** | End date for the report |
|
9
|
-
**message_types** | **Array<String>** | Optional list of message types (sms, viber, whatsapp, hlr, telegram) | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **start_date** | **Date** | Start date for the report | |
|
8
|
+
| **end_date** | **Date** | End date for the report | |
|
9
|
+
| **message_types** | **Array<String>** | Optional list of message types (sms, viber, whatsapp, hlr, telegram) | [optional] |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
|
-
require '
|
14
|
+
require 'messente_api'
|
15
15
|
|
16
|
-
instance = MessenteApi::StatisticsReportSettings.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = MessenteApi::StatisticsReportSettings.new(
|
17
|
+
start_date: null,
|
18
|
+
end_date: null,
|
19
|
+
message_types: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**reports** | [**Array<StatisticsReport>**](StatisticsReport.md) | Array of report objects |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **reports** | [**Array<StatisticsReport>**](StatisticsReport.md) | Array of report objects | |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'messente_api'
|
13
13
|
|
14
|
-
instance = MessenteApi::StatisticsReportSuccess.new(
|
14
|
+
instance = MessenteApi::StatisticsReportSuccess.new(
|
15
|
+
reports: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
data/docs/Status.md
CHANGED
@@ -2,15 +2,14 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
7
|
|
8
|
-
##
|
8
|
+
## Example
|
9
9
|
|
10
10
|
```ruby
|
11
|
-
require '
|
11
|
+
require 'messente_api'
|
12
12
|
|
13
13
|
instance = MessenteApi::Status.new()
|
14
14
|
```
|
15
15
|
|
16
|
-
|
@@ -2,32 +2,33 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**number** | **String** | Phone number in e.164 format |
|
8
|
-
**roaming** | **Boolean** | Indicates if a number is roaming | [optional]
|
9
|
-
**ported** | **Boolean** | Indicates if a number is ported | [optional]
|
10
|
-
**roaming_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
|
11
|
-
**current_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
|
12
|
-
**original_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
|
13
|
-
**ported_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
|
14
|
-
**status** | **String** | Status of the phone number | [optional]
|
15
|
-
**error** |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **number** | **String** | Phone number in e.164 format | |
|
8
|
+
| **roaming** | **Boolean** | Indicates if a number is roaming | [optional] |
|
9
|
+
| **ported** | **Boolean** | Indicates if a number is ported | [optional] |
|
10
|
+
| **roaming_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional] |
|
11
|
+
| **current_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional] |
|
12
|
+
| **original_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional] |
|
13
|
+
| **ported_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional] |
|
14
|
+
| **status** | **String** | Status of the phone number | [optional] |
|
15
|
+
| **error** | **Object** | Indicates if any error occurred while handling the request | [optional] |
|
16
16
|
|
17
|
-
##
|
17
|
+
## Example
|
18
18
|
|
19
19
|
```ruby
|
20
|
-
require '
|
20
|
+
require 'messente_api'
|
21
21
|
|
22
|
-
instance = MessenteApi::SyncNumberLookupResult.new(
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
22
|
+
instance = MessenteApi::SyncNumberLookupResult.new(
|
23
|
+
number: null,
|
24
|
+
roaming: null,
|
25
|
+
ported: null,
|
26
|
+
roaming_network: null,
|
27
|
+
current_network: null,
|
28
|
+
original_network: null,
|
29
|
+
ported_network: null,
|
30
|
+
status: null,
|
31
|
+
error: null
|
32
|
+
)
|
31
33
|
```
|
32
34
|
|
33
|
-
|
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**request_id** | **String** | ID of the request |
|
8
|
-
**result** | [**Array<SyncNumberLookupResult>**](SyncNumberLookupResult.md) | A container for phone number info objects |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **request_id** | **String** | ID of the request | |
|
8
|
+
| **result** | [**Array<SyncNumberLookupResult>**](SyncNumberLookupResult.md) | A container for phone number info objects | |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
|
-
require '
|
13
|
+
require 'messente_api'
|
14
14
|
|
15
|
-
instance = MessenteApi::SyncNumberLookupSuccess.new(
|
16
|
-
|
15
|
+
instance = MessenteApi::SyncNumberLookupSuccess.new(
|
16
|
+
request_id: null,
|
17
|
+
result: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
data/docs/Telegram.md
CHANGED
@@ -2,28 +2,29 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**sender** | **String** | Phone number or alphanumeric sender name | [optional]
|
8
|
-
**validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted | [optional]
|
9
|
-
**text** | **String** | Plaintext content for Telegram | [optional]
|
10
|
-
**image_url** | **String** | URL for the embedded image. Mutually exclusive with \"document_url\" and \"audio_url\" | [optional]
|
11
|
-
**document_url** | **String** | URL for the embedded image. Mutually exclusive with \"audio_url\" and \"image_url\" | [optional]
|
12
|
-
**audio_url** | **String** | URL for the embedded image. Mutually exclusive with \"document_url\" and \"image_url\" | [optional]
|
13
|
-
**channel** | **String** | The channel used to deliver the message | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sender** | **String** | Phone number or alphanumeric sender name | [optional] |
|
8
|
+
| **validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted | [optional] |
|
9
|
+
| **text** | **String** | Plaintext content for Telegram | [optional] |
|
10
|
+
| **image_url** | **String** | URL for the embedded image. Mutually exclusive with \"document_url\" and \"audio_url\" | [optional] |
|
11
|
+
| **document_url** | **String** | URL for the embedded image. Mutually exclusive with \"audio_url\" and \"image_url\" | [optional] |
|
12
|
+
| **audio_url** | **String** | URL for the embedded image. Mutually exclusive with \"document_url\" and \"image_url\" | [optional] |
|
13
|
+
| **channel** | **String** | The channel used to deliver the message | [optional][default to 'telegram'] |
|
14
14
|
|
15
|
-
##
|
15
|
+
## Example
|
16
16
|
|
17
17
|
```ruby
|
18
|
-
require '
|
18
|
+
require 'messente_api'
|
19
19
|
|
20
|
-
instance = MessenteApi::Telegram.new(
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
20
|
+
instance = MessenteApi::Telegram.new(
|
21
|
+
sender: null,
|
22
|
+
validity: 360,
|
23
|
+
text: null,
|
24
|
+
image_url: null,
|
25
|
+
document_url: null,
|
26
|
+
audio_url: null,
|
27
|
+
channel: null
|
28
|
+
)
|
27
29
|
```
|
28
30
|
|
29
|
-
|
data/docs/TextStore.md
CHANGED
@@ -2,15 +2,14 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
7
|
|
8
|
-
##
|
8
|
+
## Example
|
9
9
|
|
10
10
|
```ruby
|
11
|
-
require '
|
11
|
+
require 'messente_api'
|
12
12
|
|
13
13
|
instance = MessenteApi::TextStore.new()
|
14
14
|
```
|
15
15
|
|
16
|
-
|