docs/GroupsApi.md in messente_api-1.0.1 vs docs/GroupsApi.md in messente_api-1.0.2

- old
+ new

@@ -2,23 +2,23 @@ All URIs are relative to *https://api.messente.com/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_group**](GroupsApi.md#create_group) | **POST** /groups | Creates a new group with the provided name. -[**delete_group**](GroupsApi.md#delete_group) | **DELETE** /groups/{groupId} | Deletes a group. -[**fetch_group**](GroupsApi.md#fetch_group) | **GET** /groups/{groupId} | Lists a group. -[**fetch_groups**](GroupsApi.md#fetch_groups) | **GET** /groups | Returns all groups. -[**update_group**](GroupsApi.md#update_group) | **PUT** /groups/{groupId} | Updates a group with the provided name. +[**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) -Creates a new group with the provided name. +Creates a new group with the provided name ### Example ```ruby # load the gem @@ -32,11 +32,11 @@ api_instance = MessenteApi::GroupsApi.new group_name = MessenteApi::GroupName.new # 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}" end @@ -65,11 +65,11 @@ ## delete_group > delete_group(group_id) -Deletes a group. +Deletes a group ### Example ```ruby # load the gem @@ -80,14 +80,14 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MessenteApi::GroupsApi.new -group_id = 'group_id_example' # String | String in uuid format. +group_id = 'group_id_example' # 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}" end ``` @@ -95,11 +95,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **group_id** | **String**| String in uuid format. | + **group_id** | **String**| String in UUID format | ### Return type nil (empty response body) @@ -115,11 +115,11 @@ ## fetch_group > GroupEnvelope fetch_group(group_id) -Lists a group. +Lists a group ### Example ```ruby # load the gem @@ -130,14 +130,14 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MessenteApi::GroupsApi.new -group_id = 'group_id_example' # String | String in uuid format. +group_id = 'group_id_example' # 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}" end @@ -146,11 +146,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **group_id** | **String**| String in uuid format. | + **group_id** | **String**| String in UUID format | ### Return type [**GroupEnvelope**](GroupEnvelope.md) @@ -166,11 +166,11 @@ ## fetch_groups > GroupListEnvelope fetch_groups -Returns all groups. +Returns all groups ### Example ```ruby # load the gem @@ -183,11 +183,11 @@ 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}" end @@ -213,11 +213,11 @@ ## update_group > GroupEnvelope update_group(group_id, group_name) -Updates a group with the provided name. +Updates a group with the provided name ### Example ```ruby # load the gem @@ -228,15 +228,15 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = MessenteApi::GroupsApi.new -group_id = 'group_id_example' # String | String in uuid format. +group_id = 'group_id_example' # String | String in UUID format group_name = MessenteApi::GroupName.new # 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}" end @@ -245,10 +245,10 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **group_id** | **String**| String in uuid format. | + **group_id** | **String**| String in UUID format | **group_name** | [**GroupName**](GroupName.md)| | ### Return type [**GroupEnvelope**](GroupEnvelope.md)