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

feat: 更新 memos api

Browse Source
This commit is contained in:
Ching 2024-04-30 10:31:09 +08:00
parent 000e0252cd
commit c2643e6b5d
352 changed files with 24520 additions and 1603 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

313
README.md
View File

@ -53,7 +53,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.ActivityServiceApi(memos.ApiClient(configuration)) api_instance = memos.ActivityServiceApi(memos.ApiClient(configuration))
id = 56 # int | id = 56 # int | The system-generated unique identifier for the activity.
try: try:
# GetActivity returns the activity with the given id. # GetActivity returns the activity with the given id.
@ -69,159 +69,184 @@ All URIs are relative to */*
Class | Method | HTTP request | Description 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. *ActivityServiceApi* | [**activity_service_get_activity**](docs/ActivityServiceApi.md#activity_service_get_activity) | **GET** /api/v1/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_get_auth_status**](docs/AuthServiceApi.md#auth_service_get_auth_status) | **POST** /api/v1/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**](docs/AuthServiceApi.md#auth_service_sign_in) | **POST** /api/v1/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_in_with_sso**](docs/AuthServiceApi.md#auth_service_sign_in_with_sso) | **POST** /api/v1/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_out**](docs/AuthServiceApi.md#auth_service_sign_out) | **POST** /api/v1/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. *AuthServiceApi* | [**auth_service_sign_up**](docs/AuthServiceApi.md#auth_service_sign_up) | **POST** /api/v1/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. *IdentityProviderServiceApi* | [**identity_provider_service_create_identity_provider**](docs/IdentityProviderServiceApi.md#identity_provider_service_create_identity_provider) | **POST** /api/v1/identityProviders | CreateIdentityProvider creates an identity provider.
*InboxServiceApi* | [**inbox_service_list_inboxes**](docs/InboxServiceApi.md#inbox_service_list_inboxes) | **GET** /api/v2/inboxes | ListInboxes lists inboxes for a user. *IdentityProviderServiceApi* | [**identity_provider_service_delete_identity_provider**](docs/IdentityProviderServiceApi.md#identity_provider_service_delete_identity_provider) | **DELETE** /api/v1/{name_1} | DeleteIdentityProvider deletes an identity provider.
*InboxServiceApi* | [**inbox_service_update_inbox**](docs/InboxServiceApi.md#inbox_service_update_inbox) | **PATCH** /api/v2/{inbox.name} | UpdateInbox updates an inbox. *IdentityProviderServiceApi* | [**identity_provider_service_get_identity_provider**](docs/IdentityProviderServiceApi.md#identity_provider_service_get_identity_provider) | **GET** /api/v1/{name_1} | GetIdentityProvider gets an identity provider.
*MemoServiceApi* | [**memo_service_create_memo**](docs/MemoServiceApi.md#memo_service_create_memo) | **POST** /api/v2/memos | CreateMemo creates a memo. *IdentityProviderServiceApi* | [**identity_provider_service_list_identity_providers**](docs/IdentityProviderServiceApi.md#identity_provider_service_list_identity_providers) | **GET** /api/v1/identityProviders | ListIdentityProviders lists identity providers.
*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. *IdentityProviderServiceApi* | [**identity_provider_service_update_identity_provider**](docs/IdentityProviderServiceApi.md#identity_provider_service_update_identity_provider) | **PATCH** /api/v1/{identityProvider.name} | UpdateIdentityProvider updates an identity provider.
*MemoServiceApi* | [**memo_service_delete_memo**](docs/MemoServiceApi.md#memo_service_delete_memo) | **DELETE** /api/v2/memos/{id} | DeleteMemo deletes a memo by id. *InboxServiceApi* | [**inbox_service_delete_inbox**](docs/InboxServiceApi.md#inbox_service_delete_inbox) | **DELETE** /api/v1/{name_2} | DeleteInbox deletes an inbox.
*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. *InboxServiceApi* | [**inbox_service_list_inboxes**](docs/InboxServiceApi.md#inbox_service_list_inboxes) | **GET** /api/v1/inboxes | ListInboxes lists inboxes for a user.
*MemoServiceApi* | [**memo_service_export_memos**](docs/MemoServiceApi.md#memo_service_export_memos) | **POST** /api/v2/memos:export | ExportMemos exports memos. *InboxServiceApi* | [**inbox_service_update_inbox**](docs/InboxServiceApi.md#inbox_service_update_inbox) | **PATCH** /api/v1/{inbox.name} | UpdateInbox updates an inbox.
*MemoServiceApi* | [**memo_service_get_memo**](docs/MemoServiceApi.md#memo_service_get_memo) | **GET** /api/v2/memos/{id} | GetMemo gets a memo by id. *MarkdownServiceApi* | [**markdown_service_get_link_metadata**](docs/MarkdownServiceApi.md#markdown_service_get_link_metadata) | **GET** /api/v1/markdown/link:metadata | GetLinkMetadata returns metadata for a given link.
*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. *MarkdownServiceApi* | [**markdown_service_parse_markdown**](docs/MarkdownServiceApi.md#markdown_service_parse_markdown) | **POST** /api/v1/markdown/parse | Parses the given markdown content and returns a list of nodes.
*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. *MarkdownServiceApi* | [**markdown_service_restore_markdown**](docs/MarkdownServiceApi.md#markdown_service_restore_markdown) | **POST** /api/v1/markdown:restore | Restores the given nodes to markdown content.
*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_create_memo**](docs/MemoServiceApi.md#memo_service_create_memo) | **POST** /api/v1/memos | CreateMemo creates 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_create_memo_comment**](docs/MemoServiceApi.md#memo_service_create_memo_comment) | **POST** /api/v1/{name}/comments | CreateMemoComment creates a comment 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_delete_memo**](docs/MemoServiceApi.md#memo_service_delete_memo) | **DELETE** /api/v1/{name_4} | DeleteMemo deletes 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_delete_memo_reaction**](docs/MemoServiceApi.md#memo_service_delete_memo_reaction) | **DELETE** /api/v1/reactions/{reactionId} | DeleteMemoReaction deletes a reaction 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_export_memos**](docs/MemoServiceApi.md#memo_service_export_memos) | **POST** /api/v1/memos:export | ExportMemos exports memos.
*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_get_memo**](docs/MemoServiceApi.md#memo_service_get_memo) | **GET** /api/v1/{name_3} | GetMemo gets 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_get_user_memos_stats**](docs/MemoServiceApi.md#memo_service_get_user_memos_stats) | **GET** /api/v1/memos/stats | GetUserMemosStats gets stats of memos for a user.
*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_list_memo_comments**](docs/MemoServiceApi.md#memo_service_list_memo_comments) | **GET** /api/v1/{name}/comments | ListMemoComments lists comments for 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. *MemoServiceApi* | [**memo_service_list_memo_reactions**](docs/MemoServiceApi.md#memo_service_list_memo_reactions) | **GET** /api/v1/{name}/reactions | ListMemoReactions lists reactions for a memo.
*ResourceServiceApi* | [**resource_service_create_resource**](docs/ResourceServiceApi.md#resource_service_create_resource) | **POST** /api/v2/resources | CreateResource creates a new resource. *MemoServiceApi* | [**memo_service_list_memo_relations**](docs/MemoServiceApi.md#memo_service_list_memo_relations) | **GET** /api/v1/{name}/relations | ListMemoRelations lists relations for a memo.
*ResourceServiceApi* | [**resource_service_delete_resource**](docs/ResourceServiceApi.md#resource_service_delete_resource) | **DELETE** /api/v2/resources/{id} | DeleteResource deletes a resource by id. *MemoServiceApi* | [**memo_service_list_memo_resources**](docs/MemoServiceApi.md#memo_service_list_memo_resources) | **GET** /api/v1/{name}/resources | ListMemoResources lists resources for a memo.
*ResourceServiceApi* | [**resource_service_get_resource**](docs/ResourceServiceApi.md#resource_service_get_resource) | **GET** /api/v2/resources/{id} | GetResource returns a resource by id. *MemoServiceApi* | [**memo_service_list_memos**](docs/MemoServiceApi.md#memo_service_list_memos) | **GET** /api/v1/memos | ListMemos lists memos with pagination and filter.
*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. *MemoServiceApi* | [**memo_service_search_memos**](docs/MemoServiceApi.md#memo_service_search_memos) | **GET** /api/v1/memos:search | SearchMemos searches memos.
*ResourceServiceApi* | [**resource_service_list_resources**](docs/ResourceServiceApi.md#resource_service_list_resources) | **GET** /api/v2/resources | ListResources lists all resources. *MemoServiceApi* | [**memo_service_set_memo_relations**](docs/MemoServiceApi.md#memo_service_set_memo_relations) | **PATCH** /api/v1/{name}/relations | SetMemoRelations sets relations for a memo.
*ResourceServiceApi* | [**resource_service_update_resource**](docs/ResourceServiceApi.md#resource_service_update_resource) | **PATCH** /api/v2/resources/{resource.id} | UpdateResource updates a resource. *MemoServiceApi* | [**memo_service_set_memo_resources**](docs/MemoServiceApi.md#memo_service_set_memo_resources) | **PATCH** /api/v1/{name}/resources | SetMemoResources sets resources for a memo.
*TagServiceApi* | [**tag_service_batch_upsert_tag**](docs/TagServiceApi.md#tag_service_batch_upsert_tag) | **POST** /api/v2/tags:batchUpsert | BatchUpsertTag upserts multiple tags. *MemoServiceApi* | [**memo_service_update_memo**](docs/MemoServiceApi.md#memo_service_update_memo) | **PATCH** /api/v1/{memo.name} | UpdateMemo updates a memo.
*TagServiceApi* | [**tag_service_delete_tag**](docs/TagServiceApi.md#tag_service_delete_tag) | **DELETE** /api/v2/tags | DeleteTag deletes a tag. *MemoServiceApi* | [**memo_service_upsert_memo_reaction**](docs/MemoServiceApi.md#memo_service_upsert_memo_reaction) | **POST** /api/v1/{name}/reactions | UpsertMemoReaction upserts a reaction for a memo.
*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. *ResourceServiceApi* | [**resource_service_create_resource**](docs/ResourceServiceApi.md#resource_service_create_resource) | **POST** /api/v1/resources | CreateResource creates a new resource.
*TagServiceApi* | [**tag_service_list_tags**](docs/TagServiceApi.md#tag_service_list_tags) | **GET** /api/v2/tags | ListTags lists tags. *ResourceServiceApi* | [**resource_service_delete_resource**](docs/ResourceServiceApi.md#resource_service_delete_resource) | **DELETE** /api/v1/{name_3} | DeleteResource deletes a resource by name.
*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. *ResourceServiceApi* | [**resource_service_get_resource**](docs/ResourceServiceApi.md#resource_service_get_resource) | **GET** /api/v1/{name_2} | GetResource returns a resource by name.
*TagServiceApi* | [**tag_service_upsert_tag**](docs/TagServiceApi.md#tag_service_upsert_tag) | **POST** /api/v2/tags | UpsertTag upserts a tag. *ResourceServiceApi* | [**resource_service_list_resources**](docs/ResourceServiceApi.md#resource_service_list_resources) | **GET** /api/v1/resources | ListResources lists all resources.
*UserServiceApi* | [**user_service_create_user**](docs/UserServiceApi.md#user_service_create_user) | **POST** /api/v2/users | CreateUser creates a new user. *ResourceServiceApi* | [**resource_service_search_resources**](docs/ResourceServiceApi.md#resource_service_search_resources) | **GET** /api/v1/resources:search | SearchResources searches memos.
*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. *ResourceServiceApi* | [**resource_service_update_resource**](docs/ResourceServiceApi.md#resource_service_update_resource) | **PATCH** /api/v1/{resource.name} | UpdateResource updates a resource.
*UserServiceApi* | [**user_service_delete_user**](docs/UserServiceApi.md#user_service_delete_user) | **DELETE** /api/v2/{name} | DeleteUser deletes a user. *TagServiceApi* | [**tag_service_batch_upsert_tag**](docs/TagServiceApi.md#tag_service_batch_upsert_tag) | **POST** /api/v1/tags:batchUpsert | BatchUpsertTag upserts multiple tags.
*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. *TagServiceApi* | [**tag_service_delete_tag**](docs/TagServiceApi.md#tag_service_delete_tag) | **DELETE** /api/v1/tags | DeleteTag deletes a tag.
*UserServiceApi* | [**user_service_get_user**](docs/UserServiceApi.md#user_service_get_user) | **GET** /api/v2/{name} | GetUser gets a user by name. *TagServiceApi* | [**tag_service_get_tag_suggestions**](docs/TagServiceApi.md#tag_service_get_tag_suggestions) | **GET** /api/v1/tags/suggestion | GetTagSuggestions gets tag suggestions from the user's memos.
*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. *TagServiceApi* | [**tag_service_list_tags**](docs/TagServiceApi.md#tag_service_list_tags) | **GET** /api/v1/tags | ListTags lists tags.
*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. *TagServiceApi* | [**tag_service_rename_tag**](docs/TagServiceApi.md#tag_service_rename_tag) | **PATCH** /api/v1/tags:rename | RenameTag renames a tag. All related memos will be updated.
*UserServiceApi* | [**user_service_list_users**](docs/UserServiceApi.md#user_service_list_users) | **GET** /api/v2/users | ListUsers returns a list of users. *TagServiceApi* | [**tag_service_upsert_tag**](docs/TagServiceApi.md#tag_service_upsert_tag) | **POST** /api/v1/tags | UpsertTag upserts a tag.
*UserServiceApi* | [**user_service_update_user**](docs/UserServiceApi.md#user_service_update_user) | **PATCH** /api/v2/{user.name} | UpdateUser updates a user. *UserServiceApi* | [**user_service_create_user**](docs/UserServiceApi.md#user_service_create_user) | **POST** /api/v1/users | CreateUser creates a new 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. *UserServiceApi* | [**user_service_create_user_access_token**](docs/UserServiceApi.md#user_service_create_user_access_token) | **POST** /api/v1/{name}/access_tokens | CreateUserAccessToken creates a new access token for a user.
*WebhookServiceApi* | [**webhook_service_create_webhook**](docs/WebhookServiceApi.md#webhook_service_create_webhook) | **POST** /api/v2/webhooks | CreateWebhook creates a new webhook. *UserServiceApi* | [**user_service_delete_user**](docs/UserServiceApi.md#user_service_delete_user) | **DELETE** /api/v1/{name} | DeleteUser deletes a user.
*WebhookServiceApi* | [**webhook_service_delete_webhook**](docs/WebhookServiceApi.md#webhook_service_delete_webhook) | **DELETE** /api/v2/webhooks/{id} | DeleteWebhook deletes a webhook by id. *UserServiceApi* | [**user_service_delete_user_access_token**](docs/UserServiceApi.md#user_service_delete_user_access_token) | **DELETE** /api/v1/{name}/access_tokens/{accessToken} | DeleteUserAccessToken deletes an access token for a user.
*WebhookServiceApi* | [**webhook_service_get_webhook**](docs/WebhookServiceApi.md#webhook_service_get_webhook) | **GET** /api/v2/webhooks/{id} | GetWebhook returns a webhook by id. *UserServiceApi* | [**user_service_get_user**](docs/UserServiceApi.md#user_service_get_user) | **GET** /api/v1/{name} | GetUser gets a user by name.
*WebhookServiceApi* | [**webhook_service_list_webhooks**](docs/WebhookServiceApi.md#webhook_service_list_webhooks) | **GET** /api/v2/webhooks | ListWebhooks returns a list of webhooks. *UserServiceApi* | [**user_service_get_user_setting**](docs/UserServiceApi.md#user_service_get_user_setting) | **GET** /api/v1/{name}/setting | GetUserSetting gets the setting of a user.
*WebhookServiceApi* | [**webhook_service_update_webhook**](docs/WebhookServiceApi.md#webhook_service_update_webhook) | **PATCH** /api/v2/webhooks/{webhook.id} | UpdateWebhook updates a webhook. *UserServiceApi* | [**user_service_list_user_access_tokens**](docs/UserServiceApi.md#user_service_list_user_access_tokens) | **GET** /api/v1/{name}/access_tokens | ListUserAccessTokens returns a list of access tokens for a user.
*WorkspaceServiceApi* | [**workspace_service_get_workspace_profile**](docs/WorkspaceServiceApi.md#workspace_service_get_workspace_profile) | **GET** /api/v2/workspace/profile | GetWorkspaceProfile returns the workspace profile. *UserServiceApi* | [**user_service_list_users**](docs/UserServiceApi.md#user_service_list_users) | **GET** /api/v1/users | ListUsers returns a list of users.
*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. *UserServiceApi* | [**user_service_search_users**](docs/UserServiceApi.md#user_service_search_users) | **GET** /api/v1/users:search | SearchUsers searches users by filter.
*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. *UserServiceApi* | [**user_service_update_user**](docs/UserServiceApi.md#user_service_update_user) | **PATCH** /api/v1/{user.name} | UpdateUser updates a user.
*UserServiceApi* | [**user_service_update_user_setting**](docs/UserServiceApi.md#user_service_update_user_setting) | **PATCH** /api/v1/{setting.name} | UpdateUserSetting updates the setting of a user.
*WebhookServiceApi* | [**webhook_service_create_webhook**](docs/WebhookServiceApi.md#webhook_service_create_webhook) | **POST** /api/v1/webhooks | CreateWebhook creates a new webhook.
*WebhookServiceApi* | [**webhook_service_delete_webhook**](docs/WebhookServiceApi.md#webhook_service_delete_webhook) | **DELETE** /api/v1/webhooks/{id} | DeleteWebhook deletes a webhook by id.
*WebhookServiceApi* | [**webhook_service_get_webhook**](docs/WebhookServiceApi.md#webhook_service_get_webhook) | **GET** /api/v1/webhooks/{id} | GetWebhook returns a webhook by id.
*WebhookServiceApi* | [**webhook_service_list_webhooks**](docs/WebhookServiceApi.md#webhook_service_list_webhooks) | **GET** /api/v1/webhooks | ListWebhooks returns a list of webhooks.
*WebhookServiceApi* | [**webhook_service_update_webhook**](docs/WebhookServiceApi.md#webhook_service_update_webhook) | **PATCH** /api/v1/webhooks/{webhook.id} | UpdateWebhook updates a webhook.
*WorkspaceServiceApi* | [**workspace_service_get_workspace_profile**](docs/WorkspaceServiceApi.md#workspace_service_get_workspace_profile) | **GET** /api/v1/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/v1/workspace/{name} | GetWorkspaceSetting returns the setting by name.
*WorkspaceSettingServiceApi* | [**workspace_setting_service_list_workspace_settings**](docs/WorkspaceSettingServiceApi.md#workspace_setting_service_list_workspace_settings) | **GET** /api/v1/workspace/settings | ListWorkspaceSetting returns the list of settings.
*WorkspaceSettingServiceApi* | [**workspace_setting_service_set_workspace_setting**](docs/WorkspaceSettingServiceApi.md#workspace_setting_service_set_workspace_setting) | **PATCH** /api/v1/workspace/{setting.name} | SetWorkspaceSetting updates the setting.
## Documentation For Models ## Documentation For Models
- [Apiv2ActivityMemoCommentPayload](docs/Apiv2ActivityMemoCommentPayload.md) - [Apiv1ActivityMemoCommentPayload](docs/Apiv1ActivityMemoCommentPayload.md)
- [Apiv2ActivityPayload](docs/Apiv2ActivityPayload.md) - [Apiv1ActivityPayload](docs/Apiv1ActivityPayload.md)
- [Apiv2ActivityVersionUpdatePayload](docs/Apiv2ActivityVersionUpdatePayload.md) - [Apiv1ActivityVersionUpdatePayload](docs/Apiv1ActivityVersionUpdatePayload.md)
- [Apiv2Reaction](docs/Apiv2Reaction.md) - [Apiv1FieldMapping](docs/Apiv1FieldMapping.md)
- [Apiv2ReactionType](docs/Apiv2ReactionType.md) - [Apiv1IdentityProvider](docs/Apiv1IdentityProvider.md)
- [Apiv2RowStatus](docs/Apiv2RowStatus.md) - [Apiv1IdentityProviderConfig](docs/Apiv1IdentityProviderConfig.md)
- [Apiv2UserSetting](docs/Apiv2UserSetting.md) - [Apiv1IdentityProviderType](docs/Apiv1IdentityProviderType.md)
- [Apiv2Webhook](docs/Apiv2Webhook.md) - [Apiv1OAuth2Config](docs/Apiv1OAuth2Config.md)
- [Apiv2WorkspaceGeneralSetting](docs/Apiv2WorkspaceGeneralSetting.md) - [Apiv1UserSetting](docs/Apiv1UserSetting.md)
- [Apiv2WorkspaceSetting](docs/Apiv2WorkspaceSetting.md) - [Apiv1WorkspaceCustomProfile](docs/Apiv1WorkspaceCustomProfile.md)
- [Apiv1WorkspaceGeneralSetting](docs/Apiv1WorkspaceGeneralSetting.md)
- [Apiv1WorkspaceMemoRelatedSetting](docs/Apiv1WorkspaceMemoRelatedSetting.md)
- [Apiv1WorkspaceSetting](docs/Apiv1WorkspaceSetting.md)
- [Apiv1WorkspaceStorageSetting](docs/Apiv1WorkspaceStorageSetting.md)
- [Apiv1WorkspaceStorageSettingS3Config](docs/Apiv1WorkspaceStorageSettingS3Config.md)
- [Apiv1WorkspaceStorageSettingStorageType](docs/Apiv1WorkspaceStorageSettingStorageType.md)
- [GooglerpcStatus](docs/GooglerpcStatus.md) - [GooglerpcStatus](docs/GooglerpcStatus.md)
- [MemoServiceSetMemoRelationsBody](docs/MemoServiceSetMemoRelationsBody.md) - [MemoServiceSetMemoRelationsBody](docs/MemoServiceSetMemoRelationsBody.md)
- [MemoServiceSetMemoResourcesBody](docs/MemoServiceSetMemoResourcesBody.md) - [MemoServiceSetMemoResourcesBody](docs/MemoServiceSetMemoResourcesBody.md)
- [MemosMemoIdBody](docs/MemosMemoIdBody.md) - [MemoServiceUpsertMemoReactionBody](docs/MemoServiceUpsertMemoReactionBody.md)
- [ProtobufAny](docs/ProtobufAny.md) - [ProtobufAny](docs/ProtobufAny.md)
- [ResourcesResourceIdBody](docs/ResourcesResourceIdBody.md)
- [SettingIsTheSettingToUpdate_](docs/SettingIsTheSettingToUpdate_.md) - [SettingIsTheSettingToUpdate_](docs/SettingIsTheSettingToUpdate_.md)
- [TableNodeRow](docs/TableNodeRow.md)
- [TheIdentityProviderToUpdate_](docs/TheIdentityProviderToUpdate_.md)
- [UserRole](docs/UserRole.md) - [UserRole](docs/UserRole.md)
- [UserServiceCreateUserAccessTokenBody](docs/UserServiceCreateUserAccessTokenBody.md) - [UserServiceCreateUserAccessTokenBody](docs/UserServiceCreateUserAccessTokenBody.md)
- [V2Activity](docs/V2Activity.md) - [V1Activity](docs/V1Activity.md)
- [V2BatchUpsertTagResponse](docs/V2BatchUpsertTagResponse.md) - [V1AutoLinkNode](docs/V1AutoLinkNode.md)
- [V2CreateMemoCommentResponse](docs/V2CreateMemoCommentResponse.md) - [V1BatchUpsertTagRequest](docs/V1BatchUpsertTagRequest.md)
- [V2CreateMemoRequest](docs/V2CreateMemoRequest.md) - [V1BlockquoteNode](docs/V1BlockquoteNode.md)
- [V2CreateMemoResponse](docs/V2CreateMemoResponse.md) - [V1BoldItalicNode](docs/V1BoldItalicNode.md)
- [V2CreateResourceResponse](docs/V2CreateResourceResponse.md) - [V1BoldNode](docs/V1BoldNode.md)
- [V2CreateUserAccessTokenResponse](docs/V2CreateUserAccessTokenResponse.md) - [V1CodeBlockNode](docs/V1CodeBlockNode.md)
- [V2CreateUserResponse](docs/V2CreateUserResponse.md) - [V1CodeNode](docs/V1CodeNode.md)
- [V2CreateWebhookRequest](docs/V2CreateWebhookRequest.md) - [V1CreateMemoRequest](docs/V1CreateMemoRequest.md)
- [V2CreateWebhookResponse](docs/V2CreateWebhookResponse.md) - [V1CreateWebhookRequest](docs/V1CreateWebhookRequest.md)
- [V2DeleteInboxResponse](docs/V2DeleteInboxResponse.md) - [V1EmbeddedContentNode](docs/V1EmbeddedContentNode.md)
- [V2DeleteMemoReactionResponse](docs/V2DeleteMemoReactionResponse.md) - [V1EscapingCharacterNode](docs/V1EscapingCharacterNode.md)
- [V2DeleteMemoResponse](docs/V2DeleteMemoResponse.md) - [V1ExportMemosRequest](docs/V1ExportMemosRequest.md)
- [V2DeleteResourceResponse](docs/V2DeleteResourceResponse.md) - [V1ExportMemosResponse](docs/V1ExportMemosResponse.md)
- [V2DeleteTagResponse](docs/V2DeleteTagResponse.md) - [V1GetTagSuggestionsResponse](docs/V1GetTagSuggestionsResponse.md)
- [V2DeleteUserAccessTokenResponse](docs/V2DeleteUserAccessTokenResponse.md) - [V1GetUserMemosStatsResponse](docs/V1GetUserMemosStatsResponse.md)
- [V2DeleteUserResponse](docs/V2DeleteUserResponse.md) - [V1HeadingNode](docs/V1HeadingNode.md)
- [V2DeleteWebhookResponse](docs/V2DeleteWebhookResponse.md) - [V1HighlightNode](docs/V1HighlightNode.md)
- [V2ExportMemosResponse](docs/V2ExportMemosResponse.md) - [V1HorizontalRuleNode](docs/V1HorizontalRuleNode.md)
- [V2GetActivityResponse](docs/V2GetActivityResponse.md) - [V1ImageNode](docs/V1ImageNode.md)
- [V2GetAuthStatusResponse](docs/V2GetAuthStatusResponse.md) - [V1Inbox](docs/V1Inbox.md)
- [V2GetMemoByNameResponse](docs/V2GetMemoByNameResponse.md) - [V1InboxNameBody](docs/V1InboxNameBody.md)
- [V2GetMemoResponse](docs/V2GetMemoResponse.md) - [V1InboxStatus](docs/V1InboxStatus.md)
- [V2GetResourceByNameResponse](docs/V2GetResourceByNameResponse.md) - [V1InboxType](docs/V1InboxType.md)
- [V2GetResourceResponse](docs/V2GetResourceResponse.md) - [V1ItalicNode](docs/V1ItalicNode.md)
- [V2GetTagSuggestionsResponse](docs/V2GetTagSuggestionsResponse.md) - [V1LineBreakNode](docs/V1LineBreakNode.md)
- [V2GetUserMemosStatsResponse](docs/V2GetUserMemosStatsResponse.md) - [V1LinkMetadata](docs/V1LinkMetadata.md)
- [V2GetUserResponse](docs/V2GetUserResponse.md) - [V1LinkNode](docs/V1LinkNode.md)
- [V2GetUserSettingResponse](docs/V2GetUserSettingResponse.md) - [V1ListIdentityProvidersResponse](docs/V1ListIdentityProvidersResponse.md)
- [V2GetWebhookResponse](docs/V2GetWebhookResponse.md) - [V1ListInboxesResponse](docs/V1ListInboxesResponse.md)
- [V2GetWorkspaceProfileResponse](docs/V2GetWorkspaceProfileResponse.md) - [V1ListMemoCommentsResponse](docs/V1ListMemoCommentsResponse.md)
- [V2GetWorkspaceSettingResponse](docs/V2GetWorkspaceSettingResponse.md) - [V1ListMemoReactionsResponse](docs/V1ListMemoReactionsResponse.md)
- [V2Inbox](docs/V2Inbox.md) - [V1ListMemoRelationsResponse](docs/V1ListMemoRelationsResponse.md)
- [V2InboxNameBody](docs/V2InboxNameBody.md) - [V1ListMemoResourcesResponse](docs/V1ListMemoResourcesResponse.md)
- [V2InboxStatus](docs/V2InboxStatus.md) - [V1ListMemosResponse](docs/V1ListMemosResponse.md)
- [V2InboxType](docs/V2InboxType.md) - [V1ListResourcesResponse](docs/V1ListResourcesResponse.md)
- [V2ListInboxesResponse](docs/V2ListInboxesResponse.md) - [V1ListTagsResponse](docs/V1ListTagsResponse.md)
- [V2ListMemoCommentsResponse](docs/V2ListMemoCommentsResponse.md) - [V1ListUserAccessTokensResponse](docs/V1ListUserAccessTokensResponse.md)
- [V2ListMemoReactionsResponse](docs/V2ListMemoReactionsResponse.md) - [V1ListUsersResponse](docs/V1ListUsersResponse.md)
- [V2ListMemoRelationsResponse](docs/V2ListMemoRelationsResponse.md) - [V1ListWebhooksResponse](docs/V1ListWebhooksResponse.md)
- [V2ListMemoResourcesResponse](docs/V2ListMemoResourcesResponse.md) - [V1ListWorkspaceSettingsResponse](docs/V1ListWorkspaceSettingsResponse.md)
- [V2ListMemosResponse](docs/V2ListMemosResponse.md) - [V1MathBlockNode](docs/V1MathBlockNode.md)
- [V2ListResourcesResponse](docs/V2ListResourcesResponse.md) - [V1MathNode](docs/V1MathNode.md)
- [V2ListTagsResponse](docs/V2ListTagsResponse.md) - [V1Memo](docs/V1Memo.md)
- [V2ListUserAccessTokensResponse](docs/V2ListUserAccessTokensResponse.md) - [V1MemoNameBody](docs/V1MemoNameBody.md)
- [V2ListUsersResponse](docs/V2ListUsersResponse.md) - [V1MemoRelation](docs/V1MemoRelation.md)
- [V2ListWebhooksResponse](docs/V2ListWebhooksResponse.md) - [V1MemoRelationType](docs/V1MemoRelationType.md)
- [V2Memo](docs/V2Memo.md) - [V1Node](docs/V1Node.md)
- [V2MemoRelation](docs/V2MemoRelation.md) - [V1NodeType](docs/V1NodeType.md)
- [V2MemoRelationType](docs/V2MemoRelationType.md) - [V1OrderedListNode](docs/V1OrderedListNode.md)
- [V2RenameTagResponse](docs/V2RenameTagResponse.md) - [V1ParagraphNode](docs/V1ParagraphNode.md)
- [V2Resource](docs/V2Resource.md) - [V1ParseMarkdownRequest](docs/V1ParseMarkdownRequest.md)
- [V2SetMemoRelationsResponse](docs/V2SetMemoRelationsResponse.md) - [V1ParseMarkdownResponse](docs/V1ParseMarkdownResponse.md)
- [V2SetMemoResourcesResponse](docs/V2SetMemoResourcesResponse.md) - [V1Reaction](docs/V1Reaction.md)
- [V2SetWorkspaceSettingResponse](docs/V2SetWorkspaceSettingResponse.md) - [V1ReactionType](docs/V1ReactionType.md)
- [V2SettingNameBody](docs/V2SettingNameBody.md) - [V1ReferencedContentNode](docs/V1ReferencedContentNode.md)
- [V2SignInResponse](docs/V2SignInResponse.md) - [V1RenameTagRequest](docs/V1RenameTagRequest.md)
- [V2SignInWithSSOResponse](docs/V2SignInWithSSOResponse.md) - [V1Resource](docs/V1Resource.md)
- [V2SignOutResponse](docs/V2SignOutResponse.md) - [V1ResourceNameBody](docs/V1ResourceNameBody.md)
- [V2SignUpResponse](docs/V2SignUpResponse.md) - [V1RestoreMarkdownRequest](docs/V1RestoreMarkdownRequest.md)
- [V2Tag](docs/V2Tag.md) - [V1RestoreMarkdownResponse](docs/V1RestoreMarkdownResponse.md)
- [V2UpdateInboxResponse](docs/V2UpdateInboxResponse.md) - [V1RowStatus](docs/V1RowStatus.md)
- [V2UpdateMemoResponse](docs/V2UpdateMemoResponse.md) - [V1SearchMemosResponse](docs/V1SearchMemosResponse.md)
- [V2UpdateResourceResponse](docs/V2UpdateResourceResponse.md) - [V1SearchResourcesResponse](docs/V1SearchResourcesResponse.md)
- [V2UpdateUserResponse](docs/V2UpdateUserResponse.md) - [V1SearchUsersResponse](docs/V1SearchUsersResponse.md)
- [V2UpdateUserSettingResponse](docs/V2UpdateUserSettingResponse.md) - [V1SettingNameBody](docs/V1SettingNameBody.md)
- [V2UpdateWebhookResponse](docs/V2UpdateWebhookResponse.md) - [V1SpoilerNode](docs/V1SpoilerNode.md)
- [V2UpsertMemoReactionResponse](docs/V2UpsertMemoReactionResponse.md) - [V1StrikethroughNode](docs/V1StrikethroughNode.md)
- [V2UpsertTagRequest](docs/V2UpsertTagRequest.md) - [V1SubscriptNode](docs/V1SubscriptNode.md)
- [V2UpsertTagResponse](docs/V2UpsertTagResponse.md) - [V1SuperscriptNode](docs/V1SuperscriptNode.md)
- [V2User](docs/V2User.md) - [V1TableNode](docs/V1TableNode.md)
- [V2UserAccessToken](docs/V2UserAccessToken.md) - [V1Tag](docs/V1Tag.md)
- [V2UserNameBody](docs/V2UserNameBody.md) - [V1TagNode](docs/V1TagNode.md)
- [V2Visibility](docs/V2Visibility.md) - [V1TaskListNode](docs/V1TaskListNode.md)
- [V2WorkspaceProfile](docs/V2WorkspaceProfile.md) - [V1TextNode](docs/V1TextNode.md)
- [V1UnorderedListNode](docs/V1UnorderedListNode.md)
- [V1UpsertTagRequest](docs/V1UpsertTagRequest.md)
- [V1User](docs/V1User.md)
- [V1UserAccessToken](docs/V1UserAccessToken.md)
- [V1UserNameBody](docs/V1UserNameBody.md)
- [V1Visibility](docs/V1Visibility.md)
- [V1Webhook](docs/V1Webhook.md)
- [V1WorkspaceProfile](docs/V1WorkspaceProfile.md)
- [WebhooksWebhookIdBody](docs/WebhooksWebhookIdBody.md) - [WebhooksWebhookIdBody](docs/WebhooksWebhookIdBody.md)
## Documentation For Authorization ## Documentation For Authorization

10
docs/ActivityServiceApi.md
View File

@ -4,10 +4,10 @@ All URIs are relative to */*
Method | HTTP request | Description 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**](ActivityServiceApi.md#activity_service_get_activity) | **GET** /api/v1/activities/{id} | GetActivity returns the activity with the given id.
# **activity_service_get_activity** # **activity_service_get_activity**
> V2GetActivityResponse activity_service_get_activity(id) > V1Activity activity_service_get_activity(id)
GetActivity returns the activity with the given id. GetActivity returns the activity with the given id.
@ -21,7 +21,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.ActivityServiceApi() api_instance = memos.ActivityServiceApi()
id = 56 # int | id = 56 # int | The system-generated unique identifier for the activity.
try: try:
# GetActivity returns the activity with the given id. # GetActivity returns the activity with the given id.
@ -35,11 +35,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **id** | **int**| The system-generated unique identifier for the activity. |
### Return type ### Return type
[**V2GetActivityResponse**](V2GetActivityResponse.md) [**V1Activity**](V1Activity.md)
### Authorization ### Authorization

10
docs/Apiv1ActivityMemoCommentPayload.md Normal file
View File

@ -0,0 +1,10 @@
# Apiv1ActivityMemoCommentPayload
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memo_id** | **int** | The memo id of comment. | [optional]
**related_memo_id** | **int** | The memo id of related memo. | [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/Apiv1ActivityPayload.md Normal file
View File

@ -0,0 +1,10 @@
# Apiv1ActivityPayload
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memo_comment** | [**Apiv1ActivityMemoCommentPayload**](Apiv1ActivityMemoCommentPayload.md) | | [optional]
**version_update** | [**Apiv1ActivityVersionUpdatePayload**](Apiv1ActivityVersionUpdatePayload.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/Apiv1ActivityVersionUpdatePayload.md Normal file
View File

@ -0,0 +1,9 @@
# Apiv1ActivityVersionUpdatePayload
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **str** | The updated version of memos. | [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/Apiv1FieldMapping.md Normal file
View File

@ -0,0 +1,11 @@
# Apiv1FieldMapping
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identifier** | **str** | | [optional]
**display_name** | **str** | | [optional]
**email** | **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/Apiv1IdentityProvider.md Normal file
View File

@ -0,0 +1,13 @@
# Apiv1IdentityProvider
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**type** | [**Apiv1IdentityProviderType**](Apiv1IdentityProviderType.md) | | [optional]
**title** | **str** | | [optional]
**identifier_filter** | **str** | | [optional]
**config** | [**Apiv1IdentityProviderConfig**](Apiv1IdentityProviderConfig.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/Apiv1IdentityProviderConfig.md Normal file
View File

@ -0,0 +1,9 @@
# Apiv1IdentityProviderConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**oauth2_config** | [**Apiv1OAuth2Config**](Apiv1OAuth2Config.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/Apiv1IdentityProviderType.md Normal file
View File

@ -0,0 +1,8 @@
# Apiv1IdentityProviderType
## 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)

15
docs/Apiv1OAuth2Config.md Normal file
View File

@ -0,0 +1,15 @@
# Apiv1OAuth2Config
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client_id** | **str** | | [optional]
**client_secret** | **str** | | [optional]
**auth_url** | **str** | | [optional]
**token_url** | **str** | | [optional]
**user_info_url** | **str** | | [optional]
**scopes** | **list[str]** | | [optional]
**field_mapping** | [**Apiv1FieldMapping**](Apiv1FieldMapping.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/Apiv1UserSetting.md Normal file
View File

@ -0,0 +1,12 @@
# Apiv1UserSetting
## 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]
[[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/Apiv1WorkspaceCustomProfile.md Normal file
View File

@ -0,0 +1,13 @@
# Apiv1WorkspaceCustomProfile
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | | [optional]
**description** | **str** | | [optional]
**logo_url** | **str** | | [optional]
**locale** | **str** | | [optional]
**appearance** | **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)

14
docs/Apiv1WorkspaceGeneralSetting.md Normal file
View File

@ -0,0 +1,14 @@
# Apiv1WorkspaceGeneralSetting
## 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]
**custom_profile** | [**Apiv1WorkspaceCustomProfile**](Apiv1WorkspaceCustomProfile.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/Apiv1WorkspaceMemoRelatedSetting.md Normal file
View File

@ -0,0 +1,10 @@
# Apiv1WorkspaceMemoRelatedSetting
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**disallow_public_visible** | **bool** | disallow_public_share disallows set memo as public visible. | [optional]
**display_with_update_time** | **bool** | display_with_update_time orders and displays memo with update time. | [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/Apiv1WorkspaceSetting.md Normal file
View File

@ -0,0 +1,12 @@
# Apiv1WorkspaceSetting
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**general_setting** | [**Apiv1WorkspaceGeneralSetting**](Apiv1WorkspaceGeneralSetting.md) | | [optional]
**storage_setting** | [**Apiv1WorkspaceStorageSetting**](Apiv1WorkspaceStorageSetting.md) | | [optional]
**memo_related_setting** | [**Apiv1WorkspaceMemoRelatedSetting**](Apiv1WorkspaceMemoRelatedSetting.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/Apiv1WorkspaceStorageSetting.md Normal file
View File

@ -0,0 +1,12 @@
# Apiv1WorkspaceStorageSetting
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**storage_type** | [**Apiv1WorkspaceStorageSettingStorageType**](Apiv1WorkspaceStorageSettingStorageType.md) | | [optional]
**filepath_template** | **str** | | [optional]
**upload_size_limit_mb** | **str** | The max upload size in megabytes. | [optional]
**s3_config** | [**Apiv1WorkspaceStorageSettingS3Config**](Apiv1WorkspaceStorageSettingS3Config.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)

13
docs/Apiv1WorkspaceStorageSettingS3Config.md Normal file
View File

@ -0,0 +1,13 @@
# Apiv1WorkspaceStorageSettingS3Config
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_key_id** | **str** | | [optional]
**access_key_secret** | **str** | | [optional]
**endpoint** | **str** | | [optional]
**region** | **str** | | [optional]
**bucket** | **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)

8
docs/Apiv1WorkspaceStorageSettingStorageType.md Normal file
View File

@ -0,0 +1,8 @@
# Apiv1WorkspaceStorageSettingStorageType
## 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)

62
docs/AuthServiceApi.md
View File

@ -4,14 +4,14 @@ All URIs are relative to */*
Method | HTTP request | Description 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_get_auth_status**](AuthServiceApi.md#auth_service_get_auth_status) | **POST** /api/v1/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**](AuthServiceApi.md#auth_service_sign_in) | **POST** /api/v1/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_in_with_sso**](AuthServiceApi.md#auth_service_sign_in_with_sso) | **POST** /api/v1/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_out**](AuthServiceApi.md#auth_service_sign_out) | **POST** /api/v1/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_sign_up**](AuthServiceApi.md#auth_service_sign_up) | **POST** /api/v1/auth/signup | SignUp signs up the user with the given username and password.
# **auth_service_get_auth_status** # **auth_service_get_auth_status**
> V2GetAuthStatusResponse auth_service_get_auth_status() > V1User auth_service_get_auth_status()
GetAuthStatus returns the current auth status of the user. GetAuthStatus returns the current auth status of the user.
@ -39,7 +39,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**V2GetAuthStatusResponse**](V2GetAuthStatusResponse.md) [**V1User**](V1User.md)
### Authorization ### Authorization
@ -53,7 +53,7 @@ No authorization required
[[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) [[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** # **auth_service_sign_in**
> V2SignInResponse auth_service_sign_in(username=username, password=password, never_expire=never_expire) > V1User auth_service_sign_in(username=username, password=password, never_expire=never_expire)
SignIn signs in the user with the given username and password. SignIn signs in the user with the given username and password.
@ -67,9 +67,9 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.AuthServiceApi() api_instance = memos.AuthServiceApi()
username = 'username_example' # str | (optional) username = 'username_example' # str | The username to sign in with. (optional)
password = 'password_example' # str | (optional) password = 'password_example' # str | The password to sign in with. (optional)
never_expire = true # bool | (optional) never_expire = true # bool | Whether the session should never expire. (optional)
try: try:
# SignIn signs in the user with the given username and password. # SignIn signs in the user with the given username and password.
@ -83,13 +83,13 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**username** | **str**| | [optional] **username** | **str**| The username to sign in with. | [optional]
**password** | **str**| | [optional] **password** | **str**| The password to sign in with. | [optional]
**never_expire** | **bool**| | [optional] **never_expire** | **bool**| Whether the session should never expire. | [optional]
### Return type ### Return type
[**V2SignInResponse**](V2SignInResponse.md) [**V1User**](V1User.md)
### Authorization ### Authorization
@ -103,7 +103,7 @@ No authorization required
[[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) [[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** # **auth_service_sign_in_with_sso**
> V2SignInWithSSOResponse auth_service_sign_in_with_sso(idp_id=idp_id, code=code, redirect_uri=redirect_uri) > V1User 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. SignInWithSSO signs in the user with the given SSO code.
@ -117,9 +117,9 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.AuthServiceApi() api_instance = memos.AuthServiceApi()
idp_id = 56 # int | (optional) idp_id = 56 # int | The ID of the SSO provider. (optional)
code = 'code_example' # str | (optional) code = 'code_example' # str | The code to sign in with. (optional)
redirect_uri = 'redirect_uri_example' # str | (optional) redirect_uri = 'redirect_uri_example' # str | The redirect URI. (optional)
try: try:
# SignInWithSSO signs in the user with the given SSO code. # SignInWithSSO signs in the user with the given SSO code.
@ -133,13 +133,13 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**idp_id** | **int**| | [optional] **idp_id** | **int**| The ID of the SSO provider. | [optional]
**code** | **str**| | [optional] **code** | **str**| The code to sign in with. | [optional]
**redirect_uri** | **str**| | [optional] **redirect_uri** | **str**| The redirect URI. | [optional]
### Return type ### Return type
[**V2SignInWithSSOResponse**](V2SignInWithSSOResponse.md) [**V1User**](V1User.md)
### Authorization ### Authorization
@ -153,7 +153,7 @@ No authorization required
[[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) [[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** # **auth_service_sign_out**
> V2SignOutResponse auth_service_sign_out() > object auth_service_sign_out()
SignOut signs out the user. SignOut signs out the user.
@ -181,7 +181,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**V2SignOutResponse**](V2SignOutResponse.md) **object**
### Authorization ### Authorization
@ -195,7 +195,7 @@ No authorization required
[[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) [[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** # **auth_service_sign_up**
> V2SignUpResponse auth_service_sign_up(username=username, password=password) > V1User auth_service_sign_up(username=username, password=password)
SignUp signs up the user with the given username and password. SignUp signs up the user with the given username and password.
@ -209,8 +209,8 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.AuthServiceApi() api_instance = memos.AuthServiceApi()
username = 'username_example' # str | (optional) username = 'username_example' # str | The username to sign up with. (optional)
password = 'password_example' # str | (optional) password = 'password_example' # str | The password to sign up with. (optional)
try: try:
# SignUp signs up the user with the given username and password. # SignUp signs up the user with the given username and password.
@ -224,12 +224,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**username** | **str**| | [optional] **username** | **str**| The username to sign up with. | [optional]
**password** | **str**| | [optional] **password** | **str**| The password to sign up with. | [optional]
### Return type ### Return type
[**V2SignUpResponse**](V2SignUpResponse.md) [**V1User**](V1User.md)
### Authorization ### Authorization

240
docs/IdentityProviderServiceApi.md Normal file
View File

@ -0,0 +1,240 @@
# memos.IdentityProviderServiceApi
All URIs are relative to */*
Method | HTTP request | Description
------------- | ------------- | -------------
[**identity_provider_service_create_identity_provider**](IdentityProviderServiceApi.md#identity_provider_service_create_identity_provider) | **POST** /api/v1/identityProviders | CreateIdentityProvider creates an identity provider.
[**identity_provider_service_delete_identity_provider**](IdentityProviderServiceApi.md#identity_provider_service_delete_identity_provider) | **DELETE** /api/v1/{name_1} | DeleteIdentityProvider deletes an identity provider.
[**identity_provider_service_get_identity_provider**](IdentityProviderServiceApi.md#identity_provider_service_get_identity_provider) | **GET** /api/v1/{name_1} | GetIdentityProvider gets an identity provider.
[**identity_provider_service_list_identity_providers**](IdentityProviderServiceApi.md#identity_provider_service_list_identity_providers) | **GET** /api/v1/identityProviders | ListIdentityProviders lists identity providers.
[**identity_provider_service_update_identity_provider**](IdentityProviderServiceApi.md#identity_provider_service_update_identity_provider) | **PATCH** /api/v1/{identityProvider.name} | UpdateIdentityProvider updates an identity provider.
# **identity_provider_service_create_identity_provider**
> Apiv1IdentityProvider identity_provider_service_create_identity_provider(body)
CreateIdentityProvider creates an identity provider.
### 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.IdentityProviderServiceApi()
body = memos.Apiv1IdentityProvider() # Apiv1IdentityProvider | The identityProvider to create.
try:
# CreateIdentityProvider creates an identity provider.
api_response = api_instance.identity_provider_service_create_identity_provider(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderServiceApi->identity_provider_service_create_identity_provider: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Apiv1IdentityProvider**](Apiv1IdentityProvider.md)| The identityProvider to create. |
### Return type
[**Apiv1IdentityProvider**](Apiv1IdentityProvider.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)
# **identity_provider_service_delete_identity_provider**
> object identity_provider_service_delete_identity_provider(name_1)
DeleteIdentityProvider deletes an identity provider.
### 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.IdentityProviderServiceApi()
name_1 = 'name_1_example' # str | The name of the identityProvider to delete. Format: identityProviders/{id}
try:
# DeleteIdentityProvider deletes an identity provider.
api_response = api_instance.identity_provider_service_delete_identity_provider(name_1)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderServiceApi->identity_provider_service_delete_identity_provider: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name_1** | **str**| The name of the identityProvider to delete. Format: identityProviders/{id} |
### Return type
**object**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **identity_provider_service_get_identity_provider**
> Apiv1IdentityProvider identity_provider_service_get_identity_provider(name_1)
GetIdentityProvider gets an identity provider.
### 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.IdentityProviderServiceApi()
name_1 = 'name_1_example' # str | The name of the identityProvider to get. Format: identityProviders/{id}
try:
# GetIdentityProvider gets an identity provider.
api_response = api_instance.identity_provider_service_get_identity_provider(name_1)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderServiceApi->identity_provider_service_get_identity_provider: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name_1** | **str**| The name of the identityProvider to get. Format: identityProviders/{id} |
### Return type
[**Apiv1IdentityProvider**](Apiv1IdentityProvider.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)
# **identity_provider_service_list_identity_providers**
> V1ListIdentityProvidersResponse identity_provider_service_list_identity_providers()
ListIdentityProviders lists identity providers.
### 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.IdentityProviderServiceApi()
try:
# ListIdentityProviders lists identity providers.
api_response = api_instance.identity_provider_service_list_identity_providers()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderServiceApi->identity_provider_service_list_identity_providers: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**V1ListIdentityProvidersResponse**](V1ListIdentityProvidersResponse.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)
# **identity_provider_service_update_identity_provider**
> Apiv1IdentityProvider identity_provider_service_update_identity_provider(body, identity_provider_name)
UpdateIdentityProvider updates an identity provider.
### 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.IdentityProviderServiceApi()
body = memos.TheIdentityProviderToUpdate_() # TheIdentityProviderToUpdate_ | The identityProvider to update.
identity_provider_name = 'identity_provider_name_example' # str | The name of the identityProvider. Format: identityProviders/{id}
try:
# UpdateIdentityProvider updates an identity provider.
api_response = api_instance.identity_provider_service_update_identity_provider(body, identity_provider_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderServiceApi->identity_provider_service_update_identity_provider: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**TheIdentityProviderToUpdate_**](TheIdentityProviderToUpdate_.md)| The identityProvider to update. |
**identity_provider_name** | **str**| The name of the identityProvider. Format: identityProviders/{id} |
### Return type
[**Apiv1IdentityProvider**](Apiv1IdentityProvider.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)

36
docs/InboxServiceApi.md
View File

@ -4,12 +4,12 @@ All URIs are relative to */*
Method | HTTP request | Description 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_delete_inbox**](InboxServiceApi.md#inbox_service_delete_inbox) | **DELETE** /api/v1/{name_2} | 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_list_inboxes**](InboxServiceApi.md#inbox_service_list_inboxes) | **GET** /api/v1/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_update_inbox**](InboxServiceApi.md#inbox_service_update_inbox) | **PATCH** /api/v1/{inbox.name} | UpdateInbox updates an inbox.
# **inbox_service_delete_inbox** # **inbox_service_delete_inbox**
> V2DeleteInboxResponse inbox_service_delete_inbox(name_1) > object inbox_service_delete_inbox(name_2)
DeleteInbox deletes an inbox. DeleteInbox deletes an inbox.
@ -23,11 +23,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.InboxServiceApi() api_instance = memos.InboxServiceApi()
name_1 = 'name_1_example' # str | The name of the inbox to delete. Format: inboxes/{uid} name_2 = 'name_2_example' # str | The name of the inbox to delete. Format: inboxes/{id}
try: try:
# DeleteInbox deletes an inbox. # DeleteInbox deletes an inbox.
api_response = api_instance.inbox_service_delete_inbox(name_1) api_response = api_instance.inbox_service_delete_inbox(name_2)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling InboxServiceApi->inbox_service_delete_inbox: %s\n" % e) print("Exception when calling InboxServiceApi->inbox_service_delete_inbox: %s\n" % e)
@ -37,11 +37,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**name_1** | **str**| The name of the inbox to delete. Format: inboxes/{uid} | **name_2** | **str**| The name of the inbox to delete. Format: inboxes/{id} |
### Return type ### Return type
[**V2DeleteInboxResponse**](V2DeleteInboxResponse.md) **object**
### Authorization ### Authorization
@ -55,7 +55,7 @@ No authorization required
[[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) [[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** # **inbox_service_list_inboxes**
> V2ListInboxesResponse inbox_service_list_inboxes(user=user) > V1ListInboxesResponse inbox_service_list_inboxes(user=user)
ListInboxes lists inboxes for a user. ListInboxes lists inboxes for a user.
@ -69,7 +69,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.InboxServiceApi() api_instance = memos.InboxServiceApi()
user = 'user_example' # str | Format: users/{username} (optional) user = 'user_example' # str | Format: users/{id} (optional)
try: try:
# ListInboxes lists inboxes for a user. # ListInboxes lists inboxes for a user.
@ -83,11 +83,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**user** | **str**| Format: users/{username} | [optional] **user** | **str**| Format: users/{id} | [optional]
### Return type ### Return type
[**V2ListInboxesResponse**](V2ListInboxesResponse.md) [**V1ListInboxesResponse**](V1ListInboxesResponse.md)
### Authorization ### Authorization
@ -101,7 +101,7 @@ No authorization required
[[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) [[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** # **inbox_service_update_inbox**
> V2UpdateInboxResponse inbox_service_update_inbox(body, inbox_name) > V1Inbox inbox_service_update_inbox(body, inbox_name)
UpdateInbox updates an inbox. UpdateInbox updates an inbox.
@ -115,8 +115,8 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.InboxServiceApi() api_instance = memos.InboxServiceApi()
body = memos.V2InboxNameBody() # V2InboxNameBody | body = memos.V1InboxNameBody() # V1InboxNameBody |
inbox_name = 'inbox_name_example' # str | The name of the inbox. Format: inboxes/{uid} inbox_name = 'inbox_name_example' # str | The name of the inbox. Format: inboxes/{id}
try: try:
# UpdateInbox updates an inbox. # UpdateInbox updates an inbox.
@ -130,12 +130,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**V2InboxNameBody**](V2InboxNameBody.md)| | **body** | [**V1InboxNameBody**](V1InboxNameBody.md)| |
**inbox_name** | **str**| The name of the inbox. Format: inboxes/{uid} | **inbox_name** | **str**| The name of the inbox. Format: inboxes/{id} |
### Return type ### Return type
[**V2UpdateInboxResponse**](V2UpdateInboxResponse.md) [**V1Inbox**](V1Inbox.md)
### Authorization ### Authorization

148
docs/MarkdownServiceApi.md Normal file
View File

@ -0,0 +1,148 @@
# memos.MarkdownServiceApi
All URIs are relative to */*
Method | HTTP request | Description
------------- | ------------- | -------------
[**markdown_service_get_link_metadata**](MarkdownServiceApi.md#markdown_service_get_link_metadata) | **GET** /api/v1/markdown/link:metadata | GetLinkMetadata returns metadata for a given link.
[**markdown_service_parse_markdown**](MarkdownServiceApi.md#markdown_service_parse_markdown) | **POST** /api/v1/markdown/parse | Parses the given markdown content and returns a list of nodes.
[**markdown_service_restore_markdown**](MarkdownServiceApi.md#markdown_service_restore_markdown) | **POST** /api/v1/markdown:restore | Restores the given nodes to markdown content.
# **markdown_service_get_link_metadata**
> V1LinkMetadata markdown_service_get_link_metadata(link=link)
GetLinkMetadata returns metadata for a given link.
### 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.MarkdownServiceApi()
link = 'link_example' # str | (optional)
try:
# GetLinkMetadata returns metadata for a given link.
api_response = api_instance.markdown_service_get_link_metadata(link=link)
pprint(api_response)
except ApiException as e:
print("Exception when calling MarkdownServiceApi->markdown_service_get_link_metadata: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**link** | **str**| | [optional]
### Return type
[**V1LinkMetadata**](V1LinkMetadata.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)
# **markdown_service_parse_markdown**
> V1ParseMarkdownResponse markdown_service_parse_markdown(body)
Parses the given markdown content and returns a list of nodes.
### 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.MarkdownServiceApi()
body = memos.V1ParseMarkdownRequest() # V1ParseMarkdownRequest |
try:
# Parses the given markdown content and returns a list of nodes.
api_response = api_instance.markdown_service_parse_markdown(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling MarkdownServiceApi->markdown_service_parse_markdown: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**V1ParseMarkdownRequest**](V1ParseMarkdownRequest.md)| |
### Return type
[**V1ParseMarkdownResponse**](V1ParseMarkdownResponse.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)
# **markdown_service_restore_markdown**
> V1RestoreMarkdownResponse markdown_service_restore_markdown(body)
Restores the given nodes to markdown content.
### 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.MarkdownServiceApi()
body = memos.V1RestoreMarkdownRequest() # V1RestoreMarkdownRequest |
try:
# Restores the given nodes to markdown content.
api_response = api_instance.markdown_service_restore_markdown(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling MarkdownServiceApi->markdown_service_restore_markdown: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**V1RestoreMarkdownRequest**](V1RestoreMarkdownRequest.md)| |
### Return type
[**V1RestoreMarkdownResponse**](V1RestoreMarkdownResponse.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)

312
docs/MemoServiceApi.md
View File

@ -4,26 +4,26 @@ All URIs are relative to */*
Method | HTTP request | Description 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**](MemoServiceApi.md#memo_service_create_memo) | **POST** /api/v1/memos | CreateMemo creates a memo.
[**memo_service_create_memo_comment**](MemoServiceApi.md#memo_service_create_memo_comment) | **POST** /api/v2/memos/{id}/comments | CreateMemoComment creates a comment for a memo. [**memo_service_create_memo_comment**](MemoServiceApi.md#memo_service_create_memo_comment) | **POST** /api/v1/{name}/comments | CreateMemoComment creates a comment for a memo.
[**memo_service_delete_memo**](MemoServiceApi.md#memo_service_delete_memo) | **DELETE** /api/v2/memos/{id} | DeleteMemo deletes a memo by id. [**memo_service_delete_memo**](MemoServiceApi.md#memo_service_delete_memo) | **DELETE** /api/v1/{name_4} | DeleteMemo deletes a memo.
[**memo_service_delete_memo_reaction**](MemoServiceApi.md#memo_service_delete_memo_reaction) | **DELETE** /api/v2/memos/{id}/reactions/{reactionId} | DeleteMemoReaction deletes a reaction for a memo. [**memo_service_delete_memo_reaction**](MemoServiceApi.md#memo_service_delete_memo_reaction) | **DELETE** /api/v1/reactions/{reactionId} | DeleteMemoReaction deletes a reaction for a memo.
[**memo_service_export_memos**](MemoServiceApi.md#memo_service_export_memos) | **POST** /api/v2/memos:export | ExportMemos exports memos. [**memo_service_export_memos**](MemoServiceApi.md#memo_service_export_memos) | **POST** /api/v1/memos:export | ExportMemos exports memos.
[**memo_service_get_memo**](MemoServiceApi.md#memo_service_get_memo) | **GET** /api/v2/memos/{id} | GetMemo gets a memo by id. [**memo_service_get_memo**](MemoServiceApi.md#memo_service_get_memo) | **GET** /api/v1/{name_3} | GetMemo gets a memo.
[**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/v1/memos/stats | GetUserMemosStats gets stats of memos for a user.
[**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/v1/{name}/comments | ListMemoComments lists comments for a memo.
[**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/v1/{name}/reactions | ListMemoReactions lists reactions 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/v1/{name}/relations | ListMemoRelations lists relations 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/v1/{name}/resources | ListMemoResources lists resources 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/v1/memos | ListMemos lists memos with pagination and filter.
[**memo_service_list_memos**](MemoServiceApi.md#memo_service_list_memos) | **GET** /api/v2/memos | ListMemos lists memos with pagination and filter. [**memo_service_search_memos**](MemoServiceApi.md#memo_service_search_memos) | **GET** /api/v1/memos:search | SearchMemos searches memos.
[**memo_service_set_memo_relations**](MemoServiceApi.md#memo_service_set_memo_relations) | **POST** /api/v2/memos/{id}/relations | SetMemoRelations sets relations for a memo. [**memo_service_set_memo_relations**](MemoServiceApi.md#memo_service_set_memo_relations) | **PATCH** /api/v1/{name}/relations | SetMemoRelations sets relations for a memo.
[**memo_service_set_memo_resources**](MemoServiceApi.md#memo_service_set_memo_resources) | **POST** /api/v2/memos/{id}/resources | SetMemoResources sets resources for a memo. [**memo_service_set_memo_resources**](MemoServiceApi.md#memo_service_set_memo_resources) | **PATCH** /api/v1/{name}/resources | SetMemoResources sets resources for a memo.
[**memo_service_update_memo**](MemoServiceApi.md#memo_service_update_memo) | **PATCH** /api/v2/memos/{memo.id} | UpdateMemo updates a memo. [**memo_service_update_memo**](MemoServiceApi.md#memo_service_update_memo) | **PATCH** /api/v1/{memo.name} | UpdateMemo updates a memo.
[**memo_service_upsert_memo_reaction**](MemoServiceApi.md#memo_service_upsert_memo_reaction) | **POST** /api/v2/memos/{id}/reactions | UpsertMemoReaction upserts a reaction for a memo. [**memo_service_upsert_memo_reaction**](MemoServiceApi.md#memo_service_upsert_memo_reaction) | **POST** /api/v1/{name}/reactions | UpsertMemoReaction upserts a reaction for a memo.
# **memo_service_create_memo** # **memo_service_create_memo**
> V2CreateMemoResponse memo_service_create_memo(body) > V1Memo memo_service_create_memo(body)
CreateMemo creates a memo. CreateMemo creates a memo.
@ -37,7 +37,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
body = memos.V2CreateMemoRequest() # V2CreateMemoRequest | body = memos.V1CreateMemoRequest() # V1CreateMemoRequest |
try: try:
# CreateMemo creates a memo. # CreateMemo creates a memo.
@ -51,11 +51,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**V2CreateMemoRequest**](V2CreateMemoRequest.md)| | **body** | [**V1CreateMemoRequest**](V1CreateMemoRequest.md)| |
### Return type ### Return type
[**V2CreateMemoResponse**](V2CreateMemoResponse.md) [**V1Memo**](V1Memo.md)
### Authorization ### Authorization
@ -69,7 +69,7 @@ No authorization required
[[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) [[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** # **memo_service_create_memo_comment**
> V2CreateMemoCommentResponse memo_service_create_memo_comment(id, create_content=create_content, create_visibility=create_visibility) > V1Memo memo_service_create_memo_comment(body, name)
CreateMemoComment creates a comment for a memo. CreateMemoComment creates a comment for a memo.
@ -83,13 +83,12 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int | id is the memo id to create comment for. body = memos.V1CreateMemoRequest() # V1CreateMemoRequest |
create_content = 'create_content_example' # str | (optional) name = 'name_example' # str | The name of the memo. Format: memos/{id}
create_visibility = 'VISIBILITY_UNSPECIFIED' # str | (optional) (default to VISIBILITY_UNSPECIFIED)
try: try:
# CreateMemoComment creates a comment for a memo. # 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) api_response = api_instance.memo_service_create_memo_comment(body, name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_create_memo_comment: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_create_memo_comment: %s\n" % e)
@ -99,13 +98,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| id is the memo id to create comment for. | **body** | [**V1CreateMemoRequest**](V1CreateMemoRequest.md)| |
**create_content** | **str**| | [optional] **name** | **str**| The name of the memo. Format: memos/{id} |
**create_visibility** | **str**| | [optional] [default to VISIBILITY_UNSPECIFIED]
### Return type ### Return type
[**V2CreateMemoCommentResponse**](V2CreateMemoCommentResponse.md) [**V1Memo**](V1Memo.md)
### Authorization ### Authorization
@ -113,15 +111,15 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: 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) [[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** # **memo_service_delete_memo**
> V2DeleteMemoResponse memo_service_delete_memo(id) > object memo_service_delete_memo(name_4)
DeleteMemo deletes a memo by id. DeleteMemo deletes a memo.
### Example ### Example
```python ```python
@ -133,11 +131,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int | name_4 = 'name_4_example' # str | The name of the memo. Format: memos/{id}
try: try:
# DeleteMemo deletes a memo by id. # DeleteMemo deletes a memo.
api_response = api_instance.memo_service_delete_memo(id) api_response = api_instance.memo_service_delete_memo(name_4)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_delete_memo: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_delete_memo: %s\n" % e)
@ -147,11 +145,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **name_4** | **str**| The name of the memo. Format: memos/{id} |
### Return type ### Return type
[**V2DeleteMemoResponse**](V2DeleteMemoResponse.md) **object**
### Authorization ### Authorization
@ -165,7 +163,7 @@ No authorization required
[[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) [[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** # **memo_service_delete_memo_reaction**
> V2DeleteMemoReactionResponse memo_service_delete_memo_reaction(id, reaction_id) > object memo_service_delete_memo_reaction(reaction_id)
DeleteMemoReaction deletes a reaction for a memo. DeleteMemoReaction deletes a reaction for a memo.
@ -179,12 +177,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int |
reaction_id = 56 # int | reaction_id = 56 # int |
try: try:
# DeleteMemoReaction deletes a reaction for a memo. # DeleteMemoReaction deletes a reaction for a memo.
api_response = api_instance.memo_service_delete_memo_reaction(id, reaction_id) api_response = api_instance.memo_service_delete_memo_reaction(reaction_id)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_delete_memo_reaction: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_delete_memo_reaction: %s\n" % e)
@ -194,12 +191,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| |
**reaction_id** | **int**| | **reaction_id** | **int**| |
### Return type ### Return type
[**V2DeleteMemoReactionResponse**](V2DeleteMemoReactionResponse.md) **object**
### Authorization ### Authorization
@ -213,7 +209,7 @@ No authorization required
[[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) [[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** # **memo_service_export_memos**
> V2ExportMemosResponse memo_service_export_memos(filter=filter) > V1ExportMemosResponse memo_service_export_memos(body)
ExportMemos exports memos. ExportMemos exports memos.
@ -227,11 +223,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
filter = 'filter_example' # str | Same as ListMemosRequest.filter (optional) body = memos.V1ExportMemosRequest() # V1ExportMemosRequest |
try: try:
# ExportMemos exports memos. # ExportMemos exports memos.
api_response = api_instance.memo_service_export_memos(filter=filter) api_response = api_instance.memo_service_export_memos(body)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_export_memos: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_export_memos: %s\n" % e)
@ -241,11 +237,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**filter** | **str**| Same as ListMemosRequest.filter | [optional] **body** | [**V1ExportMemosRequest**](V1ExportMemosRequest.md)| |
### Return type ### Return type
[**V2ExportMemosResponse**](V2ExportMemosResponse.md) [**V1ExportMemosResponse**](V1ExportMemosResponse.md)
### Authorization ### Authorization
@ -253,15 +249,15 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: 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) [[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** # **memo_service_get_memo**
> V2GetMemoResponse memo_service_get_memo(id) > V1Memo memo_service_get_memo(name_3)
GetMemo gets a memo by id. GetMemo gets a memo.
### Example ### Example
```python ```python
@ -273,11 +269,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int | name_3 = 'name_3_example' # str | The name of the memo. Format: memos/{id}
try: try:
# GetMemo gets a memo by id. # GetMemo gets a memo.
api_response = api_instance.memo_service_get_memo(id) api_response = api_instance.memo_service_get_memo(name_3)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_get_memo: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_get_memo: %s\n" % e)
@ -287,57 +283,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **name_3** | **str**| The name of the memo. Format: memos/{id} |
### Return type ### Return type
[**V2GetMemoResponse**](V2GetMemoResponse.md) [**V1Memo**](V1Memo.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **memo_service_get_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 ### Authorization
@ -351,7 +301,7 @@ No authorization required
[[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) [[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** # **memo_service_get_user_memos_stats**
> V2GetUserMemosStatsResponse memo_service_get_user_memos_stats(name=name, timezone=timezone, filter=filter) > V1GetUserMemosStatsResponse memo_service_get_user_memos_stats(name=name, timezone=timezone, filter=filter)
GetUserMemosStats gets stats of memos for a user. GetUserMemosStats gets stats of memos for a user.
@ -365,7 +315,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
name = 'name_example' # str | name is the name of the user to get stats for. Format: users/{username} (optional) name = 'name_example' # str | name is the name of the user to get stats for. Format: users/{id} (optional)
timezone = 'timezone_example' # str | timezone location Format: uses tz identifier https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional) 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) filter = 'filter_example' # str | Same as ListMemosRequest.filter (optional)
@ -381,13 +331,13 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**name** | **str**| name is the name of the user to get stats for. Format: users/{username} | [optional] **name** | **str**| name is the name of the user to get stats for. Format: users/{id} | [optional]
**timezone** | **str**| timezone location Format: uses tz identifier https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | [optional] **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] **filter** | **str**| Same as ListMemosRequest.filter | [optional]
### Return type ### Return type
[**V2GetUserMemosStatsResponse**](V2GetUserMemosStatsResponse.md) [**V1GetUserMemosStatsResponse**](V1GetUserMemosStatsResponse.md)
### Authorization ### Authorization
@ -401,7 +351,7 @@ No authorization required
[[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) [[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** # **memo_service_list_memo_comments**
> V2ListMemoCommentsResponse memo_service_list_memo_comments(id) > V1ListMemoCommentsResponse memo_service_list_memo_comments(name)
ListMemoComments lists comments for a memo. ListMemoComments lists comments for a memo.
@ -415,11 +365,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int | name = 'name_example' # str | The name of the memo. Format: memos/{id}
try: try:
# ListMemoComments lists comments for a memo. # ListMemoComments lists comments for a memo.
api_response = api_instance.memo_service_list_memo_comments(id) api_response = api_instance.memo_service_list_memo_comments(name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_list_memo_comments: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_list_memo_comments: %s\n" % e)
@ -429,11 +379,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **name** | **str**| The name of the memo. Format: memos/{id} |
### Return type ### Return type
[**V2ListMemoCommentsResponse**](V2ListMemoCommentsResponse.md) [**V1ListMemoCommentsResponse**](V1ListMemoCommentsResponse.md)
### Authorization ### Authorization
@ -447,7 +397,7 @@ No authorization required
[[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) [[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** # **memo_service_list_memo_reactions**
> V2ListMemoReactionsResponse memo_service_list_memo_reactions(id) > V1ListMemoReactionsResponse memo_service_list_memo_reactions(name)
ListMemoReactions lists reactions for a memo. ListMemoReactions lists reactions for a memo.
@ -461,11 +411,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int | name = 'name_example' # str | The name of the memo. Format: memos/{id}
try: try:
# ListMemoReactions lists reactions for a memo. # ListMemoReactions lists reactions for a memo.
api_response = api_instance.memo_service_list_memo_reactions(id) api_response = api_instance.memo_service_list_memo_reactions(name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_list_memo_reactions: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_list_memo_reactions: %s\n" % e)
@ -475,11 +425,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **name** | **str**| The name of the memo. Format: memos/{id} |
### Return type ### Return type
[**V2ListMemoReactionsResponse**](V2ListMemoReactionsResponse.md) [**V1ListMemoReactionsResponse**](V1ListMemoReactionsResponse.md)
### Authorization ### Authorization
@ -493,7 +443,7 @@ No authorization required
[[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) [[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** # **memo_service_list_memo_relations**
> V2ListMemoRelationsResponse memo_service_list_memo_relations(id) > V1ListMemoRelationsResponse memo_service_list_memo_relations(name)
ListMemoRelations lists relations for a memo. ListMemoRelations lists relations for a memo.
@ -507,11 +457,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int | name = 'name_example' # str | The name of the memo. Format: memos/{id}
try: try:
# ListMemoRelations lists relations for a memo. # ListMemoRelations lists relations for a memo.
api_response = api_instance.memo_service_list_memo_relations(id) api_response = api_instance.memo_service_list_memo_relations(name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_list_memo_relations: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_list_memo_relations: %s\n" % e)
@ -521,11 +471,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **name** | **str**| The name of the memo. Format: memos/{id} |
### Return type ### Return type
[**V2ListMemoRelationsResponse**](V2ListMemoRelationsResponse.md) [**V1ListMemoRelationsResponse**](V1ListMemoRelationsResponse.md)
### Authorization ### Authorization
@ -539,7 +489,7 @@ No authorization required
[[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) [[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** # **memo_service_list_memo_resources**
> V2ListMemoResourcesResponse memo_service_list_memo_resources(id) > V1ListMemoResourcesResponse memo_service_list_memo_resources(name)
ListMemoResources lists resources for a memo. ListMemoResources lists resources for a memo.
@ -553,11 +503,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int | name = 'name_example' # str | The name of the memo. Format: memos/{id}
try: try:
# ListMemoResources lists resources for a memo. # ListMemoResources lists resources for a memo.
api_response = api_instance.memo_service_list_memo_resources(id) api_response = api_instance.memo_service_list_memo_resources(name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_list_memo_resources: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_list_memo_resources: %s\n" % e)
@ -567,11 +517,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **name** | **str**| The name of the memo. Format: memos/{id} |
### Return type ### Return type
[**V2ListMemoResourcesResponse**](V2ListMemoResourcesResponse.md) [**V1ListMemoResourcesResponse**](V1ListMemoResourcesResponse.md)
### Authorization ### Authorization
@ -585,7 +535,7 @@ No authorization required
[[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) [[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** # **memo_service_list_memos**
> V2ListMemosResponse memo_service_list_memos(page_size=page_size, page_token=page_token, filter=filter) > V1ListMemosResponse memo_service_list_memos(page_size=page_size, page_token=page_token, filter=filter)
ListMemos lists memos with pagination and filter. ListMemos lists memos with pagination and filter.
@ -601,7 +551,7 @@ from pprint import pprint
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
page_size = 56 # int | The maximum number of memos to return. (optional) 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) 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) filter = 'filter_example' # str | Filter is used to filter memos returned in the list. Format: \"creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']\" (optional)
try: try:
# ListMemos lists memos with pagination and filter. # ListMemos lists memos with pagination and filter.
@ -617,11 +567,57 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**page_size** | **int**| The maximum number of memos to return. | [optional] **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] **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] **filter** | **str**| Filter is used to filter memos returned in the list. Format: \"creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']\" | [optional]
### Return type ### Return type
[**V2ListMemosResponse**](V2ListMemosResponse.md) [**V1ListMemosResponse**](V1ListMemosResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **memo_service_search_memos**
> V1SearchMemosResponse memo_service_search_memos(filter=filter)
SearchMemos searches memos.
### Example
```python
from __future__ import print_function
import time
import memos
from memos.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = memos.MemoServiceApi()
filter = 'filter_example' # str | Filter is used to filter memos returned. Format: \"creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']\" (optional)
try:
# SearchMemos searches memos.
api_response = api_instance.memo_service_search_memos(filter=filter)
pprint(api_response)
except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_search_memos: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **str**| Filter is used to filter memos returned. Format: \"creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']\" | [optional]
### Return type
[**V1SearchMemosResponse**](V1SearchMemosResponse.md)
### Authorization ### Authorization
@ -635,7 +631,7 @@ No authorization required
[[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) [[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** # **memo_service_set_memo_relations**
> V2SetMemoRelationsResponse memo_service_set_memo_relations(body, id) > object memo_service_set_memo_relations(body, name)
SetMemoRelations sets relations for a memo. SetMemoRelations sets relations for a memo.
@ -650,11 +646,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
body = memos.MemoServiceSetMemoRelationsBody() # MemoServiceSetMemoRelationsBody | body = memos.MemoServiceSetMemoRelationsBody() # MemoServiceSetMemoRelationsBody |
id = 56 # int | name = 'name_example' # str | The name of the memo. Format: memos/{id}
try: try:
# SetMemoRelations sets relations for a memo. # SetMemoRelations sets relations for a memo.
api_response = api_instance.memo_service_set_memo_relations(body, id) api_response = api_instance.memo_service_set_memo_relations(body, name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_set_memo_relations: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_set_memo_relations: %s\n" % e)
@ -665,11 +661,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**MemoServiceSetMemoRelationsBody**](MemoServiceSetMemoRelationsBody.md)| | **body** | [**MemoServiceSetMemoRelationsBody**](MemoServiceSetMemoRelationsBody.md)| |
**id** | **int**| | **name** | **str**| The name of the memo. Format: memos/{id} |
### Return type ### Return type
[**V2SetMemoRelationsResponse**](V2SetMemoRelationsResponse.md) **object**
### Authorization ### Authorization
@ -683,7 +679,7 @@ No authorization required
[[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) [[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** # **memo_service_set_memo_resources**
> V2SetMemoResourcesResponse memo_service_set_memo_resources(body, id) > object memo_service_set_memo_resources(body, name)
SetMemoResources sets resources for a memo. SetMemoResources sets resources for a memo.
@ -698,11 +694,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
body = memos.MemoServiceSetMemoResourcesBody() # MemoServiceSetMemoResourcesBody | body = memos.MemoServiceSetMemoResourcesBody() # MemoServiceSetMemoResourcesBody |
id = 56 # int | name = 'name_example' # str | The name of the memo. Format: memos/{id}
try: try:
# SetMemoResources sets resources for a memo. # SetMemoResources sets resources for a memo.
api_response = api_instance.memo_service_set_memo_resources(body, id) api_response = api_instance.memo_service_set_memo_resources(body, name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_set_memo_resources: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_set_memo_resources: %s\n" % e)
@ -713,11 +709,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**MemoServiceSetMemoResourcesBody**](MemoServiceSetMemoResourcesBody.md)| | **body** | [**MemoServiceSetMemoResourcesBody**](MemoServiceSetMemoResourcesBody.md)| |
**id** | **int**| | **name** | **str**| The name of the memo. Format: memos/{id} |
### Return type ### Return type
[**V2SetMemoResourcesResponse**](V2SetMemoResourcesResponse.md) **object**
### Authorization ### Authorization
@ -731,7 +727,7 @@ No authorization required
[[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) [[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** # **memo_service_update_memo**
> V2UpdateMemoResponse memo_service_update_memo(body, memo_id) > V1Memo memo_service_update_memo(body, memo_name)
UpdateMemo updates a memo. UpdateMemo updates a memo.
@ -745,12 +741,12 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
body = memos.MemosMemoIdBody() # MemosMemoIdBody | body = memos.V1MemoNameBody() # V1MemoNameBody |
memo_id = 56 # int | id is the system generated unique identifier. memo_name = 'memo_name_example' # str | The name of the memo. Format: memos/{id} id is the system generated id.
try: try:
# UpdateMemo updates a memo. # UpdateMemo updates a memo.
api_response = api_instance.memo_service_update_memo(body, memo_id) api_response = api_instance.memo_service_update_memo(body, memo_name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_update_memo: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_update_memo: %s\n" % e)
@ -760,12 +756,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**MemosMemoIdBody**](MemosMemoIdBody.md)| | **body** | [**V1MemoNameBody**](V1MemoNameBody.md)| |
**memo_id** | **int**| id is the system generated unique identifier. | **memo_name** | **str**| The name of the memo. Format: memos/{id} id is the system generated id. |
### Return type ### Return type
[**V2UpdateMemoResponse**](V2UpdateMemoResponse.md) [**V1Memo**](V1Memo.md)
### Authorization ### Authorization
@ -779,7 +775,7 @@ No authorization required
[[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) [[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** # **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) > V1Reaction memo_service_upsert_memo_reaction(body, name)
UpsertMemoReaction upserts a reaction for a memo. UpsertMemoReaction upserts a reaction for a memo.
@ -793,15 +789,12 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.MemoServiceApi() api_instance = memos.MemoServiceApi()
id = 56 # int | body = memos.MemoServiceUpsertMemoReactionBody() # MemoServiceUpsertMemoReactionBody |
reaction_id = 56 # int | (optional) name = 'name_example' # str | The name of the memo. Format: memos/{id}
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: try:
# UpsertMemoReaction upserts a reaction for a memo. # 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) api_response = api_instance.memo_service_upsert_memo_reaction(body, name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MemoServiceApi->memo_service_upsert_memo_reaction: %s\n" % e) print("Exception when calling MemoServiceApi->memo_service_upsert_memo_reaction: %s\n" % e)
@ -811,15 +804,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **body** | [**MemoServiceUpsertMemoReactionBody**](MemoServiceUpsertMemoReactionBody.md)| |
**reaction_id** | **int**| | [optional] **name** | **str**| The name of the memo. Format: memos/{id} |
**reaction_creator** | **str**| | [optional]
**reaction_content_id** | **str**| | [optional]
**reaction_reaction_type** | **str**| | [optional] [default to TYPE_UNSPECIFIED]
### Return type ### Return type
[**V2UpsertMemoReactionResponse**](V2UpsertMemoReactionResponse.md) [**V1Reaction**](V1Reaction.md)
### Authorization ### Authorization
@ -827,7 +817,7 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: 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) [[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)

2
docs/MemoServiceSetMemoRelationsBody.md
View File

@ -3,7 +3,7 @@
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**relations** | [**list[V2MemoRelation]**](V2MemoRelation.md) | | [optional] **relations** | [**list[V1MemoRelation]**](V1MemoRelation.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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2
docs/MemoServiceSetMemoResourcesBody.md
View File

@ -3,7 +3,7 @@
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**resources** | [**list[V2Resource]**](V2Resource.md) | | [optional] **resources** | [**list[V1Resource]**](V1Resource.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) [[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/MemoServiceUpsertMemoReactionBody.md Normal file
View File

@ -0,0 +1,9 @@
# MemoServiceUpsertMemoReactionBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reaction** | [**V1Reaction**](V1Reaction.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)

168
docs/ResourceServiceApi.md
View File

@ -4,15 +4,15 @@ All URIs are relative to */*
Method | HTTP request | Description 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_create_resource**](ResourceServiceApi.md#resource_service_create_resource) | **POST** /api/v1/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_delete_resource**](ResourceServiceApi.md#resource_service_delete_resource) | **DELETE** /api/v1/{name_3} | DeleteResource deletes a resource by name.
[**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**](ResourceServiceApi.md#resource_service_get_resource) | **GET** /api/v1/{name_2} | GetResource returns a resource by name.
[**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/v1/resources | ListResources lists all resources.
[**resource_service_list_resources**](ResourceServiceApi.md#resource_service_list_resources) | **GET** /api/v2/resources | ListResources lists all resources. [**resource_service_search_resources**](ResourceServiceApi.md#resource_service_search_resources) | **GET** /api/v1/resources:search | SearchResources searches memos.
[**resource_service_update_resource**](ResourceServiceApi.md#resource_service_update_resource) | **PATCH** /api/v2/resources/{resource.id} | UpdateResource updates a resource. [**resource_service_update_resource**](ResourceServiceApi.md#resource_service_update_resource) | **PATCH** /api/v1/{resource.name} | UpdateResource updates a resource.
# **resource_service_create_resource** # **resource_service_create_resource**
> V2CreateResourceResponse resource_service_create_resource(filename=filename, external_link=external_link, type=type, memo_id=memo_id) > V1Resource resource_service_create_resource(body)
CreateResource creates a new resource. CreateResource creates a new resource.
@ -26,14 +26,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.ResourceServiceApi() api_instance = memos.ResourceServiceApi()
filename = 'filename_example' # str | (optional) body = memos.V1Resource() # V1Resource |
external_link = 'external_link_example' # str | (optional)
type = 'type_example' # str | (optional)
memo_id = 56 # int | (optional)
try: try:
# CreateResource creates a new resource. # 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) api_response = api_instance.resource_service_create_resource(body)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling ResourceServiceApi->resource_service_create_resource: %s\n" % e) print("Exception when calling ResourceServiceApi->resource_service_create_resource: %s\n" % e)
@ -43,14 +40,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**filename** | **str**| | [optional] **body** | [**V1Resource**](V1Resource.md)| |
**external_link** | **str**| | [optional]
**type** | **str**| | [optional]
**memo_id** | **int**| | [optional]
### Return type ### Return type
[**V2CreateResourceResponse**](V2CreateResourceResponse.md) [**V1Resource**](V1Resource.md)
### Authorization ### Authorization
@ -58,15 +52,15 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: 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) [[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** # **resource_service_delete_resource**
> V2DeleteResourceResponse resource_service_delete_resource(id) > object resource_service_delete_resource(name_3)
DeleteResource deletes a resource by id. DeleteResource deletes a resource by name.
### Example ### Example
```python ```python
@ -78,11 +72,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.ResourceServiceApi() api_instance = memos.ResourceServiceApi()
id = 56 # int | name_3 = 'name_3_example' # str | The name of the resource. Format: resources/{id} id is the system generated unique identifier.
try: try:
# DeleteResource deletes a resource by id. # DeleteResource deletes a resource by name.
api_response = api_instance.resource_service_delete_resource(id) api_response = api_instance.resource_service_delete_resource(name_3)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling ResourceServiceApi->resource_service_delete_resource: %s\n" % e) print("Exception when calling ResourceServiceApi->resource_service_delete_resource: %s\n" % e)
@ -92,11 +86,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **name_3** | **str**| The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
### Return type ### Return type
[**V2DeleteResourceResponse**](V2DeleteResourceResponse.md) **object**
### Authorization ### Authorization
@ -110,9 +104,9 @@ No authorization required
[[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) [[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** # **resource_service_get_resource**
> V2GetResourceResponse resource_service_get_resource(id) > V1Resource resource_service_get_resource(name_2)
GetResource returns a resource by id. GetResource returns a resource by name.
### Example ### Example
```python ```python
@ -124,11 +118,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.ResourceServiceApi() api_instance = memos.ResourceServiceApi()
id = 56 # int | name_2 = 'name_2_example' # str | The name of the resource. Format: resources/{id} id is the system generated unique identifier.
try: try:
# GetResource returns a resource by id. # GetResource returns a resource by name.
api_response = api_instance.resource_service_get_resource(id) api_response = api_instance.resource_service_get_resource(name_2)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling ResourceServiceApi->resource_service_get_resource: %s\n" % e) print("Exception when calling ResourceServiceApi->resource_service_get_resource: %s\n" % e)
@ -138,57 +132,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **int**| | **name_2** | **str**| The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
### Return type ### Return type
[**V2GetResourceResponse**](V2GetResourceResponse.md) [**V1Resource**](V1Resource.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 ### Authorization
@ -202,7 +150,7 @@ No authorization required
[[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) [[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** # **resource_service_list_resources**
> V2ListResourcesResponse resource_service_list_resources() > V1ListResourcesResponse resource_service_list_resources()
ListResources lists all resources. ListResources lists all resources.
@ -230,7 +178,53 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**V2ListResourcesResponse**](V2ListResourcesResponse.md) [**V1ListResourcesResponse**](V1ListResourcesResponse.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_search_resources**
> V1SearchResourcesResponse resource_service_search_resources(filter=filter)
SearchResources searches memos.
### Example
```python
from __future__ import print_function
import time
import memos
from memos.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = memos.ResourceServiceApi()
filter = 'filter_example' # str | (optional)
try:
# SearchResources searches memos.
api_response = api_instance.resource_service_search_resources(filter=filter)
pprint(api_response)
except ApiException as e:
print("Exception when calling ResourceServiceApi->resource_service_search_resources: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **str**| | [optional]
### Return type
[**V1SearchResourcesResponse**](V1SearchResourcesResponse.md)
### Authorization ### Authorization
@ -244,7 +238,7 @@ No authorization required
[[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) [[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** # **resource_service_update_resource**
> V2UpdateResourceResponse resource_service_update_resource(body, resource_id) > V1Resource resource_service_update_resource(body, resource_name)
UpdateResource updates a resource. UpdateResource updates a resource.
@ -258,12 +252,12 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.ResourceServiceApi() api_instance = memos.ResourceServiceApi()
body = memos.ResourcesResourceIdBody() # ResourcesResourceIdBody | body = memos.V1ResourceNameBody() # V1ResourceNameBody |
resource_id = 56 # int | id is the system generated unique identifier. resource_name = 'resource_name_example' # str | The name of the resource. Format: resources/{id} id is the system generated unique identifier.
try: try:
# UpdateResource updates a resource. # UpdateResource updates a resource.
api_response = api_instance.resource_service_update_resource(body, resource_id) api_response = api_instance.resource_service_update_resource(body, resource_name)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling ResourceServiceApi->resource_service_update_resource: %s\n" % e) print("Exception when calling ResourceServiceApi->resource_service_update_resource: %s\n" % e)
@ -273,12 +267,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**ResourcesResourceIdBody**](ResourcesResourceIdBody.md)| | **body** | [**V1ResourceNameBody**](V1ResourceNameBody.md)| |
**resource_id** | **int**| id is the system generated unique identifier. | **resource_name** | **str**| The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
### Return type ### Return type
[**V2UpdateResourceResponse**](V2UpdateResourceResponse.md) [**V1Resource**](V1Resource.md)
### Authorization ### Authorization

4
docs/SettingIsTheSettingToUpdate_.md
View File

@ -3,7 +3,9 @@
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**general_setting** | [**Apiv2WorkspaceGeneralSetting**](Apiv2WorkspaceGeneralSetting.md) | | [optional] **general_setting** | [**Apiv1WorkspaceGeneralSetting**](Apiv1WorkspaceGeneralSetting.md) | | [optional]
**storage_setting** | [**Apiv1WorkspaceStorageSetting**](Apiv1WorkspaceStorageSetting.md) | | [optional]
**memo_related_setting** | [**Apiv1WorkspaceMemoRelatedSetting**](Apiv1WorkspaceMemoRelatedSetting.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) [[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/TableNodeRow.md Normal file
View File

@ -0,0 +1,9 @@
# TableNodeRow
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cells** | **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)

82
docs/TagServiceApi.md
View File

@ -4,15 +4,15 @@ All URIs are relative to */*
Method | HTTP request | Description 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_batch_upsert_tag**](TagServiceApi.md#tag_service_batch_upsert_tag) | **POST** /api/v1/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_delete_tag**](TagServiceApi.md#tag_service_delete_tag) | **DELETE** /api/v1/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_get_tag_suggestions**](TagServiceApi.md#tag_service_get_tag_suggestions) | **GET** /api/v1/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_list_tags**](TagServiceApi.md#tag_service_list_tags) | **GET** /api/v1/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_rename_tag**](TagServiceApi.md#tag_service_rename_tag) | **PATCH** /api/v1/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_upsert_tag**](TagServiceApi.md#tag_service_upsert_tag) | **POST** /api/v1/tags | UpsertTag upserts a tag.
# **tag_service_batch_upsert_tag** # **tag_service_batch_upsert_tag**
> V2BatchUpsertTagResponse tag_service_batch_upsert_tag() > object tag_service_batch_upsert_tag(body)
BatchUpsertTag upserts multiple tags. BatchUpsertTag upserts multiple tags.
@ -26,21 +26,25 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.TagServiceApi() api_instance = memos.TagServiceApi()
body = memos.V1BatchUpsertTagRequest() # V1BatchUpsertTagRequest |
try: try:
# BatchUpsertTag upserts multiple tags. # BatchUpsertTag upserts multiple tags.
api_response = api_instance.tag_service_batch_upsert_tag() api_response = api_instance.tag_service_batch_upsert_tag(body)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling TagServiceApi->tag_service_batch_upsert_tag: %s\n" % e) print("Exception when calling TagServiceApi->tag_service_batch_upsert_tag: %s\n" % e)
``` ```
### Parameters ### Parameters
This endpoint does not need any parameter.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**V1BatchUpsertTagRequest**](V1BatchUpsertTagRequest.md)| |
### Return type ### Return type
[**V2BatchUpsertTagResponse**](V2BatchUpsertTagResponse.md) **object**
### Authorization ### Authorization
@ -48,13 +52,13 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: 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) [[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** # **tag_service_delete_tag**
> V2DeleteTagResponse tag_service_delete_tag(tag_name=tag_name, tag_creator=tag_creator) > object tag_service_delete_tag(tag_name=tag_name, tag_creator=tag_creator)
DeleteTag deletes a tag. DeleteTag deletes a tag.
@ -69,7 +73,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.TagServiceApi() api_instance = memos.TagServiceApi()
tag_name = 'tag_name_example' # str | (optional) tag_name = 'tag_name_example' # str | (optional)
tag_creator = 'tag_creator_example' # str | The creator of tags. Format: users/{username} (optional) tag_creator = 'tag_creator_example' # str | The creator of tags. Format: users/{id} (optional)
try: try:
# DeleteTag deletes a tag. # DeleteTag deletes a tag.
@ -84,11 +88,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**tag_name** | **str**| | [optional] **tag_name** | **str**| | [optional]
**tag_creator** | **str**| The creator of tags. Format: users/{username} | [optional] **tag_creator** | **str**| The creator of tags. Format: users/{id} | [optional]
### Return type ### Return type
[**V2DeleteTagResponse**](V2DeleteTagResponse.md) **object**
### Authorization ### Authorization
@ -102,7 +106,7 @@ No authorization required
[[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) [[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** # **tag_service_get_tag_suggestions**
> V2GetTagSuggestionsResponse tag_service_get_tag_suggestions(user=user) > V1GetTagSuggestionsResponse tag_service_get_tag_suggestions(user=user)
GetTagSuggestions gets tag suggestions from the user's memos. GetTagSuggestions gets tag suggestions from the user's memos.
@ -116,7 +120,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.TagServiceApi() api_instance = memos.TagServiceApi()
user = 'user_example' # str | The creator of tags. Format: users/{username} (optional) user = 'user_example' # str | The creator of tags. Format: users/{id} (optional)
try: try:
# GetTagSuggestions gets tag suggestions from the user's memos. # GetTagSuggestions gets tag suggestions from the user's memos.
@ -130,11 +134,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**user** | **str**| The creator of tags. Format: users/{username} | [optional] **user** | **str**| The creator of tags. Format: users/{id} | [optional]
### Return type ### Return type
[**V2GetTagSuggestionsResponse**](V2GetTagSuggestionsResponse.md) [**V1GetTagSuggestionsResponse**](V1GetTagSuggestionsResponse.md)
### Authorization ### Authorization
@ -148,7 +152,7 @@ No authorization required
[[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) [[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** # **tag_service_list_tags**
> V2ListTagsResponse tag_service_list_tags(user=user) > V1ListTagsResponse tag_service_list_tags()
ListTags lists tags. ListTags lists tags.
@ -162,25 +166,21 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.TagServiceApi() api_instance = memos.TagServiceApi()
user = 'user_example' # str | The creator of tags. Format: users/{username} (optional)
try: try:
# ListTags lists tags. # ListTags lists tags.
api_response = api_instance.tag_service_list_tags(user=user) api_response = api_instance.tag_service_list_tags()
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling TagServiceApi->tag_service_list_tags: %s\n" % e) print("Exception when calling TagServiceApi->tag_service_list_tags: %s\n" % e)
``` ```
### Parameters ### Parameters
This endpoint does not need any parameter.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user** | **str**| The creator of tags. Format: users/{username} | [optional]
### Return type ### Return type
[**V2ListTagsResponse**](V2ListTagsResponse.md) [**V1ListTagsResponse**](V1ListTagsResponse.md)
### Authorization ### Authorization
@ -194,7 +194,7 @@ No authorization required
[[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) [[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** # **tag_service_rename_tag**
> V2RenameTagResponse tag_service_rename_tag(user=user, old_name=old_name, new_name=new_name) > object tag_service_rename_tag(body)
RenameTag renames a tag. All related memos will be updated. RenameTag renames a tag. All related memos will be updated.
@ -208,13 +208,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.TagServiceApi() api_instance = memos.TagServiceApi()
user = 'user_example' # str | The creator of tags. Format: users/{username} (optional) body = memos.V1RenameTagRequest() # V1RenameTagRequest |
old_name = 'old_name_example' # str | (optional)
new_name = 'new_name_example' # str | (optional)
try: try:
# RenameTag renames a tag. All related memos will be updated. # 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) api_response = api_instance.tag_service_rename_tag(body)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling TagServiceApi->tag_service_rename_tag: %s\n" % e) print("Exception when calling TagServiceApi->tag_service_rename_tag: %s\n" % e)
@ -224,13 +222,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**user** | **str**| The creator of tags. Format: users/{username} | [optional] **body** | [**V1RenameTagRequest**](V1RenameTagRequest.md)| |
**old_name** | **str**| | [optional]
**new_name** | **str**| | [optional]
### Return type ### Return type
[**V2RenameTagResponse**](V2RenameTagResponse.md) **object**
### Authorization ### Authorization
@ -238,13 +234,13 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: 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) [[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** # **tag_service_upsert_tag**
> V2UpsertTagResponse tag_service_upsert_tag(name=name) > V1Tag tag_service_upsert_tag(body)
UpsertTag upserts a tag. UpsertTag upserts a tag.
@ -258,11 +254,11 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.TagServiceApi() api_instance = memos.TagServiceApi()
name = 'name_example' # str | (optional) body = memos.V1UpsertTagRequest() # V1UpsertTagRequest |
try: try:
# UpsertTag upserts a tag. # UpsertTag upserts a tag.
api_response = api_instance.tag_service_upsert_tag(name=name) api_response = api_instance.tag_service_upsert_tag(body)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling TagServiceApi->tag_service_upsert_tag: %s\n" % e) print("Exception when calling TagServiceApi->tag_service_upsert_tag: %s\n" % e)
@ -272,11 +268,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**name** | **str**| | [optional] **body** | [**V1UpsertTagRequest**](V1UpsertTagRequest.md)| |
### Return type ### Return type
[**V2UpsertTagResponse**](V2UpsertTagResponse.md) [**V1Tag**](V1Tag.md)
### Authorization ### Authorization
@ -284,7 +280,7 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: 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) [[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)

12
docs/TheIdentityProviderToUpdate_.md Normal file
View File

@ -0,0 +1,12 @@
# TheIdentityProviderToUpdate_
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**Apiv1IdentityProviderType**](Apiv1IdentityProviderType.md) | | [optional]
**title** | **str** | | [optional]
**identifier_filter** | **str** | | [optional]
**config** | [**Apiv1IdentityProviderConfig**](Apiv1IdentityProviderConfig.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)

151
docs/UserServiceApi.md
View File

@ -4,19 +4,20 @@ All URIs are relative to */*
Method | HTTP request | Description 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**](UserServiceApi.md#user_service_create_user) | **POST** /api/v1/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_create_user_access_token**](UserServiceApi.md#user_service_create_user_access_token) | **POST** /api/v1/{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**](UserServiceApi.md#user_service_delete_user) | **DELETE** /api/v1/{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_delete_user_access_token**](UserServiceApi.md#user_service_delete_user_access_token) | **DELETE** /api/v1/{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**](UserServiceApi.md#user_service_get_user) | **GET** /api/v1/{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_get_user_setting**](UserServiceApi.md#user_service_get_user_setting) | **GET** /api/v1/{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_user_access_tokens**](UserServiceApi.md#user_service_list_user_access_tokens) | **GET** /api/v1/{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_list_users**](UserServiceApi.md#user_service_list_users) | **GET** /api/v1/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_search_users**](UserServiceApi.md#user_service_search_users) | **GET** /api/v1/users:search | SearchUsers searches users by filter.
[**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_update_user**](UserServiceApi.md#user_service_update_user) | **PATCH** /api/v1/{user.name} | UpdateUser updates a user.
[**user_service_update_user_setting**](UserServiceApi.md#user_service_update_user_setting) | **PATCH** /api/v1/{setting.name} | UpdateUserSetting updates the setting of a user.
# **user_service_create_user** # **user_service_create_user**
> V2CreateUserResponse user_service_create_user(body) > V1User user_service_create_user(body)
CreateUser creates a new user. CreateUser creates a new user.
@ -30,7 +31,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
body = memos.V2User() # V2User | body = memos.V1User() # V1User |
try: try:
# CreateUser creates a new user. # CreateUser creates a new user.
@ -44,11 +45,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**V2User**](V2User.md)| | **body** | [**V1User**](V1User.md)| |
### Return type ### Return type
[**V2CreateUserResponse**](V2CreateUserResponse.md) [**V1User**](V1User.md)
### Authorization ### Authorization
@ -62,7 +63,7 @@ No authorization required
[[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) [[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** # **user_service_create_user_access_token**
> V2CreateUserAccessTokenResponse user_service_create_user_access_token(body, name) > V1UserAccessToken user_service_create_user_access_token(body, name)
CreateUserAccessToken creates a new access token for a user. CreateUserAccessToken creates a new access token for a user.
@ -77,7 +78,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
body = memos.UserServiceCreateUserAccessTokenBody() # UserServiceCreateUserAccessTokenBody | body = memos.UserServiceCreateUserAccessTokenBody() # UserServiceCreateUserAccessTokenBody |
name = 'name_example' # str | The name of the user. Format: users/{username} name = 'name_example' # str | The name of the user. Format: users/{id}
try: try:
# CreateUserAccessToken creates a new access token for a user. # CreateUserAccessToken creates a new access token for a user.
@ -92,11 +93,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**UserServiceCreateUserAccessTokenBody**](UserServiceCreateUserAccessTokenBody.md)| | **body** | [**UserServiceCreateUserAccessTokenBody**](UserServiceCreateUserAccessTokenBody.md)| |
**name** | **str**| The name of the user. Format: users/{username} | **name** | **str**| The name of the user. Format: users/{id} |
### Return type ### Return type
[**V2CreateUserAccessTokenResponse**](V2CreateUserAccessTokenResponse.md) [**V1UserAccessToken**](V1UserAccessToken.md)
### Authorization ### Authorization
@ -110,7 +111,7 @@ No authorization required
[[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) [[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** # **user_service_delete_user**
> V2DeleteUserResponse user_service_delete_user(name) > object user_service_delete_user(name)
DeleteUser deletes a user. DeleteUser deletes a user.
@ -124,7 +125,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
name = 'name_example' # str | The name of the user. Format: users/{username} name = 'name_example' # str | The name of the user. Format: users/{id}
try: try:
# DeleteUser deletes a user. # DeleteUser deletes a user.
@ -138,11 +139,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**name** | **str**| The name of the user. Format: users/{username} | **name** | **str**| The name of the user. Format: users/{id} |
### Return type ### Return type
[**V2DeleteUserResponse**](V2DeleteUserResponse.md) **object**
### Authorization ### Authorization
@ -156,7 +157,7 @@ No authorization required
[[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) [[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** # **user_service_delete_user_access_token**
> V2DeleteUserAccessTokenResponse user_service_delete_user_access_token(name, access_token) > object user_service_delete_user_access_token(name, access_token)
DeleteUserAccessToken deletes an access token for a user. DeleteUserAccessToken deletes an access token for a user.
@ -170,7 +171,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
name = 'name_example' # str | The name of the user. Format: users/{username} name = 'name_example' # str | The name of the user. Format: users/{id}
access_token = 'access_token_example' # str | access_token is the access token to delete. access_token = 'access_token_example' # str | access_token is the access token to delete.
try: try:
@ -185,12 +186,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**name** | **str**| The name of the user. Format: users/{username} | **name** | **str**| The name of the user. Format: users/{id} |
**access_token** | **str**| access_token is the access token to delete. | **access_token** | **str**| access_token is the access token to delete. |
### Return type ### Return type
[**V2DeleteUserAccessTokenResponse**](V2DeleteUserAccessTokenResponse.md) **object**
### Authorization ### Authorization
@ -204,7 +205,7 @@ No authorization required
[[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) [[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** # **user_service_get_user**
> V2GetUserResponse user_service_get_user(name) > V1User user_service_get_user(name)
GetUser gets a user by name. GetUser gets a user by name.
@ -218,7 +219,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
name = 'name_example' # str | The name of the user. Format: users/{username} name = 'name_example' # str | The name of the user. Format: users/{id}
try: try:
# GetUser gets a user by name. # GetUser gets a user by name.
@ -232,11 +233,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**name** | **str**| The name of the user. Format: users/{username} | **name** | **str**| The name of the user. Format: users/{id} |
### Return type ### Return type
[**V2GetUserResponse**](V2GetUserResponse.md) [**V1User**](V1User.md)
### Authorization ### Authorization
@ -250,7 +251,7 @@ No authorization required
[[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) [[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** # **user_service_get_user_setting**
> V2GetUserSettingResponse user_service_get_user_setting(name) > Apiv1UserSetting user_service_get_user_setting(name)
GetUserSetting gets the setting of a user. GetUserSetting gets the setting of a user.
@ -264,7 +265,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
name = 'name_example' # str | The name of the user. Format: users/{username} name = 'name_example' # str | The name of the user. Format: users/{id}
try: try:
# GetUserSetting gets the setting of a user. # GetUserSetting gets the setting of a user.
@ -278,11 +279,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**name** | **str**| The name of the user. Format: users/{username} | **name** | **str**| The name of the user. Format: users/{id} |
### Return type ### Return type
[**V2GetUserSettingResponse**](V2GetUserSettingResponse.md) [**Apiv1UserSetting**](Apiv1UserSetting.md)
### Authorization ### Authorization
@ -296,7 +297,7 @@ No authorization required
[[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) [[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** # **user_service_list_user_access_tokens**
> V2ListUserAccessTokensResponse user_service_list_user_access_tokens(name) > V1ListUserAccessTokensResponse user_service_list_user_access_tokens(name)
ListUserAccessTokens returns a list of access tokens for a user. ListUserAccessTokens returns a list of access tokens for a user.
@ -310,7 +311,7 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
name = 'name_example' # str | The name of the user. Format: users/{username} name = 'name_example' # str | The name of the user. Format: users/{id}
try: try:
# ListUserAccessTokens returns a list of access tokens for a user. # ListUserAccessTokens returns a list of access tokens for a user.
@ -324,11 +325,11 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**name** | **str**| The name of the user. Format: users/{username} | **name** | **str**| The name of the user. Format: users/{id} |
### Return type ### Return type
[**V2ListUserAccessTokensResponse**](V2ListUserAccessTokensResponse.md) [**V1ListUserAccessTokensResponse**](V1ListUserAccessTokensResponse.md)
### Authorization ### Authorization
@ -342,7 +343,7 @@ No authorization required
[[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) [[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** # **user_service_list_users**
> V2ListUsersResponse user_service_list_users() > V1ListUsersResponse user_service_list_users()
ListUsers returns a list of users. ListUsers returns a list of users.
@ -370,7 +371,53 @@ This endpoint does not need any parameter.
### Return type ### Return type
[**V2ListUsersResponse**](V2ListUsersResponse.md) [**V1ListUsersResponse**](V1ListUsersResponse.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_search_users**
> V1SearchUsersResponse user_service_search_users(filter=filter)
SearchUsers searches users by 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.UserServiceApi()
filter = 'filter_example' # str | Filter is used to filter users returned in the list. Format: \"username == frank\" (optional)
try:
# SearchUsers searches users by filter.
api_response = api_instance.user_service_search_users(filter=filter)
pprint(api_response)
except ApiException as e:
print("Exception when calling UserServiceApi->user_service_search_users: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **str**| Filter is used to filter users returned in the list. Format: \"username == frank\" | [optional]
### Return type
[**V1SearchUsersResponse**](V1SearchUsersResponse.md)
### Authorization ### Authorization
@ -384,7 +431,7 @@ No authorization required
[[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) [[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** # **user_service_update_user**
> V2UpdateUserResponse user_service_update_user(body, user_name) > V1User user_service_update_user(body, user_name)
UpdateUser updates a user. UpdateUser updates a user.
@ -398,8 +445,8 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
body = memos.V2UserNameBody() # V2UserNameBody | body = memos.V1UserNameBody() # V1UserNameBody |
user_name = 'user_name_example' # str | The name of the user. Format: users/{username} user_name = 'user_name_example' # str | The name of the user. Format: users/{id}
try: try:
# UpdateUser updates a user. # UpdateUser updates a user.
@ -413,12 +460,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**V2UserNameBody**](V2UserNameBody.md)| | **body** | [**V1UserNameBody**](V1UserNameBody.md)| |
**user_name** | **str**| The name of the user. Format: users/{username} | **user_name** | **str**| The name of the user. Format: users/{id} |
### Return type ### Return type
[**V2UpdateUserResponse**](V2UpdateUserResponse.md) [**V1User**](V1User.md)
### Authorization ### Authorization
@ -432,7 +479,7 @@ No authorization required
[[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) [[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** # **user_service_update_user_setting**
> V2UpdateUserSettingResponse user_service_update_user_setting(body, setting_name) > Apiv1UserSetting user_service_update_user_setting(body, setting_name)
UpdateUserSetting updates the setting of a user. UpdateUserSetting updates the setting of a user.
@ -446,8 +493,8 @@ from pprint import pprint
# create an instance of the API class # create an instance of the API class
api_instance = memos.UserServiceApi() api_instance = memos.UserServiceApi()
body = memos.V2SettingNameBody() # V2SettingNameBody | body = memos.V1SettingNameBody() # V1SettingNameBody |
setting_name = 'setting_name_example' # str | The name of the user. Format: users/{username} setting_name = 'setting_name_example' # str | The name of the user. Format: users/{id}
try: try:
# UpdateUserSetting updates the setting of a user. # UpdateUserSetting updates the setting of a user.
@ -461,12 +508,12 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**V2SettingNameBody**](V2SettingNameBody.md)| | **body** | [**V1SettingNameBody**](V1SettingNameBody.md)| |
**setting_name** | **str**| The name of the user. Format: users/{username} | **setting_name** | **str**| The name of the user. Format: users/{id} |
### Return type ### Return type
[**V2UpdateUserSettingResponse**](V2UpdateUserSettingResponse.md) [**Apiv1UserSetting**](Apiv1UserSetting.md)
### Authorization ### Authorization

14
docs/V1Activity.md Normal file
View File

@ -0,0 +1,14 @@
# V1Activity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | The system-generated unique identifier for the activity. | [optional]
**creator_id** | **int** | The system-generated unique identifier for the user who created the activity. | [optional]
**type** | **str** | The type of the activity. | [optional]
**level** | **str** | The level of the activity. | [optional]
**create_time** | **datetime** | The create time of the activity. | [optional]
**payload** | [**Apiv1ActivityPayload**](Apiv1ActivityPayload.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/V1AutoLinkNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1AutoLinkNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **str** | | [optional]
**is_raw_text** | **bool** | | [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/V1BatchUpsertTagRequest.md Normal file
View File

@ -0,0 +1,9 @@
# V1BatchUpsertTagRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**requests** | [**list[V1UpsertTagRequest]**](V1UpsertTagRequest.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/V1BlockquoteNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1BlockquoteNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**children** | [**list[V1Node]**](V1Node.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/V1BoldItalicNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1BoldItalicNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | | [optional]
**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)

10
docs/V1BoldNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1BoldNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | | [optional]
**children** | [**list[V1Node]**](V1Node.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/V1CodeBlockNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1CodeBlockNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**language** | **str** | | [optional]
**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/V1CodeNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1CodeNode
## 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)

10
docs/V1CreateMemoRequest.md Normal file
View File

@ -0,0 +1,10 @@
# V1CreateMemoRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | **str** | | [optional]
**visibility** | [**V1Visibility**](V1Visibility.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/V1CreateWebhookRequest.md Normal file
View File

@ -0,0 +1,10 @@
# V1CreateWebhookRequest
## 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)

10
docs/V1EmbeddedContentNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1EmbeddedContentNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**resource_name** | **str** | | [optional]
**params** | **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/V1EscapingCharacterNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1EscapingCharacterNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **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/V1ExportMemosRequest.md Normal file
View File

@ -0,0 +1,9 @@
# V1ExportMemosRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filter** | **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/V1ExportMemosResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ExportMemosResponse
## 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/V1GetTagSuggestionsResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1GetTagSuggestionsResponse
## 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/V1GetUserMemosStatsResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1GetUserMemosStatsResponse
## 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)

10
docs/V1HeadingNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1HeadingNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**level** | **int** | | [optional]
**children** | [**list[V1Node]**](V1Node.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/V1HighlightNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1HighlightNode
## 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/V1HorizontalRuleNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1HorizontalRuleNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **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)

10
docs/V1ImageNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1ImageNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alt_text** | **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)

15
docs/V1Inbox.md Normal file
View File

@ -0,0 +1,15 @@
# V1Inbox
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**sender** | **str** | | [optional]
**receiver** | **str** | | [optional]
**status** | [**V1InboxStatus**](V1InboxStatus.md) | | [optional]
**create_time** | **datetime** | | [optional]
**type** | [**V1InboxType**](V1InboxType.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/V1InboxNameBody.md Normal file
View File

@ -0,0 +1,14 @@
# V1InboxNameBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sender** | **str** | | [optional]
**receiver** | **str** | | [optional]
**status** | [**V1InboxStatus**](V1InboxStatus.md) | | [optional]
**create_time** | **datetime** | | [optional]
**type** | [**V1InboxType**](V1InboxType.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/V1InboxStatus.md Normal file
View File

@ -0,0 +1,8 @@
# V1InboxStatus
## 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/V1InboxType.md Normal file
View File

@ -0,0 +1,8 @@
# V1InboxType
## 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)

10
docs/V1ItalicNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1ItalicNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | | [optional]
**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)

8
docs/V1LineBreakNode.md Normal file
View File

@ -0,0 +1,8 @@
# V1LineBreakNode
## 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)

11
docs/V1LinkMetadata.md Normal file
View File

@ -0,0 +1,11 @@
# V1LinkMetadata
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | | [optional]
**description** | **str** | | [optional]
**image** | **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)

10
docs/V1LinkNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1LinkNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text** | **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/V1ListIdentityProvidersResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListIdentityProvidersResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_providers** | [**list[Apiv1IdentityProvider]**](Apiv1IdentityProvider.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/V1ListInboxesResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListInboxesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**inboxes** | [**list[V1Inbox]**](V1Inbox.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/V1ListMemoCommentsResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListMemoCommentsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memos** | [**list[V1Memo]**](V1Memo.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/V1ListMemoReactionsResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListMemoReactionsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reactions** | [**list[V1Reaction]**](V1Reaction.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/V1ListMemoRelationsResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListMemoRelationsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**relations** | [**list[V1MemoRelation]**](V1MemoRelation.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/V1ListMemoResourcesResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListMemoResourcesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**resources** | [**list[V1Resource]**](V1Resource.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/V1ListMemosResponse.md Normal file
View File

@ -0,0 +1,10 @@
# V1ListMemosResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memos** | [**list[V1Memo]**](V1Memo.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/V1ListResourcesResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListResourcesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**resources** | [**list[V1Resource]**](V1Resource.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/V1ListTagsResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListTagsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tags** | [**list[V1Tag]**](V1Tag.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/V1ListUserAccessTokensResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListUserAccessTokensResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_tokens** | [**list[V1UserAccessToken]**](V1UserAccessToken.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/V1ListUsersResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListUsersResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**users** | [**list[V1User]**](V1User.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/V1ListWebhooksResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListWebhooksResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**webhooks** | [**list[V1Webhook]**](V1Webhook.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/V1ListWorkspaceSettingsResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ListWorkspaceSettingsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**settings** | [**list[Apiv1WorkspaceSetting]**](Apiv1WorkspaceSetting.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/V1MathBlockNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1MathBlockNode
## 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/V1MathNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1MathNode
## 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)

23
docs/V1Memo.md Normal file
View File

@ -0,0 +1,23 @@
# V1Memo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the memo. Format: memos/{id} id is the system generated id. | [optional]
**uid** | **str** | The user defined id of the memo. | [optional]
**row_status** | [**V1RowStatus**](V1RowStatus.md) | | [optional]
**creator** | **str** | | [optional]
**create_time** | **datetime** | | [optional]
**update_time** | **datetime** | | [optional]
**display_time** | **datetime** | | [optional]
**content** | **str** | | [optional]
**nodes** | [**list[V1Node]**](V1Node.md) | | [optional]
**visibility** | [**V1Visibility**](V1Visibility.md) | | [optional]
**pinned** | **bool** | | [optional]
**parent_id** | **int** | | [optional]
**resources** | [**list[V1Resource]**](V1Resource.md) | | [optional]
**relations** | [**list[V1MemoRelation]**](V1MemoRelation.md) | | [optional]
**reactions** | [**list[V1Reaction]**](V1Reaction.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/V1MemoNameBody.md Normal file
View File

@ -0,0 +1,22 @@
# V1MemoNameBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uid** | **str** | The user defined id of the memo. | [optional]
**row_status** | [**V1RowStatus**](V1RowStatus.md) | | [optional]
**creator** | **str** | | [optional]
**create_time** | **datetime** | | [optional]
**update_time** | **datetime** | | [optional]
**display_time** | **datetime** | | [optional]
**content** | **str** | | [optional]
**nodes** | [**list[V1Node]**](V1Node.md) | | [optional]
**visibility** | [**V1Visibility**](V1Visibility.md) | | [optional]
**pinned** | **bool** | | [optional]
**parent_id** | **int** | | [optional]
**resources** | [**list[V1Resource]**](V1Resource.md) | | [optional]
**relations** | [**list[V1MemoRelation]**](V1MemoRelation.md) | | [optional]
**reactions** | [**list[V1Reaction]**](V1Reaction.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/V1MemoRelation.md Normal file
View File

@ -0,0 +1,11 @@
# V1MemoRelation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memo** | **str** | | [optional]
**related_memo** | **str** | | [optional]
**type** | [**V1MemoRelationType**](V1MemoRelationType.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/V1MemoRelationType.md Normal file
View File

@ -0,0 +1,8 @@
# V1MemoRelationType
## 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)

38
docs/V1Node.md Normal file
View File

@ -0,0 +1,38 @@
# V1Node
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**V1NodeType**](V1NodeType.md) | | [optional]
**line_break_node** | [**V1LineBreakNode**](V1LineBreakNode.md) | | [optional]
**paragraph_node** | [**V1ParagraphNode**](V1ParagraphNode.md) | | [optional]
**code_block_node** | [**V1CodeBlockNode**](V1CodeBlockNode.md) | | [optional]
**heading_node** | [**V1HeadingNode**](V1HeadingNode.md) | | [optional]
**horizontal_rule_node** | [**V1HorizontalRuleNode**](V1HorizontalRuleNode.md) | | [optional]
**blockquote_node** | [**V1BlockquoteNode**](V1BlockquoteNode.md) | | [optional]
**ordered_list_node** | [**V1OrderedListNode**](V1OrderedListNode.md) | | [optional]
**unordered_list_node** | [**V1UnorderedListNode**](V1UnorderedListNode.md) | | [optional]
**task_list_node** | [**V1TaskListNode**](V1TaskListNode.md) | | [optional]
**math_block_node** | [**V1MathBlockNode**](V1MathBlockNode.md) | | [optional]
**table_node** | [**V1TableNode**](V1TableNode.md) | | [optional]
**embedded_content_node** | [**V1EmbeddedContentNode**](V1EmbeddedContentNode.md) | | [optional]
**text_node** | [**V1TextNode**](V1TextNode.md) | | [optional]
**bold_node** | [**V1BoldNode**](V1BoldNode.md) | | [optional]
**italic_node** | [**V1ItalicNode**](V1ItalicNode.md) | | [optional]
**bold_italic_node** | [**V1BoldItalicNode**](V1BoldItalicNode.md) | | [optional]
**code_node** | [**V1CodeNode**](V1CodeNode.md) | | [optional]
**image_node** | [**V1ImageNode**](V1ImageNode.md) | | [optional]
**link_node** | [**V1LinkNode**](V1LinkNode.md) | | [optional]
**auto_link_node** | [**V1AutoLinkNode**](V1AutoLinkNode.md) | | [optional]
**tag_node** | [**V1TagNode**](V1TagNode.md) | | [optional]
**strikethrough_node** | [**V1StrikethroughNode**](V1StrikethroughNode.md) | | [optional]
**escaping_character_node** | [**V1EscapingCharacterNode**](V1EscapingCharacterNode.md) | | [optional]
**math_node** | [**V1MathNode**](V1MathNode.md) | | [optional]
**highlight_node** | [**V1HighlightNode**](V1HighlightNode.md) | | [optional]
**subscript_node** | [**V1SubscriptNode**](V1SubscriptNode.md) | | [optional]
**superscript_node** | [**V1SuperscriptNode**](V1SuperscriptNode.md) | | [optional]
**referenced_content_node** | [**V1ReferencedContentNode**](V1ReferencedContentNode.md) | | [optional]
**spoiler_node** | [**V1SpoilerNode**](V1SpoilerNode.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/V1NodeType.md Normal file
View File

@ -0,0 +1,8 @@
# V1NodeType
## 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)

11
docs/V1OrderedListNode.md Normal file
View File

@ -0,0 +1,11 @@
# V1OrderedListNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**number** | **str** | | [optional]
**indent** | **int** | | [optional]
**children** | [**list[V1Node]**](V1Node.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/V1ParagraphNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1ParagraphNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**children** | [**list[V1Node]**](V1Node.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/V1ParseMarkdownRequest.md Normal file
View File

@ -0,0 +1,9 @@
# V1ParseMarkdownRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**markdown** | **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/V1ParseMarkdownResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1ParseMarkdownResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nodes** | [**list[V1Node]**](V1Node.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/V1Reaction.md Normal file
View File

@ -0,0 +1,12 @@
# V1Reaction
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**creator** | **str** | | [optional]
**content_id** | **str** | | [optional]
**reaction_type** | [**V1ReactionType**](V1ReactionType.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/V1ReactionType.md Normal file
View File

@ -0,0 +1,8 @@
# V1ReactionType
## 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)

10
docs/V1ReferencedContentNode.md Normal file
View File

@ -0,0 +1,10 @@
# V1ReferencedContentNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**resource_name** | **str** | | [optional]
**params** | **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)

11
docs/V1RenameTagRequest.md Normal file
View File

@ -0,0 +1,11 @@
# V1RenameTagRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user** | **str** | | [optional]
**old_name** | **str** | | [optional]
**new_name** | **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)

17
docs/V1Resource.md Normal file
View File

@ -0,0 +1,17 @@
# V1Resource
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the resource. Format: resources/{id} id is the system generated unique identifier. | [optional]
**uid** | **str** | The user defined id of the resource. | [optional]
**create_time** | **datetime** | | [optional]
**filename** | **str** | | [optional]
**content** | **str** | | [optional]
**external_link** | **str** | | [optional]
**type** | **str** | | [optional]
**size** | **str** | | [optional]
**memo** | **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)

16
docs/V1ResourceNameBody.md Normal file
View File

@ -0,0 +1,16 @@
# V1ResourceNameBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uid** | **str** | The user defined id of the resource. | [optional]
**create_time** | **datetime** | | [optional]
**filename** | **str** | | [optional]
**content** | **str** | | [optional]
**external_link** | **str** | | [optional]
**type** | **str** | | [optional]
**size** | **str** | | [optional]
**memo** | **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/V1RestoreMarkdownRequest.md Normal file
View File

@ -0,0 +1,9 @@
# V1RestoreMarkdownRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nodes** | [**list[V1Node]**](V1Node.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/V1RestoreMarkdownResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1RestoreMarkdownResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**markdown** | **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)

8
docs/V1RowStatus.md Normal file
View File

@ -0,0 +1,8 @@
# V1RowStatus
## 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/V1SearchMemosResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1SearchMemosResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memos** | [**list[V1Memo]**](V1Memo.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/V1SearchResourcesResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1SearchResourcesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**resources** | [**list[V1Resource]**](V1Resource.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/V1SearchUsersResponse.md Normal file
View File

@ -0,0 +1,9 @@
# V1SearchUsersResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**users** | [**list[V1User]**](V1User.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/V1SettingNameBody.md Normal file
View File

@ -0,0 +1,11 @@
# V1SettingNameBody
## 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]
[[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/V1SpoilerNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1SpoilerNode
## 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/V1StrikethroughNode.md Normal file
View File

@ -0,0 +1,9 @@
# V1StrikethroughNode
## 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)

Some files were not shown because too many files have changed in this diff Show More