messente_api 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +22 -22
- data/docs/BlacklistApi.md +12 -12
- data/docs/ContactFields.md +9 -9
- data/docs/ContactListEnvelope.md +1 -1
- data/docs/ContactUpdateFields.md +9 -9
- data/docs/ContactsApi.md +30 -30
- data/docs/DeliveryReportApi.md +6 -6
- data/docs/DeliveryReportResponse.md +2 -2
- data/docs/DeliveryResult.md +1 -1
- data/docs/ErrorItemOmnichannel.md +1 -1
- data/docs/ErrorItemPhonebook.md +1 -1
- data/docs/ErrorOmnichannel.md +1 -1
- data/docs/ErrorPhonebook.md +1 -1
- data/docs/FetchBlacklistSuccess.md +1 -1
- data/docs/GroupListEnvelope.md +1 -1
- data/docs/GroupName.md +1 -1
- data/docs/GroupResponseFields.md +4 -4
- data/docs/GroupsApi.md +21 -21
- data/docs/OmniMessageCreateSuccessResponse.md +2 -2
- data/docs/Omnimessage.md +2 -2
- data/docs/OmnimessageApi.md +8 -8
- data/docs/SMS.md +2 -2
- data/docs/Viber.md +2 -2
- data/docs/WhatsApp.md +1 -1
- data/docs/WhatsAppText.md +1 -1
- data/lib/messente_api.rb +1 -1
- data/lib/messente_api/api/blacklist_api.rb +11 -11
- data/lib/messente_api/api/contacts_api.rb +31 -31
- data/lib/messente_api/api/delivery_report_api.rb +6 -6
- data/lib/messente_api/api/groups_api.rb +22 -22
- data/lib/messente_api/api/omnimessage_api.rb +7 -7
- data/lib/messente_api/api_client.rb +1 -1
- data/lib/messente_api/api_error.rb +1 -1
- data/lib/messente_api/configuration.rb +1 -1
- data/lib/messente_api/models/channel.rb +1 -1
- data/lib/messente_api/models/contact_envelope.rb +2 -1
- data/lib/messente_api/models/contact_fields.rb +11 -1
- data/lib/messente_api/models/contact_list_envelope.rb +3 -1
- data/lib/messente_api/models/contact_update_fields.rb +11 -1
- data/lib/messente_api/models/delivery_report_response.rb +4 -3
- data/lib/messente_api/models/delivery_result.rb +3 -2
- data/lib/messente_api/models/error_code_omnichannel.rb +1 -1
- data/lib/messente_api/models/error_code_omnichannel_machine.rb +1 -1
- data/lib/messente_api/models/error_code_phonebook.rb +1 -1
- data/lib/messente_api/models/error_item_omnichannel.rb +3 -2
- data/lib/messente_api/models/error_item_phonebook.rb +3 -2
- data/lib/messente_api/models/error_omnichannel.rb +3 -1
- data/lib/messente_api/models/error_phonebook.rb +3 -1
- data/lib/messente_api/models/error_title_omnichannel.rb +1 -1
- data/lib/messente_api/models/error_title_phonebook.rb +1 -1
- data/lib/messente_api/models/fetch_blacklist_success.rb +3 -1
- data/lib/messente_api/models/group_envelope.rb +2 -1
- data/lib/messente_api/models/group_list_envelope.rb +3 -1
- data/lib/messente_api/models/group_name.rb +3 -1
- data/lib/messente_api/models/group_response_fields.rb +6 -3
- data/lib/messente_api/models/message_result.rb +2 -1
- data/lib/messente_api/models/number_to_blacklist.rb +2 -1
- data/lib/messente_api/models/omni_message_create_success_response.rb +4 -3
- data/lib/messente_api/models/omnimessage.rb +4 -2
- data/lib/messente_api/models/sms.rb +3 -2
- data/lib/messente_api/models/status.rb +1 -1
- data/lib/messente_api/models/text_store.rb +1 -1
- data/lib/messente_api/models/viber.rb +3 -2
- data/lib/messente_api/models/whats_app.rb +3 -2
- data/lib/messente_api/models/whats_app_audio.rb +2 -1
- data/lib/messente_api/models/whats_app_document.rb +2 -1
- data/lib/messente_api/models/whats_app_image.rb +2 -1
- data/lib/messente_api/models/whats_app_text.rb +3 -2
- data/lib/messente_api/version.rb +2 -2
- data/messente_api.gemspec +1 -1
- data/spec/api/blacklist_api_spec.rb +5 -5
- data/spec/api/contacts_api_spec.rb +12 -12
- data/spec/api/delivery_report_api_spec.rb +3 -3
- data/spec/api/groups_api_spec.rb +9 -9
- data/spec/api/omnimessage_api_spec.rb +4 -4
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/channel_spec.rb +1 -1
- data/spec/models/contact_envelope_spec.rb +1 -1
- data/spec/models/contact_fields_spec.rb +1 -1
- data/spec/models/contact_list_envelope_spec.rb +1 -1
- data/spec/models/contact_update_fields_spec.rb +1 -1
- data/spec/models/delivery_report_response_spec.rb +1 -1
- data/spec/models/delivery_result_spec.rb +1 -1
- data/spec/models/error_code_omnichannel_machine_spec.rb +1 -1
- data/spec/models/error_code_omnichannel_spec.rb +1 -1
- data/spec/models/error_code_phonebook_spec.rb +1 -1
- data/spec/models/error_item_omnichannel_spec.rb +1 -1
- data/spec/models/error_item_phonebook_spec.rb +1 -1
- data/spec/models/error_omnichannel_spec.rb +1 -1
- data/spec/models/error_phonebook_spec.rb +1 -1
- data/spec/models/error_title_omnichannel_spec.rb +1 -1
- data/spec/models/error_title_phonebook_spec.rb +1 -1
- data/spec/models/fetch_blacklist_success_spec.rb +1 -1
- data/spec/models/group_envelope_spec.rb +1 -1
- data/spec/models/group_list_envelope_spec.rb +1 -1
- data/spec/models/group_name_spec.rb +1 -1
- data/spec/models/group_response_fields_spec.rb +1 -1
- data/spec/models/message_result_spec.rb +1 -1
- data/spec/models/number_to_blacklist_spec.rb +1 -1
- data/spec/models/omni_message_create_success_response_spec.rb +1 -1
- data/spec/models/omnimessage_spec.rb +1 -1
- data/spec/models/sms_spec.rb +1 -1
- data/spec/models/status_spec.rb +1 -1
- data/spec/models/text_store_spec.rb +1 -1
- data/spec/models/viber_spec.rb +1 -1
- data/spec/models/whats_app_audio_spec.rb +1 -1
- data/spec/models/whats_app_document_spec.rb +1 -1
- data/spec/models/whats_app_image_spec.rb +1 -1
- data/spec/models/whats_app_spec.rb +1 -1
- data/spec/models/whats_app_text_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e6fd4c57c60b3b5d7f8af3a877103634e18a1e07
|
4
|
+
data.tar.gz: 18f8da6761f778861b8b571bd184b00d7c976b6a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4cfc50a7ef1f5242e856ad716e61cb19e2483d1f3967a9cf36f540b2dc7a0303212f9cdc18533c033d2b8ed544e5c3c59474bdb353e480221d99dde7a3199d1f
|
7
|
+
data.tar.gz: 0c2993a67d955e5f4f0e05673a5bcbd99333ccad1baacb3c93ad39c19827bc6956358157a6606ab2b92c6bee51344f743a551ee0a180093c8d721fddf4c76876
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Messente API Library
|
2
2
|
|
3
|
-
- Messente API version: 1.0.
|
4
|
-
- Ruby gem version: 1.0.
|
3
|
+
- Messente API version: 1.0.2
|
4
|
+
- Ruby gem version: 1.0.2
|
5
5
|
|
6
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 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.
|
7
7
|
|
@@ -20,38 +20,38 @@ Messente API Library provides the operations described below to access the featu
|
|
20
20
|
|
21
21
|
### BlacklistApi
|
22
22
|
|
23
|
-
1. Adds a phone number to the blacklist
|
24
|
-
1. Deletes a phone number from the blacklist
|
25
|
-
1. Returns all blacklisted phone numbers
|
26
|
-
1. Checks if a phone number 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)
|
27
27
|
|
28
28
|
### ContactsApi
|
29
29
|
|
30
|
-
1. Adds a contact to a group
|
31
|
-
1. Creates a new contact
|
32
|
-
1. Deletes a contact
|
33
|
-
1. Lists a contact
|
34
|
-
1. Lists groups of a contact
|
35
|
-
1. Returns all contacts
|
36
|
-
1. Removes a contact from a group
|
37
|
-
1. Updates a 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)
|
38
38
|
|
39
39
|
### DeliveryReportApi
|
40
40
|
|
41
|
-
1. Retrieves the delivery report for the Omnimessage
|
41
|
+
1. Retrieves the delivery report for the Omnimessage [`retrieve_delivery_report`](docs/DeliveryReportApi.md#retrieve_delivery_report)
|
42
42
|
|
43
43
|
### GroupsApi
|
44
44
|
|
45
|
-
1. Creates a new group with the provided name
|
46
|
-
1. Deletes a group
|
47
|
-
1. Lists a group
|
48
|
-
1. Returns all groups
|
49
|
-
1. Updates a group with the provided name
|
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)
|
50
50
|
|
51
51
|
### OmnimessageApi
|
52
52
|
|
53
|
-
1. Cancels a scheduled Omnimessage
|
54
|
-
1. Sends an 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)
|
55
55
|
|
56
56
|
## Auth
|
57
57
|
|
data/docs/BlacklistApi.md
CHANGED
@@ -4,10 +4,10 @@ All URIs are relative to *https://api.messente.com/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
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
|
11
11
|
|
12
12
|
|
13
13
|
|
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
|
15
15
|
|
16
16
|
> add_to_blacklist(number_to_blacklist)
|
17
17
|
|
18
|
-
Adds a phone number to the blacklist
|
18
|
+
Adds a phone number to the blacklist
|
19
19
|
|
20
20
|
### Example
|
21
21
|
|
@@ -33,7 +33,7 @@ api_instance = MessenteApi::BlacklistApi.new
|
|
33
33
|
number_to_blacklist = MessenteApi::NumberToBlacklist.new # NumberToBlacklist | Phone number to be blacklisted
|
34
34
|
|
35
35
|
begin
|
36
|
-
#Adds a phone number to the blacklist
|
36
|
+
#Adds a phone number to the blacklist
|
37
37
|
api_instance.add_to_blacklist(number_to_blacklist)
|
38
38
|
rescue MessenteApi::ApiError => e
|
39
39
|
puts "Exception when calling BlacklistApi->add_to_blacklist: #{e}"
|
@@ -65,7 +65,7 @@ nil (empty response body)
|
|
65
65
|
|
66
66
|
> delete_from_blacklist(phone)
|
67
67
|
|
68
|
-
Deletes a phone number from the blacklist
|
68
|
+
Deletes a phone number from the blacklist
|
69
69
|
|
70
70
|
### Example
|
71
71
|
|
@@ -83,7 +83,7 @@ api_instance = MessenteApi::BlacklistApi.new
|
|
83
83
|
phone = 'phone_example' # String | A phone number
|
84
84
|
|
85
85
|
begin
|
86
|
-
#Deletes a phone number from the blacklist
|
86
|
+
#Deletes a phone number from the blacklist
|
87
87
|
api_instance.delete_from_blacklist(phone)
|
88
88
|
rescue MessenteApi::ApiError => e
|
89
89
|
puts "Exception when calling BlacklistApi->delete_from_blacklist: #{e}"
|
@@ -115,7 +115,7 @@ nil (empty response body)
|
|
115
115
|
|
116
116
|
> FetchBlacklistSuccess fetch_blacklist
|
117
117
|
|
118
|
-
Returns all blacklisted phone numbers
|
118
|
+
Returns all blacklisted phone numbers
|
119
119
|
|
120
120
|
### Example
|
121
121
|
|
@@ -132,7 +132,7 @@ end
|
|
132
132
|
api_instance = MessenteApi::BlacklistApi.new
|
133
133
|
|
134
134
|
begin
|
135
|
-
#Returns all blacklisted phone numbers
|
135
|
+
#Returns all blacklisted phone numbers
|
136
136
|
result = api_instance.fetch_blacklist
|
137
137
|
p result
|
138
138
|
rescue MessenteApi::ApiError => e
|
@@ -162,7 +162,7 @@ This endpoint does not need any parameter.
|
|
162
162
|
|
163
163
|
> is_blacklisted(phone)
|
164
164
|
|
165
|
-
Checks if a phone number is blacklisted
|
165
|
+
Checks if a phone number is blacklisted
|
166
166
|
|
167
167
|
### Example
|
168
168
|
|
@@ -180,7 +180,7 @@ api_instance = MessenteApi::BlacklistApi.new
|
|
180
180
|
phone = 'phone_example' # String | A phone number
|
181
181
|
|
182
182
|
begin
|
183
|
-
#Checks if a phone number is blacklisted
|
183
|
+
#Checks if a phone number is blacklisted
|
184
184
|
api_instance.is_blacklisted(phone)
|
185
185
|
rescue MessenteApi::ApiError => e
|
186
186
|
puts "Exception when calling BlacklistApi->is_blacklisted: #{e}"
|
data/docs/ContactFields.md
CHANGED
@@ -5,15 +5,15 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**phone_number** | **String** | Phone number in e.164 format |
|
8
|
-
**email** | **String** |
|
9
|
-
**first_name** | **String** |
|
10
|
-
**last_name** | **String** |
|
11
|
-
**company** | **String** |
|
12
|
-
**title** | **String** |
|
13
|
-
**custom** | **String** |
|
14
|
-
**custom2** | **String** |
|
15
|
-
**custom3** | **String** |
|
16
|
-
**custom4** | **String** |
|
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]
|
17
17
|
|
18
18
|
## Code Sample
|
19
19
|
|
data/docs/ContactListEnvelope.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**contacts** | [**Array<ContactFields>**](ContactFields.md) |
|
7
|
+
**contacts** | [**Array<ContactFields>**](ContactFields.md) | An array of contacts | [optional]
|
8
8
|
|
9
9
|
## Code Sample
|
10
10
|
|
data/docs/ContactUpdateFields.md
CHANGED
@@ -4,15 +4,15 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**email** | **String** |
|
8
|
-
**first_name** | **String** |
|
9
|
-
**last_name** | **String** |
|
10
|
-
**company** | **String** |
|
11
|
-
**title** | **String** |
|
12
|
-
**custom** | **String** |
|
13
|
-
**custom2** | **String** |
|
14
|
-
**custom3** | **String** |
|
15
|
-
**custom4** | **String** |
|
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]
|
16
16
|
|
17
17
|
## Code Sample
|
18
18
|
|
data/docs/ContactsApi.md
CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://api.messente.com/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**add_contact_to_group**](ContactsApi.md#add_contact_to_group) | **POST** /groups/{groupId}/contacts/{phone} | Adds a contact to a group
|
8
|
-
[**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Creates a new contact
|
9
|
-
[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{phone} | Deletes a contact
|
10
|
-
[**fetch_contact**](ContactsApi.md#fetch_contact) | **GET** /contacts/{phone} | Lists a contact
|
11
|
-
[**fetch_contact_groups**](ContactsApi.md#fetch_contact_groups) | **GET** /contacts/{phone}/groups | Lists groups of a contact
|
12
|
-
[**fetch_contacts**](ContactsApi.md#fetch_contacts) | **GET** /contacts | Returns all contacts
|
13
|
-
[**remove_contact_from_group**](ContactsApi.md#remove_contact_from_group) | **DELETE** /groups/{groupId}/contacts/{phone} | Removes a contact from a group
|
14
|
-
[**update_contact**](ContactsApi.md#update_contact) | **PATCH** /contacts/{phone} | Updates a contact
|
7
|
+
[**add_contact_to_group**](ContactsApi.md#add_contact_to_group) | **POST** /phonebook/groups/{groupId}/contacts/{phone} | Adds a contact to a group
|
8
|
+
[**create_contact**](ContactsApi.md#create_contact) | **POST** /phonebook/contacts | Creates a new contact
|
9
|
+
[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /phonebook/contacts/{phone} | Deletes a contact
|
10
|
+
[**fetch_contact**](ContactsApi.md#fetch_contact) | **GET** /phonebook/contacts/{phone} | Lists a contact
|
11
|
+
[**fetch_contact_groups**](ContactsApi.md#fetch_contact_groups) | **GET** /phonebook/contacts/{phone}/groups | Lists groups of a contact
|
12
|
+
[**fetch_contacts**](ContactsApi.md#fetch_contacts) | **GET** /phonebook/contacts | Returns all contacts
|
13
|
+
[**remove_contact_from_group**](ContactsApi.md#remove_contact_from_group) | **DELETE** /phonebook/groups/{groupId}/contacts/{phone} | Removes a contact from a group
|
14
|
+
[**update_contact**](ContactsApi.md#update_contact) | **PATCH** /phonebook/contacts/{phone} | Updates a contact
|
15
15
|
|
16
16
|
|
17
17
|
|
@@ -19,7 +19,7 @@ Method | HTTP request | Description
|
|
19
19
|
|
20
20
|
> Object add_contact_to_group(group_id, phone)
|
21
21
|
|
22
|
-
Adds a contact to a group
|
22
|
+
Adds a contact to a group
|
23
23
|
|
24
24
|
### Example
|
25
25
|
|
@@ -34,11 +34,11 @@ MessenteApi.configure do |config|
|
|
34
34
|
end
|
35
35
|
|
36
36
|
api_instance = MessenteApi::ContactsApi.new
|
37
|
-
group_id = 'group_id_example' # String | String in
|
37
|
+
group_id = 'group_id_example' # String | String in UUID format
|
38
38
|
phone = 'phone_example' # String | A phone number
|
39
39
|
|
40
40
|
begin
|
41
|
-
#Adds a contact to a group
|
41
|
+
#Adds a contact to a group
|
42
42
|
result = api_instance.add_contact_to_group(group_id, phone)
|
43
43
|
p result
|
44
44
|
rescue MessenteApi::ApiError => e
|
@@ -51,7 +51,7 @@ end
|
|
51
51
|
|
52
52
|
Name | Type | Description | Notes
|
53
53
|
------------- | ------------- | ------------- | -------------
|
54
|
-
**group_id** | **String**| String in
|
54
|
+
**group_id** | **String**| String in UUID format |
|
55
55
|
**phone** | **String**| A phone number |
|
56
56
|
|
57
57
|
### Return type
|
@@ -72,7 +72,7 @@ Name | Type | Description | Notes
|
|
72
72
|
|
73
73
|
> ContactEnvelope create_contact(contact_fields)
|
74
74
|
|
75
|
-
Creates a new contact
|
75
|
+
Creates a new contact
|
76
76
|
|
77
77
|
### Example
|
78
78
|
|
@@ -90,7 +90,7 @@ api_instance = MessenteApi::ContactsApi.new
|
|
90
90
|
contact_fields = MessenteApi::ContactFields.new # ContactFields |
|
91
91
|
|
92
92
|
begin
|
93
|
-
#Creates a new contact
|
93
|
+
#Creates a new contact
|
94
94
|
result = api_instance.create_contact(contact_fields)
|
95
95
|
p result
|
96
96
|
rescue MessenteApi::ApiError => e
|
@@ -123,7 +123,7 @@ Name | Type | Description | Notes
|
|
123
123
|
|
124
124
|
> delete_contact(phone)
|
125
125
|
|
126
|
-
Deletes a contact
|
126
|
+
Deletes a contact
|
127
127
|
|
128
128
|
### Example
|
129
129
|
|
@@ -141,7 +141,7 @@ api_instance = MessenteApi::ContactsApi.new
|
|
141
141
|
phone = 'phone_example' # String | A phone number
|
142
142
|
|
143
143
|
begin
|
144
|
-
#Deletes a contact
|
144
|
+
#Deletes a contact
|
145
145
|
api_instance.delete_contact(phone)
|
146
146
|
rescue MessenteApi::ApiError => e
|
147
147
|
puts "Exception when calling ContactsApi->delete_contact: #{e}"
|
@@ -173,7 +173,7 @@ nil (empty response body)
|
|
173
173
|
|
174
174
|
> ContactEnvelope fetch_contact(phone)
|
175
175
|
|
176
|
-
Lists a contact
|
176
|
+
Lists a contact
|
177
177
|
|
178
178
|
### Example
|
179
179
|
|
@@ -191,7 +191,7 @@ api_instance = MessenteApi::ContactsApi.new
|
|
191
191
|
phone = 'phone_example' # String | A phone number
|
192
192
|
|
193
193
|
begin
|
194
|
-
#Lists a contact
|
194
|
+
#Lists a contact
|
195
195
|
result = api_instance.fetch_contact(phone)
|
196
196
|
p result
|
197
197
|
rescue MessenteApi::ApiError => e
|
@@ -224,7 +224,7 @@ Name | Type | Description | Notes
|
|
224
224
|
|
225
225
|
> GroupListEnvelope fetch_contact_groups(phone)
|
226
226
|
|
227
|
-
Lists groups of a contact
|
227
|
+
Lists groups of a contact
|
228
228
|
|
229
229
|
### Example
|
230
230
|
|
@@ -242,7 +242,7 @@ api_instance = MessenteApi::ContactsApi.new
|
|
242
242
|
phone = 'phone_example' # String | A phone number
|
243
243
|
|
244
244
|
begin
|
245
|
-
#Lists groups of a contact
|
245
|
+
#Lists groups of a contact
|
246
246
|
result = api_instance.fetch_contact_groups(phone)
|
247
247
|
p result
|
248
248
|
rescue MessenteApi::ApiError => e
|
@@ -275,7 +275,7 @@ Name | Type | Description | Notes
|
|
275
275
|
|
276
276
|
> ContactListEnvelope fetch_contacts(opts)
|
277
277
|
|
278
|
-
Returns all contacts
|
278
|
+
Returns all contacts
|
279
279
|
|
280
280
|
### Example
|
281
281
|
|
@@ -291,11 +291,11 @@ end
|
|
291
291
|
|
292
292
|
api_instance = MessenteApi::ContactsApi.new
|
293
293
|
opts = {
|
294
|
-
group_ids: ['group_ids_example'] # Array<String> | Optional one or many group id strings in
|
294
|
+
group_ids: ['group_ids_example'] # Array<String> | Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\"
|
295
295
|
}
|
296
296
|
|
297
297
|
begin
|
298
|
-
#Returns all contacts
|
298
|
+
#Returns all contacts
|
299
299
|
result = api_instance.fetch_contacts(opts)
|
300
300
|
p result
|
301
301
|
rescue MessenteApi::ApiError => e
|
@@ -308,7 +308,7 @@ end
|
|
308
308
|
|
309
309
|
Name | Type | Description | Notes
|
310
310
|
------------- | ------------- | ------------- | -------------
|
311
|
-
**group_ids** | [**Array<String>**](String.md)| Optional one or many group id strings in
|
311
|
+
**group_ids** | [**Array<String>**](String.md)| Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\" | [optional]
|
312
312
|
|
313
313
|
### Return type
|
314
314
|
|
@@ -328,7 +328,7 @@ Name | Type | Description | Notes
|
|
328
328
|
|
329
329
|
> remove_contact_from_group(group_id, phone)
|
330
330
|
|
331
|
-
Removes a contact from a group
|
331
|
+
Removes a contact from a group
|
332
332
|
|
333
333
|
### Example
|
334
334
|
|
@@ -343,11 +343,11 @@ MessenteApi.configure do |config|
|
|
343
343
|
end
|
344
344
|
|
345
345
|
api_instance = MessenteApi::ContactsApi.new
|
346
|
-
group_id = 'group_id_example' # String | String in
|
346
|
+
group_id = 'group_id_example' # String | String in UUID format
|
347
347
|
phone = 'phone_example' # String | A phone number
|
348
348
|
|
349
349
|
begin
|
350
|
-
#Removes a contact from a group
|
350
|
+
#Removes a contact from a group
|
351
351
|
api_instance.remove_contact_from_group(group_id, phone)
|
352
352
|
rescue MessenteApi::ApiError => e
|
353
353
|
puts "Exception when calling ContactsApi->remove_contact_from_group: #{e}"
|
@@ -359,7 +359,7 @@ end
|
|
359
359
|
|
360
360
|
Name | Type | Description | Notes
|
361
361
|
------------- | ------------- | ------------- | -------------
|
362
|
-
**group_id** | **String**| String in
|
362
|
+
**group_id** | **String**| String in UUID format |
|
363
363
|
**phone** | **String**| A phone number |
|
364
364
|
|
365
365
|
### Return type
|
@@ -380,7 +380,7 @@ nil (empty response body)
|
|
380
380
|
|
381
381
|
> ContactEnvelope update_contact(phone, contact_update_fields)
|
382
382
|
|
383
|
-
Updates a contact
|
383
|
+
Updates a contact
|
384
384
|
|
385
385
|
### Example
|
386
386
|
|
@@ -399,7 +399,7 @@ phone = 'phone_example' # String | A phone number
|
|
399
399
|
contact_update_fields = MessenteApi::ContactUpdateFields.new # ContactUpdateFields |
|
400
400
|
|
401
401
|
begin
|
402
|
-
#Updates a contact
|
402
|
+
#Updates a contact
|
403
403
|
result = api_instance.update_contact(phone, contact_update_fields)
|
404
404
|
p result
|
405
405
|
rescue MessenteApi::ApiError => e
|
data/docs/DeliveryReportApi.md
CHANGED
@@ -4,7 +4,7 @@ All URIs are relative to *https://api.messente.com/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**retrieve_delivery_report**](DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessageId}/status | Retrieves the delivery report for the Omnimessage
|
7
|
+
[**retrieve_delivery_report**](DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessageId}/status | Retrieves the delivery report for the Omnimessage
|
8
8
|
|
9
9
|
|
10
10
|
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
12
12
|
|
13
13
|
> DeliveryReportResponse retrieve_delivery_report(omnimessage_id)
|
14
14
|
|
15
|
-
Retrieves the delivery report for the Omnimessage
|
15
|
+
Retrieves the delivery report for the Omnimessage
|
16
16
|
|
17
17
|
### Example
|
18
18
|
|
@@ -27,10 +27,10 @@ MessenteApi.configure do |config|
|
|
27
27
|
end
|
28
28
|
|
29
29
|
api_instance = MessenteApi::DeliveryReportApi.new
|
30
|
-
omnimessage_id = 'omnimessage_id_example' # String | UUID of the
|
30
|
+
omnimessage_id = 'omnimessage_id_example' # String | UUID of the omnimessage to for which the delivery report is to be retrieved
|
31
31
|
|
32
32
|
begin
|
33
|
-
#Retrieves the delivery report for the Omnimessage
|
33
|
+
#Retrieves the delivery report for the Omnimessage
|
34
34
|
result = api_instance.retrieve_delivery_report(omnimessage_id)
|
35
35
|
p result
|
36
36
|
rescue MessenteApi::ApiError => e
|
@@ -43,7 +43,7 @@ end
|
|
43
43
|
|
44
44
|
Name | Type | Description | Notes
|
45
45
|
------------- | ------------- | ------------- | -------------
|
46
|
-
**omnimessage_id** |
|
46
|
+
**omnimessage_id** | **String**| UUID of the omnimessage to for which the delivery report is to be retrieved |
|
47
47
|
|
48
48
|
### Return type
|
49
49
|
|
@@ -56,5 +56,5 @@ Name | Type | Description | Notes
|
|
56
56
|
### HTTP request headers
|
57
57
|
|
58
58
|
- **Content-Type**: Not defined
|
59
|
-
- **Accept**:
|
59
|
+
- **Accept**: application/json
|
60
60
|
|