825 lines
26 KiB
Markdown
825 lines
26 KiB
Markdown
# memos.MemoServiceApi
|
|
|
|
All URIs are relative to */*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**memo_service_create_memo**](MemoServiceApi.md#memo_service_create_memo) | **POST** /api/v1/memos | CreateMemo creates a memo.
|
|
[**memo_service_create_memo_comment**](MemoServiceApi.md#memo_service_create_memo_comment) | **POST** /api/v1/{name}/comments | CreateMemoComment creates a comment for a memo.
|
|
[**memo_service_delete_memo**](MemoServiceApi.md#memo_service_delete_memo) | **DELETE** /api/v1/{name_4} | DeleteMemo deletes a memo.
|
|
[**memo_service_delete_memo_reaction**](MemoServiceApi.md#memo_service_delete_memo_reaction) | **DELETE** /api/v1/reactions/{reactionId} | DeleteMemoReaction deletes a reaction for a memo.
|
|
[**memo_service_export_memos**](MemoServiceApi.md#memo_service_export_memos) | **POST** /api/v1/memos:export | ExportMemos exports memos.
|
|
[**memo_service_get_memo**](MemoServiceApi.md#memo_service_get_memo) | **GET** /api/v1/{name_3} | GetMemo gets a memo.
|
|
[**memo_service_get_user_memos_stats**](MemoServiceApi.md#memo_service_get_user_memos_stats) | **GET** /api/v1/memos/stats | GetUserMemosStats gets stats of memos for a user.
|
|
[**memo_service_list_memo_comments**](MemoServiceApi.md#memo_service_list_memo_comments) | **GET** /api/v1/{name}/comments | ListMemoComments lists comments for a memo.
|
|
[**memo_service_list_memo_reactions**](MemoServiceApi.md#memo_service_list_memo_reactions) | **GET** /api/v1/{name}/reactions | ListMemoReactions lists reactions for a memo.
|
|
[**memo_service_list_memo_relations**](MemoServiceApi.md#memo_service_list_memo_relations) | **GET** /api/v1/{name}/relations | ListMemoRelations lists relations for a memo.
|
|
[**memo_service_list_memo_resources**](MemoServiceApi.md#memo_service_list_memo_resources) | **GET** /api/v1/{name}/resources | ListMemoResources lists resources for a memo.
|
|
[**memo_service_list_memos**](MemoServiceApi.md#memo_service_list_memos) | **GET** /api/v1/memos | ListMemos lists memos with pagination and filter.
|
|
[**memo_service_search_memos**](MemoServiceApi.md#memo_service_search_memos) | **GET** /api/v1/memos:search | SearchMemos searches memos.
|
|
[**memo_service_set_memo_relations**](MemoServiceApi.md#memo_service_set_memo_relations) | **PATCH** /api/v1/{name}/relations | SetMemoRelations sets relations for a memo.
|
|
[**memo_service_set_memo_resources**](MemoServiceApi.md#memo_service_set_memo_resources) | **PATCH** /api/v1/{name}/resources | SetMemoResources sets resources for a memo.
|
|
[**memo_service_update_memo**](MemoServiceApi.md#memo_service_update_memo) | **PATCH** /api/v1/{memo.name} | UpdateMemo updates a memo.
|
|
[**memo_service_upsert_memo_reaction**](MemoServiceApi.md#memo_service_upsert_memo_reaction) | **POST** /api/v1/{name}/reactions | UpsertMemoReaction upserts a reaction for a memo.
|
|
|
|
# **memo_service_create_memo**
|
|
> V1Memo memo_service_create_memo(body)
|
|
|
|
CreateMemo creates a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
body = memos.V1CreateMemoRequest() # V1CreateMemoRequest |
|
|
|
|
try:
|
|
# CreateMemo creates a memo.
|
|
api_response = api_instance.memo_service_create_memo(body)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_create_memo: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**V1CreateMemoRequest**](V1CreateMemoRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**V1Memo**](V1Memo.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_create_memo_comment**
|
|
> V1Memo memo_service_create_memo_comment(body, name)
|
|
|
|
CreateMemoComment creates a comment for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
body = memos.V1CreateMemoRequest() # V1CreateMemoRequest |
|
|
name = 'name_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# CreateMemoComment creates a comment for a memo.
|
|
api_response = api_instance.memo_service_create_memo_comment(body, name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_create_memo_comment: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**V1CreateMemoRequest**](V1CreateMemoRequest.md)| |
|
|
**name** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
[**V1Memo**](V1Memo.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_delete_memo**
|
|
> object memo_service_delete_memo(name_4)
|
|
|
|
DeleteMemo deletes a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
name_4 = 'name_4_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# DeleteMemo deletes a memo.
|
|
api_response = api_instance.memo_service_delete_memo(name_4)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_delete_memo: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name_4** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
**object**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_delete_memo_reaction**
|
|
> object memo_service_delete_memo_reaction(reaction_id)
|
|
|
|
DeleteMemoReaction deletes a reaction for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
reaction_id = 56 # int |
|
|
|
|
try:
|
|
# DeleteMemoReaction deletes a reaction for a memo.
|
|
api_response = api_instance.memo_service_delete_memo_reaction(reaction_id)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_delete_memo_reaction: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**reaction_id** | **int**| |
|
|
|
|
### Return type
|
|
|
|
**object**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_export_memos**
|
|
> V1ExportMemosResponse memo_service_export_memos(body)
|
|
|
|
ExportMemos exports memos.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
body = memos.V1ExportMemosRequest() # V1ExportMemosRequest |
|
|
|
|
try:
|
|
# ExportMemos exports memos.
|
|
api_response = api_instance.memo_service_export_memos(body)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_export_memos: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**V1ExportMemosRequest**](V1ExportMemosRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**V1ExportMemosResponse**](V1ExportMemosResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_get_memo**
|
|
> V1Memo memo_service_get_memo(name_3)
|
|
|
|
GetMemo gets a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
name_3 = 'name_3_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# GetMemo gets a memo.
|
|
api_response = api_instance.memo_service_get_memo(name_3)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_get_memo: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name_3** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
[**V1Memo**](V1Memo.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_get_user_memos_stats**
|
|
> V1GetUserMemosStatsResponse memo_service_get_user_memos_stats(name=name, timezone=timezone, filter=filter)
|
|
|
|
GetUserMemosStats gets stats of memos for a user.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
name = 'name_example' # str | name is the name of the user to get stats for. Format: users/{id} (optional)
|
|
timezone = 'timezone_example' # str | timezone location Format: uses tz identifier https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)
|
|
filter = 'filter_example' # str | Same as ListMemosRequest.filter (optional)
|
|
|
|
try:
|
|
# GetUserMemosStats gets stats of memos for a user.
|
|
api_response = api_instance.memo_service_get_user_memos_stats(name=name, timezone=timezone, filter=filter)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_get_user_memos_stats: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| name is the name of the user to get stats for. Format: users/{id} | [optional]
|
|
**timezone** | **str**| timezone location Format: uses tz identifier https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | [optional]
|
|
**filter** | **str**| Same as ListMemosRequest.filter | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1GetUserMemosStatsResponse**](V1GetUserMemosStatsResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_list_memo_comments**
|
|
> V1ListMemoCommentsResponse memo_service_list_memo_comments(name)
|
|
|
|
ListMemoComments lists comments for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
name = 'name_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# ListMemoComments lists comments for a memo.
|
|
api_response = api_instance.memo_service_list_memo_comments(name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_list_memo_comments: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
[**V1ListMemoCommentsResponse**](V1ListMemoCommentsResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_list_memo_reactions**
|
|
> V1ListMemoReactionsResponse memo_service_list_memo_reactions(name)
|
|
|
|
ListMemoReactions lists reactions for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
name = 'name_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# ListMemoReactions lists reactions for a memo.
|
|
api_response = api_instance.memo_service_list_memo_reactions(name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_list_memo_reactions: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
[**V1ListMemoReactionsResponse**](V1ListMemoReactionsResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_list_memo_relations**
|
|
> V1ListMemoRelationsResponse memo_service_list_memo_relations(name)
|
|
|
|
ListMemoRelations lists relations for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
name = 'name_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# ListMemoRelations lists relations for a memo.
|
|
api_response = api_instance.memo_service_list_memo_relations(name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_list_memo_relations: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
[**V1ListMemoRelationsResponse**](V1ListMemoRelationsResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_list_memo_resources**
|
|
> V1ListMemoResourcesResponse memo_service_list_memo_resources(name)
|
|
|
|
ListMemoResources lists resources for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
name = 'name_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# ListMemoResources lists resources for a memo.
|
|
api_response = api_instance.memo_service_list_memo_resources(name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_list_memo_resources: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
[**V1ListMemoResourcesResponse**](V1ListMemoResourcesResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_list_memos**
|
|
> V1ListMemosResponse memo_service_list_memos(page_size=page_size, page_token=page_token, filter=filter)
|
|
|
|
ListMemos lists memos with pagination and filter.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
page_size = 56 # int | The maximum number of memos to return. (optional)
|
|
page_token = 'page_token_example' # str | A page token, received from a previous `ListMemos` call. Provide this to retrieve the subsequent page. (optional)
|
|
filter = 'filter_example' # str | Filter is used to filter memos returned in the list. Format: \"creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']\" (optional)
|
|
|
|
try:
|
|
# ListMemos lists memos with pagination and filter.
|
|
api_response = api_instance.memo_service_list_memos(page_size=page_size, page_token=page_token, filter=filter)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_list_memos: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**page_size** | **int**| The maximum number of memos to return. | [optional]
|
|
**page_token** | **str**| A page token, received from a previous `ListMemos` call. Provide this to retrieve the subsequent page. | [optional]
|
|
**filter** | **str**| Filter is used to filter memos returned in the list. Format: \"creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']\" | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1ListMemosResponse**](V1ListMemosResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_search_memos**
|
|
> V1SearchMemosResponse memo_service_search_memos(filter=filter)
|
|
|
|
SearchMemos searches memos.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
filter = 'filter_example' # str | Filter is used to filter memos returned. Format: \"creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']\" (optional)
|
|
|
|
try:
|
|
# SearchMemos searches memos.
|
|
api_response = api_instance.memo_service_search_memos(filter=filter)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_search_memos: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**filter** | **str**| Filter is used to filter memos returned. Format: \"creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']\" | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1SearchMemosResponse**](V1SearchMemosResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_set_memo_relations**
|
|
> object memo_service_set_memo_relations(body, name)
|
|
|
|
SetMemoRelations sets relations for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
body = memos.MemoServiceSetMemoRelationsBody() # MemoServiceSetMemoRelationsBody |
|
|
name = 'name_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# SetMemoRelations sets relations for a memo.
|
|
api_response = api_instance.memo_service_set_memo_relations(body, name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_set_memo_relations: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**MemoServiceSetMemoRelationsBody**](MemoServiceSetMemoRelationsBody.md)| |
|
|
**name** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
**object**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_set_memo_resources**
|
|
> object memo_service_set_memo_resources(body, name)
|
|
|
|
SetMemoResources sets resources for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
body = memos.MemoServiceSetMemoResourcesBody() # MemoServiceSetMemoResourcesBody |
|
|
name = 'name_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# SetMemoResources sets resources for a memo.
|
|
api_response = api_instance.memo_service_set_memo_resources(body, name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_set_memo_resources: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**MemoServiceSetMemoResourcesBody**](MemoServiceSetMemoResourcesBody.md)| |
|
|
**name** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
**object**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_update_memo**
|
|
> V1Memo memo_service_update_memo(body, memo_name)
|
|
|
|
UpdateMemo updates a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
body = memos.V1MemoNameBody() # V1MemoNameBody |
|
|
memo_name = 'memo_name_example' # str | The name of the memo. Format: memos/{id} id is the system generated id.
|
|
|
|
try:
|
|
# UpdateMemo updates a memo.
|
|
api_response = api_instance.memo_service_update_memo(body, memo_name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_update_memo: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**V1MemoNameBody**](V1MemoNameBody.md)| |
|
|
**memo_name** | **str**| The name of the memo. Format: memos/{id} id is the system generated id. |
|
|
|
|
### Return type
|
|
|
|
[**V1Memo**](V1Memo.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **memo_service_upsert_memo_reaction**
|
|
> V1Reaction memo_service_upsert_memo_reaction(body, name)
|
|
|
|
UpsertMemoReaction upserts a reaction for a memo.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MemoServiceApi()
|
|
body = memos.MemoServiceUpsertMemoReactionBody() # MemoServiceUpsertMemoReactionBody |
|
|
name = 'name_example' # str | The name of the memo. Format: memos/{id}
|
|
|
|
try:
|
|
# UpsertMemoReaction upserts a reaction for a memo.
|
|
api_response = api_instance.memo_service_upsert_memo_reaction(body, name)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MemoServiceApi->memo_service_upsert_memo_reaction: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**MemoServiceUpsertMemoReactionBody**](MemoServiceUpsertMemoReactionBody.md)| |
|
|
**name** | **str**| The name of the memo. Format: memos/{id} |
|
|
|
|
### Return type
|
|
|
|
[**V1Reaction**](V1Reaction.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|