Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions .github/workflows/rubygems.yml

This file was deleted.

56 changes: 56 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
Gemfile
README.md
Rakefile
docs/AccountBalanceApi.md
docs/BlacklistApi.md
docs/BulkMessagingApi.md
docs/BulkOmniMessageCreateSuccessResponse.md
Expand Down Expand Up @@ -47,12 +48,16 @@ docs/MessageResult.md
docs/MobileNetwork.md
docs/NumberLookupApi.md
docs/NumberToBlacklist.md
docs/NumberVerificationApi.md
docs/NumbersToInvestigate.md
docs/OmniMessageCreateSuccessResponse.md
docs/Omnimessage.md
docs/OmnimessageApi.md
docs/OmnimessageMessagesInner.md
docs/Price.md
docs/PriceInfo.md
docs/PriceNetworksInner.md
docs/PricingApi.md
docs/Priority.md
docs/SMS.md
docs/StatisticsApi.md
Expand All @@ -67,24 +72,51 @@ docs/TextStore.md
docs/Viber.md
docs/ViberVideo.md
docs/WhatsApp.md
docs/WhatsAppAudio.md
docs/WhatsAppComponent.md
docs/WhatsAppCurrency.md
docs/WhatsAppDatetime.md
docs/WhatsAppDocument.md
docs/WhatsAppImage.md
docs/WhatsAppLanguage.md
docs/WhatsAppMedia.md
docs/WhatsAppParameter.md
docs/WhatsAppSticker.md
docs/WhatsAppTemplate.md
docs/WhatsAppTemplatesApi.md
docs/WhatsAppText.md
docs/WhatsAppVideo.md
docs/WhatsappButtonType.md
docs/WhatsappComponentType.md
docs/WhatsappCreateTemplateRequest.md
docs/WhatsappCreateTemplateResponse.md
docs/WhatsappHeaderFormat.md
docs/WhatsappListTemplatesResponse.md
docs/WhatsappOtpButtonType.md
docs/WhatsappPagination.md
docs/WhatsappPagingCursors.md
docs/WhatsappSupportedApp.md
docs/WhatsappTemplateButton.md
docs/WhatsappTemplateCategory.md
docs/WhatsappTemplateComponent.md
docs/WhatsappTemplateExample.md
docs/WhatsappTemplateResponse.md
docs/WhatsappTemplateStatus.md
docs/WhatsappUpdateTemplateRequest.md
git_push.sh
lib/messente_api.rb
lib/messente_api/api/account_balance_api.rb
lib/messente_api/api/blacklist_api.rb
lib/messente_api/api/bulk_messaging_api.rb
lib/messente_api/api/contacts_api.rb
lib/messente_api/api/delivery_report_api.rb
lib/messente_api/api/groups_api.rb
lib/messente_api/api/number_lookup_api.rb
lib/messente_api/api/number_verification_api.rb
lib/messente_api/api/omnimessage_api.rb
lib/messente_api/api/pricing_api.rb
lib/messente_api/api/statistics_api.rb
lib/messente_api/api/whats_app_templates_api.rb
lib/messente_api/api_client.rb
lib/messente_api/api_error.rb
lib/messente_api/configuration.rb
Expand Down Expand Up @@ -126,7 +158,9 @@ lib/messente_api/models/numbers_to_investigate.rb
lib/messente_api/models/omni_message_create_success_response.rb
lib/messente_api/models/omnimessage.rb
lib/messente_api/models/omnimessage_messages_inner.rb
lib/messente_api/models/price.rb
lib/messente_api/models/price_info.rb
lib/messente_api/models/price_networks_inner.rb
lib/messente_api/models/priority.rb
lib/messente_api/models/sms.rb
lib/messente_api/models/statistics_report.rb
Expand All @@ -140,14 +174,36 @@ lib/messente_api/models/text_store.rb
lib/messente_api/models/viber.rb
lib/messente_api/models/viber_video.rb
lib/messente_api/models/whats_app.rb
lib/messente_api/models/whats_app_audio.rb
lib/messente_api/models/whats_app_component.rb
lib/messente_api/models/whats_app_currency.rb
lib/messente_api/models/whats_app_datetime.rb
lib/messente_api/models/whats_app_document.rb
lib/messente_api/models/whats_app_image.rb
lib/messente_api/models/whats_app_language.rb
lib/messente_api/models/whats_app_media.rb
lib/messente_api/models/whats_app_parameter.rb
lib/messente_api/models/whats_app_sticker.rb
lib/messente_api/models/whats_app_template.rb
lib/messente_api/models/whats_app_text.rb
lib/messente_api/models/whats_app_video.rb
lib/messente_api/models/whatsapp_button_type.rb
lib/messente_api/models/whatsapp_component_type.rb
lib/messente_api/models/whatsapp_create_template_request.rb
lib/messente_api/models/whatsapp_create_template_response.rb
lib/messente_api/models/whatsapp_header_format.rb
lib/messente_api/models/whatsapp_list_templates_response.rb
lib/messente_api/models/whatsapp_otp_button_type.rb
lib/messente_api/models/whatsapp_pagination.rb
lib/messente_api/models/whatsapp_paging_cursors.rb
lib/messente_api/models/whatsapp_supported_app.rb
lib/messente_api/models/whatsapp_template_button.rb
lib/messente_api/models/whatsapp_template_category.rb
lib/messente_api/models/whatsapp_template_component.rb
lib/messente_api/models/whatsapp_template_example.rb
lib/messente_api/models/whatsapp_template_response.rb
lib/messente_api/models/whatsapp_template_status.rb
lib/messente_api/models/whatsapp_update_template_request.rb
lib/messente_api/version.rb
messente_api.gemspec
spec/spec_helper.rb
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.6.0
7.11.0
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ script:
- bundle install --path vendor/bundle
- bundle exec rspec
- gem build messente_api.gemspec
- gem install ./messente_api-2.3.0.gem
- gem install ./messente_api-2.4.0.gem
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Messente API Library

