ching/memos-script
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
memos-script/README.md

235 lines
18 KiB
Markdown
Raw Blame History

# 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
Reference in New Issue View Git Blame Copy Permalink