Skip to content

Commit fdd4a07

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

114 files changed

Lines changed: 399 additions & 346 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.

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ script:
88
- bundle install --path vendor/bundle
99
- bundle exec rspec
1010
- gem build messente_api.gemspec
11-
- gem install ./messente_api-1.0.1.gem
11+
- gem install ./messente_api-1.0.2.gem

Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
messente_api (1.0.1)
4+
messente_api (1.0.2)
55
json (~> 2.1, >= 2.1.0)
66
typhoeus (~> 1.0, >= 1.0.1)
77

README.md

Lines changed: 22 additions & 22 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-
- Ruby gem version: 1.0.1
3+
- Messente API version: 1.0.2
4+
- Ruby gem 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

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

2121
### BlacklistApi
2222

23-
1. Adds a phone number to the blacklist. [`add_to_blacklist`](docs/BlacklistApi.md#add_to_blacklist)
24-
1. Deletes a phone number from the blacklist. [`delete_from_blacklist`](docs/BlacklistApi.md#delete_from_blacklist)
25-
1. Returns all blacklisted phone numbers. [`fetch_blacklist`](docs/BlacklistApi.md#fetch_blacklist)
26-
1. Checks if a phone number is blacklisted. [`is_blacklisted`](docs/BlacklistApi.md#is_blacklisted)
23+
1. Adds a phone number to the blacklist [`add_to_blacklist`](docs/BlacklistApi.md#add_to_blacklist)
24+
1. Deletes a phone number from the blacklist [`delete_from_blacklist`](docs/BlacklistApi.md#delete_from_blacklist)
25+
1. Returns all blacklisted phone numbers [`fetch_blacklist`](docs/BlacklistApi.md#fetch_blacklist)
26+
1. Checks if a phone number is blacklisted [`is_blacklisted`](docs/BlacklistApi.md#is_blacklisted)
2727

2828
### ContactsApi
2929

30-
1. Adds a contact to a group. [`add_contact_to_group`](docs/ContactsApi.md#add_contact_to_group)
31-
1. Creates a new contact. [`create_contact`](docs/ContactsApi.md#create_contact)
32-
1. Deletes a contact. [`delete_contact`](docs/ContactsApi.md#delete_contact)
33-
1. Lists a contact. [`fetch_contact`](docs/ContactsApi.md#fetch_contact)
34-
1. Lists groups of a contact. [`fetch_contact_groups`](docs/ContactsApi.md#fetch_contact_groups)
35-
1. Returns all contacts. [`fetch_contacts`](docs/ContactsApi.md#fetch_contacts)
36-
1. Removes a contact from a group. [`remove_contact_from_group`](docs/ContactsApi.md#remove_contact_from_group)
37-
1. Updates a contact. [`update_contact`](docs/ContactsApi.md#update_contact)
30+
1. Adds a contact to a group [`add_contact_to_group`](docs/ContactsApi.md#add_contact_to_group)
31+
1. Creates a new contact [`create_contact`](docs/ContactsApi.md#create_contact)
32+
1. Deletes a contact [`delete_contact`](docs/ContactsApi.md#delete_contact)
33+
1. Lists a contact [`fetch_contact`](docs/ContactsApi.md#fetch_contact)
34+
1. Lists groups of a contact [`fetch_contact_groups`](docs/ContactsApi.md#fetch_contact_groups)
35+
1. Returns all contacts [`fetch_contacts`](docs/ContactsApi.md#fetch_contacts)
36+
1. Removes a contact from a group [`remove_contact_from_group`](docs/ContactsApi.md#remove_contact_from_group)
37+
1. Updates a contact [`update_contact`](docs/ContactsApi.md#update_contact)
3838

3939
### DeliveryReportApi
4040

41-
1. Retrieves the delivery report for the Omnimessage. [`retrieve_delivery_report`](docs/DeliveryReportApi.md#retrieve_delivery_report)
41+
1. Retrieves the delivery report for the Omnimessage [`retrieve_delivery_report`](docs/DeliveryReportApi.md#retrieve_delivery_report)
4242

4343
### GroupsApi
4444

45-
1. Creates a new group with the provided name. [`create_group`](docs/GroupsApi.md#create_group)
46-
1. Deletes a group. [`delete_group`](docs/GroupsApi.md#delete_group)
47-
1. Lists a group. [`fetch_group`](docs/GroupsApi.md#fetch_group)
48-
1. Returns all groups. [`fetch_groups`](docs/GroupsApi.md#fetch_groups)
49-
1. Updates a group with the provided name. [`update_group`](docs/GroupsApi.md#update_group)
45+
1. Creates a new group with the provided name [`create_group`](docs/GroupsApi.md#create_group)
46+
1. Deletes a group [`delete_group`](docs/GroupsApi.md#delete_group)
47+
1. Lists a group [`fetch_group`](docs/GroupsApi.md#fetch_group)
48+
1. Returns all groups [`fetch_groups`](docs/GroupsApi.md#fetch_groups)
49+
1. Updates a group with the provided name [`update_group`](docs/GroupsApi.md#update_group)
5050

5151
### OmnimessageApi
5252

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

5656
## Auth
5757

docs/BlacklistApi.md

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

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**add_to_blacklist**](BlacklistApi.md#add_to_blacklist) | **POST** /phonebook/blacklist | Adds a phone number to the blacklist.
8-
[**delete_from_blacklist**](BlacklistApi.md#delete_from_blacklist) | **DELETE** /blacklist/{phone} | Deletes a phone number from the blacklist.
9-
[**fetch_blacklist**](BlacklistApi.md#fetch_blacklist) | **GET** /phonebook/blacklist | Returns all blacklisted phone numbers.
10-
[**is_blacklisted**](BlacklistApi.md#is_blacklisted) | **GET** /blacklist/{phone} | Checks if a phone number is blacklisted.
7+
[**add_to_blacklist**](BlacklistApi.md#add_to_blacklist) | **POST** /phonebook/blacklist | Adds a phone number to the blacklist
8+
[**delete_from_blacklist**](BlacklistApi.md#delete_from_blacklist) | **DELETE** /phonebook/blacklist/{phone} | Deletes a phone number from the blacklist
9+
[**fetch_blacklist**](BlacklistApi.md#fetch_blacklist) | **GET** /phonebook/blacklist | Returns all blacklisted phone numbers
10+
[**is_blacklisted**](BlacklistApi.md#is_blacklisted) | **GET** /phonebook/blacklist/{phone} | Checks if a phone number is blacklisted
1111

1212

1313

1414
## add_to_blacklist
1515

1616
> add_to_blacklist(number_to_blacklist)
1717
18-
Adds a phone number to the blacklist.
18+
Adds a phone number to the blacklist
1919

2020
### Example
2121

@@ -33,7 +33,7 @@ api_instance = MessenteApi::BlacklistApi.new
3333
number_to_blacklist = MessenteApi::NumberToBlacklist.new # NumberToBlacklist | Phone number to be blacklisted
3434

3535
begin
36-
#Adds a phone number to the blacklist.
36+
#Adds a phone number to the blacklist
3737
api_instance.add_to_blacklist(number_to_blacklist)
3838
rescue MessenteApi::ApiError => e
3939
puts "Exception when calling BlacklistApi->add_to_blacklist: #{e}"
@@ -65,7 +65,7 @@ nil (empty response body)
6565

6666
> delete_from_blacklist(phone)
6767
68-
Deletes a phone number from the blacklist.
68+
Deletes a phone number from the blacklist
6969

7070
### Example
7171

@@ -83,7 +83,7 @@ api_instance = MessenteApi::BlacklistApi.new
8383
phone = 'phone_example' # String | A phone number
8484

8585
begin
86-
#Deletes a phone number from the blacklist.
86+
#Deletes a phone number from the blacklist
8787
api_instance.delete_from_blacklist(phone)
8888
rescue MessenteApi::ApiError => e
8989
puts "Exception when calling BlacklistApi->delete_from_blacklist: #{e}"
@@ -115,7 +115,7 @@ nil (empty response body)
115115

116116
> FetchBlacklistSuccess fetch_blacklist
117117
118-
Returns all blacklisted phone numbers.
118+
Returns all blacklisted phone numbers
119119

120120
### Example
121121

@@ -132,7 +132,7 @@ end
132132
api_instance = MessenteApi::BlacklistApi.new
133133

134134
begin
135-
#Returns all blacklisted phone numbers.
135+
#Returns all blacklisted phone numbers
136136
result = api_instance.fetch_blacklist
137137
p result
138138
rescue MessenteApi::ApiError => e
@@ -162,7 +162,7 @@ This endpoint does not need any parameter.
162162

163163
> is_blacklisted(phone)
164164
165-
Checks if a phone number is blacklisted.
165+
Checks if a phone number is blacklisted
166166

167167
### Example
168168

@@ -180,7 +180,7 @@ api_instance = MessenteApi::BlacklistApi.new
180180
phone = 'phone_example' # String | A phone number
181181

182182
begin
183-
#Checks if a phone number is blacklisted.
183+
#Checks if a phone number is blacklisted
184184
api_instance.is_blacklisted(phone)
185185
rescue MessenteApi::ApiError => e
186186
puts "Exception when calling BlacklistApi->is_blacklisted: #{e}"

docs/ContactFields.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**phone_number** | **String** | Phone number in e.164 format |
8-
**email** | **String** | | [optional]
9-
**first_name** | **String** | | [optional]
10-
**last_name** | **String** | | [optional]
11-
**company** | **String** | | [optional]
12-
**title** | **String** | | [optional]
13-
**custom** | **String** | | [optional]
14-
**custom2** | **String** | | [optional]
15-
**custom3** | **String** | | [optional]
16-
**custom4** | **String** | | [optional]
8+
**email** | **String** | The email of the contact | [optional]
9+
**first_name** | **String** | The first name of the contact | [optional]
10+
**last_name** | **String** | The last name of the contact | [optional]
11+
**company** | **String** | The company of the contact | [optional]
12+
**title** | **String** | The title of the contact | [optional]
13+
**custom** | **String** | The first custom field | [optional]
14+
**custom2** | **String** | The second custom field | [optional]
15+
**custom3** | **String** | The third custom field | [optional]
16+
**custom4** | **String** | The fourth custom field | [optional]
1717

1818
## Code Sample
1919

docs/ContactListEnvelope.md

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

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**contacts** | [**Array<ContactFields>**](ContactFields.md) | | [optional]
7+
**contacts** | [**Array<ContactFields>**](ContactFields.md) | An array of contacts | [optional]
88

99
## Code Sample
1010

docs/ContactUpdateFields.md

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

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**email** | **String** | | [optional]
8-
**first_name** | **String** | | [optional]
9-
**last_name** | **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+
**first_name** | **String** | The first name of the contact | [optional]
9+
**last_name** | **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
## Code Sample
1818

0 commit comments

Comments
 (0)