- Messente API version: 2.0.0
- Ruby gem version: 2.3.0
- Ruby gem version: 2.4.0

[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.

Expand All @@ -18,6 +18,11 @@ Messente API has the following features:

Messente API Library provides the operations described below to access the features.

### AccountBalanceApi

1. Get account balance [`get_account_balance`](docs/AccountBalanceApi.md#get_account_balance)
1. Get account balance [`get_account_balance_using_post`](docs/AccountBalanceApi.md#get_account_balance_using_post)

### BlacklistApi

1. Adds a phone number to the blacklist [`add_to_blacklist`](docs/BlacklistApi.md#add_to_blacklist)
Expand Down Expand Up @@ -56,15 +61,33 @@ Messente API Library provides the operations described below to access the featu

1. Requests info about phone numbers [`fetch_info`](docs/NumberLookupApi.md#fetch_info)

### NumberVerificationApi

1. verify number [`verify_number`](docs/NumberVerificationApi.md#verify_number)
1. verified the PIN code entered by the user. [`verify_pin`](docs/NumberVerificationApi.md#verify_pin)

### OmnimessageApi

1. Cancels a scheduled Omnimessage [`cancel_scheduled_message`](docs/OmnimessageApi.md#cancel_scheduled_message)
1. Sends an Omnimessage [`send_omnimessage`](docs/OmnimessageApi.md#send_omnimessage)

### PricingApi

1. Get pricelist for account [`get_pricelist`](docs/PricingApi.md#get_pricelist)
1. Get pricing for a specific country [`get_prices`](docs/PricingApi.md#get_prices)

### StatisticsApi

1. Requests statistics reports for each country [`create_statistics_report`](docs/StatisticsApi.md#create_statistics_report)

### WhatsAppTemplatesApi

1. Creates a WhatsApp template [`create_whatsapp_template`](docs/WhatsAppTemplatesApi.md#create_whatsapp_template)
1. Deletes a WhatsApp template [`delete_whatsapp_template`](docs/WhatsAppTemplatesApi.md#delete_whatsapp_template)
1. Requests a WhatsApp template with the given ID [`get_whatsapp_template_by_id`](docs/WhatsAppTemplatesApi.md#get_whatsapp_template_by_id)
1. Requests a list of WhatsApp templates [`list_whatsapp_templates`](docs/WhatsAppTemplatesApi.md#list_whatsapp_templates)
1. Updates a WhatsApp template [`update_whatsapp_template`](docs/WhatsAppTemplatesApi.md#update_whatsapp_template)

## Auth

**Type**: HTTP basic authentication
Expand Down
161 changes: 161 additions & 0 deletions docs/AccountBalanceApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
# MessenteApi::AccountBalanceApi

All URIs are relative to *https://api.messente.com/v1*

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**get_account_balance**](AccountBalanceApi.md#get_account_balance) | **GET** /get_balance | Get account balance |
| [**get_account_balance_using_post**](AccountBalanceApi.md#get_account_balance_using_post) | **POST** /get_balance | Get account balance |


## get_account_balance

> String get_account_balance(username, password)

Get account balance

### Examples

```ruby
require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
# Configure API key authorization: apiPassword
config.api_key['password'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['password'] = 'Bearer'

# Configure API key authorization: apiUsername
config.api_key['username'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['username'] = 'Bearer'
end

api_instance = MessenteApi::AccountBalanceApi.new
username = 'username_example' # String | The API username
password = 'password_example' # String | The API password

begin
# Get account balance
result = api_instance.get_account_balance(username, password)
p result
rescue MessenteApi::ApiError => e
puts "Error when calling AccountBalanceApi->get_account_balance: #{e}"
end
```

#### Using the get_account_balance_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(String, Integer, Hash)> get_account_balance_with_http_info(username, password)

```ruby
begin
# Get account balance
data, status_code, headers = api_instance.get_account_balance_with_http_info(username, password)
p status_code # => 2xx
p headers # => { ... }
p data # => String
rescue MessenteApi::ApiError => e
puts "Error when calling AccountBalanceApi->get_account_balance_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **username** | **String** | The API username | |
| **password** | **String** | The API password | |

### Return type

**String**

### Authorization

[apiPassword](../README.md#apiPassword), [apiUsername](../README.md#apiUsername)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain


## get_account_balance_using_post

> String get_account_balance_using_post(username, password)

Get account balance

### Examples

```ruby
require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
# Configure API key authorization: apiPassword
config.api_key['password'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['password'] = 'Bearer'

# Configure API key authorization: apiUsername
config.api_key['username'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['username'] = 'Bearer'
end

api_instance = MessenteApi::AccountBalanceApi.new
username = 'username_example' # String | The API username
password = 'password_example' # String | The API password

begin
# Get account balance
result = api_instance.get_account_balance_using_post(username, password)
p result
rescue MessenteApi::ApiError => e
puts "Error when calling AccountBalanceApi->get_account_balance_using_post: #{e}"
end
```

#### Using the get_account_balance_using_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(String, Integer, Hash)> get_account_balance_using_post_with_http_info(username, password)

```ruby
begin
# Get account balance
data, status_code, headers = api_instance.get_account_balance_using_post_with_http_info(username, password)
p status_code # => 2xx
p headers # => { ... }
p data # => String
rescue MessenteApi::ApiError => e
puts "Error when calling AccountBalanceApi->get_account_balance_using_post_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **username** | **String** | The API username | |
| **password** | **String** | The API password | |

### Return type

**String**

### Authorization

[apiPassword](../README.md#apiPassword), [apiUsername](../README.md#apiUsername)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

Loading