feat: 增加 memos api client； 增加给带链接 memo 增加 tag 的脚本
This commit is contained in:
Ching
parent
36b1e16200
commit
000e0252cd
108
.gitignore
vendored
108
.gitignore
vendored
@ -1,4 +1,3 @@
|
|||||||
# ---> Python
|
|
||||||
# Byte-compiled / optimized / DLL files
|
# Byte-compiled / optimized / DLL files
|
||||||
__pycache__/
|
__pycache__/
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
@ -9,6 +8,7 @@ __pycache__/
|
|||||||
|
|
||||||
# Distribution / packaging
|
# Distribution / packaging
|
||||||
.Python
|
.Python
|
||||||
|
env/
|
||||||
build/
|
build/
|
||||||
develop-eggs/
|
develop-eggs/
|
||||||
dist/
|
dist/
|
||||||
@ -20,12 +20,9 @@ lib64/
|
|||||||
parts/
|
parts/
|
||||||
sdist/
|
sdist/
|
||||||
var/
|
var/
|
||||||
wheels/
|
|
||||||
share/python-wheels/
|
|
||||||
*.egg-info/
|
*.egg-info/
|
||||||
.installed.cfg
|
.installed.cfg
|
||||||
*.egg
|
*.egg
|
||||||
MANIFEST
|
|
||||||
|
|
||||||
# PyInstaller
|
# PyInstaller
|
||||||
# Usually these files are written by a python script from a template
|
# Usually these files are written by a python script from a template
|
||||||
@ -40,17 +37,15 @@ pip-delete-this-directory.txt
|
|||||||
# Unit test / coverage reports
|
# Unit test / coverage reports
|
||||||
htmlcov/
|
htmlcov/
|
||||||
.tox/
|
.tox/
|
||||||
.nox/
|
|
||||||
.coverage
|
.coverage
|
||||||
.coverage.*
|
.coverage.*
|
||||||
.cache
|
.cache
|
||||||
nosetests.xml
|
nosetests.xml
|
||||||
coverage.xml
|
coverage.xml
|
||||||
*.cover
|
*,cover
|
||||||
*.py,cover
|
|
||||||
.hypothesis/
|
.hypothesis/
|
||||||
.pytest_cache/
|
venv/
|
||||||
cover/
|
.python-version
|
||||||
|
|
||||||
# Translations
|
# Translations
|
||||||
*.mo
|
*.mo
|
||||||
@ -58,105 +53,12 @@ cover/
|
|||||||
|
|
||||||
# Django stuff:
|
# Django stuff:
|
||||||
*.log
|
*.log
|
||||||
local_settings.py
|
|
||||||
db.sqlite3
|
|
||||||
db.sqlite3-journal
|
|
||||||
|
|
||||||
# Flask stuff:
|
|
||||||
instance/
|
|
||||||
.webassets-cache
|
|
||||||
|
|
||||||
# Scrapy stuff:
|
|
||||||
.scrapy
|
|
||||||
|
|
||||||
# Sphinx documentation
|
# Sphinx documentation
|
||||||
docs/_build/
|
docs/_build/
|
||||||
|
|
||||||
# PyBuilder
|
# PyBuilder
|
||||||
.pybuilder/
|
|
||||||
target/
|
target/
|
||||||
|
|
||||||
# Jupyter Notebook
|
#Ipython Notebook
|
||||||
.ipynb_checkpoints
|
.ipynb_checkpoints
|
||||||
|
|
||||||
# IPython
|
|
||||||
profile_default/
|
|
||||||
ipython_config.py
|
|
||||||
|
|
||||||
# pyenv
|
|
||||||
# For a library or package, you might want to ignore these files since the code is
|
|
||||||
# intended to run in multiple environments; otherwise, check them in:
|
|
||||||
# .python-version
|
|
||||||
|
|
||||||
# pipenv
|
|
||||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
||||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
||||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
||||||
# install all needed dependencies.
|
|
||||||
#Pipfile.lock
|
|
||||||
|
|
||||||
# poetry
|
|
||||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
||||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
||||||
# commonly ignored for libraries.
|
|
||||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
||||||
#poetry.lock
|
|
||||||
|
|
||||||
# pdm
|
|
||||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
||||||
#pdm.lock
|
|
||||||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
||||||
# in version control.
|
|
||||||
# https://pdm.fming.dev/#use-with-ide
|
|
||||||
.pdm.toml
|
|
||||||
|
|
||||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
||||||
__pypackages__/
|
|
||||||
|
|
||||||
# Celery stuff
|
|
||||||
celerybeat-schedule
|
|
||||||
celerybeat.pid
|
|
||||||
|
|
||||||
# SageMath parsed files
|
|
||||||
*.sage.py
|
|
||||||
|
|
||||||
# Environments
|
|
||||||
.env
|
|
||||||
.venv
|
|
||||||
env/
|
|
||||||
venv/
|
|
||||||
ENV/
|
|
||||||
env.bak/
|
|
||||||
venv.bak/
|
|
||||||
|
|
||||||
# Spyder project settings
|
|
||||||
.spyderproject
|
|
||||||
.spyproject
|
|
||||||
|
|
||||||
# Rope project settings
|
|
||||||
.ropeproject
|
|
||||||
|
|
||||||
# mkdocs documentation
|
|
||||||
/site
|
|
||||||
|
|
||||||
# mypy
|
|
||||||
.mypy_cache/
|
|
||||||
.dmypy.json
|
|
||||||
dmypy.json
|
|
||||||
|
|
||||||
# Pyre type checker
|
|
||||||
.pyre/
|
|
||||||
|
|
||||||
# pytype static type analyzer
|
|
||||||
.pytype/
|
|
||||||
|
|
||||||
# Cython debug symbols
|
|
||||||
cython_debug/
|
|
||||||
|
|
||||||
# PyCharm
|
|
||||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
||||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
||||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
||||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
||||||
#.idea/
|
|
||||||
|
|
||||||
|
|||||||
23
.swagger-codegen-ignore
Normal file
23
.swagger-codegen-ignore
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# Swagger Codegen Ignore
|
||||||
|
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
|
||||||
|
|
||||||
|
# Use this file to prevent files from being overwritten by the generator.
|
||||||
|
# The patterns follow closely to .gitignore or .dockerignore.
|
||||||
|
|
||||||
|
# As an example, the C# client generator defines ApiClient.cs.
|
||||||
|
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
|
||||||
|
#ApiClient.cs
|
||||||
|
|
||||||
|
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||||
|
#foo/*/qux
|
||||||
|
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||||
|
|
||||||
|
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||||
|
#foo/**/qux
|
||||||
|
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||||
|
|
||||||
|
# You can also negate patterns with an exclamation (!).
|
||||||
|
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||||
|
#docs/*.md
|
||||||
|
# Then explicitly reverse the ignore rule for a single file:
|
||||||
|
#!docs/README.md
|
||||||
1
.swagger-codegen/VERSION
Normal file
1
.swagger-codegen/VERSION
Normal file
@ -0,0 +1 @@
|
|||||||
|
3.0.46
|
||||||
13
.travis.yml
Normal file
13
.travis.yml
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# ref: https://docs.travis-ci.com/user/languages/python
|
||||||
|
language: python
|
||||||
|
python:
|
||||||
|
- "3.2"
|
||||||
|
- "3.3"
|
||||||
|
- "3.4"
|
||||||
|
- "3.5"
|
||||||
|
#- "3.5-dev" # 3.5 development branch
|
||||||
|
#- "nightly" # points to the latest development branch e.g. 3.6-dev
|
||||||
|
# command to install dependencies
|
||||||
|
install: "pip install -r requirements.txt"
|
||||||
|
# command to run tests
|
||||||
|
script: nosetests
|
||||||
234
README.md
234
README.md
@ -1,2 +1,234 @@
|
|||||||
# memos-script
|
# memos-python
|
||||||
|
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
||||||
|
|
||||||
|
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
||||||
|
|
||||||
|
- API version: version not set
|
||||||
|
- Package version: 1.0.0
|
||||||
|
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
|
||||||
|
|
||||||
|
## Requirements.
|
||||||
|
|
||||||
|
Python 2.7 and 3.4+
|
||||||
|
|
||||||
|
## Installation & Usage
|
||||||
|
### pip install
|
||||||
|
|
||||||
|
If the python package is hosted on Github, you can install directly from Github
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pip install git+https://github.com/looching/memos-python.git
|
||||||
|
```
|
||||||
|
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/looching/memos-python.git`)
|
||||||
|
|
||||||
|
Then import the package:
|
||||||
|
```python
|
||||||
|
import memos
|
||||||
|
```
|
||||||
|
|
||||||
|
### Setuptools
|
||||||
|
|
||||||
|
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python setup.py install --user
|
||||||
|
```
|
||||||
|
(or `sudo python setup.py install` to install the package for all users)
|
||||||
|
|
||||||
|
Then import the package:
|
||||||
|
```python
|
||||||
|
import memos
|
||||||
|
```
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Please follow the [installation procedure](#installation--usage) and then run the following:
|
||||||
|
|
||||||
|
```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.ActivityServiceApi(memos.ApiClient(configuration))
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetActivity returns the activity with the given id.
|
||||||
|
api_response = api_instance.activity_service_get_activity(id)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling ActivityServiceApi->activity_service_get_activity: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation for API Endpoints
|
||||||
|
|
||||||
|
All URIs are relative to */*
|
||||||
|
|
||||||
|
Class | Method | HTTP request | Description
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
*ActivityServiceApi* | [**activity_service_get_activity**](docs/ActivityServiceApi.md#activity_service_get_activity) | **GET** /v2/activities/{id} | GetActivity returns the activity with the given id.
|
||||||
|
*AuthServiceApi* | [**auth_service_get_auth_status**](docs/AuthServiceApi.md#auth_service_get_auth_status) | **POST** /api/v2/auth/status | GetAuthStatus returns the current auth status of the user.
|
||||||
|
*AuthServiceApi* | [**auth_service_sign_in**](docs/AuthServiceApi.md#auth_service_sign_in) | **POST** /api/v2/auth/signin | SignIn signs in the user with the given username and password.
|
||||||
|
*AuthServiceApi* | [**auth_service_sign_in_with_sso**](docs/AuthServiceApi.md#auth_service_sign_in_with_sso) | **POST** /api/v2/auth/signin/sso | SignInWithSSO signs in the user with the given SSO code.
|
||||||
|
*AuthServiceApi* | [**auth_service_sign_out**](docs/AuthServiceApi.md#auth_service_sign_out) | **POST** /api/v2/auth/signout | SignOut signs out the user.
|
||||||
|
*AuthServiceApi* | [**auth_service_sign_up**](docs/AuthServiceApi.md#auth_service_sign_up) | **POST** /api/v2/auth/signup | SignUp signs up the user with the given username and password.
|
||||||
|
*InboxServiceApi* | [**inbox_service_delete_inbox**](docs/InboxServiceApi.md#inbox_service_delete_inbox) | **DELETE** /api/v2/{name_1} | DeleteInbox deletes an inbox.
|
||||||
|
*InboxServiceApi* | [**inbox_service_list_inboxes**](docs/InboxServiceApi.md#inbox_service_list_inboxes) | **GET** /api/v2/inboxes | ListInboxes lists inboxes for a user.
|
||||||
|
*InboxServiceApi* | [**inbox_service_update_inbox**](docs/InboxServiceApi.md#inbox_service_update_inbox) | **PATCH** /api/v2/{inbox.name} | UpdateInbox updates an inbox.
|
||||||
|
*MemoServiceApi* | [**memo_service_create_memo**](docs/MemoServiceApi.md#memo_service_create_memo) | **POST** /api/v2/memos | CreateMemo creates a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_create_memo_comment**](docs/MemoServiceApi.md#memo_service_create_memo_comment) | **POST** /api/v2/memos/{id}/comments | CreateMemoComment creates a comment for a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_delete_memo**](docs/MemoServiceApi.md#memo_service_delete_memo) | **DELETE** /api/v2/memos/{id} | DeleteMemo deletes a memo by id.
|
||||||
|
*MemoServiceApi* | [**memo_service_delete_memo_reaction**](docs/MemoServiceApi.md#memo_service_delete_memo_reaction) | **DELETE** /api/v2/memos/{id}/reactions/{reactionId} | DeleteMemoReaction deletes a reaction for a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_export_memos**](docs/MemoServiceApi.md#memo_service_export_memos) | **POST** /api/v2/memos:export | ExportMemos exports memos.
|
||||||
|
*MemoServiceApi* | [**memo_service_get_memo**](docs/MemoServiceApi.md#memo_service_get_memo) | **GET** /api/v2/memos/{id} | GetMemo gets a memo by id.
|
||||||
|
*MemoServiceApi* | [**memo_service_get_memo_by_name**](docs/MemoServiceApi.md#memo_service_get_memo_by_name) | **GET** /api/v2/memos/name/{name} | GetMemoByName gets a memo by name.
|
||||||
|
*MemoServiceApi* | [**memo_service_get_user_memos_stats**](docs/MemoServiceApi.md#memo_service_get_user_memos_stats) | **GET** /api/v2/memos/stats | GetUserMemosStats gets stats of memos for a user.
|
||||||
|
*MemoServiceApi* | [**memo_service_list_memo_comments**](docs/MemoServiceApi.md#memo_service_list_memo_comments) | **GET** /api/v2/memos/{id}/comments | ListMemoComments lists comments for a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_list_memo_reactions**](docs/MemoServiceApi.md#memo_service_list_memo_reactions) | **GET** /api/v2/memos/{id}/reactions | ListMemoReactions lists reactions for a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_list_memo_relations**](docs/MemoServiceApi.md#memo_service_list_memo_relations) | **GET** /api/v2/memos/{id}/relations | ListMemoRelations lists relations for a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_list_memo_resources**](docs/MemoServiceApi.md#memo_service_list_memo_resources) | **GET** /api/v2/memos/{id}/resources | ListMemoResources lists resources for a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_list_memos**](docs/MemoServiceApi.md#memo_service_list_memos) | **GET** /api/v2/memos | ListMemos lists memos with pagination and filter.
|
||||||
|
*MemoServiceApi* | [**memo_service_set_memo_relations**](docs/MemoServiceApi.md#memo_service_set_memo_relations) | **POST** /api/v2/memos/{id}/relations | SetMemoRelations sets relations for a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_set_memo_resources**](docs/MemoServiceApi.md#memo_service_set_memo_resources) | **POST** /api/v2/memos/{id}/resources | SetMemoResources sets resources for a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_update_memo**](docs/MemoServiceApi.md#memo_service_update_memo) | **PATCH** /api/v2/memos/{memo.id} | UpdateMemo updates a memo.
|
||||||
|
*MemoServiceApi* | [**memo_service_upsert_memo_reaction**](docs/MemoServiceApi.md#memo_service_upsert_memo_reaction) | **POST** /api/v2/memos/{id}/reactions | UpsertMemoReaction upserts a reaction for a memo.
|
||||||
|
*ResourceServiceApi* | [**resource_service_create_resource**](docs/ResourceServiceApi.md#resource_service_create_resource) | **POST** /api/v2/resources | CreateResource creates a new resource.
|
||||||
|
*ResourceServiceApi* | [**resource_service_delete_resource**](docs/ResourceServiceApi.md#resource_service_delete_resource) | **DELETE** /api/v2/resources/{id} | DeleteResource deletes a resource by id.
|
||||||
|
*ResourceServiceApi* | [**resource_service_get_resource**](docs/ResourceServiceApi.md#resource_service_get_resource) | **GET** /api/v2/resources/{id} | GetResource returns a resource by id.
|
||||||
|
*ResourceServiceApi* | [**resource_service_get_resource_by_name**](docs/ResourceServiceApi.md#resource_service_get_resource_by_name) | **GET** /api/v2/resources/name/{name} | GetResourceByName returns a resource by name.
|
||||||
|
*ResourceServiceApi* | [**resource_service_list_resources**](docs/ResourceServiceApi.md#resource_service_list_resources) | **GET** /api/v2/resources | ListResources lists all resources.
|
||||||
|
*ResourceServiceApi* | [**resource_service_update_resource**](docs/ResourceServiceApi.md#resource_service_update_resource) | **PATCH** /api/v2/resources/{resource.id} | UpdateResource updates a resource.
|
||||||
|
*TagServiceApi* | [**tag_service_batch_upsert_tag**](docs/TagServiceApi.md#tag_service_batch_upsert_tag) | **POST** /api/v2/tags:batchUpsert | BatchUpsertTag upserts multiple tags.
|
||||||
|
*TagServiceApi* | [**tag_service_delete_tag**](docs/TagServiceApi.md#tag_service_delete_tag) | **DELETE** /api/v2/tags | DeleteTag deletes a tag.
|
||||||
|
*TagServiceApi* | [**tag_service_get_tag_suggestions**](docs/TagServiceApi.md#tag_service_get_tag_suggestions) | **GET** /api/v2/tags/suggestion | GetTagSuggestions gets tag suggestions from the user's memos.
|
||||||
|
*TagServiceApi* | [**tag_service_list_tags**](docs/TagServiceApi.md#tag_service_list_tags) | **GET** /api/v2/tags | ListTags lists tags.
|
||||||
|
*TagServiceApi* | [**tag_service_rename_tag**](docs/TagServiceApi.md#tag_service_rename_tag) | **PATCH** /api/v2/tags:rename | RenameTag renames a tag. All related memos will be updated.
|
||||||
|
*TagServiceApi* | [**tag_service_upsert_tag**](docs/TagServiceApi.md#tag_service_upsert_tag) | **POST** /api/v2/tags | UpsertTag upserts a tag.
|
||||||
|
*UserServiceApi* | [**user_service_create_user**](docs/UserServiceApi.md#user_service_create_user) | **POST** /api/v2/users | CreateUser creates a new user.
|
||||||
|
*UserServiceApi* | [**user_service_create_user_access_token**](docs/UserServiceApi.md#user_service_create_user_access_token) | **POST** /api/v2/{name}/access_tokens | CreateUserAccessToken creates a new access token for a user.
|
||||||
|
*UserServiceApi* | [**user_service_delete_user**](docs/UserServiceApi.md#user_service_delete_user) | **DELETE** /api/v2/{name} | DeleteUser deletes a user.
|
||||||
|
*UserServiceApi* | [**user_service_delete_user_access_token**](docs/UserServiceApi.md#user_service_delete_user_access_token) | **DELETE** /api/v2/{name}/access_tokens/{accessToken} | DeleteUserAccessToken deletes an access token for a user.
|
||||||
|
*UserServiceApi* | [**user_service_get_user**](docs/UserServiceApi.md#user_service_get_user) | **GET** /api/v2/{name} | GetUser gets a user by name.
|
||||||
|
*UserServiceApi* | [**user_service_get_user_setting**](docs/UserServiceApi.md#user_service_get_user_setting) | **GET** /api/v2/{name}/setting | GetUserSetting gets the setting of a user.
|
||||||
|
*UserServiceApi* | [**user_service_list_user_access_tokens**](docs/UserServiceApi.md#user_service_list_user_access_tokens) | **GET** /api/v2/{name}/access_tokens | ListUserAccessTokens returns a list of access tokens for a user.
|
||||||
|
*UserServiceApi* | [**user_service_list_users**](docs/UserServiceApi.md#user_service_list_users) | **GET** /api/v2/users | ListUsers returns a list of users.
|
||||||
|
*UserServiceApi* | [**user_service_update_user**](docs/UserServiceApi.md#user_service_update_user) | **PATCH** /api/v2/{user.name} | UpdateUser updates a user.
|
||||||
|
*UserServiceApi* | [**user_service_update_user_setting**](docs/UserServiceApi.md#user_service_update_user_setting) | **PATCH** /api/v2/{setting.name} | UpdateUserSetting updates the setting of a user.
|
||||||
|
*WebhookServiceApi* | [**webhook_service_create_webhook**](docs/WebhookServiceApi.md#webhook_service_create_webhook) | **POST** /api/v2/webhooks | CreateWebhook creates a new webhook.
|
||||||
|
*WebhookServiceApi* | [**webhook_service_delete_webhook**](docs/WebhookServiceApi.md#webhook_service_delete_webhook) | **DELETE** /api/v2/webhooks/{id} | DeleteWebhook deletes a webhook by id.
|
||||||
|
*WebhookServiceApi* | [**webhook_service_get_webhook**](docs/WebhookServiceApi.md#webhook_service_get_webhook) | **GET** /api/v2/webhooks/{id} | GetWebhook returns a webhook by id.
|
||||||
|
*WebhookServiceApi* | [**webhook_service_list_webhooks**](docs/WebhookServiceApi.md#webhook_service_list_webhooks) | **GET** /api/v2/webhooks | ListWebhooks returns a list of webhooks.
|
||||||
|
*WebhookServiceApi* | [**webhook_service_update_webhook**](docs/WebhookServiceApi.md#webhook_service_update_webhook) | **PATCH** /api/v2/webhooks/{webhook.id} | UpdateWebhook updates a webhook.
|
||||||
|
*WorkspaceServiceApi* | [**workspace_service_get_workspace_profile**](docs/WorkspaceServiceApi.md#workspace_service_get_workspace_profile) | **GET** /api/v2/workspace/profile | GetWorkspaceProfile returns the workspace profile.
|
||||||
|
*WorkspaceSettingServiceApi* | [**workspace_setting_service_get_workspace_setting**](docs/WorkspaceSettingServiceApi.md#workspace_setting_service_get_workspace_setting) | **GET** /api/v2/workspace/{name} | GetWorkspaceSetting returns the setting by name.
|
||||||
|
*WorkspaceSettingServiceApi* | [**workspace_setting_service_set_workspace_setting**](docs/WorkspaceSettingServiceApi.md#workspace_setting_service_set_workspace_setting) | **PATCH** /api/v2/workspace/{setting.name} | SetWorkspaceSetting updates the setting.
|
||||||
|
|
||||||
|
## Documentation For Models
|
||||||
|
|
||||||
|
- [Apiv2ActivityMemoCommentPayload](docs/Apiv2ActivityMemoCommentPayload.md)
|
||||||
|
- [Apiv2ActivityPayload](docs/Apiv2ActivityPayload.md)
|
||||||
|
- [Apiv2ActivityVersionUpdatePayload](docs/Apiv2ActivityVersionUpdatePayload.md)
|
||||||
|
- [Apiv2Reaction](docs/Apiv2Reaction.md)
|
||||||
|
- [Apiv2ReactionType](docs/Apiv2ReactionType.md)
|
||||||
|
- [Apiv2RowStatus](docs/Apiv2RowStatus.md)
|
||||||
|
- [Apiv2UserSetting](docs/Apiv2UserSetting.md)
|
||||||
|
- [Apiv2Webhook](docs/Apiv2Webhook.md)
|
||||||
|
- [Apiv2WorkspaceGeneralSetting](docs/Apiv2WorkspaceGeneralSetting.md)
|
||||||
|
- [Apiv2WorkspaceSetting](docs/Apiv2WorkspaceSetting.md)
|
||||||
|
- [GooglerpcStatus](docs/GooglerpcStatus.md)
|
||||||
|
- [MemoServiceSetMemoRelationsBody](docs/MemoServiceSetMemoRelationsBody.md)
|
||||||
|
- [MemoServiceSetMemoResourcesBody](docs/MemoServiceSetMemoResourcesBody.md)
|
||||||
|
- [MemosMemoIdBody](docs/MemosMemoIdBody.md)
|
||||||
|
- [ProtobufAny](docs/ProtobufAny.md)
|
||||||
|
- [ResourcesResourceIdBody](docs/ResourcesResourceIdBody.md)
|
||||||
|
- [SettingIsTheSettingToUpdate_](docs/SettingIsTheSettingToUpdate_.md)
|
||||||
|
- [UserRole](docs/UserRole.md)
|
||||||
|
- [UserServiceCreateUserAccessTokenBody](docs/UserServiceCreateUserAccessTokenBody.md)
|
||||||
|
- [V2Activity](docs/V2Activity.md)
|
||||||
|
- [V2BatchUpsertTagResponse](docs/V2BatchUpsertTagResponse.md)
|
||||||
|
- [V2CreateMemoCommentResponse](docs/V2CreateMemoCommentResponse.md)
|
||||||
|
- [V2CreateMemoRequest](docs/V2CreateMemoRequest.md)
|
||||||
|
- [V2CreateMemoResponse](docs/V2CreateMemoResponse.md)
|
||||||
|
- [V2CreateResourceResponse](docs/V2CreateResourceResponse.md)
|
||||||
|
- [V2CreateUserAccessTokenResponse](docs/V2CreateUserAccessTokenResponse.md)
|
||||||
|
- [V2CreateUserResponse](docs/V2CreateUserResponse.md)
|
||||||
|
- [V2CreateWebhookRequest](docs/V2CreateWebhookRequest.md)
|
||||||
|
- [V2CreateWebhookResponse](docs/V2CreateWebhookResponse.md)
|
||||||
|
- [V2DeleteInboxResponse](docs/V2DeleteInboxResponse.md)
|
||||||
|
- [V2DeleteMemoReactionResponse](docs/V2DeleteMemoReactionResponse.md)
|
||||||
|
- [V2DeleteMemoResponse](docs/V2DeleteMemoResponse.md)
|
||||||
|
- [V2DeleteResourceResponse](docs/V2DeleteResourceResponse.md)
|
||||||
|
- [V2DeleteTagResponse](docs/V2DeleteTagResponse.md)
|
||||||
|
- [V2DeleteUserAccessTokenResponse](docs/V2DeleteUserAccessTokenResponse.md)
|
||||||
|
- [V2DeleteUserResponse](docs/V2DeleteUserResponse.md)
|
||||||
|
- [V2DeleteWebhookResponse](docs/V2DeleteWebhookResponse.md)
|
||||||
|
- [V2ExportMemosResponse](docs/V2ExportMemosResponse.md)
|
||||||
|
- [V2GetActivityResponse](docs/V2GetActivityResponse.md)
|
||||||
|
- [V2GetAuthStatusResponse](docs/V2GetAuthStatusResponse.md)
|
||||||
|
- [V2GetMemoByNameResponse](docs/V2GetMemoByNameResponse.md)
|
||||||
|
- [V2GetMemoResponse](docs/V2GetMemoResponse.md)
|
||||||
|
- [V2GetResourceByNameResponse](docs/V2GetResourceByNameResponse.md)
|
||||||
|
- [V2GetResourceResponse](docs/V2GetResourceResponse.md)
|
||||||
|
- [V2GetTagSuggestionsResponse](docs/V2GetTagSuggestionsResponse.md)
|
||||||
|
- [V2GetUserMemosStatsResponse](docs/V2GetUserMemosStatsResponse.md)
|
||||||
|
- [V2GetUserResponse](docs/V2GetUserResponse.md)
|
||||||
|
- [V2GetUserSettingResponse](docs/V2GetUserSettingResponse.md)
|
||||||
|
- [V2GetWebhookResponse](docs/V2GetWebhookResponse.md)
|
||||||
|
- [V2GetWorkspaceProfileResponse](docs/V2GetWorkspaceProfileResponse.md)
|
||||||
|
- [V2GetWorkspaceSettingResponse](docs/V2GetWorkspaceSettingResponse.md)
|
||||||
|
- [V2Inbox](docs/V2Inbox.md)
|
||||||
|
- [V2InboxNameBody](docs/V2InboxNameBody.md)
|
||||||
|
- [V2InboxStatus](docs/V2InboxStatus.md)
|
||||||
|
- [V2InboxType](docs/V2InboxType.md)
|
||||||
|
- [V2ListInboxesResponse](docs/V2ListInboxesResponse.md)
|
||||||
|
- [V2ListMemoCommentsResponse](docs/V2ListMemoCommentsResponse.md)
|
||||||
|
- [V2ListMemoReactionsResponse](docs/V2ListMemoReactionsResponse.md)
|
||||||
|
- [V2ListMemoRelationsResponse](docs/V2ListMemoRelationsResponse.md)
|
||||||
|
- [V2ListMemoResourcesResponse](docs/V2ListMemoResourcesResponse.md)
|
||||||
|
- [V2ListMemosResponse](docs/V2ListMemosResponse.md)
|
||||||
|
- [V2ListResourcesResponse](docs/V2ListResourcesResponse.md)
|
||||||
|
- [V2ListTagsResponse](docs/V2ListTagsResponse.md)
|
||||||
|
- [V2ListUserAccessTokensResponse](docs/V2ListUserAccessTokensResponse.md)
|
||||||
|
- [V2ListUsersResponse](docs/V2ListUsersResponse.md)
|
||||||
|
- [V2ListWebhooksResponse](docs/V2ListWebhooksResponse.md)
|
||||||
|
- [V2Memo](docs/V2Memo.md)
|
||||||
|
- [V2MemoRelation](docs/V2MemoRelation.md)
|
||||||
|
- [V2MemoRelationType](docs/V2MemoRelationType.md)
|
||||||
|
- [V2RenameTagResponse](docs/V2RenameTagResponse.md)
|
||||||
|
- [V2Resource](docs/V2Resource.md)
|
||||||
|
- [V2SetMemoRelationsResponse](docs/V2SetMemoRelationsResponse.md)
|
||||||
|
- [V2SetMemoResourcesResponse](docs/V2SetMemoResourcesResponse.md)
|
||||||
|
- [V2SetWorkspaceSettingResponse](docs/V2SetWorkspaceSettingResponse.md)
|
||||||
|
- [V2SettingNameBody](docs/V2SettingNameBody.md)
|
||||||
|
- [V2SignInResponse](docs/V2SignInResponse.md)
|
||||||
|
- [V2SignInWithSSOResponse](docs/V2SignInWithSSOResponse.md)
|
||||||
|
- [V2SignOutResponse](docs/V2SignOutResponse.md)
|
||||||
|
- [V2SignUpResponse](docs/V2SignUpResponse.md)
|
||||||
|
- [V2Tag](docs/V2Tag.md)
|
||||||
|
- [V2UpdateInboxResponse](docs/V2UpdateInboxResponse.md)
|
||||||
|
- [V2UpdateMemoResponse](docs/V2UpdateMemoResponse.md)
|
||||||
|
- [V2UpdateResourceResponse](docs/V2UpdateResourceResponse.md)
|
||||||
|
- [V2UpdateUserResponse](docs/V2UpdateUserResponse.md)
|
||||||
|
- [V2UpdateUserSettingResponse](docs/V2UpdateUserSettingResponse.md)
|
||||||
|
- [V2UpdateWebhookResponse](docs/V2UpdateWebhookResponse.md)
|
||||||
|
- [V2UpsertMemoReactionResponse](docs/V2UpsertMemoReactionResponse.md)
|
||||||
|
- [V2UpsertTagRequest](docs/V2UpsertTagRequest.md)
|
||||||
|
- [V2UpsertTagResponse](docs/V2UpsertTagResponse.md)
|
||||||
|
- [V2User](docs/V2User.md)
|
||||||
|
- [V2UserAccessToken](docs/V2UserAccessToken.md)
|
||||||
|
- [V2UserNameBody](docs/V2UserNameBody.md)
|
||||||
|
- [V2Visibility](docs/V2Visibility.md)
|
||||||
|
- [V2WorkspaceProfile](docs/V2WorkspaceProfile.md)
|
||||||
|
- [WebhooksWebhookIdBody](docs/WebhooksWebhookIdBody.md)
|
||||||
|
|
||||||
|
## Documentation For Authorization
|
||||||
|
|
||||||
|
All endpoints do not require authorization.
|
||||||
|
|
||||||
|
|
||||||
|
## Author
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
6
config.json
Normal file
6
config.json
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"packageName": "memos",
|
||||||
|
"projectName": "memos-python",
|
||||||
|
"packageVersion": "1.0.0",
|
||||||
|
"packageUrl": "https://github.com/looching/memos-python"
|
||||||
|
}
|
||||||
54
docs/ActivityServiceApi.md
Normal file
54
docs/ActivityServiceApi.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
# memos.ActivityServiceApi
|
||||||
|
|
||||||
|
All URIs are relative to */*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**activity_service_get_activity**](ActivityServiceApi.md#activity_service_get_activity) | **GET** /v2/activities/{id} | GetActivity returns the activity with the given id.
|
||||||
|
|
||||||
|
# **activity_service_get_activity**
|
||||||
|
> V2GetActivityResponse activity_service_get_activity(id)
|
||||||
|
|
||||||
|
GetActivity returns the activity with the given id.
|
||||||
|
|
||||||
|
### 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.ActivityServiceApi()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetActivity returns the activity with the given id.
|
||||||
|
api_response = api_instance.activity_service_get_activity(id)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling ActivityServiceApi->activity_service_get_activity: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetActivityResponse**](V2GetActivityResponse.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)
|
||||||
|
|
||||||
10
docs/Apiv2ActivityMemoCommentPayload.md
Normal file
10
docs/Apiv2ActivityMemoCommentPayload.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# Apiv2ActivityMemoCommentPayload
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memo_id** | **int** | | [optional]
|
||||||
|
**related_memo_id** | **int** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
10
docs/Apiv2ActivityPayload.md
Normal file
10
docs/Apiv2ActivityPayload.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# Apiv2ActivityPayload
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memo_comment** | [**Apiv2ActivityMemoCommentPayload**](Apiv2ActivityMemoCommentPayload.md) | | [optional]
|
||||||
|
**version_update** | [**Apiv2ActivityVersionUpdatePayload**](Apiv2ActivityVersionUpdatePayload.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/Apiv2ActivityVersionUpdatePayload.md
Normal file
9
docs/Apiv2ActivityVersionUpdatePayload.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# Apiv2ActivityVersionUpdatePayload
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**version** | **str** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
12
docs/Apiv2Reaction.md
Normal file
12
docs/Apiv2Reaction.md
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# Apiv2Reaction
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **int** | | [optional]
|
||||||
|
**creator** | **str** | | [optional]
|
||||||
|
**content_id** | **str** | | [optional]
|
||||||
|
**reaction_type** | [**Apiv2ReactionType**](Apiv2ReactionType.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/Apiv2ReactionType.md
Normal file
8
docs/Apiv2ReactionType.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# Apiv2ReactionType
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/Apiv2RowStatus.md
Normal file
8
docs/Apiv2RowStatus.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# Apiv2RowStatus
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
13
docs/Apiv2UserSetting.md
Normal file
13
docs/Apiv2UserSetting.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Apiv2UserSetting
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **str** | | [optional]
|
||||||
|
**locale** | **str** | The preferred locale of the user. | [optional]
|
||||||
|
**appearance** | **str** | The preferred appearance of the user. | [optional]
|
||||||
|
**memo_visibility** | **str** | The default visibility of the memo. | [optional]
|
||||||
|
**telegram_user_id** | **str** | The telegram user id of the user. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
15
docs/Apiv2Webhook.md
Normal file
15
docs/Apiv2Webhook.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# Apiv2Webhook
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **int** | | [optional]
|
||||||
|
**creator_id** | **int** | | [optional]
|
||||||
|
**created_time** | **datetime** | | [optional]
|
||||||
|
**updated_time** | **datetime** | | [optional]
|
||||||
|
**row_status** | [**Apiv2RowStatus**](Apiv2RowStatus.md) | | [optional]
|
||||||
|
**name** | **str** | | [optional]
|
||||||
|
**url** | **str** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
13
docs/Apiv2WorkspaceGeneralSetting.md
Normal file
13
docs/Apiv2WorkspaceGeneralSetting.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Apiv2WorkspaceGeneralSetting
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**instance_url** | **str** | instance_url is the instance URL. | [optional]
|
||||||
|
**disallow_signup** | **bool** | disallow_signup is the flag to disallow signup. | [optional]
|
||||||
|
**disallow_password_login** | **bool** | disallow_password_login is the flag to disallow password login. | [optional]
|
||||||
|
**additional_script** | **str** | additional_script is the additional script. | [optional]
|
||||||
|
**additional_style** | **str** | additional_style is the additional style. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
10
docs/Apiv2WorkspaceSetting.md
Normal file
10
docs/Apiv2WorkspaceSetting.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# Apiv2WorkspaceSetting
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **str** | | [optional]
|
||||||
|
**general_setting** | [**Apiv2WorkspaceGeneralSetting**](Apiv2WorkspaceGeneralSetting.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
244
docs/AuthServiceApi.md
Normal file
244
docs/AuthServiceApi.md
Normal file
@ -0,0 +1,244 @@
|
|||||||
|
# memos.AuthServiceApi
|
||||||
|
|
||||||
|
All URIs are relative to */*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**auth_service_get_auth_status**](AuthServiceApi.md#auth_service_get_auth_status) | **POST** /api/v2/auth/status | GetAuthStatus returns the current auth status of the user.
|
||||||
|
[**auth_service_sign_in**](AuthServiceApi.md#auth_service_sign_in) | **POST** /api/v2/auth/signin | SignIn signs in the user with the given username and password.
|
||||||
|
[**auth_service_sign_in_with_sso**](AuthServiceApi.md#auth_service_sign_in_with_sso) | **POST** /api/v2/auth/signin/sso | SignInWithSSO signs in the user with the given SSO code.
|
||||||
|
[**auth_service_sign_out**](AuthServiceApi.md#auth_service_sign_out) | **POST** /api/v2/auth/signout | SignOut signs out the user.
|
||||||
|
[**auth_service_sign_up**](AuthServiceApi.md#auth_service_sign_up) | **POST** /api/v2/auth/signup | SignUp signs up the user with the given username and password.
|
||||||
|
|
||||||
|
# **auth_service_get_auth_status**
|
||||||
|
> V2GetAuthStatusResponse auth_service_get_auth_status()
|
||||||
|
|
||||||
|
GetAuthStatus returns the current auth status of the 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.AuthServiceApi()
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetAuthStatus returns the current auth status of the user.
|
||||||
|
api_response = api_instance.auth_service_get_auth_status()
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling AuthServiceApi->auth_service_get_auth_status: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
This endpoint does not need any parameter.
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetAuthStatusResponse**](V2GetAuthStatusResponse.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)
|
||||||
|
|
||||||
|
# **auth_service_sign_in**
|
||||||
|
> V2SignInResponse auth_service_sign_in(username=username, password=password, never_expire=never_expire)
|
||||||
|
|
||||||
|
SignIn signs in the user with the given username and password.
|
||||||
|
|
||||||
|
### 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.AuthServiceApi()
|
||||||
|
username = 'username_example' # str | (optional)
|
||||||
|
password = 'password_example' # str | (optional)
|
||||||
|
never_expire = true # bool | (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# SignIn signs in the user with the given username and password.
|
||||||
|
api_response = api_instance.auth_service_sign_in(username=username, password=password, never_expire=never_expire)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling AuthServiceApi->auth_service_sign_in: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**username** | **str**| | [optional]
|
||||||
|
**password** | **str**| | [optional]
|
||||||
|
**never_expire** | **bool**| | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2SignInResponse**](V2SignInResponse.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)
|
||||||
|
|
||||||
|
# **auth_service_sign_in_with_sso**
|
||||||
|
> V2SignInWithSSOResponse auth_service_sign_in_with_sso(idp_id=idp_id, code=code, redirect_uri=redirect_uri)
|
||||||
|
|
||||||
|
SignInWithSSO signs in the user with the given SSO code.
|
||||||
|
|
||||||
|
### 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.AuthServiceApi()
|
||||||
|
idp_id = 56 # int | (optional)
|
||||||
|
code = 'code_example' # str | (optional)
|
||||||
|
redirect_uri = 'redirect_uri_example' # str | (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# SignInWithSSO signs in the user with the given SSO code.
|
||||||
|
api_response = api_instance.auth_service_sign_in_with_sso(idp_id=idp_id, code=code, redirect_uri=redirect_uri)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling AuthServiceApi->auth_service_sign_in_with_sso: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**idp_id** | **int**| | [optional]
|
||||||
|
**code** | **str**| | [optional]
|
||||||
|
**redirect_uri** | **str**| | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2SignInWithSSOResponse**](V2SignInWithSSOResponse.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)
|
||||||
|
|
||||||
|
# **auth_service_sign_out**
|
||||||
|
> V2SignOutResponse auth_service_sign_out()
|
||||||
|
|
||||||
|
SignOut signs out the 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.AuthServiceApi()
|
||||||
|
|
||||||
|
try:
|
||||||
|
# SignOut signs out the user.
|
||||||
|
api_response = api_instance.auth_service_sign_out()
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling AuthServiceApi->auth_service_sign_out: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
This endpoint does not need any parameter.
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2SignOutResponse**](V2SignOutResponse.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)
|
||||||
|
|
||||||
|
# **auth_service_sign_up**
|
||||||
|
> V2SignUpResponse auth_service_sign_up(username=username, password=password)
|
||||||
|
|
||||||
|
SignUp signs up the user with the given username and password.
|
||||||
|
|
||||||
|
### 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.AuthServiceApi()
|
||||||
|
username = 'username_example' # str | (optional)
|
||||||
|
password = 'password_example' # str | (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# SignUp signs up the user with the given username and password.
|
||||||
|
api_response = api_instance.auth_service_sign_up(username=username, password=password)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling AuthServiceApi->auth_service_sign_up: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**username** | **str**| | [optional]
|
||||||
|
**password** | **str**| | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2SignUpResponse**](V2SignUpResponse.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)
|
||||||
|
|
||||||
11
docs/GooglerpcStatus.md
Normal file
11
docs/GooglerpcStatus.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# GooglerpcStatus
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**code** | **int** | | [optional]
|
||||||
|
**message** | **str** | | [optional]
|
||||||
|
**details** | [**list[ProtobufAny]**](ProtobufAny.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
150
docs/InboxServiceApi.md
Normal file
150
docs/InboxServiceApi.md
Normal file
@ -0,0 +1,150 @@
|
|||||||
|
# memos.InboxServiceApi
|
||||||
|
|
||||||
|
All URIs are relative to */*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**inbox_service_delete_inbox**](InboxServiceApi.md#inbox_service_delete_inbox) | **DELETE** /api/v2/{name_1} | DeleteInbox deletes an inbox.
|
||||||
|
[**inbox_service_list_inboxes**](InboxServiceApi.md#inbox_service_list_inboxes) | **GET** /api/v2/inboxes | ListInboxes lists inboxes for a user.
|
||||||
|
[**inbox_service_update_inbox**](InboxServiceApi.md#inbox_service_update_inbox) | **PATCH** /api/v2/{inbox.name} | UpdateInbox updates an inbox.
|
||||||
|
|
||||||
|
# **inbox_service_delete_inbox**
|
||||||
|
> V2DeleteInboxResponse inbox_service_delete_inbox(name_1)
|
||||||
|
|
||||||
|
DeleteInbox deletes an inbox.
|
||||||
|
|
||||||
|
### 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.InboxServiceApi()
|
||||||
|
name_1 = 'name_1_example' # str | The name of the inbox to delete. Format: inboxes/{uid}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# DeleteInbox deletes an inbox.
|
||||||
|
api_response = api_instance.inbox_service_delete_inbox(name_1)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling InboxServiceApi->inbox_service_delete_inbox: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name_1** | **str**| The name of the inbox to delete. Format: inboxes/{uid} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2DeleteInboxResponse**](V2DeleteInboxResponse.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)
|
||||||
|
|
||||||
|
# **inbox_service_list_inboxes**
|
||||||
|
> V2ListInboxesResponse inbox_service_list_inboxes(user=user)
|
||||||
|
|
||||||
|
ListInboxes lists inboxes 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.InboxServiceApi()
|
||||||
|
user = 'user_example' # str | Format: users/{username} (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListInboxes lists inboxes for a user.
|
||||||
|
api_response = api_instance.inbox_service_list_inboxes(user=user)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling InboxServiceApi->inbox_service_list_inboxes: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**user** | **str**| Format: users/{username} | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListInboxesResponse**](V2ListInboxesResponse.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)
|
||||||
|
|
||||||
|
# **inbox_service_update_inbox**
|
||||||
|
> V2UpdateInboxResponse inbox_service_update_inbox(body, inbox_name)
|
||||||
|
|
||||||
|
UpdateInbox updates an inbox.
|
||||||
|
|
||||||
|
### 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.InboxServiceApi()
|
||||||
|
body = memos.V2InboxNameBody() # V2InboxNameBody |
|
||||||
|
inbox_name = 'inbox_name_example' # str | The name of the inbox. Format: inboxes/{uid}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# UpdateInbox updates an inbox.
|
||||||
|
api_response = api_instance.inbox_service_update_inbox(body, inbox_name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling InboxServiceApi->inbox_service_update_inbox: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**body** | [**V2InboxNameBody**](V2InboxNameBody.md)| |
|
||||||
|
**inbox_name** | **str**| The name of the inbox. Format: inboxes/{uid} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2UpdateInboxResponse**](V2UpdateInboxResponse.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)
|
||||||
|
|
||||||
834
docs/MemoServiceApi.md
Normal file
834
docs/MemoServiceApi.md
Normal file
@ -0,0 +1,834 @@
|
|||||||
|
# memos.MemoServiceApi
|
||||||
|
|
||||||
|
All URIs are relative to */*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**memo_service_create_memo**](MemoServiceApi.md#memo_service_create_memo) | **POST** /api/v2/memos | CreateMemo creates a memo.
|
||||||
|
[**memo_service_create_memo_comment**](MemoServiceApi.md#memo_service_create_memo_comment) | **POST** /api/v2/memos/{id}/comments | CreateMemoComment creates a comment for a memo.
|
||||||
|
[**memo_service_delete_memo**](MemoServiceApi.md#memo_service_delete_memo) | **DELETE** /api/v2/memos/{id} | DeleteMemo deletes a memo by id.
|
||||||
|
[**memo_service_delete_memo_reaction**](MemoServiceApi.md#memo_service_delete_memo_reaction) | **DELETE** /api/v2/memos/{id}/reactions/{reactionId} | DeleteMemoReaction deletes a reaction for a memo.
|
||||||
|
[**memo_service_export_memos**](MemoServiceApi.md#memo_service_export_memos) | **POST** /api/v2/memos:export | ExportMemos exports memos.
|
||||||
|
[**memo_service_get_memo**](MemoServiceApi.md#memo_service_get_memo) | **GET** /api/v2/memos/{id} | GetMemo gets a memo by id.
|
||||||
|
[**memo_service_get_memo_by_name**](MemoServiceApi.md#memo_service_get_memo_by_name) | **GET** /api/v2/memos/name/{name} | GetMemoByName gets a memo by name.
|
||||||
|
[**memo_service_get_user_memos_stats**](MemoServiceApi.md#memo_service_get_user_memos_stats) | **GET** /api/v2/memos/stats | GetUserMemosStats gets stats of memos for a user.
|
||||||
|
[**memo_service_list_memo_comments**](MemoServiceApi.md#memo_service_list_memo_comments) | **GET** /api/v2/memos/{id}/comments | ListMemoComments lists comments for a memo.
|
||||||
|
[**memo_service_list_memo_reactions**](MemoServiceApi.md#memo_service_list_memo_reactions) | **GET** /api/v2/memos/{id}/reactions | ListMemoReactions lists reactions for a memo.
|
||||||
|
[**memo_service_list_memo_relations**](MemoServiceApi.md#memo_service_list_memo_relations) | **GET** /api/v2/memos/{id}/relations | ListMemoRelations lists relations for a memo.
|
||||||
|
[**memo_service_list_memo_resources**](MemoServiceApi.md#memo_service_list_memo_resources) | **GET** /api/v2/memos/{id}/resources | ListMemoResources lists resources for a memo.
|
||||||
|
[**memo_service_list_memos**](MemoServiceApi.md#memo_service_list_memos) | **GET** /api/v2/memos | ListMemos lists memos with pagination and filter.
|
||||||
|
[**memo_service_set_memo_relations**](MemoServiceApi.md#memo_service_set_memo_relations) | **POST** /api/v2/memos/{id}/relations | SetMemoRelations sets relations for a memo.
|
||||||
|
[**memo_service_set_memo_resources**](MemoServiceApi.md#memo_service_set_memo_resources) | **POST** /api/v2/memos/{id}/resources | SetMemoResources sets resources for a memo.
|
||||||
|
[**memo_service_update_memo**](MemoServiceApi.md#memo_service_update_memo) | **PATCH** /api/v2/memos/{memo.id} | UpdateMemo updates a memo.
|
||||||
|
[**memo_service_upsert_memo_reaction**](MemoServiceApi.md#memo_service_upsert_memo_reaction) | **POST** /api/v2/memos/{id}/reactions | UpsertMemoReaction upserts a reaction for a memo.
|
||||||
|
|
||||||
|
# **memo_service_create_memo**
|
||||||
|
> V2CreateMemoResponse 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.V2CreateMemoRequest() # V2CreateMemoRequest |
|
||||||
|
|
||||||
|
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** | [**V2CreateMemoRequest**](V2CreateMemoRequest.md)| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2CreateMemoResponse**](V2CreateMemoResponse.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**
|
||||||
|
> V2CreateMemoCommentResponse memo_service_create_memo_comment(id, create_content=create_content, create_visibility=create_visibility)
|
||||||
|
|
||||||
|
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()
|
||||||
|
id = 56 # int | id is the memo id to create comment for.
|
||||||
|
create_content = 'create_content_example' # str | (optional)
|
||||||
|
create_visibility = 'VISIBILITY_UNSPECIFIED' # str | (optional) (default to VISIBILITY_UNSPECIFIED)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# CreateMemoComment creates a comment for a memo.
|
||||||
|
api_response = api_instance.memo_service_create_memo_comment(id, create_content=create_content, create_visibility=create_visibility)
|
||||||
|
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
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| id is the memo id to create comment for. |
|
||||||
|
**create_content** | **str**| | [optional]
|
||||||
|
**create_visibility** | **str**| | [optional] [default to VISIBILITY_UNSPECIFIED]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2CreateMemoCommentResponse**](V2CreateMemoCommentResponse.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_delete_memo**
|
||||||
|
> V2DeleteMemoResponse memo_service_delete_memo(id)
|
||||||
|
|
||||||
|
DeleteMemo deletes a memo by id.
|
||||||
|
|
||||||
|
### 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()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# DeleteMemo deletes a memo by id.
|
||||||
|
api_response = api_instance.memo_service_delete_memo(id)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling MemoServiceApi->memo_service_delete_memo: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2DeleteMemoResponse**](V2DeleteMemoResponse.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_delete_memo_reaction**
|
||||||
|
> V2DeleteMemoReactionResponse memo_service_delete_memo_reaction(id, 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()
|
||||||
|
id = 56 # int |
|
||||||
|
reaction_id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# DeleteMemoReaction deletes a reaction for a memo.
|
||||||
|
api_response = api_instance.memo_service_delete_memo_reaction(id, 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
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
**reaction_id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2DeleteMemoReactionResponse**](V2DeleteMemoReactionResponse.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_export_memos**
|
||||||
|
> V2ExportMemosResponse memo_service_export_memos(filter=filter)
|
||||||
|
|
||||||
|
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()
|
||||||
|
filter = 'filter_example' # str | Same as ListMemosRequest.filter (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ExportMemos exports memos.
|
||||||
|
api_response = api_instance.memo_service_export_memos(filter=filter)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling MemoServiceApi->memo_service_export_memos: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**filter** | **str**| Same as ListMemosRequest.filter | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ExportMemosResponse**](V2ExportMemosResponse.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_memo**
|
||||||
|
> V2GetMemoResponse memo_service_get_memo(id)
|
||||||
|
|
||||||
|
GetMemo gets a memo by id.
|
||||||
|
|
||||||
|
### 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()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetMemo gets a memo by id.
|
||||||
|
api_response = api_instance.memo_service_get_memo(id)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling MemoServiceApi->memo_service_get_memo: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetMemoResponse**](V2GetMemoResponse.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_memo_by_name**
|
||||||
|
> V2GetMemoByNameResponse memo_service_get_memo_by_name(name)
|
||||||
|
|
||||||
|
GetMemoByName gets a memo by name.
|
||||||
|
|
||||||
|
### 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 |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetMemoByName gets a memo by name.
|
||||||
|
api_response = api_instance.memo_service_get_memo_by_name(name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling MemoServiceApi->memo_service_get_memo_by_name: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **str**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetMemoByNameResponse**](V2GetMemoByNameResponse.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**
|
||||||
|
> V2GetUserMemosStatsResponse 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/{username} (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/{username} | [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
|
||||||
|
|
||||||
|
[**V2GetUserMemosStatsResponse**](V2GetUserMemosStatsResponse.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**
|
||||||
|
> V2ListMemoCommentsResponse memo_service_list_memo_comments(id)
|
||||||
|
|
||||||
|
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()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListMemoComments lists comments for a memo.
|
||||||
|
api_response = api_instance.memo_service_list_memo_comments(id)
|
||||||
|
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
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListMemoCommentsResponse**](V2ListMemoCommentsResponse.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**
|
||||||
|
> V2ListMemoReactionsResponse memo_service_list_memo_reactions(id)
|
||||||
|
|
||||||
|
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()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListMemoReactions lists reactions for a memo.
|
||||||
|
api_response = api_instance.memo_service_list_memo_reactions(id)
|
||||||
|
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
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListMemoReactionsResponse**](V2ListMemoReactionsResponse.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**
|
||||||
|
> V2ListMemoRelationsResponse memo_service_list_memo_relations(id)
|
||||||
|
|
||||||
|
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()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListMemoRelations lists relations for a memo.
|
||||||
|
api_response = api_instance.memo_service_list_memo_relations(id)
|
||||||
|
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
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListMemoRelationsResponse**](V2ListMemoRelationsResponse.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**
|
||||||
|
> V2ListMemoResourcesResponse memo_service_list_memo_resources(id)
|
||||||
|
|
||||||
|
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()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListMemoResources lists resources for a memo.
|
||||||
|
api_response = api_instance.memo_service_list_memo_resources(id)
|
||||||
|
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
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListMemoResourcesResponse**](V2ListMemoResourcesResponse.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**
|
||||||
|
> V2ListMemosResponse 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/{username} && 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/{username} && visibilities == ['PUBLIC', 'PROTECTED']\" | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListMemosResponse**](V2ListMemosResponse.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**
|
||||||
|
> V2SetMemoRelationsResponse memo_service_set_memo_relations(body, id)
|
||||||
|
|
||||||
|
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 |
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# SetMemoRelations sets relations for a memo.
|
||||||
|
api_response = api_instance.memo_service_set_memo_relations(body, id)
|
||||||
|
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)| |
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2SetMemoRelationsResponse**](V2SetMemoRelationsResponse.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_set_memo_resources**
|
||||||
|
> V2SetMemoResourcesResponse memo_service_set_memo_resources(body, id)
|
||||||
|
|
||||||
|
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 |
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# SetMemoResources sets resources for a memo.
|
||||||
|
api_response = api_instance.memo_service_set_memo_resources(body, id)
|
||||||
|
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)| |
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2SetMemoResourcesResponse**](V2SetMemoResourcesResponse.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_update_memo**
|
||||||
|
> V2UpdateMemoResponse memo_service_update_memo(body, memo_id)
|
||||||
|
|
||||||
|
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.MemosMemoIdBody() # MemosMemoIdBody |
|
||||||
|
memo_id = 56 # int | id is the system generated unique identifier.
|
||||||
|
|
||||||
|
try:
|
||||||
|
# UpdateMemo updates a memo.
|
||||||
|
api_response = api_instance.memo_service_update_memo(body, memo_id)
|
||||||
|
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** | [**MemosMemoIdBody**](MemosMemoIdBody.md)| |
|
||||||
|
**memo_id** | **int**| id is the system generated unique identifier. |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2UpdateMemoResponse**](V2UpdateMemoResponse.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**
|
||||||
|
> V2UpsertMemoReactionResponse memo_service_upsert_memo_reaction(id, reaction_id=reaction_id, reaction_creator=reaction_creator, reaction_content_id=reaction_content_id, reaction_reaction_type=reaction_reaction_type)
|
||||||
|
|
||||||
|
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()
|
||||||
|
id = 56 # int |
|
||||||
|
reaction_id = 56 # int | (optional)
|
||||||
|
reaction_creator = 'reaction_creator_example' # str | (optional)
|
||||||
|
reaction_content_id = 'reaction_content_id_example' # str | (optional)
|
||||||
|
reaction_reaction_type = 'TYPE_UNSPECIFIED' # str | (optional) (default to TYPE_UNSPECIFIED)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# UpsertMemoReaction upserts a reaction for a memo.
|
||||||
|
api_response = api_instance.memo_service_upsert_memo_reaction(id, reaction_id=reaction_id, reaction_creator=reaction_creator, reaction_content_id=reaction_content_id, reaction_reaction_type=reaction_reaction_type)
|
||||||
|
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
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
**reaction_id** | **int**| | [optional]
|
||||||
|
**reaction_creator** | **str**| | [optional]
|
||||||
|
**reaction_content_id** | **str**| | [optional]
|
||||||
|
**reaction_reaction_type** | **str**| | [optional] [default to TYPE_UNSPECIFIED]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2UpsertMemoReactionResponse**](V2UpsertMemoReactionResponse.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)
|
||||||
|
|
||||||
9
docs/MemoServiceSetMemoRelationsBody.md
Normal file
9
docs/MemoServiceSetMemoRelationsBody.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# MemoServiceSetMemoRelationsBody
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**relations** | [**list[V2MemoRelation]**](V2MemoRelation.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/MemoServiceSetMemoResourcesBody.md
Normal file
9
docs/MemoServiceSetMemoResourcesBody.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# MemoServiceSetMemoResourcesBody
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**resources** | [**list[V2Resource]**](V2Resource.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
22
docs/MemosMemoIdBody.md
Normal file
22
docs/MemosMemoIdBody.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
# MemosMemoIdBody
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **str** | name is the user provided name. | [optional]
|
||||||
|
**row_status** | [**Apiv2RowStatus**](Apiv2RowStatus.md) | | [optional]
|
||||||
|
**creator** | **str** | | [optional]
|
||||||
|
**creator_id** | **int** | | [optional]
|
||||||
|
**create_time** | **datetime** | | [optional]
|
||||||
|
**update_time** | **datetime** | | [optional]
|
||||||
|
**display_time** | **datetime** | | [optional]
|
||||||
|
**content** | **str** | | [optional]
|
||||||
|
**visibility** | [**V2Visibility**](V2Visibility.md) | | [optional]
|
||||||
|
**pinned** | **bool** | | [optional]
|
||||||
|
**parent_id** | **int** | | [optional]
|
||||||
|
**resources** | [**list[V2Resource]**](V2Resource.md) | | [optional]
|
||||||
|
**relations** | [**list[V2MemoRelation]**](V2MemoRelation.md) | | [optional]
|
||||||
|
**reactions** | [**list[Apiv2Reaction]**](Apiv2Reaction.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/ProtobufAny.md
Normal file
8
docs/ProtobufAny.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# ProtobufAny
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
293
docs/ResourceServiceApi.md
Normal file
293
docs/ResourceServiceApi.md
Normal file
@ -0,0 +1,293 @@
|
|||||||
|
# memos.ResourceServiceApi
|
||||||
|
|
||||||
|
All URIs are relative to */*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**resource_service_create_resource**](ResourceServiceApi.md#resource_service_create_resource) | **POST** /api/v2/resources | CreateResource creates a new resource.
|
||||||
|
[**resource_service_delete_resource**](ResourceServiceApi.md#resource_service_delete_resource) | **DELETE** /api/v2/resources/{id} | DeleteResource deletes a resource by id.
|
||||||
|
[**resource_service_get_resource**](ResourceServiceApi.md#resource_service_get_resource) | **GET** /api/v2/resources/{id} | GetResource returns a resource by id.
|
||||||
|
[**resource_service_get_resource_by_name**](ResourceServiceApi.md#resource_service_get_resource_by_name) | **GET** /api/v2/resources/name/{name} | GetResourceByName returns a resource by name.
|
||||||
|
[**resource_service_list_resources**](ResourceServiceApi.md#resource_service_list_resources) | **GET** /api/v2/resources | ListResources lists all resources.
|
||||||
|
[**resource_service_update_resource**](ResourceServiceApi.md#resource_service_update_resource) | **PATCH** /api/v2/resources/{resource.id} | UpdateResource updates a resource.
|
||||||
|
|
||||||
|
# **resource_service_create_resource**
|
||||||
|
> V2CreateResourceResponse resource_service_create_resource(filename=filename, external_link=external_link, type=type, memo_id=memo_id)
|
||||||
|
|
||||||
|
CreateResource creates a new resource.
|
||||||
|
|
||||||
|
### 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.ResourceServiceApi()
|
||||||
|
filename = 'filename_example' # str | (optional)
|
||||||
|
external_link = 'external_link_example' # str | (optional)
|
||||||
|
type = 'type_example' # str | (optional)
|
||||||
|
memo_id = 56 # int | (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# CreateResource creates a new resource.
|
||||||
|
api_response = api_instance.resource_service_create_resource(filename=filename, external_link=external_link, type=type, memo_id=memo_id)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling ResourceServiceApi->resource_service_create_resource: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**filename** | **str**| | [optional]
|
||||||
|
**external_link** | **str**| | [optional]
|
||||||
|
**type** | **str**| | [optional]
|
||||||
|
**memo_id** | **int**| | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2CreateResourceResponse**](V2CreateResourceResponse.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)
|
||||||
|
|
||||||
|
# **resource_service_delete_resource**
|
||||||
|
> V2DeleteResourceResponse resource_service_delete_resource(id)
|
||||||
|
|
||||||
|
DeleteResource deletes a resource by id.
|
||||||
|
|
||||||
|
### 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.ResourceServiceApi()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# DeleteResource deletes a resource by id.
|
||||||
|
api_response = api_instance.resource_service_delete_resource(id)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling ResourceServiceApi->resource_service_delete_resource: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2DeleteResourceResponse**](V2DeleteResourceResponse.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)
|
||||||
|
|
||||||
|
# **resource_service_get_resource**
|
||||||
|
> V2GetResourceResponse resource_service_get_resource(id)
|
||||||
|
|
||||||
|
GetResource returns a resource by id.
|
||||||
|
|
||||||
|
### 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.ResourceServiceApi()
|
||||||
|
id = 56 # int |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetResource returns a resource by id.
|
||||||
|
api_response = api_instance.resource_service_get_resource(id)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling ResourceServiceApi->resource_service_get_resource: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **int**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetResourceResponse**](V2GetResourceResponse.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)
|
||||||
|
|
||||||
|
# **resource_service_get_resource_by_name**
|
||||||
|
> V2GetResourceByNameResponse resource_service_get_resource_by_name(name)
|
||||||
|
|
||||||
|
GetResourceByName returns a resource by name.
|
||||||
|
|
||||||
|
### 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.ResourceServiceApi()
|
||||||
|
name = 'name_example' # str |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetResourceByName returns a resource by name.
|
||||||
|
api_response = api_instance.resource_service_get_resource_by_name(name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling ResourceServiceApi->resource_service_get_resource_by_name: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **str**| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetResourceByNameResponse**](V2GetResourceByNameResponse.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)
|
||||||
|
|
||||||
|
# **resource_service_list_resources**
|
||||||
|
> V2ListResourcesResponse resource_service_list_resources()
|
||||||
|
|
||||||
|
ListResources lists all resources.
|
||||||
|
|
||||||
|
### 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.ResourceServiceApi()
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListResources lists all resources.
|
||||||
|
api_response = api_instance.resource_service_list_resources()
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling ResourceServiceApi->resource_service_list_resources: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
This endpoint does not need any parameter.
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListResourcesResponse**](V2ListResourcesResponse.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)
|
||||||
|
|
||||||
|
# **resource_service_update_resource**
|
||||||
|
> V2UpdateResourceResponse resource_service_update_resource(body, resource_id)
|
||||||
|
|
||||||
|
UpdateResource updates a resource.
|
||||||
|
|
||||||
|
### 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.ResourceServiceApi()
|
||||||
|
body = memos.ResourcesResourceIdBody() # ResourcesResourceIdBody |
|
||||||
|
resource_id = 56 # int | id is the system generated unique identifier.
|
||||||
|
|
||||||
|
try:
|
||||||
|
# UpdateResource updates a resource.
|
||||||
|
api_response = api_instance.resource_service_update_resource(body, resource_id)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling ResourceServiceApi->resource_service_update_resource: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**body** | [**ResourcesResourceIdBody**](ResourcesResourceIdBody.md)| |
|
||||||
|
**resource_id** | **int**| id is the system generated unique identifier. |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2UpdateResourceResponse**](V2UpdateResourceResponse.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)
|
||||||
|
|
||||||
15
docs/ResourcesResourceIdBody.md
Normal file
15
docs/ResourcesResourceIdBody.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# ResourcesResourceIdBody
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **str** | name is the user provided name. | [optional]
|
||||||
|
**create_time** | **datetime** | | [optional]
|
||||||
|
**filename** | **str** | | [optional]
|
||||||
|
**external_link** | **str** | | [optional]
|
||||||
|
**type** | **str** | | [optional]
|
||||||
|
**size** | **str** | | [optional]
|
||||||
|
**memo_id** | **int** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/SettingIsTheSettingToUpdate_.md
Normal file
9
docs/SettingIsTheSettingToUpdate_.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# SettingIsTheSettingToUpdate_
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**general_setting** | [**Apiv2WorkspaceGeneralSetting**](Apiv2WorkspaceGeneralSetting.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
291
docs/TagServiceApi.md
Normal file
291
docs/TagServiceApi.md
Normal file
@ -0,0 +1,291 @@
|
|||||||
|
# memos.TagServiceApi
|
||||||
|
|
||||||
|
All URIs are relative to */*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**tag_service_batch_upsert_tag**](TagServiceApi.md#tag_service_batch_upsert_tag) | **POST** /api/v2/tags:batchUpsert | BatchUpsertTag upserts multiple tags.
|
||||||
|
[**tag_service_delete_tag**](TagServiceApi.md#tag_service_delete_tag) | **DELETE** /api/v2/tags | DeleteTag deletes a tag.
|
||||||
|
[**tag_service_get_tag_suggestions**](TagServiceApi.md#tag_service_get_tag_suggestions) | **GET** /api/v2/tags/suggestion | GetTagSuggestions gets tag suggestions from the user's memos.
|
||||||
|
[**tag_service_list_tags**](TagServiceApi.md#tag_service_list_tags) | **GET** /api/v2/tags | ListTags lists tags.
|
||||||
|
[**tag_service_rename_tag**](TagServiceApi.md#tag_service_rename_tag) | **PATCH** /api/v2/tags:rename | RenameTag renames a tag. All related memos will be updated.
|
||||||
|
[**tag_service_upsert_tag**](TagServiceApi.md#tag_service_upsert_tag) | **POST** /api/v2/tags | UpsertTag upserts a tag.
|
||||||
|
|
||||||
|
# **tag_service_batch_upsert_tag**
|
||||||
|
> V2BatchUpsertTagResponse tag_service_batch_upsert_tag()
|
||||||
|
|
||||||
|
BatchUpsertTag upserts multiple tags.
|
||||||
|
|
||||||
|
### 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.TagServiceApi()
|
||||||
|
|
||||||
|
try:
|
||||||
|
# BatchUpsertTag upserts multiple tags.
|
||||||
|
api_response = api_instance.tag_service_batch_upsert_tag()
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling TagServiceApi->tag_service_batch_upsert_tag: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
This endpoint does not need any parameter.
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2BatchUpsertTagResponse**](V2BatchUpsertTagResponse.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)
|
||||||
|
|
||||||
|
# **tag_service_delete_tag**
|
||||||
|
> V2DeleteTagResponse tag_service_delete_tag(tag_name=tag_name, tag_creator=tag_creator)
|
||||||
|
|
||||||
|
DeleteTag deletes a tag.
|
||||||
|
|
||||||
|
### 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.TagServiceApi()
|
||||||
|
tag_name = 'tag_name_example' # str | (optional)
|
||||||
|
tag_creator = 'tag_creator_example' # str | The creator of tags. Format: users/{username} (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# DeleteTag deletes a tag.
|
||||||
|
api_response = api_instance.tag_service_delete_tag(tag_name=tag_name, tag_creator=tag_creator)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling TagServiceApi->tag_service_delete_tag: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**tag_name** | **str**| | [optional]
|
||||||
|
**tag_creator** | **str**| The creator of tags. Format: users/{username} | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2DeleteTagResponse**](V2DeleteTagResponse.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)
|
||||||
|
|
||||||
|
# **tag_service_get_tag_suggestions**
|
||||||
|
> V2GetTagSuggestionsResponse tag_service_get_tag_suggestions(user=user)
|
||||||
|
|
||||||
|
GetTagSuggestions gets tag suggestions from the user's 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.TagServiceApi()
|
||||||
|
user = 'user_example' # str | The creator of tags. Format: users/{username} (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetTagSuggestions gets tag suggestions from the user's memos.
|
||||||
|
api_response = api_instance.tag_service_get_tag_suggestions(user=user)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling TagServiceApi->tag_service_get_tag_suggestions: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**user** | **str**| The creator of tags. Format: users/{username} | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetTagSuggestionsResponse**](V2GetTagSuggestionsResponse.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)
|
||||||
|
|
||||||
|
# **tag_service_list_tags**
|
||||||
|
> V2ListTagsResponse tag_service_list_tags(user=user)
|
||||||
|
|
||||||
|
ListTags lists tags.
|
||||||
|
|
||||||
|
### 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.TagServiceApi()
|
||||||
|
user = 'user_example' # str | The creator of tags. Format: users/{username} (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListTags lists tags.
|
||||||
|
api_response = api_instance.tag_service_list_tags(user=user)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling TagServiceApi->tag_service_list_tags: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**user** | **str**| The creator of tags. Format: users/{username} | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListTagsResponse**](V2ListTagsResponse.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)
|
||||||
|
|
||||||
|
# **tag_service_rename_tag**
|
||||||
|
> V2RenameTagResponse tag_service_rename_tag(user=user, old_name=old_name, new_name=new_name)
|
||||||
|
|
||||||
|
RenameTag renames a tag. All related memos will be updated.
|
||||||
|
|
||||||
|
### 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.TagServiceApi()
|
||||||
|
user = 'user_example' # str | The creator of tags. Format: users/{username} (optional)
|
||||||
|
old_name = 'old_name_example' # str | (optional)
|
||||||
|
new_name = 'new_name_example' # str | (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# RenameTag renames a tag. All related memos will be updated.
|
||||||
|
api_response = api_instance.tag_service_rename_tag(user=user, old_name=old_name, new_name=new_name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling TagServiceApi->tag_service_rename_tag: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**user** | **str**| The creator of tags. Format: users/{username} | [optional]
|
||||||
|
**old_name** | **str**| | [optional]
|
||||||
|
**new_name** | **str**| | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2RenameTagResponse**](V2RenameTagResponse.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)
|
||||||
|
|
||||||
|
# **tag_service_upsert_tag**
|
||||||
|
> V2UpsertTagResponse tag_service_upsert_tag(name=name)
|
||||||
|
|
||||||
|
UpsertTag upserts a tag.
|
||||||
|
|
||||||
|
### 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.TagServiceApi()
|
||||||
|
name = 'name_example' # str | (optional)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# UpsertTag upserts a tag.
|
||||||
|
api_response = api_instance.tag_service_upsert_tag(name=name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling TagServiceApi->tag_service_upsert_tag: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **str**| | [optional]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2UpsertTagResponse**](V2UpsertTagResponse.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)
|
||||||
|
|
||||||
8
docs/UserRole.md
Normal file
8
docs/UserRole.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# UserRole
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
481
docs/UserServiceApi.md
Normal file
481
docs/UserServiceApi.md
Normal file
@ -0,0 +1,481 @@
|
|||||||
|
# memos.UserServiceApi
|
||||||
|
|
||||||
|
All URIs are relative to */*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**user_service_create_user**](UserServiceApi.md#user_service_create_user) | **POST** /api/v2/users | CreateUser creates a new user.
|
||||||
|
[**user_service_create_user_access_token**](UserServiceApi.md#user_service_create_user_access_token) | **POST** /api/v2/{name}/access_tokens | CreateUserAccessToken creates a new access token for a user.
|
||||||
|
[**user_service_delete_user**](UserServiceApi.md#user_service_delete_user) | **DELETE** /api/v2/{name} | DeleteUser deletes a user.
|
||||||
|
[**user_service_delete_user_access_token**](UserServiceApi.md#user_service_delete_user_access_token) | **DELETE** /api/v2/{name}/access_tokens/{accessToken} | DeleteUserAccessToken deletes an access token for a user.
|
||||||
|
[**user_service_get_user**](UserServiceApi.md#user_service_get_user) | **GET** /api/v2/{name} | GetUser gets a user by name.
|
||||||
|
[**user_service_get_user_setting**](UserServiceApi.md#user_service_get_user_setting) | **GET** /api/v2/{name}/setting | GetUserSetting gets the setting of a user.
|
||||||
|
[**user_service_list_user_access_tokens**](UserServiceApi.md#user_service_list_user_access_tokens) | **GET** /api/v2/{name}/access_tokens | ListUserAccessTokens returns a list of access tokens for a user.
|
||||||
|
[**user_service_list_users**](UserServiceApi.md#user_service_list_users) | **GET** /api/v2/users | ListUsers returns a list of users.
|
||||||
|
[**user_service_update_user**](UserServiceApi.md#user_service_update_user) | **PATCH** /api/v2/{user.name} | UpdateUser updates a user.
|
||||||
|
[**user_service_update_user_setting**](UserServiceApi.md#user_service_update_user_setting) | **PATCH** /api/v2/{setting.name} | UpdateUserSetting updates the setting of a user.
|
||||||
|
|
||||||
|
# **user_service_create_user**
|
||||||
|
> V2CreateUserResponse user_service_create_user(body)
|
||||||
|
|
||||||
|
CreateUser creates a new 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.UserServiceApi()
|
||||||
|
body = memos.V2User() # V2User |
|
||||||
|
|
||||||
|
try:
|
||||||
|
# CreateUser creates a new user.
|
||||||
|
api_response = api_instance.user_service_create_user(body)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_create_user: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**body** | [**V2User**](V2User.md)| |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2CreateUserResponse**](V2CreateUserResponse.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)
|
||||||
|
|
||||||
|
# **user_service_create_user_access_token**
|
||||||
|
> V2CreateUserAccessTokenResponse user_service_create_user_access_token(body, name)
|
||||||
|
|
||||||
|
CreateUserAccessToken creates a new access token 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.UserServiceApi()
|
||||||
|
body = memos.UserServiceCreateUserAccessTokenBody() # UserServiceCreateUserAccessTokenBody |
|
||||||
|
name = 'name_example' # str | The name of the user. Format: users/{username}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# CreateUserAccessToken creates a new access token for a user.
|
||||||
|
api_response = api_instance.user_service_create_user_access_token(body, name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_create_user_access_token: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**body** | [**UserServiceCreateUserAccessTokenBody**](UserServiceCreateUserAccessTokenBody.md)| |
|
||||||
|
**name** | **str**| The name of the user. Format: users/{username} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2CreateUserAccessTokenResponse**](V2CreateUserAccessTokenResponse.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)
|
||||||
|
|
||||||
|
# **user_service_delete_user**
|
||||||
|
> V2DeleteUserResponse user_service_delete_user(name)
|
||||||
|
|
||||||
|
DeleteUser deletes 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.UserServiceApi()
|
||||||
|
name = 'name_example' # str | The name of the user. Format: users/{username}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# DeleteUser deletes a user.
|
||||||
|
api_response = api_instance.user_service_delete_user(name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_delete_user: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **str**| The name of the user. Format: users/{username} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2DeleteUserResponse**](V2DeleteUserResponse.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)
|
||||||
|
|
||||||
|
# **user_service_delete_user_access_token**
|
||||||
|
> V2DeleteUserAccessTokenResponse user_service_delete_user_access_token(name, access_token)
|
||||||
|
|
||||||
|
DeleteUserAccessToken deletes an access token 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.UserServiceApi()
|
||||||
|
name = 'name_example' # str | The name of the user. Format: users/{username}
|
||||||
|
access_token = 'access_token_example' # str | access_token is the access token to delete.
|
||||||
|
|
||||||
|
try:
|
||||||
|
# DeleteUserAccessToken deletes an access token for a user.
|
||||||
|
api_response = api_instance.user_service_delete_user_access_token(name, access_token)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_delete_user_access_token: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **str**| The name of the user. Format: users/{username} |
|
||||||
|
**access_token** | **str**| access_token is the access token to delete. |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2DeleteUserAccessTokenResponse**](V2DeleteUserAccessTokenResponse.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)
|
||||||
|
|
||||||
|
# **user_service_get_user**
|
||||||
|
> V2GetUserResponse user_service_get_user(name)
|
||||||
|
|
||||||
|
GetUser gets a user by name.
|
||||||
|
|
||||||
|
### 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.UserServiceApi()
|
||||||
|
name = 'name_example' # str | The name of the user. Format: users/{username}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetUser gets a user by name.
|
||||||
|
api_response = api_instance.user_service_get_user(name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_get_user: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **str**| The name of the user. Format: users/{username} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetUserResponse**](V2GetUserResponse.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)
|
||||||
|
|
||||||
|
# **user_service_get_user_setting**
|
||||||
|
> V2GetUserSettingResponse user_service_get_user_setting(name)
|
||||||
|
|
||||||
|
GetUserSetting gets the setting of 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.UserServiceApi()
|
||||||
|
name = 'name_example' # str | The name of the user. Format: users/{username}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# GetUserSetting gets the setting of a user.
|
||||||
|
api_response = api_instance.user_service_get_user_setting(name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_get_user_setting: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **str**| The name of the user. Format: users/{username} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2GetUserSettingResponse**](V2GetUserSettingResponse.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)
|
||||||
|
|
||||||
|
# **user_service_list_user_access_tokens**
|
||||||
|
> V2ListUserAccessTokensResponse user_service_list_user_access_tokens(name)
|
||||||
|
|
||||||
|
ListUserAccessTokens returns a list of access tokens 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.UserServiceApi()
|
||||||
|
name = 'name_example' # str | The name of the user. Format: users/{username}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListUserAccessTokens returns a list of access tokens for a user.
|
||||||
|
api_response = api_instance.user_service_list_user_access_tokens(name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_list_user_access_tokens: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **str**| The name of the user. Format: users/{username} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListUserAccessTokensResponse**](V2ListUserAccessTokensResponse.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)
|
||||||
|
|
||||||
|
# **user_service_list_users**
|
||||||
|
> V2ListUsersResponse user_service_list_users()
|
||||||
|
|
||||||
|
ListUsers returns a list of users.
|
||||||
|
|
||||||
|
### 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.UserServiceApi()
|
||||||
|
|
||||||
|
try:
|
||||||
|
# ListUsers returns a list of users.
|
||||||
|
api_response = api_instance.user_service_list_users()
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_list_users: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
This endpoint does not need any parameter.
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2ListUsersResponse**](V2ListUsersResponse.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)
|
||||||
|
|
||||||
|
# **user_service_update_user**
|
||||||
|
> V2UpdateUserResponse user_service_update_user(body, user_name)
|
||||||
|
|
||||||
|
UpdateUser updates 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.UserServiceApi()
|
||||||
|
body = memos.V2UserNameBody() # V2UserNameBody |
|
||||||
|
user_name = 'user_name_example' # str | The name of the user. Format: users/{username}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# UpdateUser updates a user.
|
||||||
|
api_response = api_instance.user_service_update_user(body, user_name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_update_user: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**body** | [**V2UserNameBody**](V2UserNameBody.md)| |
|
||||||
|
**user_name** | **str**| The name of the user. Format: users/{username} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2UpdateUserResponse**](V2UpdateUserResponse.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)
|
||||||
|
|
||||||
|
# **user_service_update_user_setting**
|
||||||
|
> V2UpdateUserSettingResponse user_service_update_user_setting(body, setting_name)
|
||||||
|
|
||||||
|
UpdateUserSetting updates the setting of 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.UserServiceApi()
|
||||||
|
body = memos.V2SettingNameBody() # V2SettingNameBody |
|
||||||
|
setting_name = 'setting_name_example' # str | The name of the user. Format: users/{username}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# UpdateUserSetting updates the setting of a user.
|
||||||
|
api_response = api_instance.user_service_update_user_setting(body, setting_name)
|
||||||
|
pprint(api_response)
|
||||||
|
except ApiException as e:
|
||||||
|
print("Exception when calling UserServiceApi->user_service_update_user_setting: %s\n" % e)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------- | ------------- | ------------- | -------------
|
||||||
|
**body** | [**V2SettingNameBody**](V2SettingNameBody.md)| |
|
||||||
|
**setting_name** | **str**| The name of the user. Format: users/{username} |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**V2UpdateUserSettingResponse**](V2UpdateUserSettingResponse.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)
|
||||||
|
|
||||||
10
docs/UserServiceCreateUserAccessTokenBody.md
Normal file
10
docs/UserServiceCreateUserAccessTokenBody.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# UserServiceCreateUserAccessTokenBody
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**description** | **str** | | [optional]
|
||||||
|
**expires_at** | **datetime** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
14
docs/V2Activity.md
Normal file
14
docs/V2Activity.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
# V2Activity
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **int** | | [optional]
|
||||||
|
**creator_id** | **int** | | [optional]
|
||||||
|
**type** | **str** | | [optional]
|
||||||
|
**level** | **str** | | [optional]
|
||||||
|
**create_time** | **datetime** | | [optional]
|
||||||
|
**payload** | [**Apiv2ActivityPayload**](Apiv2ActivityPayload.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2BatchUpsertTagResponse.md
Normal file
8
docs/V2BatchUpsertTagResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2BatchUpsertTagResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2CreateMemoCommentResponse.md
Normal file
9
docs/V2CreateMemoCommentResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2CreateMemoCommentResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memo** | [**V2Memo**](V2Memo.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
10
docs/V2CreateMemoRequest.md
Normal file
10
docs/V2CreateMemoRequest.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# V2CreateMemoRequest
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**content** | **str** | | [optional]
|
||||||
|
**visibility** | [**V2Visibility**](V2Visibility.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2CreateMemoResponse.md
Normal file
9
docs/V2CreateMemoResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2CreateMemoResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memo** | [**V2Memo**](V2Memo.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2CreateResourceResponse.md
Normal file
9
docs/V2CreateResourceResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2CreateResourceResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**resource** | [**V2Resource**](V2Resource.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2CreateUserAccessTokenResponse.md
Normal file
9
docs/V2CreateUserAccessTokenResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2CreateUserAccessTokenResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**access_token** | [**V2UserAccessToken**](V2UserAccessToken.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2CreateUserResponse.md
Normal file
9
docs/V2CreateUserResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2CreateUserResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**user** | [**V2User**](V2User.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
10
docs/V2CreateWebhookRequest.md
Normal file
10
docs/V2CreateWebhookRequest.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# V2CreateWebhookRequest
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **str** | | [optional]
|
||||||
|
**url** | **str** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2CreateWebhookResponse.md
Normal file
9
docs/V2CreateWebhookResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2CreateWebhookResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**webhook** | [**Apiv2Webhook**](Apiv2Webhook.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2DeleteInboxResponse.md
Normal file
8
docs/V2DeleteInboxResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2DeleteInboxResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2DeleteMemoReactionResponse.md
Normal file
8
docs/V2DeleteMemoReactionResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2DeleteMemoReactionResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2DeleteMemoResponse.md
Normal file
8
docs/V2DeleteMemoResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2DeleteMemoResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2DeleteResourceResponse.md
Normal file
8
docs/V2DeleteResourceResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2DeleteResourceResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2DeleteTagResponse.md
Normal file
8
docs/V2DeleteTagResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2DeleteTagResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2DeleteUserAccessTokenResponse.md
Normal file
8
docs/V2DeleteUserAccessTokenResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2DeleteUserAccessTokenResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2DeleteUserResponse.md
Normal file
8
docs/V2DeleteUserResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2DeleteUserResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2DeleteWebhookResponse.md
Normal file
8
docs/V2DeleteWebhookResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2DeleteWebhookResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ExportMemosResponse.md
Normal file
9
docs/V2ExportMemosResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ExportMemosResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**content** | **str** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetActivityResponse.md
Normal file
9
docs/V2GetActivityResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetActivityResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**activity** | [**V2Activity**](V2Activity.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetAuthStatusResponse.md
Normal file
9
docs/V2GetAuthStatusResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetAuthStatusResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**user** | [**V2User**](V2User.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetMemoByNameResponse.md
Normal file
9
docs/V2GetMemoByNameResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetMemoByNameResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memo** | [**V2Memo**](V2Memo.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetMemoResponse.md
Normal file
9
docs/V2GetMemoResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetMemoResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memo** | [**V2Memo**](V2Memo.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetResourceByNameResponse.md
Normal file
9
docs/V2GetResourceByNameResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetResourceByNameResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**resource** | [**V2Resource**](V2Resource.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetResourceResponse.md
Normal file
9
docs/V2GetResourceResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetResourceResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**resource** | [**V2Resource**](V2Resource.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetTagSuggestionsResponse.md
Normal file
9
docs/V2GetTagSuggestionsResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetTagSuggestionsResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**tags** | **list[str]** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetUserMemosStatsResponse.md
Normal file
9
docs/V2GetUserMemosStatsResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetUserMemosStatsResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**stats** | **dict(str, int)** | stats is the stats of memo creating/updating activities. key is the year-month-day string. e.g. \"2020-01-01\". | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetUserResponse.md
Normal file
9
docs/V2GetUserResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetUserResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**user** | [**V2User**](V2User.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetUserSettingResponse.md
Normal file
9
docs/V2GetUserSettingResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetUserSettingResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**setting** | [**Apiv2UserSetting**](Apiv2UserSetting.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetWebhookResponse.md
Normal file
9
docs/V2GetWebhookResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetWebhookResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**webhook** | [**Apiv2Webhook**](Apiv2Webhook.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetWorkspaceProfileResponse.md
Normal file
9
docs/V2GetWorkspaceProfileResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetWorkspaceProfileResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**workspace_profile** | [**V2WorkspaceProfile**](V2WorkspaceProfile.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2GetWorkspaceSettingResponse.md
Normal file
9
docs/V2GetWorkspaceSettingResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2GetWorkspaceSettingResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**setting** | [**Apiv2WorkspaceSetting**](Apiv2WorkspaceSetting.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
15
docs/V2Inbox.md
Normal file
15
docs/V2Inbox.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# V2Inbox
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **str** | | [optional]
|
||||||
|
**sender** | **str** | | [optional]
|
||||||
|
**receiver** | **str** | | [optional]
|
||||||
|
**status** | [**V2InboxStatus**](V2InboxStatus.md) | | [optional]
|
||||||
|
**create_time** | **datetime** | | [optional]
|
||||||
|
**type** | [**V2InboxType**](V2InboxType.md) | | [optional]
|
||||||
|
**activity_id** | **int** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
14
docs/V2InboxNameBody.md
Normal file
14
docs/V2InboxNameBody.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
# V2InboxNameBody
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**sender** | **str** | | [optional]
|
||||||
|
**receiver** | **str** | | [optional]
|
||||||
|
**status** | [**V2InboxStatus**](V2InboxStatus.md) | | [optional]
|
||||||
|
**create_time** | **datetime** | | [optional]
|
||||||
|
**type** | [**V2InboxType**](V2InboxType.md) | | [optional]
|
||||||
|
**activity_id** | **int** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2InboxStatus.md
Normal file
8
docs/V2InboxStatus.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2InboxStatus
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2InboxType.md
Normal file
8
docs/V2InboxType.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2InboxType
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListInboxesResponse.md
Normal file
9
docs/V2ListInboxesResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListInboxesResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**inboxes** | [**list[V2Inbox]**](V2Inbox.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListMemoCommentsResponse.md
Normal file
9
docs/V2ListMemoCommentsResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListMemoCommentsResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memos** | [**list[V2Memo]**](V2Memo.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListMemoReactionsResponse.md
Normal file
9
docs/V2ListMemoReactionsResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListMemoReactionsResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**reactions** | [**list[Apiv2Reaction]**](Apiv2Reaction.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListMemoRelationsResponse.md
Normal file
9
docs/V2ListMemoRelationsResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListMemoRelationsResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**relations** | [**list[V2MemoRelation]**](V2MemoRelation.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListMemoResourcesResponse.md
Normal file
9
docs/V2ListMemoResourcesResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListMemoResourcesResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**resources** | [**list[V2Resource]**](V2Resource.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
10
docs/V2ListMemosResponse.md
Normal file
10
docs/V2ListMemosResponse.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# V2ListMemosResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memos** | [**list[V2Memo]**](V2Memo.md) | | [optional]
|
||||||
|
**next_page_token** | **str** | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListResourcesResponse.md
Normal file
9
docs/V2ListResourcesResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListResourcesResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**resources** | [**list[V2Resource]**](V2Resource.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListTagsResponse.md
Normal file
9
docs/V2ListTagsResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListTagsResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**tags** | [**list[V2Tag]**](V2Tag.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListUserAccessTokensResponse.md
Normal file
9
docs/V2ListUserAccessTokensResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListUserAccessTokensResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**access_tokens** | [**list[V2UserAccessToken]**](V2UserAccessToken.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListUsersResponse.md
Normal file
9
docs/V2ListUsersResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListUsersResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**users** | [**list[V2User]**](V2User.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2ListWebhooksResponse.md
Normal file
9
docs/V2ListWebhooksResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2ListWebhooksResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**webhooks** | [**list[Apiv2Webhook]**](Apiv2Webhook.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
23
docs/V2Memo.md
Normal file
23
docs/V2Memo.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# V2Memo
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **int** | id is the system generated unique identifier. | [optional]
|
||||||
|
**name** | **str** | name is the user provided name. | [optional]
|
||||||
|
**row_status** | [**Apiv2RowStatus**](Apiv2RowStatus.md) | | [optional]
|
||||||
|
**creator** | **str** | | [optional]
|
||||||
|
**creator_id** | **int** | | [optional]
|
||||||
|
**create_time** | **datetime** | | [optional]
|
||||||
|
**update_time** | **datetime** | | [optional]
|
||||||
|
**display_time** | **datetime** | | [optional]
|
||||||
|
**content** | **str** | | [optional]
|
||||||
|
**visibility** | [**V2Visibility**](V2Visibility.md) | | [optional]
|
||||||
|
**pinned** | **bool** | | [optional]
|
||||||
|
**parent_id** | **int** | | [optional]
|
||||||
|
**resources** | [**list[V2Resource]**](V2Resource.md) | | [optional]
|
||||||
|
**relations** | [**list[V2MemoRelation]**](V2MemoRelation.md) | | [optional]
|
||||||
|
**reactions** | [**list[Apiv2Reaction]**](Apiv2Reaction.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
11
docs/V2MemoRelation.md
Normal file
11
docs/V2MemoRelation.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# V2MemoRelation
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memo_id** | **int** | | [optional]
|
||||||
|
**related_memo_id** | **int** | | [optional]
|
||||||
|
**type** | [**V2MemoRelationType**](V2MemoRelationType.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2MemoRelationType.md
Normal file
8
docs/V2MemoRelationType.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2MemoRelationType
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2RenameTagResponse.md
Normal file
9
docs/V2RenameTagResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2RenameTagResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**tag** | [**V2Tag**](V2Tag.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
16
docs/V2Resource.md
Normal file
16
docs/V2Resource.md
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
# V2Resource
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **int** | id is the system generated unique identifier. | [optional]
|
||||||
|
**name** | **str** | name is the user provided name. | [optional]
|
||||||
|
**create_time** | **datetime** | | [optional]
|
||||||
|
**filename** | **str** | | [optional]
|
||||||
|
**external_link** | **str** | | [optional]
|
||||||
|
**type** | **str** | | [optional]
|
||||||
|
**size** | **str** | | [optional]
|
||||||
|
**memo_id** | **int** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2SetMemoRelationsResponse.md
Normal file
8
docs/V2SetMemoRelationsResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2SetMemoRelationsResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2SetMemoResourcesResponse.md
Normal file
8
docs/V2SetMemoResourcesResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2SetMemoResourcesResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2SetWorkspaceSettingResponse.md
Normal file
9
docs/V2SetWorkspaceSettingResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2SetWorkspaceSettingResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**setting** | [**Apiv2WorkspaceSetting**](Apiv2WorkspaceSetting.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
12
docs/V2SettingNameBody.md
Normal file
12
docs/V2SettingNameBody.md
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# V2SettingNameBody
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**locale** | **str** | The preferred locale of the user. | [optional]
|
||||||
|
**appearance** | **str** | The preferred appearance of the user. | [optional]
|
||||||
|
**memo_visibility** | **str** | The default visibility of the memo. | [optional]
|
||||||
|
**telegram_user_id** | **str** | The telegram user id of the user. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2SignInResponse.md
Normal file
9
docs/V2SignInResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2SignInResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**user** | [**V2User**](V2User.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2SignInWithSSOResponse.md
Normal file
9
docs/V2SignInWithSSOResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2SignInWithSSOResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**user** | [**V2User**](V2User.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
8
docs/V2SignOutResponse.md
Normal file
8
docs/V2SignOutResponse.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# V2SignOutResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2SignUpResponse.md
Normal file
9
docs/V2SignUpResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2SignUpResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**user** | [**V2User**](V2User.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
10
docs/V2Tag.md
Normal file
10
docs/V2Tag.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# V2Tag
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **str** | | [optional]
|
||||||
|
**creator** | **str** | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2UpdateInboxResponse.md
Normal file
9
docs/V2UpdateInboxResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2UpdateInboxResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**inbox** | [**V2Inbox**](V2Inbox.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2UpdateMemoResponse.md
Normal file
9
docs/V2UpdateMemoResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2UpdateMemoResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**memo** | [**V2Memo**](V2Memo.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2UpdateResourceResponse.md
Normal file
9
docs/V2UpdateResourceResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2UpdateResourceResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**resource** | [**V2Resource**](V2Resource.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2UpdateUserResponse.md
Normal file
9
docs/V2UpdateUserResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2UpdateUserResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**user** | [**V2User**](V2User.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2UpdateUserSettingResponse.md
Normal file
9
docs/V2UpdateUserSettingResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2UpdateUserSettingResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**setting** | [**Apiv2UserSetting**](Apiv2UserSetting.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2UpdateWebhookResponse.md
Normal file
9
docs/V2UpdateWebhookResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2UpdateWebhookResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**webhook** | [**Apiv2Webhook**](Apiv2Webhook.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
9
docs/V2UpsertMemoReactionResponse.md
Normal file
9
docs/V2UpsertMemoReactionResponse.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# V2UpsertMemoReactionResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**reaction** | [**Apiv2Reaction**](Apiv2Reaction.md) | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user