docs/GroupsApi.md in messente_api-1.4.0 vs docs/GroupsApi.md in messente_api-2.1.0
- old
+ new
@@ -1,56 +1,72 @@
# MessenteApi::GroupsApi
All URIs are relative to *https://api.messente.com/v1*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_group**](GroupsApi.md#create_group) | **POST** /phonebook/groups | Creates a new group with the provided name
-[**delete_group**](GroupsApi.md#delete_group) | **DELETE** /phonebook/groups/{groupId} | Deletes a group
-[**fetch_group**](GroupsApi.md#fetch_group) | **GET** /phonebook/groups/{groupId} | Lists a group
-[**fetch_groups**](GroupsApi.md#fetch_groups) | **GET** /phonebook/groups | Returns all groups
-[**update_group**](GroupsApi.md#update_group) | **PUT** /phonebook/groups/{groupId} | Updates a group with the provided name
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_group**](GroupsApi.md#create_group) | **POST** /phonebook/groups | Creates a new group with the provided name |
+| [**delete_group**](GroupsApi.md#delete_group) | **DELETE** /phonebook/groups/{groupId} | Deletes a group |
+| [**fetch_group**](GroupsApi.md#fetch_group) | **GET** /phonebook/groups/{groupId} | Lists a group |
+| [**fetch_groups**](GroupsApi.md#fetch_groups) | **GET** /phonebook/groups | Returns all groups |
+| [**update_group**](GroupsApi.md#update_group) | **PUT** /phonebook/groups/{groupId} | Updates a group with the provided name |
-
## create_group
-> GroupEnvelope create_group(group_name)
+> <GroupEnvelope> create_group(group_name)
Creates a new group with the provided name
-### Example
+### Examples
```ruby
-# load the gem
+require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = MessenteApi::GroupsApi.new
-group_name = {"name":"Any group name"} # GroupName |
+group_name = MessenteApi::GroupName.new({name: 'name_example'}) # GroupName |
begin
- #Creates a new group with the provided name
+ # Creates a new group with the provided name
result = api_instance.create_group(group_name)
p result
rescue MessenteApi::ApiError => e
- puts "Exception when calling GroupsApi->create_group: #{e}"
+ puts "Error when calling GroupsApi->create_group: #{e}"
end
```
-### Parameters
+#### Using the create_group_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **group_name** | [**GroupName**](GroupName.md)| |
+> <Array(<GroupEnvelope>, Integer, Hash)> create_group_with_http_info(group_name)
+```ruby
+begin
+ # Creates a new group with the provided name
+ data, status_code, headers = api_instance.create_group_with_http_info(group_name)
+ p status_code # => 2xx
+ p headers # => { ... }
+ p data # => <GroupEnvelope>
+rescue MessenteApi::ApiError => e
+ puts "Error when calling GroupsApi->create_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_name** | [**GroupName**](GroupName.md) | | |
+
### Return type
[**GroupEnvelope**](GroupEnvelope.md)
### Authorization
@@ -67,14 +83,14 @@
> delete_group(group_id)
Deletes a group
-### Example
+### Examples
```ruby
-# load the gem
+require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
@@ -83,24 +99,41 @@
api_instance = MessenteApi::GroupsApi.new
group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # String | String in UUID format
begin
- #Deletes a group
+ # Deletes a group
api_instance.delete_group(group_id)
rescue MessenteApi::ApiError => e
- puts "Exception when calling GroupsApi->delete_group: #{e}"
+ puts "Error when calling GroupsApi->delete_group: #{e}"
end
```
-### Parameters
+#### Using the delete_group_with_http_info variant
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in UUID format |
+> <Array(nil, Integer, Hash)> delete_group_with_http_info(group_id)
+```ruby
+begin
+ # Deletes a group
+ data, status_code, headers = api_instance.delete_group_with_http_info(group_id)
+ p status_code # => 2xx
+ p headers # => { ... }
+ p data # => nil
+rescue MessenteApi::ApiError => e
+ puts "Error when calling GroupsApi->delete_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_id** | **String** | String in UUID format | |
+
### Return type
nil (empty response body)
### Authorization
@@ -113,18 +146,18 @@
- **Accept**: application/json
## fetch_group
-> GroupEnvelope fetch_group(group_id)
+> <GroupEnvelope> fetch_group(group_id)
Lists a group
-### Example
+### Examples
```ruby
-# load the gem
+require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
@@ -133,25 +166,42 @@
api_instance = MessenteApi::GroupsApi.new
group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # String | String in UUID format
begin
- #Lists a group
+ # Lists a group
result = api_instance.fetch_group(group_id)
p result
rescue MessenteApi::ApiError => e
- puts "Exception when calling GroupsApi->fetch_group: #{e}"
+ puts "Error when calling GroupsApi->fetch_group: #{e}"
end
```
-### Parameters
+#### Using the fetch_group_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in UUID format |
+> <Array(<GroupEnvelope>, Integer, Hash)> fetch_group_with_http_info(group_id)
+```ruby
+begin
+ # Lists a group
+ data, status_code, headers = api_instance.fetch_group_with_http_info(group_id)
+ p status_code # => 2xx
+ p headers # => { ... }
+ p data # => <GroupEnvelope>
+rescue MessenteApi::ApiError => e
+ puts "Error when calling GroupsApi->fetch_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_id** | **String** | String in UUID format | |
+
### Return type
[**GroupEnvelope**](GroupEnvelope.md)
### Authorization
@@ -164,18 +214,18 @@
- **Accept**: application/json
## fetch_groups
-> GroupListEnvelope fetch_groups
+> <GroupListEnvelope> fetch_groups
Returns all groups
-### Example
+### Examples
```ruby
-# load the gem
+require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
@@ -183,18 +233,36 @@
end
api_instance = MessenteApi::GroupsApi.new
begin
- #Returns all groups
+ # Returns all groups
result = api_instance.fetch_groups
p result
rescue MessenteApi::ApiError => e
- puts "Exception when calling GroupsApi->fetch_groups: #{e}"
+ puts "Error when calling GroupsApi->fetch_groups: #{e}"
end
```
+#### Using the fetch_groups_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GroupListEnvelope>, Integer, Hash)> fetch_groups_with_http_info
+
+```ruby
+begin
+ # Returns all groups
+ data, status_code, headers = api_instance.fetch_groups_with_http_info
+ p status_code # => 2xx
+ p headers # => { ... }
+ p data # => <GroupListEnvelope>
+rescue MessenteApi::ApiError => e
+ puts "Error when calling GroupsApi->fetch_groups_with_http_info: #{e}"
+end
+```
+
### Parameters
This endpoint does not need any parameter.
### Return type
@@ -211,45 +279,62 @@
- **Accept**: application/json
## update_group
-> GroupEnvelope update_group(group_id, group_name)
+> <GroupEnvelope> update_group(group_id, group_name)
Updates a group with the provided name
-### Example
+### Examples
```ruby
-# load the gem
+require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = MessenteApi::GroupsApi.new
group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # String | String in UUID format
-group_name = {"name":"Any group name"} # GroupName |
+group_name = MessenteApi::GroupName.new({name: 'name_example'}) # GroupName |
begin
- #Updates a group with the provided name
+ # Updates a group with the provided name
result = api_instance.update_group(group_id, group_name)
p result
rescue MessenteApi::ApiError => e
- puts "Exception when calling GroupsApi->update_group: #{e}"
+ puts "Error when calling GroupsApi->update_group: #{e}"
end
```
-### Parameters
+#### Using the update_group_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in UUID format |
- **group_name** | [**GroupName**](GroupName.md)| |
+> <Array(<GroupEnvelope>, Integer, Hash)> update_group_with_http_info(group_id, group_name)
+
+```ruby
+begin
+ # Updates a group with the provided name
+ data, status_code, headers = api_instance.update_group_with_http_info(group_id, group_name)
+ p status_code # => 2xx
+ p headers # => { ... }
+ p data # => <GroupEnvelope>
+rescue MessenteApi::ApiError => e
+ puts "Error when calling GroupsApi->update_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_id** | **String** | String in UUID format | |
+| **group_name** | [**GroupName**](GroupName.md) | | |
### Return type
[**GroupEnvelope**](GroupEnvelope.md)