messente_api 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +79 -0
- data/README.md +118 -0
- data/Rakefile +10 -0
- data/docs/BlacklistApi.md +209 -0
- data/docs/Channel.md +16 -0
- data/docs/ContactEnvelope.md +17 -0
- data/docs/ContactFields.md +35 -0
- data/docs/ContactListEnvelope.md +17 -0
- data/docs/ContactUpdateFields.md +33 -0
- data/docs/ContactsApi.md +430 -0
- data/docs/DeliveryReportApi.md +60 -0
- data/docs/DeliveryReportResponse.md +21 -0
- data/docs/DeliveryResult.md +27 -0
- data/docs/ErrorCodeOmnichannel.md +16 -0
- data/docs/ErrorCodeOmnichannelMachine.md +16 -0
- data/docs/ErrorCodePhonebook.md +16 -0
- data/docs/ErrorItemOmnichannel.md +23 -0
- data/docs/ErrorItemPhonebook.md +21 -0
- data/docs/ErrorOmnichannel.md +17 -0
- data/docs/ErrorPhonebook.md +17 -0
- data/docs/ErrorTitleOmnichannel.md +16 -0
- data/docs/ErrorTitlePhonebook.md +16 -0
- data/docs/FetchBlacklistSuccess.md +17 -0
- data/docs/GroupEnvelope.md +17 -0
- data/docs/GroupListEnvelope.md +17 -0
- data/docs/GroupName.md +17 -0
- data/docs/GroupResponseFields.md +23 -0
- data/docs/GroupsApi.md +265 -0
- data/docs/MessageResult.md +21 -0
- data/docs/NumberToBlacklist.md +17 -0
- data/docs/OmniMessageCreateSuccessResponse.md +21 -0
- data/docs/Omnimessage.md +25 -0
- data/docs/OmnimessageApi.md +111 -0
- data/docs/SMS.md +27 -0
- data/docs/Status.md +16 -0
- data/docs/TextStore.md +16 -0
- data/docs/Viber.md +29 -0
- data/docs/WhatsApp.md +29 -0
- data/docs/WhatsAppAudio.md +17 -0
- data/docs/WhatsAppDocument.md +19 -0
- data/docs/WhatsAppImage.md +19 -0
- data/docs/WhatsAppText.md +19 -0
- data/git_push.sh +55 -0
- data/lib/messente_api.rb +78 -0
- data/lib/messente_api/api/blacklist_api.rb +258 -0
- data/lib/messente_api/api/contacts_api.rb +521 -0
- data/lib/messente_api/api/delivery_report_api.rb +82 -0
- data/lib/messente_api/api/groups_api.rb +326 -0
- data/lib/messente_api/api/omnimessage_api.rb +144 -0
- data/lib/messente_api/api_client.rb +387 -0
- data/lib/messente_api/api_error.rb +57 -0
- data/lib/messente_api/configuration.rb +251 -0
- data/lib/messente_api/models/channel.rb +37 -0
- data/lib/messente_api/models/contact_envelope.rb +196 -0
- data/lib/messente_api/models/contact_fields.rb +283 -0
- data/lib/messente_api/models/contact_list_envelope.rb +198 -0
- data/lib/messente_api/models/contact_update_fields.rb +268 -0
- data/lib/messente_api/models/delivery_report_response.rb +234 -0
- data/lib/messente_api/models/delivery_result.rb +244 -0
- data/lib/messente_api/models/error_code_omnichannel.rb +41 -0
- data/lib/messente_api/models/error_code_omnichannel_machine.rb +46 -0
- data/lib/messente_api/models/error_code_phonebook.rb +40 -0
- data/lib/messente_api/models/error_item_omnichannel.rb +245 -0
- data/lib/messente_api/models/error_item_phonebook.rb +230 -0
- data/lib/messente_api/models/error_omnichannel.rb +203 -0
- data/lib/messente_api/models/error_phonebook.rb +203 -0
- data/lib/messente_api/models/error_title_omnichannel.rb +41 -0
- data/lib/messente_api/models/error_title_phonebook.rb +40 -0
- data/lib/messente_api/models/fetch_blacklist_success.rb +198 -0
- data/lib/messente_api/models/group_envelope.rb +196 -0
- data/lib/messente_api/models/group_list_envelope.rb +198 -0
- data/lib/messente_api/models/group_name.rb +220 -0
- data/lib/messente_api/models/group_response_fields.rb +240 -0
- data/lib/messente_api/models/message_result.rb +231 -0
- data/lib/messente_api/models/number_to_blacklist.rb +202 -0
- data/lib/messente_api/models/omni_message_create_success_response.rb +234 -0
- data/lib/messente_api/models/omnimessage.rb +247 -0
- data/lib/messente_api/models/sms.rb +300 -0
- data/lib/messente_api/models/status.rb +45 -0
- data/lib/messente_api/models/text_store.rb +37 -0
- data/lib/messente_api/models/viber.rb +293 -0
- data/lib/messente_api/models/whats_app.rb +289 -0
- data/lib/messente_api/models/whats_app_audio.rb +202 -0
- data/lib/messente_api/models/whats_app_document.rb +212 -0
- data/lib/messente_api/models/whats_app_image.rb +212 -0
- data/lib/messente_api/models/whats_app_text.rb +214 -0
- data/lib/messente_api/version.rb +15 -0
- data/messente_api.gemspec +45 -0
- data/spec/api/blacklist_api_spec.rb +78 -0
- data/spec/api/contacts_api_spec.rb +126 -0
- data/spec/api/delivery_report_api_spec.rb +46 -0
- data/spec/api/groups_api_spec.rb +90 -0
- data/spec/api/omnimessage_api_spec.rb +57 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/channel_spec.rb +35 -0
- data/spec/models/contact_envelope_spec.rb +41 -0
- data/spec/models/contact_fields_spec.rb +95 -0
- data/spec/models/contact_list_envelope_spec.rb +41 -0
- data/spec/models/contact_update_fields_spec.rb +89 -0
- data/spec/models/delivery_report_response_spec.rb +53 -0
- data/spec/models/delivery_result_spec.rb +71 -0
- data/spec/models/error_code_omnichannel_machine_spec.rb +35 -0
- data/spec/models/error_code_omnichannel_spec.rb +35 -0
- data/spec/models/error_code_phonebook_spec.rb +35 -0
- data/spec/models/error_item_omnichannel_spec.rb +59 -0
- data/spec/models/error_item_phonebook_spec.rb +53 -0
- data/spec/models/error_omnichannel_spec.rb +41 -0
- data/spec/models/error_phonebook_spec.rb +41 -0
- data/spec/models/error_title_omnichannel_spec.rb +35 -0
- data/spec/models/error_title_phonebook_spec.rb +35 -0
- data/spec/models/fetch_blacklist_success_spec.rb +41 -0
- data/spec/models/group_envelope_spec.rb +41 -0
- data/spec/models/group_list_envelope_spec.rb +41 -0
- data/spec/models/group_name_spec.rb +41 -0
- data/spec/models/group_response_fields_spec.rb +59 -0
- data/spec/models/message_result_spec.rb +53 -0
- data/spec/models/number_to_blacklist_spec.rb +41 -0
- data/spec/models/omni_message_create_success_response_spec.rb +53 -0
- data/spec/models/omnimessage_spec.rb +65 -0
- data/spec/models/sms_spec.rb +79 -0
- data/spec/models/status_spec.rb +35 -0
- data/spec/models/text_store_spec.rb +35 -0
- data/spec/models/viber_spec.rb +81 -0
- data/spec/models/whats_app_audio_spec.rb +41 -0
- data/spec/models/whats_app_document_spec.rb +47 -0
- data/spec/models/whats_app_image_spec.rb +47 -0
- data/spec/models/whats_app_spec.rb +81 -0
- data/spec/models/whats_app_text_spec.rb +47 -0
- data/spec/spec_helper.rb +111 -0
- metadata +401 -0
@@ -0,0 +1,60 @@
|
|
1
|
+
# MessenteApi::DeliveryReportApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.messente.com/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**retrieve_delivery_report**](DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessageId}/status | Retrieves the delivery report for the Omnimessage.
|
8
|
+
|
9
|
+
|
10
|
+
|
11
|
+
## retrieve_delivery_report
|
12
|
+
|
13
|
+
> DeliveryReportResponse retrieve_delivery_report(omnimessage_id)
|
14
|
+
|
15
|
+
Retrieves the delivery report for the Omnimessage.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'messente_api'
|
22
|
+
# setup authorization
|
23
|
+
MessenteApi.configure do |config|
|
24
|
+
# Configure HTTP basic authorization: basicAuth
|
25
|
+
config.username = 'YOUR USERNAME'
|
26
|
+
config.password = 'YOUR PASSWORD'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = MessenteApi::DeliveryReportApi.new
|
30
|
+
omnimessage_id = 'omnimessage_id_example' # String | UUID of the Omnimessage to for which the delivery report is to be retrieved
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Retrieves the delivery report for the Omnimessage.
|
34
|
+
result = api_instance.retrieve_delivery_report(omnimessage_id)
|
35
|
+
p result
|
36
|
+
rescue MessenteApi::ApiError => e
|
37
|
+
puts "Exception when calling DeliveryReportApi->retrieve_delivery_report: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
|
44
|
+
Name | Type | Description | Notes
|
45
|
+
------------- | ------------- | ------------- | -------------
|
46
|
+
**omnimessage_id** | [**String**](.md)| UUID of the Omnimessage to for which the delivery report is to be retrieved |
|
47
|
+
|
48
|
+
### Return type
|
49
|
+
|
50
|
+
[**DeliveryReportResponse**](DeliveryReportResponse.md)
|
51
|
+
|
52
|
+
### Authorization
|
53
|
+
|
54
|
+
[basicAuth](../README.md#basicAuth)
|
55
|
+
|
56
|
+
### HTTP request headers
|
57
|
+
|
58
|
+
- **Content-Type**: Not defined
|
59
|
+
- **Accept**: */*
|
60
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# MessenteApi::DeliveryReportResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**statuses** | [**Array<DeliveryResult>**](DeliveryResult.md) | Contains the delivery reports for each channnel, ordered by send order |
|
8
|
+
**to** | **String** | Phone number in e.164 format |
|
9
|
+
**omnimessage_id** | **String** | Unique identifier for the Omnimessage |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'MessenteApi'
|
15
|
+
|
16
|
+
instance = MessenteApi::DeliveryReportResponse.new(statuses: null,
|
17
|
+
to: null,
|
18
|
+
omnimessage_id: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# MessenteApi::DeliveryResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**status** | [**Status**](Status.md) | | [optional]
|
8
|
+
**channel** | [**Channel**](Channel.md) | | [optional]
|
9
|
+
**message_id** | **String** | Unique identifier for the message | [optional]
|
10
|
+
**error** | **String** | Human-readable description of what went wrong, *null* in case of success or if the messages has not been processed yet | [optional]
|
11
|
+
**err** | [**ErrorCodeOmnichannelMachine**](ErrorCodeOmnichannelMachine.md) | | [optional]
|
12
|
+
**timestamp** | **DateTime** | When this status was received by Omnichannel API | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'MessenteApi'
|
18
|
+
|
19
|
+
instance = MessenteApi::DeliveryResult.new(status: null,
|
20
|
+
channel: null,
|
21
|
+
message_id: null,
|
22
|
+
error: null,
|
23
|
+
err: null,
|
24
|
+
timestamp: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# MessenteApi::ErrorCodeOmnichannel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'MessenteApi'
|
12
|
+
|
13
|
+
instance = MessenteApi::ErrorCodeOmnichannel.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# MessenteApi::ErrorCodeOmnichannelMachine
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'MessenteApi'
|
12
|
+
|
13
|
+
instance = MessenteApi::ErrorCodeOmnichannelMachine.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# MessenteApi::ErrorCodePhonebook
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'MessenteApi'
|
12
|
+
|
13
|
+
instance = MessenteApi::ErrorCodePhonebook.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# MessenteApi::ErrorItemOmnichannel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**title** | [**ErrorTitleOmnichannel**](ErrorTitleOmnichannel.md) | |
|
8
|
+
**detail** | **String** | Free form more detailed description of the error. |
|
9
|
+
**code** | [**ErrorCodeOmnichannel**](ErrorCodeOmnichannel.md) | |
|
10
|
+
**source** | **String** | Describes which field is causing the issue in the payload, null for non 400 status code responses |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'MessenteApi'
|
16
|
+
|
17
|
+
instance = MessenteApi::ErrorItemOmnichannel.new(title: null,
|
18
|
+
detail: null,
|
19
|
+
code: null,
|
20
|
+
source: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# MessenteApi::ErrorItemPhonebook
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**title** | [**ErrorTitlePhonebook**](ErrorTitlePhonebook.md) | |
|
8
|
+
**detail** | **String** | Free form more detailed description of the error. |
|
9
|
+
**code** | [**ErrorCodePhonebook**](ErrorCodePhonebook.md) | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'MessenteApi'
|
15
|
+
|
16
|
+
instance = MessenteApi::ErrorItemPhonebook.new(title: null,
|
17
|
+
detail: null,
|
18
|
+
code: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# MessenteApi::ErrorOmnichannel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**errors** | [**Array<ErrorItemOmnichannel>**](ErrorItemOmnichannel.md) | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'MessenteApi'
|
13
|
+
|
14
|
+
instance = MessenteApi::ErrorOmnichannel.new(errors: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# MessenteApi::ErrorPhonebook
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**errors** | [**Array<ErrorItemPhonebook>**](ErrorItemPhonebook.md) | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'MessenteApi'
|
13
|
+
|
14
|
+
instance = MessenteApi::ErrorPhonebook.new(errors: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# MessenteApi::ErrorTitleOmnichannel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'MessenteApi'
|
12
|
+
|
13
|
+
instance = MessenteApi::ErrorTitleOmnichannel.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# MessenteApi::ErrorTitlePhonebook
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'MessenteApi'
|
12
|
+
|
13
|
+
instance = MessenteApi::ErrorTitlePhonebook.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# MessenteApi::FetchBlacklistSuccess
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**phone_numbers** | **Array<String>** | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'MessenteApi'
|
13
|
+
|
14
|
+
instance = MessenteApi::FetchBlacklistSuccess.new(phone_numbers: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# MessenteApi::GroupEnvelope
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**group** | [**GroupResponseFields**](GroupResponseFields.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'MessenteApi'
|
13
|
+
|
14
|
+
instance = MessenteApi::GroupEnvelope.new(group: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# MessenteApi::GroupListEnvelope
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**groups** | [**Array<GroupResponseFields>**](GroupResponseFields.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'MessenteApi'
|
13
|
+
|
14
|
+
instance = MessenteApi::GroupListEnvelope.new(groups: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/GroupName.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# MessenteApi::GroupName
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'MessenteApi'
|
13
|
+
|
14
|
+
instance = MessenteApi::GroupName.new(name: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# MessenteApi::GroupResponseFields
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | Id string in uuid format |
|
8
|
+
**name** | **String** | |
|
9
|
+
**created_on** | **String** | format %Y-%m-%dT%H:%M:%S.%fZ | [optional]
|
10
|
+
**contacts_count** | **Integer** | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'MessenteApi'
|
16
|
+
|
17
|
+
instance = MessenteApi::GroupResponseFields.new(id: null,
|
18
|
+
name: null,
|
19
|
+
created_on: null,
|
20
|
+
contacts_count: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
data/docs/GroupsApi.md
ADDED
@@ -0,0 +1,265 @@
|
|
1
|
+
# MessenteApi::GroupsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.messente.com/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_group**](GroupsApi.md#create_group) | **POST** /groups | Creates a new group with the provided name.
|
8
|
+
[**delete_group**](GroupsApi.md#delete_group) | **DELETE** /groups/{groupId} | Deletes a group.
|
9
|
+
[**fetch_group**](GroupsApi.md#fetch_group) | **GET** /groups/{groupId} | Lists a group.
|
10
|
+
[**fetch_groups**](GroupsApi.md#fetch_groups) | **GET** /groups | Returns all groups.
|
11
|
+
[**update_group**](GroupsApi.md#update_group) | **PUT** /groups/{groupId} | Updates a group with the provided name.
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
## create_group
|
16
|
+
|
17
|
+
> GroupEnvelope create_group(group_name)
|
18
|
+
|
19
|
+
Creates a new group with the provided name.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# load the gem
|
25
|
+
require 'messente_api'
|
26
|
+
# setup authorization
|
27
|
+
MessenteApi.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: basicAuth
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = MessenteApi::GroupsApi.new
|
34
|
+
group_name = MessenteApi::GroupName.new # GroupName |
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Creates a new group with the provided name.
|
38
|
+
result = api_instance.create_group(group_name)
|
39
|
+
p result
|
40
|
+
rescue MessenteApi::ApiError => e
|
41
|
+
puts "Exception when calling GroupsApi->create_group: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
|
48
|
+
Name | Type | Description | Notes
|
49
|
+
------------- | ------------- | ------------- | -------------
|
50
|
+
**group_name** | [**GroupName**](GroupName.md)| |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
[**GroupEnvelope**](GroupEnvelope.md)
|
55
|
+
|
56
|
+
### Authorization
|
57
|
+
|
58
|
+
[basicAuth](../README.md#basicAuth)
|
59
|
+
|
60
|
+
### HTTP request headers
|
61
|
+
|
62
|
+
- **Content-Type**: application/json
|
63
|
+
- **Accept**: application/json
|
64
|
+
|
65
|
+
|
66
|
+
## delete_group
|
67
|
+
|
68
|
+
> delete_group(group_id)
|
69
|
+
|
70
|
+
Deletes a group.
|
71
|
+
|
72
|
+
### Example
|
73
|
+
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'messente_api'
|
77
|
+
# setup authorization
|
78
|
+
MessenteApi.configure do |config|
|
79
|
+
# Configure HTTP basic authorization: basicAuth
|
80
|
+
config.username = 'YOUR USERNAME'
|
81
|
+
config.password = 'YOUR PASSWORD'
|
82
|
+
end
|
83
|
+
|
84
|
+
api_instance = MessenteApi::GroupsApi.new
|
85
|
+
group_id = 'group_id_example' # String | String in uuid format.
|
86
|
+
|
87
|
+
begin
|
88
|
+
#Deletes a group.
|
89
|
+
api_instance.delete_group(group_id)
|
90
|
+
rescue MessenteApi::ApiError => e
|
91
|
+
puts "Exception when calling GroupsApi->delete_group: #{e}"
|
92
|
+
end
|
93
|
+
```
|
94
|
+
|
95
|
+
### Parameters
|
96
|
+
|
97
|
+
|
98
|
+
Name | Type | Description | Notes
|
99
|
+
------------- | ------------- | ------------- | -------------
|
100
|
+
**group_id** | **String**| String in uuid format. |
|
101
|
+
|
102
|
+
### Return type
|
103
|
+
|
104
|
+
nil (empty response body)
|
105
|
+
|
106
|
+
### Authorization
|
107
|
+
|
108
|
+
[basicAuth](../README.md#basicAuth)
|
109
|
+
|
110
|
+
### HTTP request headers
|
111
|
+
|
112
|
+
- **Content-Type**: Not defined
|
113
|
+
- **Accept**: application/json
|
114
|
+
|
115
|
+
|
116
|
+
## fetch_group
|
117
|
+
|
118
|
+
> GroupEnvelope fetch_group(group_id)
|
119
|
+
|
120
|
+
Lists a group.
|
121
|
+
|
122
|
+
### Example
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
# load the gem
|
126
|
+
require 'messente_api'
|
127
|
+
# setup authorization
|
128
|
+
MessenteApi.configure do |config|
|
129
|
+
# Configure HTTP basic authorization: basicAuth
|
130
|
+
config.username = 'YOUR USERNAME'
|
131
|
+
config.password = 'YOUR PASSWORD'
|
132
|
+
end
|
133
|
+
|
134
|
+
api_instance = MessenteApi::GroupsApi.new
|
135
|
+
group_id = 'group_id_example' # String | String in uuid format.
|
136
|
+
|
137
|
+
begin
|
138
|
+
#Lists a group.
|
139
|
+
result = api_instance.fetch_group(group_id)
|
140
|
+
p result
|
141
|
+
rescue MessenteApi::ApiError => e
|
142
|
+
puts "Exception when calling GroupsApi->fetch_group: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
|
149
|
+
Name | Type | Description | Notes
|
150
|
+
------------- | ------------- | ------------- | -------------
|
151
|
+
**group_id** | **String**| String in uuid format. |
|
152
|
+
|
153
|
+
### Return type
|
154
|
+
|
155
|
+
[**GroupEnvelope**](GroupEnvelope.md)
|
156
|
+
|
157
|
+
### Authorization
|
158
|
+
|
159
|
+
[basicAuth](../README.md#basicAuth)
|
160
|
+
|
161
|
+
### HTTP request headers
|
162
|
+
|
163
|
+
- **Content-Type**: Not defined
|
164
|
+
- **Accept**: application/json
|
165
|
+
|
166
|
+
|
167
|
+
## fetch_groups
|
168
|
+
|
169
|
+
> GroupListEnvelope fetch_groups
|
170
|
+
|
171
|
+
Returns all groups.
|
172
|
+
|
173
|
+
### Example
|
174
|
+
|
175
|
+
```ruby
|
176
|
+
# load the gem
|
177
|
+
require 'messente_api'
|
178
|
+
# setup authorization
|
179
|
+
MessenteApi.configure do |config|
|
180
|
+
# Configure HTTP basic authorization: basicAuth
|
181
|
+
config.username = 'YOUR USERNAME'
|
182
|
+
config.password = 'YOUR PASSWORD'
|
183
|
+
end
|
184
|
+
|
185
|
+
api_instance = MessenteApi::GroupsApi.new
|
186
|
+
|
187
|
+
begin
|
188
|
+
#Returns all groups.
|
189
|
+
result = api_instance.fetch_groups
|
190
|
+
p result
|
191
|
+
rescue MessenteApi::ApiError => e
|
192
|
+
puts "Exception when calling GroupsApi->fetch_groups: #{e}"
|
193
|
+
end
|
194
|
+
```
|
195
|
+
|
196
|
+
### Parameters
|
197
|
+
|
198
|
+
This endpoint does not need any parameter.
|
199
|
+
|
200
|
+
### Return type
|
201
|
+
|
202
|
+
[**GroupListEnvelope**](GroupListEnvelope.md)
|
203
|
+
|
204
|
+
### Authorization
|
205
|
+
|
206
|
+
[basicAuth](../README.md#basicAuth)
|
207
|
+
|
208
|
+
### HTTP request headers
|
209
|
+
|
210
|
+
- **Content-Type**: Not defined
|
211
|
+
- **Accept**: application/json
|
212
|
+
|
213
|
+
|
214
|
+
## update_group
|
215
|
+
|
216
|
+
> GroupEnvelope update_group(group_id, group_name)
|
217
|
+
|
218
|
+
Updates a group with the provided name.
|
219
|
+
|
220
|
+
### Example
|
221
|
+
|
222
|
+
```ruby
|
223
|
+
# load the gem
|
224
|
+
require 'messente_api'
|
225
|
+
# setup authorization
|
226
|
+
MessenteApi.configure do |config|
|
227
|
+
# Configure HTTP basic authorization: basicAuth
|
228
|
+
config.username = 'YOUR USERNAME'
|
229
|
+
config.password = 'YOUR PASSWORD'
|
230
|
+
end
|
231
|
+
|
232
|
+
api_instance = MessenteApi::GroupsApi.new
|
233
|
+
group_id = 'group_id_example' # String | String in uuid format.
|
234
|
+
group_name = MessenteApi::GroupName.new # GroupName |
|
235
|
+
|
236
|
+
begin
|
237
|
+
#Updates a group with the provided name.
|
238
|
+
result = api_instance.update_group(group_id, group_name)
|
239
|
+
p result
|
240
|
+
rescue MessenteApi::ApiError => e
|
241
|
+
puts "Exception when calling GroupsApi->update_group: #{e}"
|
242
|
+
end
|
243
|
+
```
|
244
|
+
|
245
|
+
### Parameters
|
246
|
+
|
247
|
+
|
248
|
+
Name | Type | Description | Notes
|
249
|
+
------------- | ------------- | ------------- | -------------
|
250
|
+
**group_id** | **String**| String in uuid format. |
|
251
|
+
**group_name** | [**GroupName**](GroupName.md)| |
|
252
|
+
|
253
|
+
### Return type
|
254
|
+
|
255
|
+
[**GroupEnvelope**](GroupEnvelope.md)
|
256
|
+
|
257
|
+
### Authorization
|
258
|
+
|
259
|
+
[basicAuth](../README.md#basicAuth)
|
260
|
+
|
261
|
+
### HTTP request headers
|
262
|
+
|
263
|
+
- **Content-Type**: application/json
|
264
|
+
- **Accept**: application/json
|
265
|
+
|