spatio-sdk 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +31 -0
- data/Rakefile +10 -0
- data/docs/AcceptOrganizationInvitationRequest.md +18 -0
- data/docs/AccountApi.md +793 -0
- data/docs/AccountChoice.md +22 -0
- data/docs/AccountError.md +20 -0
- data/docs/AccountListResponse.md +22 -0
- data/docs/AccountPlan.md +24 -0
- data/docs/AccountStatus.md +28 -0
- data/docs/AccountTierDetails.md +46 -0
- data/docs/AccountUsage.md +32 -0
- data/docs/ActionDescriptor.md +32 -0
- data/docs/ActionsApi.md +409 -0
- data/docs/AddOrganizationMemberRequest.md +22 -0
- data/docs/AddWorkspaceMemberRequest.md +20 -0
- data/docs/Agent.md +40 -0
- data/docs/AgentConversation.md +28 -0
- data/docs/AgentConversationListResponse.md +20 -0
- data/docs/AgentListResponse.md +24 -0
- data/docs/AgentMessage.md +28 -0
- data/docs/AgentMessageListResponse.md +20 -0
- data/docs/AgentSessionContext.md +24 -0
- data/docs/AgentTaskUsage.md +26 -0
- data/docs/AgentsApi.md +884 -0
- data/docs/AmbiguousAccountError.md +22 -0
- data/docs/ApiError.md +20 -0
- data/docs/App.md +32 -0
- data/docs/AppFileContentResponse.md +20 -0
- data/docs/AppFileListResponse.md +18 -0
- data/docs/AppListResponse.md +20 -0
- data/docs/AppsApi.md +984 -0
- data/docs/AssignContactCategoryRequest.md +18 -0
- data/docs/Attachment.md +26 -0
- data/docs/AttachmentInput.md +24 -0
- data/docs/AttachmentMeta.md +24 -0
- data/docs/Attendee.md +30 -0
- data/docs/AttendeeRole.md +15 -0
- data/docs/AttendeeStatus.md +15 -0
- data/docs/Block.md +36 -0
- data/docs/BlockContent.md +38 -0
- data/docs/BlockListResponse.md +20 -0
- data/docs/BlockType.md +15 -0
- data/docs/BulkArchiveRequest.md +20 -0
- data/docs/BulkArchiveResponse.md +22 -0
- data/docs/BulkArchiveResponseFailedInner.md +20 -0
- data/docs/BulkDeleteEmailsRequest.md +22 -0
- data/docs/BulkDeleteEmailsResponse.md +22 -0
- data/docs/BulkDeleteFilesRequest.md +24 -0
- data/docs/BulkDeleteTasksRequest.md +24 -0
- data/docs/BulkDeleteTasksResponse.md +24 -0
- data/docs/BulkDeleteTasksResponseFailedInner.md +20 -0
- data/docs/BulkFilesResponse.md +24 -0
- data/docs/BulkFilesResponseFailedInner.md +20 -0
- data/docs/BulkMarkReadRequest.md +22 -0
- data/docs/BulkMarkReadResponse.md +20 -0
- data/docs/BulkMarkReadResponseFailedInner.md +20 -0
- data/docs/BulkMoveFilesRequest.md +26 -0
- data/docs/BulkUpdateTasksRequest.md +24 -0
- data/docs/BulkUpdateTasksResponse.md +24 -0
- data/docs/CalendarAccountError.md +24 -0
- data/docs/CalendarApi.md +1031 -0
- data/docs/CalendarCapabilitiesResponse.md +22 -0
- data/docs/CalendarOperationResult.md +24 -0
- data/docs/CalendarProviderInfo.md +26 -0
- data/docs/CalendarProvidersInfo.md +18 -0
- data/docs/CalendarSyncResponse.md +26 -0
- data/docs/CallListResponse.md +20 -0
- data/docs/CallRecording.md +30 -0
- data/docs/CallRecordingListResponse.md +18 -0
- data/docs/CallsApi.md +2096 -0
- data/docs/Cell.md +22 -0
- data/docs/ChangePasswordRequest.md +20 -0
- data/docs/Channel.md +38 -0
- data/docs/ChannelMembershipRequest.md +18 -0
- data/docs/ChannelsApi.md +1170 -0
- data/docs/ChatActionDefinition.md +34 -0
- data/docs/ChatActionsList.md +18 -0
- data/docs/ChatMessage.md +36 -0
- data/docs/ChatUser.md +34 -0
- data/docs/ChunkedFileManifest.md +34 -0
- data/docs/ClientRegistrationRequest.md +36 -0
- data/docs/ClientRegistrationResponse.md +38 -0
- data/docs/Comment.md +32 -0
- data/docs/CommentAuthor.md +24 -0
- data/docs/CommentListResponse.md +20 -0
- data/docs/CommentMutationResponse.md +20 -0
- data/docs/CommentResponse.md +18 -0
- data/docs/CommitChunkedUploadRequest.md +18 -0
- data/docs/CommitChunkedUploadResponse.md +36 -0
- data/docs/ConferenceData.md +28 -0
- data/docs/ConnectedAppItem.md +34 -0
- data/docs/ConnectedAppsListResponse.md +18 -0
- data/docs/ConnectionAccountListResponse.md +22 -0
- data/docs/ConnectionListResponse.md +20 -0
- data/docs/ConnectionsApi.md +748 -0
- data/docs/ConsumeAgentTaskResponse.md +26 -0
- data/docs/Contact.md +46 -0
- data/docs/ContactCategory.md +26 -0
- data/docs/ContactCategoryListResponse.md +18 -0
- data/docs/ContactListResponse.md +22 -0
- data/docs/ContactProvider.md +26 -0
- data/docs/ContactProviderListResponse.md +18 -0
- data/docs/ContactsApi.md +830 -0
- data/docs/Conversation.md +42 -0
- data/docs/ConversationMessage.md +28 -0
- data/docs/ConversationsApi.md +636 -0
- data/docs/CoreAction.md +30 -0
- data/docs/CoreActionListResponse.md +20 -0
- data/docs/CreateAgentConversationRequest.md +22 -0
- data/docs/CreateAgentMessageRequest.md +22 -0
- data/docs/CreateAgentRequest.md +30 -0
- data/docs/CreateAppRequest.md +26 -0
- data/docs/CreateBlockRequest.md +26 -0
- data/docs/CreateCalendarEvent201Response.md +24 -0
- data/docs/CreateCallRequest.md +24 -0
- data/docs/CreateChannelRequest.md +24 -0
- data/docs/CreateChannelResponse.md +20 -0
- data/docs/CreateCommentRequest.md +24 -0
- data/docs/CreateContactCategoryRequest.md +22 -0
- data/docs/CreateContactRequest.md +32 -0
- data/docs/CreateConversationRequest.md +26 -0
- data/docs/CreateDraftRequest.md +38 -0
- data/docs/CreateEmailFolderRequest.md +20 -0
- data/docs/CreateEventRequest.md +26 -0
- data/docs/CreateFolderRequest.md +26 -0
- data/docs/CreateLabelRequest.md +26 -0
- data/docs/CreateLabelResponse.md +20 -0
- data/docs/CreateMeetingRoomRequest.md +20 -0
- data/docs/CreateNote400Response.md +49 -0
- data/docs/CreateNoteRequest.md +32 -0
- data/docs/CreateOrganizationInvitationRequest.md +22 -0
- data/docs/CreateOrganizationRequest.md +28 -0
- data/docs/CreatePATRequest.md +26 -0
- data/docs/CreatePATResponse.md +20 -0
- data/docs/CreatePresentationRequest.md +26 -0
- data/docs/CreateRecordRequest.md +26 -0
- data/docs/CreateRecordTypeRequest.md +28 -0
- data/docs/CreateRoutineRequest.md +26 -0
- data/docs/CreateRowRequest.md +20 -0
- data/docs/CreateSheetRequest.md +30 -0
- data/docs/CreateSlideElementRequest.md +32 -0
- data/docs/CreateSlideRequest.md +34 -0
- data/docs/CreateTaskRequest.md +44 -0
- data/docs/CreateWorkspaceInvitationRequest.md +20 -0
- data/docs/CreateWorkspaceRequest.md +24 -0
- data/docs/DMAttachRequest.md +34 -0
- data/docs/DMForwardRequest.md +22 -0
- data/docs/DMMarkReadRequest.md +20 -0
- data/docs/DMMessageEnvelope.md +18 -0
- data/docs/DMMuteRequest.md +22 -0
- data/docs/DMMuteResponse.md +18 -0
- data/docs/DMPinnedList.md +18 -0
- data/docs/DMReactionRequest.md +20 -0
- data/docs/DMReactionResponse.md +18 -0
- data/docs/DMSearchResults.md +18 -0
- data/docs/DMSetDraftRequest.md +20 -0
- data/docs/DMThreadReplyRequest.md +20 -0
- data/docs/DirectMessagesApi.md +2246 -0
- data/docs/DisconnectConnectionRequest.md +20 -0
- data/docs/DiscoveryDocument.md +52 -0
- data/docs/DownloadFileResponse.md +20 -0
- data/docs/Draft.md +40 -0
- data/docs/DraftResponse.md +20 -0
- data/docs/Email.md +56 -0
- data/docs/EmailFolder.md +26 -0
- data/docs/EmailFolderListResponse.md +18 -0
- data/docs/EnableShareRequest.md +20 -0
- data/docs/ExecuteActionRequest.md +22 -0
- data/docs/ExecuteActionResponse.md +22 -0
- data/docs/ExecuteChatActionRequest.md +20 -0
- data/docs/ExecuteChatActionResponse.md +20 -0
- data/docs/ExportPDFR2Response.md +24 -0
- data/docs/ExportPDFRequest.md +20 -0
- data/docs/ExportPDFRequestRasterizedSlidesInner.md +20 -0
- data/docs/ExtractTextResult.md +24 -0
- data/docs/FederatedSearch200Response.md +28 -0
- data/docs/FederatedSearch200ResponseItemsInner.md +38 -0
- data/docs/FederatedSearch200ResponsePerPlatformValue.md +20 -0
- data/docs/FederatedSearchRequest.md +32 -0
- data/docs/FileListEnvelope.md +20 -0
- data/docs/FilesAndFoldersResponse.md +28 -0
- data/docs/FilesApi.md +2471 -0
- data/docs/Folder.md +32 -0
- data/docs/FolderListEnvelope.md +20 -0
- data/docs/FoldersApi.md +415 -0
- data/docs/GetChatUserResponse.md +20 -0
- data/docs/GetDomainLogo200Response.md +20 -0
- data/docs/GetEmailResponse.md +20 -0
- data/docs/GetThreadResponse.md +20 -0
- data/docs/InboxApi.md +424 -0
- data/docs/InboxCounts.md +22 -0
- data/docs/InboxItem.md +38 -0
- data/docs/InboxListResponse.md +22 -0
- data/docs/InitChunkedUploadRequest.md +30 -0
- data/docs/InitChunkedUploadResponse.md +26 -0
- data/docs/InstallConnectionRequest.md +22 -0
- data/docs/IntrospectionResponse.md +30 -0
- data/docs/IssueCollaborationToken200Response.md +26 -0
- data/docs/IssueCollaborationTokenRequest.md +18 -0
- data/docs/JWK.md +28 -0
- data/docs/JWKS.md +18 -0
- data/docs/KeyBinding.md +38 -0
- data/docs/KeyBindingListResponse.md +18 -0
- data/docs/KeybindingsApi.md +406 -0
- data/docs/Label.md +28 -0
- data/docs/LabelColor.md +20 -0
- data/docs/LinkRepoTaskRequest.md +18 -0
- data/docs/ListCalendarEvents200Response.md +24 -0
- data/docs/ListChannelsResponse.md +24 -0
- data/docs/ListChatUsersResponse.md +24 -0
- data/docs/ListDraftsResponse.md +24 -0
- data/docs/ListEmailsResponse.md +24 -0
- data/docs/ListEventsData.md +24 -0
- data/docs/ListLabelsResponse.md +20 -0
- data/docs/ListMessagesResponse.md +24 -0
- data/docs/LogosApi.md +211 -0
- data/docs/MailApi.md +3803 -0
- data/docs/MeetingRoom.md +24 -0
- data/docs/MiscApi.md +1213 -0
- data/docs/ModelsApi.md +483 -0
- data/docs/MoveBlockRequest.md +20 -0
- data/docs/MoveEmailsRequest.md +18 -0
- data/docs/MoveFileRequest.md +18 -0
- data/docs/MoveFileResponse.md +18 -0
- data/docs/NativeDMApi.md +1448 -0
- data/docs/NavigationApi.md +72 -0
- data/docs/Note.md +44 -0
- data/docs/NoteListEnvelope.md +20 -0
- data/docs/NotesApi.md +2413 -0
- data/docs/NotificationsApi.md +140 -0
- data/docs/OAuthApi.md +676 -0
- data/docs/OAuthError.md +20 -0
- data/docs/Organization.md +38 -0
- data/docs/OrganizationDetailLegacy.md +38 -0
- data/docs/OrganizationInvitation.md +38 -0
- data/docs/OrganizationInvitationListResponse.md +18 -0
- data/docs/OrganizationListResponse.md +18 -0
- data/docs/OrganizationMember.md +28 -0
- data/docs/OrganizationMemberInvitedBy.md +49 -0
- data/docs/OrganizationMemberListResponse.md +20 -0
- data/docs/OrganizationWorkspacesInner.md +22 -0
- data/docs/OrganizationsApi.md +1956 -0
- data/docs/PATListResponse.md +20 -0
- data/docs/PATScopesResponse.md +18 -0
- data/docs/PasswordRequiredError.md +24 -0
- data/docs/PersonalAccessToken.md +34 -0
- data/docs/PersonalAccessTokensApi.md +629 -0
- data/docs/PlatformsApi.md +1032 -0
- data/docs/PreconfiguredAgent.md +30 -0
- data/docs/Presentation.md +38 -0
- data/docs/PresentationListEnvelope.md +20 -0
- data/docs/ProposeRecommendationRequest.md +28 -0
- data/docs/PublicInvitationPayload.md +40 -0
- data/docs/QuotaExceededError.md +20 -0
- data/docs/RealtimeApi.md +79 -0
- data/docs/Recommendation.md +38 -0
- data/docs/RecommendationListResponse.md +18 -0
- data/docs/RecommendationsApi.md +354 -0
- data/docs/Record.md +32 -0
- data/docs/RecordListResponse.md +22 -0
- data/docs/RecordType.md +34 -0
- data/docs/RecordTypeListResponse.md +18 -0
- data/docs/RecordsApi.md +560 -0
- data/docs/RefreshConnectionRequest.md +20 -0
- data/docs/Reminder.md +20 -0
- data/docs/ReminderMethod.md +15 -0
- data/docs/ReplyEmailRequest.md +30 -0
- data/docs/RepoApi.md +2071 -0
- data/docs/ResourcesApi.md +220 -0
- data/docs/RevokeOtherSessionsResponse.md +18 -0
- data/docs/RichTextObject.md +24 -0
- data/docs/Routine.md +34 -0
- data/docs/RoutineListResponse.md +18 -0
- data/docs/RoutineRun.md +30 -0
- data/docs/RoutineRunCompleteRequest.md +20 -0
- data/docs/RoutineRunListResponse.md +18 -0
- data/docs/RoutineRunProgressRequest.md +20 -0
- data/docs/RoutinesApi.md +696 -0
- data/docs/Row.md +20 -0
- data/docs/RowList.md +20 -0
- data/docs/SaveMessageRequest.md +22 -0
- data/docs/SearchApi.md +77 -0
- data/docs/SearchEmailsResponse.md +24 -0
- data/docs/SearchFilesResponse.md +24 -0
- data/docs/SendChatMessageRequest.md +26 -0
- data/docs/SendChatMessageResponse.md +28 -0
- data/docs/SendEmailRequest.md +36 -0
- data/docs/SendEmailResponse.md +26 -0
- data/docs/Session.md +38 -0
- data/docs/SessionListResponse.md +18 -0
- data/docs/SettingsApi.md +745 -0
- data/docs/ShareSettings.md +26 -0
- data/docs/Sheet.md +48 -0
- data/docs/SheetListEnvelope.md +20 -0
- data/docs/SheetsApi.md +785 -0
- data/docs/SignInMethods.md +22 -0
- data/docs/SignInMethodsProvidersInner.md +24 -0
- data/docs/Slide.md +44 -0
- data/docs/SlideElement.md +40 -0
- data/docs/SlideElementList.md +20 -0
- data/docs/SlideList.md +20 -0
- data/docs/SlidesApi.md +1697 -0
- data/docs/SpatioCall.md +38 -0
- data/docs/SpatioConnection.md +38 -0
- data/docs/SpatioEvent.md +86 -0
- data/docs/SpatioFile.md +40 -0
- data/docs/SpatioThread.md +24 -0
- data/docs/SuccessFlag.md +18 -0
- data/docs/Task.md +58 -0
- data/docs/TaskComment.md +28 -0
- data/docs/TaskCommentAuthor.md +24 -0
- data/docs/TaskCommentList.md +20 -0
- data/docs/TaskCommentMutationResponse.md +20 -0
- data/docs/TaskCommentRequest.md +18 -0
- data/docs/TaskListEnvelope.md +20 -0
- data/docs/TaskProvidersInfo.md +20 -0
- data/docs/TaskProvidersInfoPlatform.md +20 -0
- data/docs/TasksApi.md +1783 -0
- data/docs/TerminalApi.md +345 -0
- data/docs/TextAnnotations.md +28 -0
- data/docs/TokenResponse.md +28 -0
- data/docs/UpdateAccountRequest.md +20 -0
- data/docs/UpdateAgentRequest.md +30 -0
- data/docs/UpdateAppRequest.md +24 -0
- data/docs/UpdateBlockRequest.md +22 -0
- data/docs/UpdateCellRequest.md +18 -0
- data/docs/UpdateCommentRequest.md +20 -0
- data/docs/UpdateContactCategoryRequest.md +22 -0
- data/docs/UpdateContactRequest.md +32 -0
- data/docs/UpdateConversationRequest.md +26 -0
- data/docs/UpdateDraftRequest.md +32 -0
- data/docs/UpdateEmailFolderRequest.md +18 -0
- data/docs/UpdateEmailRequest.md +26 -0
- data/docs/UpdateEmailResponse.md +20 -0
- data/docs/UpdateEventRequest.md +22 -0
- data/docs/UpdateFileRequest.md +22 -0
- data/docs/UpdateKeyBindingRequest.md +20 -0
- data/docs/UpdateMessageMetadataRequest.md +20 -0
- data/docs/UpdateNoteRequest.md +30 -0
- data/docs/UpdateOrganizationMemberRequest.md +18 -0
- data/docs/UpdateOrganizationRequest.md +22 -0
- data/docs/UpdatePATRequest.md +20 -0
- data/docs/UpdateParticipantStateRequest.md +22 -0
- data/docs/UpdatePresentationRequest.md +22 -0
- data/docs/UpdateRecommendationStatusRequest.md +18 -0
- data/docs/UpdateRecordRequest.md +22 -0
- data/docs/UpdateRecordTypeRequest.md +26 -0
- data/docs/UpdateRoutineRequest.md +26 -0
- data/docs/UpdateRowRequest.md +18 -0
- data/docs/UpdateSheetRequest.md +30 -0
- data/docs/UpdateSlideElementRequest.md +32 -0
- data/docs/UpdateSlideRequest.md +32 -0
- data/docs/UpdateTaskRequest.md +34 -0
- data/docs/UpdateWorkspaceMemberRequest.md +18 -0
- data/docs/UpdateWorkspaceRequest.md +24 -0
- data/docs/UploadChunkedBlockResponse.md +24 -0
- data/docs/UploadFileBase64Request.md +32 -0
- data/docs/UserInfoResponse.md +34 -0
- data/docs/ValidateKeyBindingRequest.md +22 -0
- data/docs/ValidateKeyBindingResponse.md +20 -0
- data/docs/Workspace.md +44 -0
- data/docs/WorkspaceEnvelope.md +18 -0
- data/docs/WorkspaceInvitation.md +34 -0
- data/docs/WorkspaceInvitationListResponse.md +18 -0
- data/docs/WorkspaceListResponse.md +20 -0
- data/docs/WorkspaceMember.md +30 -0
- data/docs/WorkspaceMemberListResponse.md +20 -0
- data/docs/WorkspaceOrganization.md +22 -0
- data/docs/WorkspacesApi.md +900 -0
- data/docs/WriteAppFileRequest.md +20 -0
- data/git_push.sh +57 -0
- data/lib/spatio-sdk/api/account_api.rb +703 -0
- data/lib/spatio-sdk/api/actions_api.rb +381 -0
- data/lib/spatio-sdk/api/agents_api.rb +824 -0
- data/lib/spatio-sdk/api/apps_api.rb +974 -0
- data/lib/spatio-sdk/api/calendar_api.rb +1015 -0
- data/lib/spatio-sdk/api/calls_api.rb +2016 -0
- data/lib/spatio-sdk/api/channels_api.rb +1165 -0
- data/lib/spatio-sdk/api/connections_api.rb +695 -0
- data/lib/spatio-sdk/api/contacts_api.rb +801 -0
- data/lib/spatio-sdk/api/conversations_api.rb +612 -0
- data/lib/spatio-sdk/api/direct_messages_api.rb +2167 -0
- data/lib/spatio-sdk/api/files_api.rb +2518 -0
- data/lib/spatio-sdk/api/folders_api.rb +409 -0
- data/lib/spatio-sdk/api/inbox_api.rb +403 -0
- data/lib/spatio-sdk/api/keybindings_api.rb +386 -0
- data/lib/spatio-sdk/api/logos_api.rb +210 -0
- data/lib/spatio-sdk/api/mail_api.rb +3780 -0
- data/lib/spatio-sdk/api/misc_api.rb +1100 -0
- data/lib/spatio-sdk/api/models_api.rb +456 -0
- data/lib/spatio-sdk/api/native_dm_api.rb +1396 -0
- data/lib/spatio-sdk/api/navigation_api.rb +77 -0
- data/lib/spatio-sdk/api/notes_api.rb +2418 -0
- data/lib/spatio-sdk/api/notifications_api.rb +143 -0
- data/lib/spatio-sdk/api/o_auth_api.rb +714 -0
- data/lib/spatio-sdk/api/organizations_api.rb +1913 -0
- data/lib/spatio-sdk/api/personal_access_tokens_api.rb +625 -0
- data/lib/spatio-sdk/api/platforms_api.rb +981 -0
- data/lib/spatio-sdk/api/realtime_api.rb +86 -0
- data/lib/spatio-sdk/api/recommendations_api.rb +346 -0
- data/lib/spatio-sdk/api/records_api.rb +550 -0
- data/lib/spatio-sdk/api/repo_api.rb +2167 -0
- data/lib/spatio-sdk/api/resources_api.rb +240 -0
- data/lib/spatio-sdk/api/routines_api.rb +670 -0
- data/lib/spatio-sdk/api/search_api.rb +90 -0
- data/lib/spatio-sdk/api/settings_api.rb +706 -0
- data/lib/spatio-sdk/api/sheets_api.rb +817 -0
- data/lib/spatio-sdk/api/slides_api.rb +1692 -0
- data/lib/spatio-sdk/api/tasks_api.rb +1787 -0
- data/lib/spatio-sdk/api/terminal_api.rb +337 -0
- data/lib/spatio-sdk/api/workspaces_api.rb +876 -0
- data/lib/spatio-sdk/api_client.rb +441 -0
- data/lib/spatio-sdk/api_error.rb +58 -0
- data/lib/spatio-sdk/api_model_base.rb +88 -0
- data/lib/spatio-sdk/configuration.rb +393 -0
- data/lib/spatio-sdk/models/accept_organization_invitation_request.rb +164 -0
- data/lib/spatio-sdk/models/account_choice.rb +200 -0
- data/lib/spatio-sdk/models/account_error.rb +191 -0
- data/lib/spatio-sdk/models/account_list_response.rb +171 -0
- data/lib/spatio-sdk/models/account_plan.rb +228 -0
- data/lib/spatio-sdk/models/account_status.rb +273 -0
- data/lib/spatio-sdk/models/account_tier_details.rb +291 -0
- data/lib/spatio-sdk/models/account_usage.rb +229 -0
- data/lib/spatio-sdk/models/action_descriptor.rb +230 -0
- data/lib/spatio-sdk/models/add_organization_member_request.rb +216 -0
- data/lib/spatio-sdk/models/add_workspace_member_request.rb +214 -0
- data/lib/spatio-sdk/models/agent.rb +268 -0
- data/lib/spatio-sdk/models/agent_conversation.rb +212 -0
- data/lib/spatio-sdk/models/agent_conversation_list_response.rb +175 -0
- data/lib/spatio-sdk/models/agent_list_response.rb +179 -0
- data/lib/spatio-sdk/models/agent_message.rb +228 -0
- data/lib/spatio-sdk/models/agent_message_list_response.rb +175 -0
- data/lib/spatio-sdk/models/agent_session_context.rb +185 -0
- data/lib/spatio-sdk/models/agent_task_usage.rb +204 -0
- data/lib/spatio-sdk/models/ambiguous_account_error.rb +194 -0
- data/lib/spatio-sdk/models/api_error.rb +176 -0
- data/lib/spatio-sdk/models/app.rb +228 -0
- data/lib/spatio-sdk/models/app_file_content_response.rb +173 -0
- data/lib/spatio-sdk/models/app_file_list_response.rb +152 -0
- data/lib/spatio-sdk/models/app_list_response.rb +161 -0
- data/lib/spatio-sdk/models/assign_contact_category_request.rb +164 -0
- data/lib/spatio-sdk/models/attachment.rb +217 -0
- data/lib/spatio-sdk/models/attachment_input.rb +227 -0
- data/lib/spatio-sdk/models/attachment_meta.rb +243 -0
- data/lib/spatio-sdk/models/attendee.rb +292 -0
- data/lib/spatio-sdk/models/attendee_role.rb +41 -0
- data/lib/spatio-sdk/models/attendee_status.rb +42 -0
- data/lib/spatio-sdk/models/block.rb +390 -0
- data/lib/spatio-sdk/models/block_content.rb +252 -0
- data/lib/spatio-sdk/models/block_list_response.rb +193 -0
- data/lib/spatio-sdk/models/block_type.rb +61 -0
- data/lib/spatio-sdk/models/bulk_archive_request.rb +175 -0
- data/lib/spatio-sdk/models/bulk_archive_response.rb +222 -0
- data/lib/spatio-sdk/models/bulk_archive_response_failed_inner.rb +190 -0
- data/lib/spatio-sdk/models/bulk_delete_emails_request.rb +185 -0
- data/lib/spatio-sdk/models/bulk_delete_emails_response.rb +221 -0
- data/lib/spatio-sdk/models/bulk_delete_files_request.rb +180 -0
- data/lib/spatio-sdk/models/bulk_delete_tasks_request.rb +181 -0
- data/lib/spatio-sdk/models/bulk_delete_tasks_response.rb +247 -0
- data/lib/spatio-sdk/models/bulk_delete_tasks_response_failed_inner.rb +190 -0
- data/lib/spatio-sdk/models/bulk_files_response.rb +247 -0
- data/lib/spatio-sdk/models/bulk_files_response_failed_inner.rb +190 -0
- data/lib/spatio-sdk/models/bulk_mark_read_request.rb +187 -0
- data/lib/spatio-sdk/models/bulk_mark_read_response.rb +194 -0
- data/lib/spatio-sdk/models/bulk_mark_read_response_failed_inner.rb +190 -0
- data/lib/spatio-sdk/models/bulk_move_files_request.rb +191 -0
- data/lib/spatio-sdk/models/bulk_update_tasks_request.rb +213 -0
- data/lib/spatio-sdk/models/bulk_update_tasks_response.rb +246 -0
- data/lib/spatio-sdk/models/calendar_account_error.rb +242 -0
- data/lib/spatio-sdk/models/calendar_capabilities_response.rb +219 -0
- data/lib/spatio-sdk/models/calendar_operation_result.rb +198 -0
- data/lib/spatio-sdk/models/calendar_provider_info.rb +220 -0
- data/lib/spatio-sdk/models/calendar_providers_info.rb +167 -0
- data/lib/spatio-sdk/models/calendar_sync_response.rb +222 -0
- data/lib/spatio-sdk/models/call_list_response.rb +161 -0
- data/lib/spatio-sdk/models/call_recording.rb +222 -0
- data/lib/spatio-sdk/models/call_recording_list_response.rb +152 -0
- data/lib/spatio-sdk/models/cell.rb +204 -0
- data/lib/spatio-sdk/models/change_password_request.rb +174 -0
- data/lib/spatio-sdk/models/channel.rb +325 -0
- data/lib/spatio-sdk/models/channel_membership_request.rb +148 -0
- data/lib/spatio-sdk/models/chat_action_definition.rb +278 -0
- data/lib/spatio-sdk/models/chat_actions_list.rb +166 -0
- data/lib/spatio-sdk/models/chat_message.rb +317 -0
- data/lib/spatio-sdk/models/chat_user.rb +287 -0
- data/lib/spatio-sdk/models/chunked_file_manifest.rb +324 -0
- data/lib/spatio-sdk/models/client_registration_request.rb +314 -0
- data/lib/spatio-sdk/models/client_registration_response.rb +329 -0
- data/lib/spatio-sdk/models/comment.rb +315 -0
- data/lib/spatio-sdk/models/comment_author.rb +226 -0
- data/lib/spatio-sdk/models/comment_list_response.rb +192 -0
- data/lib/spatio-sdk/models/comment_mutation_response.rb +191 -0
- data/lib/spatio-sdk/models/comment_response.rb +165 -0
- data/lib/spatio-sdk/models/commit_chunked_upload_request.rb +164 -0
- data/lib/spatio-sdk/models/commit_chunked_upload_response.rb +313 -0
- data/lib/spatio-sdk/models/conference_data.rb +229 -0
- data/lib/spatio-sdk/models/connected_app_item.rb +308 -0
- data/lib/spatio-sdk/models/connected_apps_list_response.rb +166 -0
- data/lib/spatio-sdk/models/connection_account_list_response.rb +172 -0
- data/lib/spatio-sdk/models/connection_list_response.rb +177 -0
- data/lib/spatio-sdk/models/consume_agent_task_response.rb +204 -0
- data/lib/spatio-sdk/models/contact.rb +294 -0
- data/lib/spatio-sdk/models/contact_category.rb +217 -0
- data/lib/spatio-sdk/models/contact_category_list_response.rb +152 -0
- data/lib/spatio-sdk/models/contact_list_response.rb +184 -0
- data/lib/spatio-sdk/models/contact_provider.rb +217 -0
- data/lib/spatio-sdk/models/contact_provider_list_response.rb +166 -0
- data/lib/spatio-sdk/models/conversation.rb +314 -0
- data/lib/spatio-sdk/models/conversation_message.rb +246 -0
- data/lib/spatio-sdk/models/core_action.rb +221 -0
- data/lib/spatio-sdk/models/core_action_list_response.rb +161 -0
- data/lib/spatio-sdk/models/create_agent_conversation_request.rb +167 -0
- data/lib/spatio-sdk/models/create_agent_message_request.rb +201 -0
- data/lib/spatio-sdk/models/create_agent_request.rb +222 -0
- data/lib/spatio-sdk/models/create_app_request.rb +200 -0
- data/lib/spatio-sdk/models/create_block_request.rb +260 -0
- data/lib/spatio-sdk/models/create_calendar_event201_response.rb +202 -0
- data/lib/spatio-sdk/models/create_call_request.rb +176 -0
- data/lib/spatio-sdk/models/create_channel_request.rb +191 -0
- data/lib/spatio-sdk/models/create_channel_response.rb +190 -0
- data/lib/spatio-sdk/models/create_comment_request.rb +177 -0
- data/lib/spatio-sdk/models/create_contact_category_request.rb +182 -0
- data/lib/spatio-sdk/models/create_contact_request.rb +212 -0
- data/lib/spatio-sdk/models/create_conversation_request.rb +185 -0
- data/lib/spatio-sdk/models/create_draft_request.rb +248 -0
- data/lib/spatio-sdk/models/create_email_folder_request.rb +173 -0
- data/lib/spatio-sdk/models/create_event_request.rb +254 -0
- data/lib/spatio-sdk/models/create_folder_request.rb +201 -0
- data/lib/spatio-sdk/models/create_label_request.rb +200 -0
- data/lib/spatio-sdk/models/create_label_response.rb +190 -0
- data/lib/spatio-sdk/models/create_meeting_room_request.rb +173 -0
- data/lib/spatio-sdk/models/create_note400_response.rb +104 -0
- data/lib/spatio-sdk/models/create_note_request.rb +232 -0
- data/lib/spatio-sdk/models/create_organization_invitation_request.rb +224 -0
- data/lib/spatio-sdk/models/create_organization_request.rb +211 -0
- data/lib/spatio-sdk/models/create_pat_request.rb +202 -0
- data/lib/spatio-sdk/models/create_pat_response.rb +174 -0
- data/lib/spatio-sdk/models/create_presentation_request.rb +200 -0
- data/lib/spatio-sdk/models/create_record_request.rb +204 -0
- data/lib/spatio-sdk/models/create_record_type_request.rb +211 -0
- data/lib/spatio-sdk/models/create_routine_request.rb +204 -0
- data/lib/spatio-sdk/models/create_row_request.rb +176 -0
- data/lib/spatio-sdk/models/create_sheet_request.rb +222 -0
- data/lib/spatio-sdk/models/create_slide_element_request.rb +229 -0
- data/lib/spatio-sdk/models/create_slide_request.rb +220 -0
- data/lib/spatio-sdk/models/create_task_request.rb +322 -0
- data/lib/spatio-sdk/models/create_workspace_invitation_request.rb +214 -0
- data/lib/spatio-sdk/models/create_workspace_request.rb +191 -0
- data/lib/spatio-sdk/models/disconnect_connection_request.rb +173 -0
- data/lib/spatio-sdk/models/discovery_document.rb +404 -0
- data/lib/spatio-sdk/models/dm_attach_request.rb +254 -0
- data/lib/spatio-sdk/models/dm_forward_request.rb +166 -0
- data/lib/spatio-sdk/models/dm_mark_read_request.rb +173 -0
- data/lib/spatio-sdk/models/dm_message_envelope.rb +165 -0
- data/lib/spatio-sdk/models/dm_mute_request.rb +166 -0
- data/lib/spatio-sdk/models/dm_mute_response.rb +148 -0
- data/lib/spatio-sdk/models/dm_pinned_list.rb +149 -0
- data/lib/spatio-sdk/models/dm_reaction_request.rb +173 -0
- data/lib/spatio-sdk/models/dm_reaction_response.rb +150 -0
- data/lib/spatio-sdk/models/dm_search_results.rb +149 -0
- data/lib/spatio-sdk/models/dm_set_draft_request.rb +173 -0
- data/lib/spatio-sdk/models/dm_thread_reply_request.rb +173 -0
- data/lib/spatio-sdk/models/download_file_response.rb +191 -0
- data/lib/spatio-sdk/models/draft.rb +339 -0
- data/lib/spatio-sdk/models/draft_response.rb +190 -0
- data/lib/spatio-sdk/models/email.rb +488 -0
- data/lib/spatio-sdk/models/email_folder.rb +202 -0
- data/lib/spatio-sdk/models/email_folder_list_response.rb +152 -0
- data/lib/spatio-sdk/models/enable_share_request.rb +157 -0
- data/lib/spatio-sdk/models/execute_action_request.rb +185 -0
- data/lib/spatio-sdk/models/execute_action_response.rb +168 -0
- data/lib/spatio-sdk/models/execute_chat_action_request.rb +175 -0
- data/lib/spatio-sdk/models/execute_chat_action_response.rb +175 -0
- data/lib/spatio-sdk/models/export_pdf_request.rb +162 -0
- data/lib/spatio-sdk/models/export_pdf_request_rasterized_slides_inner.rb +191 -0
- data/lib/spatio-sdk/models/export_pdfr2_response.rb +269 -0
- data/lib/spatio-sdk/models/extract_text_result.rb +212 -0
- data/lib/spatio-sdk/models/federated_search200_response.rb +270 -0
- data/lib/spatio-sdk/models/federated_search200_response_items_inner.rb +237 -0
- data/lib/spatio-sdk/models/federated_search200_response_per_platform_value.rb +156 -0
- data/lib/spatio-sdk/models/federated_search_request.rb +276 -0
- data/lib/spatio-sdk/models/file_list_envelope.rb +181 -0
- data/lib/spatio-sdk/models/files_and_folders_response.rb +235 -0
- data/lib/spatio-sdk/models/folder.rb +297 -0
- data/lib/spatio-sdk/models/folder_list_envelope.rb +181 -0
- data/lib/spatio-sdk/models/get_chat_user_response.rb +190 -0
- data/lib/spatio-sdk/models/get_domain_logo200_response.rb +190 -0
- data/lib/spatio-sdk/models/get_email_response.rb +190 -0
- data/lib/spatio-sdk/models/get_thread_response.rb +190 -0
- data/lib/spatio-sdk/models/inbox_counts.rb +216 -0
- data/lib/spatio-sdk/models/inbox_item.rb +275 -0
- data/lib/spatio-sdk/models/inbox_list_response.rb +218 -0
- data/lib/spatio-sdk/models/init_chunked_upload_request.rb +273 -0
- data/lib/spatio-sdk/models/init_chunked_upload_response.rb +273 -0
- data/lib/spatio-sdk/models/install_connection_request.rb +184 -0
- data/lib/spatio-sdk/models/introspection_response.rb +219 -0
- data/lib/spatio-sdk/models/issue_collaboration_token200_response.rb +254 -0
- data/lib/spatio-sdk/models/issue_collaboration_token_request.rb +148 -0
- data/lib/spatio-sdk/models/jwk.rb +297 -0
- data/lib/spatio-sdk/models/jwks.rb +166 -0
- data/lib/spatio-sdk/models/key_binding.rb +276 -0
- data/lib/spatio-sdk/models/key_binding_list_response.rb +166 -0
- data/lib/spatio-sdk/models/label.rb +244 -0
- data/lib/spatio-sdk/models/label_color.rb +190 -0
- data/lib/spatio-sdk/models/link_repo_task_request.rb +164 -0
- data/lib/spatio-sdk/models/list_calendar_events200_response.rb +202 -0
- data/lib/spatio-sdk/models/list_channels_response.rb +212 -0
- data/lib/spatio-sdk/models/list_chat_users_response.rb +211 -0
- data/lib/spatio-sdk/models/list_drafts_response.rb +227 -0
- data/lib/spatio-sdk/models/list_emails_response.rb +213 -0
- data/lib/spatio-sdk/models/list_events_data.rb +196 -0
- data/lib/spatio-sdk/models/list_labels_response.rb +192 -0
- data/lib/spatio-sdk/models/list_messages_response.rb +211 -0
- data/lib/spatio-sdk/models/meeting_room.rb +191 -0
- data/lib/spatio-sdk/models/move_block_request.rb +175 -0
- data/lib/spatio-sdk/models/move_emails_request.rb +166 -0
- data/lib/spatio-sdk/models/move_file_request.rb +149 -0
- data/lib/spatio-sdk/models/move_file_response.rb +164 -0
- data/lib/spatio-sdk/models/note.rb +380 -0
- data/lib/spatio-sdk/models/note_list_envelope.rb +195 -0
- data/lib/spatio-sdk/models/o_auth_error.rb +197 -0
- data/lib/spatio-sdk/models/organization.rb +346 -0
- data/lib/spatio-sdk/models/organization_detail_legacy.rb +377 -0
- data/lib/spatio-sdk/models/organization_invitation.rb +343 -0
- data/lib/spatio-sdk/models/organization_invitation_list_response.rb +166 -0
- data/lib/spatio-sdk/models/organization_list_response.rb +166 -0
- data/lib/spatio-sdk/models/organization_member.rb +288 -0
- data/lib/spatio-sdk/models/organization_member_invited_by.rb +105 -0
- data/lib/spatio-sdk/models/organization_member_list_response.rb +192 -0
- data/lib/spatio-sdk/models/organization_workspaces_inner.rb +216 -0
- data/lib/spatio-sdk/models/password_required_error.rb +218 -0
- data/lib/spatio-sdk/models/pat_list_response.rb +177 -0
- data/lib/spatio-sdk/models/pat_scopes_response.rb +166 -0
- data/lib/spatio-sdk/models/personal_access_token.rb +241 -0
- data/lib/spatio-sdk/models/preconfigured_agent.rb +236 -0
- data/lib/spatio-sdk/models/presentation.rb +308 -0
- data/lib/spatio-sdk/models/presentation_list_envelope.rb +194 -0
- data/lib/spatio-sdk/models/propose_recommendation_request.rb +211 -0
- data/lib/spatio-sdk/models/public_invitation_payload.rb +365 -0
- data/lib/spatio-sdk/models/quota_exceeded_error.rb +183 -0
- data/lib/spatio-sdk/models/recommendation.rb +300 -0
- data/lib/spatio-sdk/models/recommendation_list_response.rb +166 -0
- data/lib/spatio-sdk/models/record.rb +231 -0
- data/lib/spatio-sdk/models/record_list_response.rb +184 -0
- data/lib/spatio-sdk/models/record_type.rb +256 -0
- data/lib/spatio-sdk/models/record_type_list_response.rb +166 -0
- data/lib/spatio-sdk/models/refresh_connection_request.rb +173 -0
- data/lib/spatio-sdk/models/reminder.rb +213 -0
- data/lib/spatio-sdk/models/reminder_method.rb +42 -0
- data/lib/spatio-sdk/models/reply_email_request.rb +227 -0
- data/lib/spatio-sdk/models/revoke_other_sessions_response.rb +148 -0
- data/lib/spatio-sdk/models/rich_text_object.rb +216 -0
- data/lib/spatio-sdk/models/routine.rb +240 -0
- data/lib/spatio-sdk/models/routine_list_response.rb +166 -0
- data/lib/spatio-sdk/models/routine_run.rb +221 -0
- data/lib/spatio-sdk/models/routine_run_complete_request.rb +158 -0
- data/lib/spatio-sdk/models/routine_run_list_response.rb +166 -0
- data/lib/spatio-sdk/models/routine_run_progress_request.rb +158 -0
- data/lib/spatio-sdk/models/row.rb +194 -0
- data/lib/spatio-sdk/models/row_list.rb +192 -0
- data/lib/spatio-sdk/models/save_message_request.rb +201 -0
- data/lib/spatio-sdk/models/search_emails_response.rb +212 -0
- data/lib/spatio-sdk/models/search_files_response.rb +229 -0
- data/lib/spatio-sdk/models/send_chat_message_request.rb +221 -0
- data/lib/spatio-sdk/models/send_chat_message_response.rb +243 -0
- data/lib/spatio-sdk/models/send_email_request.rb +289 -0
- data/lib/spatio-sdk/models/send_email_response.rb +234 -0
- data/lib/spatio-sdk/models/session.rb +254 -0
- data/lib/spatio-sdk/models/session_list_response.rb +166 -0
- data/lib/spatio-sdk/models/share_settings.rb +221 -0
- data/lib/spatio-sdk/models/sheet.rb +446 -0
- data/lib/spatio-sdk/models/sheet_list_envelope.rb +195 -0
- data/lib/spatio-sdk/models/sign_in_methods.rb +201 -0
- data/lib/spatio-sdk/models/sign_in_methods_providers_inner.rb +193 -0
- data/lib/spatio-sdk/models/slide.rb +370 -0
- data/lib/spatio-sdk/models/slide_element.rb +455 -0
- data/lib/spatio-sdk/models/slide_element_list.rb +192 -0
- data/lib/spatio-sdk/models/slide_list.rb +192 -0
- data/lib/spatio-sdk/models/spatio_call.rb +259 -0
- data/lib/spatio-sdk/models/spatio_connection.rb +260 -0
- data/lib/spatio-sdk/models/spatio_event.rb +686 -0
- data/lib/spatio-sdk/models/spatio_file.rb +372 -0
- data/lib/spatio-sdk/models/spatio_thread.rb +212 -0
- data/lib/spatio-sdk/models/success_flag.rb +165 -0
- data/lib/spatio-sdk/models/task.rb +471 -0
- data/lib/spatio-sdk/models/task_comment.rb +294 -0
- data/lib/spatio-sdk/models/task_comment_author.rb +226 -0
- data/lib/spatio-sdk/models/task_comment_list.rb +192 -0
- data/lib/spatio-sdk/models/task_comment_mutation_response.rb +190 -0
- data/lib/spatio-sdk/models/task_comment_request.rb +164 -0
- data/lib/spatio-sdk/models/task_list_envelope.rb +195 -0
- data/lib/spatio-sdk/models/task_providers_info.rb +194 -0
- data/lib/spatio-sdk/models/task_providers_info_platform.rb +190 -0
- data/lib/spatio-sdk/models/text_annotations.rb +278 -0
- data/lib/spatio-sdk/models/token_response.rb +246 -0
- data/lib/spatio-sdk/models/update_account_request.rb +158 -0
- data/lib/spatio-sdk/models/update_agent_request.rb +205 -0
- data/lib/spatio-sdk/models/update_app_request.rb +174 -0
- data/lib/spatio-sdk/models/update_block_request.rb +168 -0
- data/lib/spatio-sdk/models/update_cell_request.rb +151 -0
- data/lib/spatio-sdk/models/update_comment_request.rb +157 -0
- data/lib/spatio-sdk/models/update_contact_category_request.rb +165 -0
- data/lib/spatio-sdk/models/update_contact_request.rb +212 -0
- data/lib/spatio-sdk/models/update_conversation_request.rb +183 -0
- data/lib/spatio-sdk/models/update_draft_request.rb +219 -0
- data/lib/spatio-sdk/models/update_email_folder_request.rb +147 -0
- data/lib/spatio-sdk/models/update_email_request.rb +188 -0
- data/lib/spatio-sdk/models/update_email_response.rb +190 -0
- data/lib/spatio-sdk/models/update_event_request.rb +236 -0
- data/lib/spatio-sdk/models/update_file_request.rb +169 -0
- data/lib/spatio-sdk/models/update_key_binding_request.rb +175 -0
- data/lib/spatio-sdk/models/update_message_metadata_request.rb +175 -0
- data/lib/spatio-sdk/models/update_note_request.rb +205 -0
- data/lib/spatio-sdk/models/update_organization_member_request.rb +188 -0
- data/lib/spatio-sdk/models/update_organization_request.rb +166 -0
- data/lib/spatio-sdk/models/update_participant_state_request.rb +166 -0
- data/lib/spatio-sdk/models/update_pat_request.rb +156 -0
- data/lib/spatio-sdk/models/update_presentation_request.rb +166 -0
- data/lib/spatio-sdk/models/update_recommendation_status_request.rb +188 -0
- data/lib/spatio-sdk/models/update_record_request.rb +169 -0
- data/lib/spatio-sdk/models/update_record_type_request.rb +185 -0
- data/lib/spatio-sdk/models/update_routine_request.rb +187 -0
- data/lib/spatio-sdk/models/update_row_request.rb +167 -0
- data/lib/spatio-sdk/models/update_sheet_request.rb +205 -0
- data/lib/spatio-sdk/models/update_slide_element_request.rb +213 -0
- data/lib/spatio-sdk/models/update_slide_request.rb +211 -0
- data/lib/spatio-sdk/models/update_task_request.rb +260 -0
- data/lib/spatio-sdk/models/update_workspace_member_request.rb +188 -0
- data/lib/spatio-sdk/models/update_workspace_request.rb +176 -0
- data/lib/spatio-sdk/models/upload_chunked_block_response.rb +243 -0
- data/lib/spatio-sdk/models/upload_file_base64_request.rb +265 -0
- data/lib/spatio-sdk/models/user_info_response.rb +237 -0
- data/lib/spatio-sdk/models/validate_key_binding_request.rb +201 -0
- data/lib/spatio-sdk/models/validate_key_binding_response.rb +175 -0
- data/lib/spatio-sdk/models/workspace.rb +321 -0
- data/lib/spatio-sdk/models/workspace_envelope.rb +164 -0
- data/lib/spatio-sdk/models/workspace_invitation.rb +324 -0
- data/lib/spatio-sdk/models/workspace_invitation_list_response.rb +166 -0
- data/lib/spatio-sdk/models/workspace_list_response.rb +175 -0
- data/lib/spatio-sdk/models/workspace_member.rb +278 -0
- data/lib/spatio-sdk/models/workspace_member_list_response.rb +175 -0
- data/lib/spatio-sdk/models/workspace_organization.rb +166 -0
- data/lib/spatio-sdk/models/write_app_file_request.rb +190 -0
- data/lib/spatio-sdk/version.rb +15 -0
- data/lib/spatio-sdk.rb +408 -0
- data/spatio-sdk.gemspec +41 -0
- data/spec/api/account_api_spec.rb +158 -0
- data/spec/api/actions_api_spec.rb +99 -0
- data/spec/api/agents_api_spec.rb +176 -0
- data/spec/api/apps_api_spec.rb +198 -0
- data/spec/api/calendar_api_spec.rb +217 -0
- data/spec/api/calls_api_spec.rb +378 -0
- data/spec/api/channels_api_spec.rb +236 -0
- data/spec/api/connections_api_spec.rb +154 -0
- data/spec/api/contacts_api_spec.rb +172 -0
- data/spec/api/conversations_api_spec.rb +140 -0
- data/spec/api/direct_messages_api_spec.rb +420 -0
- data/spec/api/files_api_spec.rb +494 -0
- data/spec/api/folders_api_spec.rb +102 -0
- data/spec/api/inbox_api_spec.rb +103 -0
- data/spec/api/keybindings_api_spec.rb +99 -0
- data/spec/api/logos_api_spec.rb +68 -0
- data/spec/api/mail_api_spec.rb +701 -0
- data/spec/api/misc_api_spec.rb +228 -0
- data/spec/api/models_api_spec.rb +112 -0
- data/spec/api/native_dm_api_spec.rb +276 -0
- data/spec/api/navigation_api_spec.rb +45 -0
- data/spec/api/notes_api_spec.rb +474 -0
- data/spec/api/notifications_api_spec.rb +56 -0
- data/spec/api/o_auth_api_spec.rb +161 -0
- data/spec/api/organizations_api_spec.rb +367 -0
- data/spec/api/personal_access_tokens_api_spec.rb +137 -0
- data/spec/api/platforms_api_spec.rb +204 -0
- data/spec/api/realtime_api_spec.rb +47 -0
- data/spec/api/recommendations_api_spec.rb +93 -0
- data/spec/api/records_api_spec.rb +127 -0
- data/spec/api/repo_api_spec.rb +402 -0
- data/spec/api/resources_api_spec.rb +73 -0
- data/spec/api/routines_api_spec.rb +149 -0
- data/spec/api/search_api_spec.rb +47 -0
- data/spec/api/settings_api_spec.rb +154 -0
- data/spec/api/sheets_api_spec.rb +184 -0
- data/spec/api/slides_api_spec.rb +355 -0
- data/spec/api/tasks_api_spec.rb +355 -0
- data/spec/api/terminal_api_spec.rb +90 -0
- data/spec/api/workspaces_api_spec.rb +184 -0
- data/spec/models/accept_organization_invitation_request_spec.rb +36 -0
- data/spec/models/account_choice_spec.rb +48 -0
- data/spec/models/account_error_spec.rb +42 -0
- data/spec/models/account_list_response_spec.rb +48 -0
- data/spec/models/account_plan_spec.rb +54 -0
- data/spec/models/account_status_spec.rb +70 -0
- data/spec/models/account_tier_details_spec.rb +120 -0
- data/spec/models/account_usage_spec.rb +78 -0
- data/spec/models/action_descriptor_spec.rb +78 -0
- data/spec/models/add_organization_member_request_spec.rb +52 -0
- data/spec/models/add_workspace_member_request_spec.rb +46 -0
- data/spec/models/agent_conversation_list_response_spec.rb +42 -0
- data/spec/models/agent_conversation_spec.rb +66 -0
- data/spec/models/agent_list_response_spec.rb +54 -0
- data/spec/models/agent_message_list_response_spec.rb +42 -0
- data/spec/models/agent_message_spec.rb +66 -0
- data/spec/models/agent_session_context_spec.rb +54 -0
- data/spec/models/agent_spec.rb +102 -0
- data/spec/models/agent_task_usage_spec.rb +60 -0
- data/spec/models/ambiguous_account_error_spec.rb +48 -0
- data/spec/models/api_error_spec.rb +42 -0
- data/spec/models/app_file_content_response_spec.rb +42 -0
- data/spec/models/app_file_list_response_spec.rb +36 -0
- data/spec/models/app_list_response_spec.rb +42 -0
- data/spec/models/app_spec.rb +78 -0
- data/spec/models/assign_contact_category_request_spec.rb +36 -0
- data/spec/models/attachment_input_spec.rb +54 -0
- data/spec/models/attachment_meta_spec.rb +54 -0
- data/spec/models/attachment_spec.rb +60 -0
- data/spec/models/attendee_role_spec.rb +30 -0
- data/spec/models/attendee_spec.rb +72 -0
- data/spec/models/attendee_status_spec.rb +30 -0
- data/spec/models/block_content_spec.rb +96 -0
- data/spec/models/block_list_response_spec.rb +42 -0
- data/spec/models/block_spec.rb +90 -0
- data/spec/models/block_type_spec.rb +30 -0
- data/spec/models/bulk_archive_request_spec.rb +42 -0
- data/spec/models/bulk_archive_response_failed_inner_spec.rb +42 -0
- data/spec/models/bulk_archive_response_spec.rb +48 -0
- data/spec/models/bulk_delete_emails_request_spec.rb +48 -0
- data/spec/models/bulk_delete_emails_response_spec.rb +48 -0
- data/spec/models/bulk_delete_files_request_spec.rb +54 -0
- data/spec/models/bulk_delete_tasks_request_spec.rb +54 -0
- data/spec/models/bulk_delete_tasks_response_failed_inner_spec.rb +42 -0
- data/spec/models/bulk_delete_tasks_response_spec.rb +54 -0
- data/spec/models/bulk_files_response_failed_inner_spec.rb +42 -0
- data/spec/models/bulk_files_response_spec.rb +54 -0
- data/spec/models/bulk_mark_read_request_spec.rb +48 -0
- data/spec/models/bulk_mark_read_response_failed_inner_spec.rb +42 -0
- data/spec/models/bulk_mark_read_response_spec.rb +42 -0
- data/spec/models/bulk_move_files_request_spec.rb +60 -0
- data/spec/models/bulk_update_tasks_request_spec.rb +54 -0
- data/spec/models/bulk_update_tasks_response_spec.rb +54 -0
- data/spec/models/calendar_account_error_spec.rb +54 -0
- data/spec/models/calendar_capabilities_response_spec.rb +48 -0
- data/spec/models/calendar_operation_result_spec.rb +54 -0
- data/spec/models/calendar_provider_info_spec.rb +60 -0
- data/spec/models/calendar_providers_info_spec.rb +36 -0
- data/spec/models/calendar_sync_response_spec.rb +60 -0
- data/spec/models/call_list_response_spec.rb +42 -0
- data/spec/models/call_recording_list_response_spec.rb +36 -0
- data/spec/models/call_recording_spec.rb +72 -0
- data/spec/models/cell_spec.rb +48 -0
- data/spec/models/change_password_request_spec.rb +42 -0
- data/spec/models/channel_membership_request_spec.rb +36 -0
- data/spec/models/channel_spec.rb +96 -0
- data/spec/models/chat_action_definition_spec.rb +84 -0
- data/spec/models/chat_actions_list_spec.rb +36 -0
- data/spec/models/chat_message_spec.rb +90 -0
- data/spec/models/chat_user_spec.rb +84 -0
- data/spec/models/chunked_file_manifest_spec.rb +84 -0
- data/spec/models/client_registration_request_spec.rb +94 -0
- data/spec/models/client_registration_response_spec.rb +96 -0
- data/spec/models/comment_author_spec.rb +54 -0
- data/spec/models/comment_list_response_spec.rb +42 -0
- data/spec/models/comment_mutation_response_spec.rb +42 -0
- data/spec/models/comment_response_spec.rb +36 -0
- data/spec/models/comment_spec.rb +78 -0
- data/spec/models/commit_chunked_upload_request_spec.rb +36 -0
- data/spec/models/commit_chunked_upload_response_spec.rb +90 -0
- data/spec/models/conference_data_spec.rb +66 -0
- data/spec/models/connected_app_item_spec.rb +84 -0
- data/spec/models/connected_apps_list_response_spec.rb +36 -0
- data/spec/models/connection_account_list_response_spec.rb +48 -0
- data/spec/models/connection_list_response_spec.rb +42 -0
- data/spec/models/consume_agent_task_response_spec.rb +60 -0
- data/spec/models/contact_category_list_response_spec.rb +36 -0
- data/spec/models/contact_category_spec.rb +60 -0
- data/spec/models/contact_list_response_spec.rb +48 -0
- data/spec/models/contact_provider_list_response_spec.rb +36 -0
- data/spec/models/contact_provider_spec.rb +60 -0
- data/spec/models/contact_spec.rb +120 -0
- data/spec/models/conversation_message_spec.rb +66 -0
- data/spec/models/conversation_spec.rb +108 -0
- data/spec/models/core_action_list_response_spec.rb +42 -0
- data/spec/models/core_action_spec.rb +72 -0
- data/spec/models/create_agent_conversation_request_spec.rb +48 -0
- data/spec/models/create_agent_message_request_spec.rb +48 -0
- data/spec/models/create_agent_request_spec.rb +72 -0
- data/spec/models/create_app_request_spec.rb +60 -0
- data/spec/models/create_block_request_spec.rb +60 -0
- data/spec/models/create_calendar_event201_response_spec.rb +54 -0
- data/spec/models/create_call_request_spec.rb +54 -0
- data/spec/models/create_channel_request_spec.rb +54 -0
- data/spec/models/create_channel_response_spec.rb +42 -0
- data/spec/models/create_comment_request_spec.rb +54 -0
- data/spec/models/create_contact_category_request_spec.rb +48 -0
- data/spec/models/create_contact_request_spec.rb +78 -0
- data/spec/models/create_conversation_request_spec.rb +60 -0
- data/spec/models/create_draft_request_spec.rb +96 -0
- data/spec/models/create_email_folder_request_spec.rb +42 -0
- data/spec/models/create_event_request_spec.rb +64 -0
- data/spec/models/create_folder_request_spec.rb +60 -0
- data/spec/models/create_label_request_spec.rb +60 -0
- data/spec/models/create_label_response_spec.rb +42 -0
- data/spec/models/create_meeting_room_request_spec.rb +42 -0
- data/spec/models/create_note400_response_spec.rb +32 -0
- data/spec/models/create_note_request_spec.rb +78 -0
- data/spec/models/create_organization_invitation_request_spec.rb +52 -0
- data/spec/models/create_organization_request_spec.rb +66 -0
- data/spec/models/create_pat_request_spec.rb +60 -0
- data/spec/models/create_pat_response_spec.rb +42 -0
- data/spec/models/create_presentation_request_spec.rb +60 -0
- data/spec/models/create_record_request_spec.rb +60 -0
- data/spec/models/create_record_type_request_spec.rb +66 -0
- data/spec/models/create_routine_request_spec.rb +60 -0
- data/spec/models/create_row_request_spec.rb +42 -0
- data/spec/models/create_sheet_request_spec.rb +72 -0
- data/spec/models/create_slide_element_request_spec.rb +78 -0
- data/spec/models/create_slide_request_spec.rb +84 -0
- data/spec/models/create_task_request_spec.rb +118 -0
- data/spec/models/create_workspace_invitation_request_spec.rb +46 -0
- data/spec/models/create_workspace_request_spec.rb +54 -0
- data/spec/models/disconnect_connection_request_spec.rb +42 -0
- data/spec/models/discovery_document_spec.rb +138 -0
- data/spec/models/dm_attach_request_spec.rb +84 -0
- data/spec/models/dm_forward_request_spec.rb +48 -0
- data/spec/models/dm_mark_read_request_spec.rb +42 -0
- data/spec/models/dm_message_envelope_spec.rb +36 -0
- data/spec/models/dm_mute_request_spec.rb +48 -0
- data/spec/models/dm_mute_response_spec.rb +36 -0
- data/spec/models/dm_pinned_list_spec.rb +36 -0
- data/spec/models/dm_reaction_request_spec.rb +42 -0
- data/spec/models/dm_reaction_response_spec.rb +36 -0
- data/spec/models/dm_search_results_spec.rb +36 -0
- data/spec/models/dm_set_draft_request_spec.rb +42 -0
- data/spec/models/dm_thread_reply_request_spec.rb +42 -0
- data/spec/models/download_file_response_spec.rb +42 -0
- data/spec/models/draft_response_spec.rb +42 -0
- data/spec/models/draft_spec.rb +102 -0
- data/spec/models/email_folder_list_response_spec.rb +36 -0
- data/spec/models/email_folder_spec.rb +60 -0
- data/spec/models/email_spec.rb +150 -0
- data/spec/models/enable_share_request_spec.rb +42 -0
- data/spec/models/execute_action_request_spec.rb +48 -0
- data/spec/models/execute_action_response_spec.rb +48 -0
- data/spec/models/execute_chat_action_request_spec.rb +42 -0
- data/spec/models/execute_chat_action_response_spec.rb +42 -0
- data/spec/models/export_pdf_request_rasterized_slides_inner_spec.rb +42 -0
- data/spec/models/export_pdf_request_spec.rb +42 -0
- data/spec/models/export_pdfr2_response_spec.rb +58 -0
- data/spec/models/extract_text_result_spec.rb +54 -0
- data/spec/models/federated_search200_response_items_inner_spec.rb +96 -0
- data/spec/models/federated_search200_response_per_platform_value_spec.rb +42 -0
- data/spec/models/federated_search200_response_spec.rb +66 -0
- data/spec/models/federated_search_request_spec.rb +82 -0
- data/spec/models/file_list_envelope_spec.rb +42 -0
- data/spec/models/files_and_folders_response_spec.rb +66 -0
- data/spec/models/folder_list_envelope_spec.rb +42 -0
- data/spec/models/folder_spec.rb +78 -0
- data/spec/models/get_chat_user_response_spec.rb +42 -0
- data/spec/models/get_domain_logo200_response_spec.rb +42 -0
- data/spec/models/get_email_response_spec.rb +42 -0
- data/spec/models/get_thread_response_spec.rb +42 -0
- data/spec/models/inbox_counts_spec.rb +48 -0
- data/spec/models/inbox_item_spec.rb +96 -0
- data/spec/models/inbox_list_response_spec.rb +48 -0
- data/spec/models/init_chunked_upload_request_spec.rb +72 -0
- data/spec/models/init_chunked_upload_response_spec.rb +60 -0
- data/spec/models/install_connection_request_spec.rb +48 -0
- data/spec/models/introspection_response_spec.rb +72 -0
- data/spec/models/issue_collaboration_token200_response_spec.rb +60 -0
- data/spec/models/issue_collaboration_token_request_spec.rb +36 -0
- data/spec/models/jwk_spec.rb +66 -0
- data/spec/models/jwks_spec.rb +36 -0
- data/spec/models/key_binding_list_response_spec.rb +36 -0
- data/spec/models/key_binding_spec.rb +96 -0
- data/spec/models/label_color_spec.rb +42 -0
- data/spec/models/label_spec.rb +66 -0
- data/spec/models/link_repo_task_request_spec.rb +36 -0
- data/spec/models/list_calendar_events200_response_spec.rb +54 -0
- data/spec/models/list_channels_response_spec.rb +54 -0
- data/spec/models/list_chat_users_response_spec.rb +54 -0
- data/spec/models/list_drafts_response_spec.rb +54 -0
- data/spec/models/list_emails_response_spec.rb +54 -0
- data/spec/models/list_events_data_spec.rb +54 -0
- data/spec/models/list_labels_response_spec.rb +42 -0
- data/spec/models/list_messages_response_spec.rb +54 -0
- data/spec/models/meeting_room_spec.rb +54 -0
- data/spec/models/move_block_request_spec.rb +42 -0
- data/spec/models/move_emails_request_spec.rb +36 -0
- data/spec/models/move_file_request_spec.rb +36 -0
- data/spec/models/move_file_response_spec.rb +36 -0
- data/spec/models/note_list_envelope_spec.rb +42 -0
- data/spec/models/note_spec.rb +114 -0
- data/spec/models/o_auth_error_spec.rb +46 -0
- data/spec/models/organization_detail_legacy_spec.rb +96 -0
- data/spec/models/organization_invitation_list_response_spec.rb +36 -0
- data/spec/models/organization_invitation_spec.rb +100 -0
- data/spec/models/organization_list_response_spec.rb +36 -0
- data/spec/models/organization_member_invited_by_spec.rb +32 -0
- data/spec/models/organization_member_list_response_spec.rb +42 -0
- data/spec/models/organization_member_spec.rb +70 -0
- data/spec/models/organization_spec.rb +96 -0
- data/spec/models/organization_workspaces_inner_spec.rb +48 -0
- data/spec/models/password_required_error_spec.rb +54 -0
- data/spec/models/pat_list_response_spec.rb +42 -0
- data/spec/models/pat_scopes_response_spec.rb +36 -0
- data/spec/models/personal_access_token_spec.rb +84 -0
- data/spec/models/preconfigured_agent_spec.rb +72 -0
- data/spec/models/presentation_list_envelope_spec.rb +42 -0
- data/spec/models/presentation_spec.rb +96 -0
- data/spec/models/propose_recommendation_request_spec.rb +66 -0
- data/spec/models/public_invitation_payload_spec.rb +110 -0
- data/spec/models/quota_exceeded_error_spec.rb +42 -0
- data/spec/models/recommendation_list_response_spec.rb +36 -0
- data/spec/models/recommendation_spec.rb +100 -0
- data/spec/models/record_list_response_spec.rb +48 -0
- data/spec/models/record_spec.rb +78 -0
- data/spec/models/record_type_list_response_spec.rb +36 -0
- data/spec/models/record_type_spec.rb +84 -0
- data/spec/models/refresh_connection_request_spec.rb +42 -0
- data/spec/models/reminder_method_spec.rb +30 -0
- data/spec/models/reminder_spec.rb +42 -0
- data/spec/models/reply_email_request_spec.rb +72 -0
- data/spec/models/revoke_other_sessions_response_spec.rb +36 -0
- data/spec/models/rich_text_object_spec.rb +58 -0
- data/spec/models/routine_list_response_spec.rb +36 -0
- data/spec/models/routine_run_complete_request_spec.rb +42 -0
- data/spec/models/routine_run_list_response_spec.rb +36 -0
- data/spec/models/routine_run_progress_request_spec.rb +42 -0
- data/spec/models/routine_run_spec.rb +72 -0
- data/spec/models/routine_spec.rb +84 -0
- data/spec/models/row_list_spec.rb +42 -0
- data/spec/models/row_spec.rb +42 -0
- data/spec/models/save_message_request_spec.rb +48 -0
- data/spec/models/search_emails_response_spec.rb +54 -0
- data/spec/models/search_files_response_spec.rb +54 -0
- data/spec/models/send_chat_message_request_spec.rb +60 -0
- data/spec/models/send_chat_message_response_spec.rb +66 -0
- data/spec/models/send_email_request_spec.rb +90 -0
- data/spec/models/send_email_response_spec.rb +60 -0
- data/spec/models/session_list_response_spec.rb +36 -0
- data/spec/models/session_spec.rb +96 -0
- data/spec/models/share_settings_spec.rb +60 -0
- data/spec/models/sheet_list_envelope_spec.rb +42 -0
- data/spec/models/sheet_spec.rb +126 -0
- data/spec/models/sign_in_methods_providers_inner_spec.rb +54 -0
- data/spec/models/sign_in_methods_spec.rb +48 -0
- data/spec/models/slide_element_list_spec.rb +42 -0
- data/spec/models/slide_element_spec.rb +102 -0
- data/spec/models/slide_list_spec.rb +42 -0
- data/spec/models/slide_spec.rb +114 -0
- data/spec/models/spatio_call_spec.rb +96 -0
- data/spec/models/spatio_connection_spec.rb +96 -0
- data/spec/models/spatio_event_spec.rb +240 -0
- data/spec/models/spatio_file_spec.rb +102 -0
- data/spec/models/spatio_thread_spec.rb +54 -0
- data/spec/models/success_flag_spec.rb +36 -0
- data/spec/models/task_comment_author_spec.rb +54 -0
- data/spec/models/task_comment_list_spec.rb +42 -0
- data/spec/models/task_comment_mutation_response_spec.rb +42 -0
- data/spec/models/task_comment_request_spec.rb +36 -0
- data/spec/models/task_comment_spec.rb +66 -0
- data/spec/models/task_list_envelope_spec.rb +42 -0
- data/spec/models/task_providers_info_platform_spec.rb +42 -0
- data/spec/models/task_providers_info_spec.rb +42 -0
- data/spec/models/task_spec.rb +160 -0
- data/spec/models/text_annotations_spec.rb +66 -0
- data/spec/models/token_response_spec.rb +66 -0
- data/spec/models/update_account_request_spec.rb +42 -0
- data/spec/models/update_agent_request_spec.rb +72 -0
- data/spec/models/update_app_request_spec.rb +54 -0
- data/spec/models/update_block_request_spec.rb +48 -0
- data/spec/models/update_cell_request_spec.rb +36 -0
- data/spec/models/update_comment_request_spec.rb +42 -0
- data/spec/models/update_contact_category_request_spec.rb +48 -0
- data/spec/models/update_contact_request_spec.rb +78 -0
- data/spec/models/update_conversation_request_spec.rb +60 -0
- data/spec/models/update_draft_request_spec.rb +78 -0
- data/spec/models/update_email_folder_request_spec.rb +36 -0
- data/spec/models/update_email_request_spec.rb +60 -0
- data/spec/models/update_email_response_spec.rb +42 -0
- data/spec/models/update_event_request_spec.rb +52 -0
- data/spec/models/update_file_request_spec.rb +48 -0
- data/spec/models/update_key_binding_request_spec.rb +42 -0
- data/spec/models/update_message_metadata_request_spec.rb +42 -0
- data/spec/models/update_note_request_spec.rb +72 -0
- data/spec/models/update_organization_member_request_spec.rb +40 -0
- data/spec/models/update_organization_request_spec.rb +48 -0
- data/spec/models/update_participant_state_request_spec.rb +48 -0
- data/spec/models/update_pat_request_spec.rb +42 -0
- data/spec/models/update_presentation_request_spec.rb +48 -0
- data/spec/models/update_recommendation_status_request_spec.rb +40 -0
- data/spec/models/update_record_request_spec.rb +48 -0
- data/spec/models/update_record_type_request_spec.rb +60 -0
- data/spec/models/update_routine_request_spec.rb +60 -0
- data/spec/models/update_row_request_spec.rb +36 -0
- data/spec/models/update_sheet_request_spec.rb +72 -0
- data/spec/models/update_slide_element_request_spec.rb +78 -0
- data/spec/models/update_slide_request_spec.rb +78 -0
- data/spec/models/update_task_request_spec.rb +88 -0
- data/spec/models/update_workspace_member_request_spec.rb +40 -0
- data/spec/models/update_workspace_request_spec.rb +54 -0
- data/spec/models/upload_chunked_block_response_spec.rb +54 -0
- data/spec/models/upload_file_base64_request_spec.rb +78 -0
- data/spec/models/user_info_response_spec.rb +84 -0
- data/spec/models/validate_key_binding_request_spec.rb +48 -0
- data/spec/models/validate_key_binding_response_spec.rb +42 -0
- data/spec/models/workspace_envelope_spec.rb +36 -0
- data/spec/models/workspace_invitation_list_response_spec.rb +36 -0
- data/spec/models/workspace_invitation_spec.rb +88 -0
- data/spec/models/workspace_list_response_spec.rb +42 -0
- data/spec/models/workspace_member_list_response_spec.rb +42 -0
- data/spec/models/workspace_member_spec.rb +76 -0
- data/spec/models/workspace_organization_spec.rb +48 -0
- data/spec/models/workspace_spec.rb +114 -0
- data/spec/models/write_app_file_request_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1597 -0
data/docs/NotesApi.md
ADDED
|
@@ -0,0 +1,2413 @@
|
|
|
1
|
+
# Spatio::NotesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spatio.app*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_block**](NotesApi.md#create_block) | **POST** /v1/notes/{id}/blocks | Insert a block in a note. |
|
|
8
|
+
| [**create_note**](NotesApi.md#create_note) | **POST** /v1/notes | Create a note. |
|
|
9
|
+
| [**create_note_comment**](NotesApi.md#create_note_comment) | **POST** /v1/notes/{id}/comments | Create a comment or reply. |
|
|
10
|
+
| [**delete_block**](NotesApi.md#delete_block) | **DELETE** /v1/notes/blocks/{id} | Delete a block. |
|
|
11
|
+
| [**delete_note**](NotesApi.md#delete_note) | **DELETE** /v1/notes/{id} | Delete a note. |
|
|
12
|
+
| [**delete_note_comment**](NotesApi.md#delete_note_comment) | **DELETE** /v1/notes/{id}/comments/{commentId} | Soft-delete (native) or hard-delete (provider) a comment. |
|
|
13
|
+
| [**disable_note_share**](NotesApi.md#disable_note_share) | **DELETE** /v1/notes/{id}/share | Disable public sharing. |
|
|
14
|
+
| [**enable_note_share**](NotesApi.md#enable_note_share) | **POST** /v1/notes/{id}/share | Enable (or update password on) public sharing. |
|
|
15
|
+
| [**get_block**](NotesApi.md#get_block) | **GET** /v1/notes/blocks/{id} | Fetch one block. |
|
|
16
|
+
| [**get_note**](NotesApi.md#get_note) | **GET** /v1/notes/{id} | Fetch one note. |
|
|
17
|
+
| [**get_note_comment**](NotesApi.md#get_note_comment) | **GET** /v1/notes/{id}/comments/{commentId} | Fetch one comment. |
|
|
18
|
+
| [**get_note_share_settings**](NotesApi.md#get_note_share_settings) | **GET** /v1/notes/{id}/share | Fetch share settings for a note. |
|
|
19
|
+
| [**get_public_note**](NotesApi.md#get_public_note) | **GET** /public/notes/{token} | Fetch a publicly shared note. |
|
|
20
|
+
| [**list_blocks**](NotesApi.md#list_blocks) | **GET** /v1/notes/{id}/blocks | List blocks under a note. |
|
|
21
|
+
| [**list_note_comments**](NotesApi.md#list_note_comments) | **GET** /v1/notes/{id}/comments | List comments on a note. |
|
|
22
|
+
| [**list_notes**](NotesApi.md#list_notes) | **GET** /v1/notes | List notes across connected accounts. |
|
|
23
|
+
| [**move_block**](NotesApi.md#move_block) | **POST** /v1/notes/blocks/{id}/move | Reparent or reorder a block. |
|
|
24
|
+
| [**rotate_note_share_token**](NotesApi.md#rotate_note_share_token) | **POST** /v1/notes/{id}/share/rotate | Rotate the share token, invalidating any outstanding URLs. |
|
|
25
|
+
| [**update_block**](NotesApi.md#update_block) | **PATCH** /v1/notes/blocks/{id} | Update a block (partial). |
|
|
26
|
+
| [**update_note**](NotesApi.md#update_note) | **PATCH** /v1/notes/{id} | Update a note (partial). |
|
|
27
|
+
| [**update_note_comment**](NotesApi.md#update_note_comment) | **PATCH** /v1/notes/{id}/comments/{commentId} | Edit a comment. |
|
|
28
|
+
| [**workspace_create_note**](NotesApi.md#workspace_create_note) | **POST** /v1/organizations/{org}/workspaces/{workspace}/notes | |
|
|
29
|
+
| [**workspace_create_note_block**](NotesApi.md#workspace_create_note_block) | **POST** /v1/organizations/{org}/workspaces/{workspace}/notes/{id}/blocks | |
|
|
30
|
+
| [**workspace_delete_note**](NotesApi.md#workspace_delete_note) | **DELETE** /v1/organizations/{org}/workspaces/{workspace}/notes/{id} | |
|
|
31
|
+
| [**workspace_delete_note_block**](NotesApi.md#workspace_delete_note_block) | **DELETE** /v1/organizations/{org}/workspaces/{workspace}/notes/blocks/{id} | |
|
|
32
|
+
| [**workspace_get_note**](NotesApi.md#workspace_get_note) | **GET** /v1/organizations/{org}/workspaces/{workspace}/notes/{id} | |
|
|
33
|
+
| [**workspace_get_note_block**](NotesApi.md#workspace_get_note_block) | **GET** /v1/organizations/{org}/workspaces/{workspace}/notes/blocks/{id} | |
|
|
34
|
+
| [**workspace_list_note_blocks**](NotesApi.md#workspace_list_note_blocks) | **GET** /v1/organizations/{org}/workspaces/{workspace}/notes/{id}/blocks | |
|
|
35
|
+
| [**workspace_list_notes**](NotesApi.md#workspace_list_notes) | **GET** /v1/organizations/{org}/workspaces/{workspace}/notes | |
|
|
36
|
+
| [**workspace_move_note_block**](NotesApi.md#workspace_move_note_block) | **POST** /v1/organizations/{org}/workspaces/{workspace}/notes/blocks/{id}/move | |
|
|
37
|
+
| [**workspace_update_note**](NotesApi.md#workspace_update_note) | **PATCH** /v1/organizations/{org}/workspaces/{workspace}/notes/{id} | |
|
|
38
|
+
| [**workspace_update_note_block**](NotesApi.md#workspace_update_note_block) | **PATCH** /v1/organizations/{org}/workspaces/{workspace}/notes/blocks/{id} | |
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
## create_block
|
|
42
|
+
|
|
43
|
+
> <Block> create_block(id, create_block_request, opts)
|
|
44
|
+
|
|
45
|
+
Insert a block in a note.
|
|
46
|
+
|
|
47
|
+
### Examples
|
|
48
|
+
|
|
49
|
+
```ruby
|
|
50
|
+
require 'time'
|
|
51
|
+
require 'spatio-sdk'
|
|
52
|
+
# setup authorization
|
|
53
|
+
Spatio.configure do |config|
|
|
54
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
55
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
api_instance = Spatio::NotesApi.new
|
|
59
|
+
id = 'id_example' # String | Note id.
|
|
60
|
+
create_block_request = Spatio::CreateBlockRequest.new({type: Spatio::BlockType::PARAGRAPH, content: Spatio::BlockContent.new, position: 37}) # CreateBlockRequest |
|
|
61
|
+
opts = {
|
|
62
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
63
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
begin
|
|
67
|
+
# Insert a block in a note.
|
|
68
|
+
result = api_instance.create_block(id, create_block_request, opts)
|
|
69
|
+
p result
|
|
70
|
+
rescue Spatio::ApiError => e
|
|
71
|
+
puts "Error when calling NotesApi->create_block: #{e}"
|
|
72
|
+
end
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
#### Using the create_block_with_http_info variant
|
|
76
|
+
|
|
77
|
+
This returns an Array which contains the response data, status code and headers.
|
|
78
|
+
|
|
79
|
+
> <Array(<Block>, Integer, Hash)> create_block_with_http_info(id, create_block_request, opts)
|
|
80
|
+
|
|
81
|
+
```ruby
|
|
82
|
+
begin
|
|
83
|
+
# Insert a block in a note.
|
|
84
|
+
data, status_code, headers = api_instance.create_block_with_http_info(id, create_block_request, opts)
|
|
85
|
+
p status_code # => 2xx
|
|
86
|
+
p headers # => { ... }
|
|
87
|
+
p data # => <Block>
|
|
88
|
+
rescue Spatio::ApiError => e
|
|
89
|
+
puts "Error when calling NotesApi->create_block_with_http_info: #{e}"
|
|
90
|
+
end
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Parameters
|
|
94
|
+
|
|
95
|
+
| Name | Type | Description | Notes |
|
|
96
|
+
| ---- | ---- | ----------- | ----- |
|
|
97
|
+
| **id** | **String** | Note id. | |
|
|
98
|
+
| **create_block_request** | [**CreateBlockRequest**](CreateBlockRequest.md) | | |
|
|
99
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
100
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
[**Block**](Block.md)
|
|
105
|
+
|
|
106
|
+
### Authorization
|
|
107
|
+
|
|
108
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
109
|
+
|
|
110
|
+
### HTTP request headers
|
|
111
|
+
|
|
112
|
+
- **Content-Type**: application/json
|
|
113
|
+
- **Accept**: application/json
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
## create_note
|
|
117
|
+
|
|
118
|
+
> <Note> create_note(create_note_request, opts)
|
|
119
|
+
|
|
120
|
+
Create a note.
|
|
121
|
+
|
|
122
|
+
Creates a new note under the target account. The target is resolved in this order: `accountId` field on the body → `?accountId=` query → `provider` field on the body → `?provider=` query → the caller's single connected account (errors with `ambiguous_account` if more than one is connected and no selector is supplied).
|
|
123
|
+
|
|
124
|
+
### Examples
|
|
125
|
+
|
|
126
|
+
```ruby
|
|
127
|
+
require 'time'
|
|
128
|
+
require 'spatio-sdk'
|
|
129
|
+
# setup authorization
|
|
130
|
+
Spatio.configure do |config|
|
|
131
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
132
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
api_instance = Spatio::NotesApi.new
|
|
136
|
+
create_note_request = Spatio::CreateNoteRequest.new({title: 'title_example'}) # CreateNoteRequest |
|
|
137
|
+
opts = {
|
|
138
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
139
|
+
provider: 'provider_example', # String | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`.
|
|
140
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
begin
|
|
144
|
+
# Create a note.
|
|
145
|
+
result = api_instance.create_note(create_note_request, opts)
|
|
146
|
+
p result
|
|
147
|
+
rescue Spatio::ApiError => e
|
|
148
|
+
puts "Error when calling NotesApi->create_note: #{e}"
|
|
149
|
+
end
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
#### Using the create_note_with_http_info variant
|
|
153
|
+
|
|
154
|
+
This returns an Array which contains the response data, status code and headers.
|
|
155
|
+
|
|
156
|
+
> <Array(<Note>, Integer, Hash)> create_note_with_http_info(create_note_request, opts)
|
|
157
|
+
|
|
158
|
+
```ruby
|
|
159
|
+
begin
|
|
160
|
+
# Create a note.
|
|
161
|
+
data, status_code, headers = api_instance.create_note_with_http_info(create_note_request, opts)
|
|
162
|
+
p status_code # => 2xx
|
|
163
|
+
p headers # => { ... }
|
|
164
|
+
p data # => <Note>
|
|
165
|
+
rescue Spatio::ApiError => e
|
|
166
|
+
puts "Error when calling NotesApi->create_note_with_http_info: #{e}"
|
|
167
|
+
end
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Parameters
|
|
171
|
+
|
|
172
|
+
| Name | Type | Description | Notes |
|
|
173
|
+
| ---- | ---- | ----------- | ----- |
|
|
174
|
+
| **create_note_request** | [**CreateNoteRequest**](CreateNoteRequest.md) | | |
|
|
175
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
176
|
+
| **provider** | **String** | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`. | [optional] |
|
|
177
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
178
|
+
|
|
179
|
+
### Return type
|
|
180
|
+
|
|
181
|
+
[**Note**](Note.md)
|
|
182
|
+
|
|
183
|
+
### Authorization
|
|
184
|
+
|
|
185
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
186
|
+
|
|
187
|
+
### HTTP request headers
|
|
188
|
+
|
|
189
|
+
- **Content-Type**: application/json
|
|
190
|
+
- **Accept**: application/json
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
## create_note_comment
|
|
194
|
+
|
|
195
|
+
> <CommentMutationResponse> create_note_comment(id, create_comment_request, opts)
|
|
196
|
+
|
|
197
|
+
Create a comment or reply.
|
|
198
|
+
|
|
199
|
+
### Examples
|
|
200
|
+
|
|
201
|
+
```ruby
|
|
202
|
+
require 'time'
|
|
203
|
+
require 'spatio-sdk'
|
|
204
|
+
# setup authorization
|
|
205
|
+
Spatio.configure do |config|
|
|
206
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
207
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
api_instance = Spatio::NotesApi.new
|
|
211
|
+
id = 'id_example' # String | Note id.
|
|
212
|
+
create_comment_request = Spatio::CreateCommentRequest.new # CreateCommentRequest |
|
|
213
|
+
opts = {
|
|
214
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
215
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
begin
|
|
219
|
+
# Create a comment or reply.
|
|
220
|
+
result = api_instance.create_note_comment(id, create_comment_request, opts)
|
|
221
|
+
p result
|
|
222
|
+
rescue Spatio::ApiError => e
|
|
223
|
+
puts "Error when calling NotesApi->create_note_comment: #{e}"
|
|
224
|
+
end
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
#### Using the create_note_comment_with_http_info variant
|
|
228
|
+
|
|
229
|
+
This returns an Array which contains the response data, status code and headers.
|
|
230
|
+
|
|
231
|
+
> <Array(<CommentMutationResponse>, Integer, Hash)> create_note_comment_with_http_info(id, create_comment_request, opts)
|
|
232
|
+
|
|
233
|
+
```ruby
|
|
234
|
+
begin
|
|
235
|
+
# Create a comment or reply.
|
|
236
|
+
data, status_code, headers = api_instance.create_note_comment_with_http_info(id, create_comment_request, opts)
|
|
237
|
+
p status_code # => 2xx
|
|
238
|
+
p headers # => { ... }
|
|
239
|
+
p data # => <CommentMutationResponse>
|
|
240
|
+
rescue Spatio::ApiError => e
|
|
241
|
+
puts "Error when calling NotesApi->create_note_comment_with_http_info: #{e}"
|
|
242
|
+
end
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### Parameters
|
|
246
|
+
|
|
247
|
+
| Name | Type | Description | Notes |
|
|
248
|
+
| ---- | ---- | ----------- | ----- |
|
|
249
|
+
| **id** | **String** | Note id. | |
|
|
250
|
+
| **create_comment_request** | [**CreateCommentRequest**](CreateCommentRequest.md) | | |
|
|
251
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
252
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
253
|
+
|
|
254
|
+
### Return type
|
|
255
|
+
|
|
256
|
+
[**CommentMutationResponse**](CommentMutationResponse.md)
|
|
257
|
+
|
|
258
|
+
### Authorization
|
|
259
|
+
|
|
260
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
261
|
+
|
|
262
|
+
### HTTP request headers
|
|
263
|
+
|
|
264
|
+
- **Content-Type**: application/json
|
|
265
|
+
- **Accept**: application/json
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
## delete_block
|
|
269
|
+
|
|
270
|
+
> <SuccessFlag> delete_block(id, opts)
|
|
271
|
+
|
|
272
|
+
Delete a block.
|
|
273
|
+
|
|
274
|
+
### Examples
|
|
275
|
+
|
|
276
|
+
```ruby
|
|
277
|
+
require 'time'
|
|
278
|
+
require 'spatio-sdk'
|
|
279
|
+
# setup authorization
|
|
280
|
+
Spatio.configure do |config|
|
|
281
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
282
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
api_instance = Spatio::NotesApi.new
|
|
286
|
+
id = 'id_example' # String | Block id.
|
|
287
|
+
opts = {
|
|
288
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
289
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
begin
|
|
293
|
+
# Delete a block.
|
|
294
|
+
result = api_instance.delete_block(id, opts)
|
|
295
|
+
p result
|
|
296
|
+
rescue Spatio::ApiError => e
|
|
297
|
+
puts "Error when calling NotesApi->delete_block: #{e}"
|
|
298
|
+
end
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
#### Using the delete_block_with_http_info variant
|
|
302
|
+
|
|
303
|
+
This returns an Array which contains the response data, status code and headers.
|
|
304
|
+
|
|
305
|
+
> <Array(<SuccessFlag>, Integer, Hash)> delete_block_with_http_info(id, opts)
|
|
306
|
+
|
|
307
|
+
```ruby
|
|
308
|
+
begin
|
|
309
|
+
# Delete a block.
|
|
310
|
+
data, status_code, headers = api_instance.delete_block_with_http_info(id, opts)
|
|
311
|
+
p status_code # => 2xx
|
|
312
|
+
p headers # => { ... }
|
|
313
|
+
p data # => <SuccessFlag>
|
|
314
|
+
rescue Spatio::ApiError => e
|
|
315
|
+
puts "Error when calling NotesApi->delete_block_with_http_info: #{e}"
|
|
316
|
+
end
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
### Parameters
|
|
320
|
+
|
|
321
|
+
| Name | Type | Description | Notes |
|
|
322
|
+
| ---- | ---- | ----------- | ----- |
|
|
323
|
+
| **id** | **String** | Block id. | |
|
|
324
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
325
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
326
|
+
|
|
327
|
+
### Return type
|
|
328
|
+
|
|
329
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
330
|
+
|
|
331
|
+
### Authorization
|
|
332
|
+
|
|
333
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
334
|
+
|
|
335
|
+
### HTTP request headers
|
|
336
|
+
|
|
337
|
+
- **Content-Type**: Not defined
|
|
338
|
+
- **Accept**: application/json
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
## delete_note
|
|
342
|
+
|
|
343
|
+
> <SuccessFlag> delete_note(id, opts)
|
|
344
|
+
|
|
345
|
+
Delete a note.
|
|
346
|
+
|
|
347
|
+
### Examples
|
|
348
|
+
|
|
349
|
+
```ruby
|
|
350
|
+
require 'time'
|
|
351
|
+
require 'spatio-sdk'
|
|
352
|
+
# setup authorization
|
|
353
|
+
Spatio.configure do |config|
|
|
354
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
355
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
api_instance = Spatio::NotesApi.new
|
|
359
|
+
id = 'id_example' # String | Note id.
|
|
360
|
+
opts = {
|
|
361
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
362
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
begin
|
|
366
|
+
# Delete a note.
|
|
367
|
+
result = api_instance.delete_note(id, opts)
|
|
368
|
+
p result
|
|
369
|
+
rescue Spatio::ApiError => e
|
|
370
|
+
puts "Error when calling NotesApi->delete_note: #{e}"
|
|
371
|
+
end
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
#### Using the delete_note_with_http_info variant
|
|
375
|
+
|
|
376
|
+
This returns an Array which contains the response data, status code and headers.
|
|
377
|
+
|
|
378
|
+
> <Array(<SuccessFlag>, Integer, Hash)> delete_note_with_http_info(id, opts)
|
|
379
|
+
|
|
380
|
+
```ruby
|
|
381
|
+
begin
|
|
382
|
+
# Delete a note.
|
|
383
|
+
data, status_code, headers = api_instance.delete_note_with_http_info(id, opts)
|
|
384
|
+
p status_code # => 2xx
|
|
385
|
+
p headers # => { ... }
|
|
386
|
+
p data # => <SuccessFlag>
|
|
387
|
+
rescue Spatio::ApiError => e
|
|
388
|
+
puts "Error when calling NotesApi->delete_note_with_http_info: #{e}"
|
|
389
|
+
end
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Parameters
|
|
393
|
+
|
|
394
|
+
| Name | Type | Description | Notes |
|
|
395
|
+
| ---- | ---- | ----------- | ----- |
|
|
396
|
+
| **id** | **String** | Note id. | |
|
|
397
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
398
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
399
|
+
|
|
400
|
+
### Return type
|
|
401
|
+
|
|
402
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
403
|
+
|
|
404
|
+
### Authorization
|
|
405
|
+
|
|
406
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
407
|
+
|
|
408
|
+
### HTTP request headers
|
|
409
|
+
|
|
410
|
+
- **Content-Type**: Not defined
|
|
411
|
+
- **Accept**: application/json
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
## delete_note_comment
|
|
415
|
+
|
|
416
|
+
> <SuccessFlag> delete_note_comment(id, comment_id, opts)
|
|
417
|
+
|
|
418
|
+
Soft-delete (native) or hard-delete (provider) a comment.
|
|
419
|
+
|
|
420
|
+
Allowed for the comment author and for the note owner.
|
|
421
|
+
|
|
422
|
+
### Examples
|
|
423
|
+
|
|
424
|
+
```ruby
|
|
425
|
+
require 'time'
|
|
426
|
+
require 'spatio-sdk'
|
|
427
|
+
# setup authorization
|
|
428
|
+
Spatio.configure do |config|
|
|
429
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
430
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
431
|
+
end
|
|
432
|
+
|
|
433
|
+
api_instance = Spatio::NotesApi.new
|
|
434
|
+
id = 'id_example' # String | Note id.
|
|
435
|
+
comment_id = 'comment_id_example' # String | Comment id.
|
|
436
|
+
opts = {
|
|
437
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
438
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
439
|
+
}
|
|
440
|
+
|
|
441
|
+
begin
|
|
442
|
+
# Soft-delete (native) or hard-delete (provider) a comment.
|
|
443
|
+
result = api_instance.delete_note_comment(id, comment_id, opts)
|
|
444
|
+
p result
|
|
445
|
+
rescue Spatio::ApiError => e
|
|
446
|
+
puts "Error when calling NotesApi->delete_note_comment: #{e}"
|
|
447
|
+
end
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
#### Using the delete_note_comment_with_http_info variant
|
|
451
|
+
|
|
452
|
+
This returns an Array which contains the response data, status code and headers.
|
|
453
|
+
|
|
454
|
+
> <Array(<SuccessFlag>, Integer, Hash)> delete_note_comment_with_http_info(id, comment_id, opts)
|
|
455
|
+
|
|
456
|
+
```ruby
|
|
457
|
+
begin
|
|
458
|
+
# Soft-delete (native) or hard-delete (provider) a comment.
|
|
459
|
+
data, status_code, headers = api_instance.delete_note_comment_with_http_info(id, comment_id, opts)
|
|
460
|
+
p status_code # => 2xx
|
|
461
|
+
p headers # => { ... }
|
|
462
|
+
p data # => <SuccessFlag>
|
|
463
|
+
rescue Spatio::ApiError => e
|
|
464
|
+
puts "Error when calling NotesApi->delete_note_comment_with_http_info: #{e}"
|
|
465
|
+
end
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
### Parameters
|
|
469
|
+
|
|
470
|
+
| Name | Type | Description | Notes |
|
|
471
|
+
| ---- | ---- | ----------- | ----- |
|
|
472
|
+
| **id** | **String** | Note id. | |
|
|
473
|
+
| **comment_id** | **String** | Comment id. | |
|
|
474
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
475
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
476
|
+
|
|
477
|
+
### Return type
|
|
478
|
+
|
|
479
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
480
|
+
|
|
481
|
+
### Authorization
|
|
482
|
+
|
|
483
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
484
|
+
|
|
485
|
+
### HTTP request headers
|
|
486
|
+
|
|
487
|
+
- **Content-Type**: Not defined
|
|
488
|
+
- **Accept**: application/json
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
## disable_note_share
|
|
492
|
+
|
|
493
|
+
> disable_note_share(id, opts)
|
|
494
|
+
|
|
495
|
+
Disable public sharing.
|
|
496
|
+
|
|
497
|
+
Owner-only. Subsequent public viewer requests 404.
|
|
498
|
+
|
|
499
|
+
### Examples
|
|
500
|
+
|
|
501
|
+
```ruby
|
|
502
|
+
require 'time'
|
|
503
|
+
require 'spatio-sdk'
|
|
504
|
+
# setup authorization
|
|
505
|
+
Spatio.configure do |config|
|
|
506
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
507
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
508
|
+
end
|
|
509
|
+
|
|
510
|
+
api_instance = Spatio::NotesApi.new
|
|
511
|
+
id = 'id_example' # String | Note id.
|
|
512
|
+
opts = {
|
|
513
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
514
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
begin
|
|
518
|
+
# Disable public sharing.
|
|
519
|
+
api_instance.disable_note_share(id, opts)
|
|
520
|
+
rescue Spatio::ApiError => e
|
|
521
|
+
puts "Error when calling NotesApi->disable_note_share: #{e}"
|
|
522
|
+
end
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
#### Using the disable_note_share_with_http_info variant
|
|
526
|
+
|
|
527
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
528
|
+
|
|
529
|
+
> <Array(nil, Integer, Hash)> disable_note_share_with_http_info(id, opts)
|
|
530
|
+
|
|
531
|
+
```ruby
|
|
532
|
+
begin
|
|
533
|
+
# Disable public sharing.
|
|
534
|
+
data, status_code, headers = api_instance.disable_note_share_with_http_info(id, opts)
|
|
535
|
+
p status_code # => 2xx
|
|
536
|
+
p headers # => { ... }
|
|
537
|
+
p data # => nil
|
|
538
|
+
rescue Spatio::ApiError => e
|
|
539
|
+
puts "Error when calling NotesApi->disable_note_share_with_http_info: #{e}"
|
|
540
|
+
end
|
|
541
|
+
```
|
|
542
|
+
|
|
543
|
+
### Parameters
|
|
544
|
+
|
|
545
|
+
| Name | Type | Description | Notes |
|
|
546
|
+
| ---- | ---- | ----------- | ----- |
|
|
547
|
+
| **id** | **String** | Note id. | |
|
|
548
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
549
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
550
|
+
|
|
551
|
+
### Return type
|
|
552
|
+
|
|
553
|
+
nil (empty response body)
|
|
554
|
+
|
|
555
|
+
### Authorization
|
|
556
|
+
|
|
557
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
558
|
+
|
|
559
|
+
### HTTP request headers
|
|
560
|
+
|
|
561
|
+
- **Content-Type**: Not defined
|
|
562
|
+
- **Accept**: application/json
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
## enable_note_share
|
|
566
|
+
|
|
567
|
+
> <ShareSettings> enable_note_share(id, opts)
|
|
568
|
+
|
|
569
|
+
Enable (or update password on) public sharing.
|
|
570
|
+
|
|
571
|
+
Owner-only. Calling with an empty body or `setPassword: false` flips the note public without changing the password. With `setPassword: true`, applies `password` (empty string clears).
|
|
572
|
+
|
|
573
|
+
### Examples
|
|
574
|
+
|
|
575
|
+
```ruby
|
|
576
|
+
require 'time'
|
|
577
|
+
require 'spatio-sdk'
|
|
578
|
+
# setup authorization
|
|
579
|
+
Spatio.configure do |config|
|
|
580
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
581
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
582
|
+
end
|
|
583
|
+
|
|
584
|
+
api_instance = Spatio::NotesApi.new
|
|
585
|
+
id = 'id_example' # String | Note id.
|
|
586
|
+
opts = {
|
|
587
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
588
|
+
x_workspace_id: 'x_workspace_id_example', # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
589
|
+
enable_share_request: Spatio::EnableShareRequest.new # EnableShareRequest |
|
|
590
|
+
}
|
|
591
|
+
|
|
592
|
+
begin
|
|
593
|
+
# Enable (or update password on) public sharing.
|
|
594
|
+
result = api_instance.enable_note_share(id, opts)
|
|
595
|
+
p result
|
|
596
|
+
rescue Spatio::ApiError => e
|
|
597
|
+
puts "Error when calling NotesApi->enable_note_share: #{e}"
|
|
598
|
+
end
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
#### Using the enable_note_share_with_http_info variant
|
|
602
|
+
|
|
603
|
+
This returns an Array which contains the response data, status code and headers.
|
|
604
|
+
|
|
605
|
+
> <Array(<ShareSettings>, Integer, Hash)> enable_note_share_with_http_info(id, opts)
|
|
606
|
+
|
|
607
|
+
```ruby
|
|
608
|
+
begin
|
|
609
|
+
# Enable (or update password on) public sharing.
|
|
610
|
+
data, status_code, headers = api_instance.enable_note_share_with_http_info(id, opts)
|
|
611
|
+
p status_code # => 2xx
|
|
612
|
+
p headers # => { ... }
|
|
613
|
+
p data # => <ShareSettings>
|
|
614
|
+
rescue Spatio::ApiError => e
|
|
615
|
+
puts "Error when calling NotesApi->enable_note_share_with_http_info: #{e}"
|
|
616
|
+
end
|
|
617
|
+
```
|
|
618
|
+
|
|
619
|
+
### Parameters
|
|
620
|
+
|
|
621
|
+
| Name | Type | Description | Notes |
|
|
622
|
+
| ---- | ---- | ----------- | ----- |
|
|
623
|
+
| **id** | **String** | Note id. | |
|
|
624
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
625
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
626
|
+
| **enable_share_request** | [**EnableShareRequest**](EnableShareRequest.md) | | [optional] |
|
|
627
|
+
|
|
628
|
+
### Return type
|
|
629
|
+
|
|
630
|
+
[**ShareSettings**](ShareSettings.md)
|
|
631
|
+
|
|
632
|
+
### Authorization
|
|
633
|
+
|
|
634
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
635
|
+
|
|
636
|
+
### HTTP request headers
|
|
637
|
+
|
|
638
|
+
- **Content-Type**: application/json
|
|
639
|
+
- **Accept**: application/json
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
## get_block
|
|
643
|
+
|
|
644
|
+
> <Block> get_block(id, opts)
|
|
645
|
+
|
|
646
|
+
Fetch one block.
|
|
647
|
+
|
|
648
|
+
### Examples
|
|
649
|
+
|
|
650
|
+
```ruby
|
|
651
|
+
require 'time'
|
|
652
|
+
require 'spatio-sdk'
|
|
653
|
+
# setup authorization
|
|
654
|
+
Spatio.configure do |config|
|
|
655
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
656
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
657
|
+
end
|
|
658
|
+
|
|
659
|
+
api_instance = Spatio::NotesApi.new
|
|
660
|
+
id = 'id_example' # String | Block id.
|
|
661
|
+
opts = {
|
|
662
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
663
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
begin
|
|
667
|
+
# Fetch one block.
|
|
668
|
+
result = api_instance.get_block(id, opts)
|
|
669
|
+
p result
|
|
670
|
+
rescue Spatio::ApiError => e
|
|
671
|
+
puts "Error when calling NotesApi->get_block: #{e}"
|
|
672
|
+
end
|
|
673
|
+
```
|
|
674
|
+
|
|
675
|
+
#### Using the get_block_with_http_info variant
|
|
676
|
+
|
|
677
|
+
This returns an Array which contains the response data, status code and headers.
|
|
678
|
+
|
|
679
|
+
> <Array(<Block>, Integer, Hash)> get_block_with_http_info(id, opts)
|
|
680
|
+
|
|
681
|
+
```ruby
|
|
682
|
+
begin
|
|
683
|
+
# Fetch one block.
|
|
684
|
+
data, status_code, headers = api_instance.get_block_with_http_info(id, opts)
|
|
685
|
+
p status_code # => 2xx
|
|
686
|
+
p headers # => { ... }
|
|
687
|
+
p data # => <Block>
|
|
688
|
+
rescue Spatio::ApiError => e
|
|
689
|
+
puts "Error when calling NotesApi->get_block_with_http_info: #{e}"
|
|
690
|
+
end
|
|
691
|
+
```
|
|
692
|
+
|
|
693
|
+
### Parameters
|
|
694
|
+
|
|
695
|
+
| Name | Type | Description | Notes |
|
|
696
|
+
| ---- | ---- | ----------- | ----- |
|
|
697
|
+
| **id** | **String** | Block id. | |
|
|
698
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
699
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
700
|
+
|
|
701
|
+
### Return type
|
|
702
|
+
|
|
703
|
+
[**Block**](Block.md)
|
|
704
|
+
|
|
705
|
+
### Authorization
|
|
706
|
+
|
|
707
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
708
|
+
|
|
709
|
+
### HTTP request headers
|
|
710
|
+
|
|
711
|
+
- **Content-Type**: Not defined
|
|
712
|
+
- **Accept**: application/json
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
## get_note
|
|
716
|
+
|
|
717
|
+
> <Note> get_note(id, opts)
|
|
718
|
+
|
|
719
|
+
Fetch one note.
|
|
720
|
+
|
|
721
|
+
### Examples
|
|
722
|
+
|
|
723
|
+
```ruby
|
|
724
|
+
require 'time'
|
|
725
|
+
require 'spatio-sdk'
|
|
726
|
+
# setup authorization
|
|
727
|
+
Spatio.configure do |config|
|
|
728
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
729
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
730
|
+
end
|
|
731
|
+
|
|
732
|
+
api_instance = Spatio::NotesApi.new
|
|
733
|
+
id = 'id_example' # String | Note id.
|
|
734
|
+
opts = {
|
|
735
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
736
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
begin
|
|
740
|
+
# Fetch one note.
|
|
741
|
+
result = api_instance.get_note(id, opts)
|
|
742
|
+
p result
|
|
743
|
+
rescue Spatio::ApiError => e
|
|
744
|
+
puts "Error when calling NotesApi->get_note: #{e}"
|
|
745
|
+
end
|
|
746
|
+
```
|
|
747
|
+
|
|
748
|
+
#### Using the get_note_with_http_info variant
|
|
749
|
+
|
|
750
|
+
This returns an Array which contains the response data, status code and headers.
|
|
751
|
+
|
|
752
|
+
> <Array(<Note>, Integer, Hash)> get_note_with_http_info(id, opts)
|
|
753
|
+
|
|
754
|
+
```ruby
|
|
755
|
+
begin
|
|
756
|
+
# Fetch one note.
|
|
757
|
+
data, status_code, headers = api_instance.get_note_with_http_info(id, opts)
|
|
758
|
+
p status_code # => 2xx
|
|
759
|
+
p headers # => { ... }
|
|
760
|
+
p data # => <Note>
|
|
761
|
+
rescue Spatio::ApiError => e
|
|
762
|
+
puts "Error when calling NotesApi->get_note_with_http_info: #{e}"
|
|
763
|
+
end
|
|
764
|
+
```
|
|
765
|
+
|
|
766
|
+
### Parameters
|
|
767
|
+
|
|
768
|
+
| Name | Type | Description | Notes |
|
|
769
|
+
| ---- | ---- | ----------- | ----- |
|
|
770
|
+
| **id** | **String** | Note id. | |
|
|
771
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
772
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
773
|
+
|
|
774
|
+
### Return type
|
|
775
|
+
|
|
776
|
+
[**Note**](Note.md)
|
|
777
|
+
|
|
778
|
+
### Authorization
|
|
779
|
+
|
|
780
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
781
|
+
|
|
782
|
+
### HTTP request headers
|
|
783
|
+
|
|
784
|
+
- **Content-Type**: Not defined
|
|
785
|
+
- **Accept**: application/json
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
## get_note_comment
|
|
789
|
+
|
|
790
|
+
> <CommentResponse> get_note_comment(id, comment_id, opts)
|
|
791
|
+
|
|
792
|
+
Fetch one comment.
|
|
793
|
+
|
|
794
|
+
Useful for permalink hydration when the renderer deep-links into a reply thread.
|
|
795
|
+
|
|
796
|
+
### Examples
|
|
797
|
+
|
|
798
|
+
```ruby
|
|
799
|
+
require 'time'
|
|
800
|
+
require 'spatio-sdk'
|
|
801
|
+
# setup authorization
|
|
802
|
+
Spatio.configure do |config|
|
|
803
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
804
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
805
|
+
end
|
|
806
|
+
|
|
807
|
+
api_instance = Spatio::NotesApi.new
|
|
808
|
+
id = 'id_example' # String | Note id.
|
|
809
|
+
comment_id = 'comment_id_example' # String | Comment id.
|
|
810
|
+
opts = {
|
|
811
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
812
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
813
|
+
}
|
|
814
|
+
|
|
815
|
+
begin
|
|
816
|
+
# Fetch one comment.
|
|
817
|
+
result = api_instance.get_note_comment(id, comment_id, opts)
|
|
818
|
+
p result
|
|
819
|
+
rescue Spatio::ApiError => e
|
|
820
|
+
puts "Error when calling NotesApi->get_note_comment: #{e}"
|
|
821
|
+
end
|
|
822
|
+
```
|
|
823
|
+
|
|
824
|
+
#### Using the get_note_comment_with_http_info variant
|
|
825
|
+
|
|
826
|
+
This returns an Array which contains the response data, status code and headers.
|
|
827
|
+
|
|
828
|
+
> <Array(<CommentResponse>, Integer, Hash)> get_note_comment_with_http_info(id, comment_id, opts)
|
|
829
|
+
|
|
830
|
+
```ruby
|
|
831
|
+
begin
|
|
832
|
+
# Fetch one comment.
|
|
833
|
+
data, status_code, headers = api_instance.get_note_comment_with_http_info(id, comment_id, opts)
|
|
834
|
+
p status_code # => 2xx
|
|
835
|
+
p headers # => { ... }
|
|
836
|
+
p data # => <CommentResponse>
|
|
837
|
+
rescue Spatio::ApiError => e
|
|
838
|
+
puts "Error when calling NotesApi->get_note_comment_with_http_info: #{e}"
|
|
839
|
+
end
|
|
840
|
+
```
|
|
841
|
+
|
|
842
|
+
### Parameters
|
|
843
|
+
|
|
844
|
+
| Name | Type | Description | Notes |
|
|
845
|
+
| ---- | ---- | ----------- | ----- |
|
|
846
|
+
| **id** | **String** | Note id. | |
|
|
847
|
+
| **comment_id** | **String** | Comment id. | |
|
|
848
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
849
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
850
|
+
|
|
851
|
+
### Return type
|
|
852
|
+
|
|
853
|
+
[**CommentResponse**](CommentResponse.md)
|
|
854
|
+
|
|
855
|
+
### Authorization
|
|
856
|
+
|
|
857
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
858
|
+
|
|
859
|
+
### HTTP request headers
|
|
860
|
+
|
|
861
|
+
- **Content-Type**: Not defined
|
|
862
|
+
- **Accept**: application/json
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
## get_note_share_settings
|
|
866
|
+
|
|
867
|
+
> <ShareSettings> get_note_share_settings(id, opts)
|
|
868
|
+
|
|
869
|
+
Fetch share settings for a note.
|
|
870
|
+
|
|
871
|
+
Owner-only. Returns the current public-share configuration, including the share token and computed public viewer URL when the note is currently public.
|
|
872
|
+
|
|
873
|
+
### Examples
|
|
874
|
+
|
|
875
|
+
```ruby
|
|
876
|
+
require 'time'
|
|
877
|
+
require 'spatio-sdk'
|
|
878
|
+
# setup authorization
|
|
879
|
+
Spatio.configure do |config|
|
|
880
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
881
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
882
|
+
end
|
|
883
|
+
|
|
884
|
+
api_instance = Spatio::NotesApi.new
|
|
885
|
+
id = 'id_example' # String | Note id.
|
|
886
|
+
opts = {
|
|
887
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
888
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
begin
|
|
892
|
+
# Fetch share settings for a note.
|
|
893
|
+
result = api_instance.get_note_share_settings(id, opts)
|
|
894
|
+
p result
|
|
895
|
+
rescue Spatio::ApiError => e
|
|
896
|
+
puts "Error when calling NotesApi->get_note_share_settings: #{e}"
|
|
897
|
+
end
|
|
898
|
+
```
|
|
899
|
+
|
|
900
|
+
#### Using the get_note_share_settings_with_http_info variant
|
|
901
|
+
|
|
902
|
+
This returns an Array which contains the response data, status code and headers.
|
|
903
|
+
|
|
904
|
+
> <Array(<ShareSettings>, Integer, Hash)> get_note_share_settings_with_http_info(id, opts)
|
|
905
|
+
|
|
906
|
+
```ruby
|
|
907
|
+
begin
|
|
908
|
+
# Fetch share settings for a note.
|
|
909
|
+
data, status_code, headers = api_instance.get_note_share_settings_with_http_info(id, opts)
|
|
910
|
+
p status_code # => 2xx
|
|
911
|
+
p headers # => { ... }
|
|
912
|
+
p data # => <ShareSettings>
|
|
913
|
+
rescue Spatio::ApiError => e
|
|
914
|
+
puts "Error when calling NotesApi->get_note_share_settings_with_http_info: #{e}"
|
|
915
|
+
end
|
|
916
|
+
```
|
|
917
|
+
|
|
918
|
+
### Parameters
|
|
919
|
+
|
|
920
|
+
| Name | Type | Description | Notes |
|
|
921
|
+
| ---- | ---- | ----------- | ----- |
|
|
922
|
+
| **id** | **String** | Note id. | |
|
|
923
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
924
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
925
|
+
|
|
926
|
+
### Return type
|
|
927
|
+
|
|
928
|
+
[**ShareSettings**](ShareSettings.md)
|
|
929
|
+
|
|
930
|
+
### Authorization
|
|
931
|
+
|
|
932
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
933
|
+
|
|
934
|
+
### HTTP request headers
|
|
935
|
+
|
|
936
|
+
- **Content-Type**: Not defined
|
|
937
|
+
- **Accept**: application/json
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
## get_public_note
|
|
941
|
+
|
|
942
|
+
> Hash<String, Object> get_public_note(token, opts)
|
|
943
|
+
|
|
944
|
+
Fetch a publicly shared note.
|
|
945
|
+
|
|
946
|
+
Unauthenticated. The share token is the credential. For password-protected notes the password is supplied via the `?password=` query param; the response distinguishes \"no password supplied\" from \"wrong password\" so the viewer can render the right prompt. Unknown tokens and disabled-share notes both return `404` to prevent token enumeration.
|
|
947
|
+
|
|
948
|
+
### Examples
|
|
949
|
+
|
|
950
|
+
```ruby
|
|
951
|
+
require 'time'
|
|
952
|
+
require 'spatio-sdk'
|
|
953
|
+
|
|
954
|
+
api_instance = Spatio::NotesApi.new
|
|
955
|
+
token = 'token_example' # String | Opaque public-share token.
|
|
956
|
+
opts = {
|
|
957
|
+
password: 'password_example' # String | Optional viewer password.
|
|
958
|
+
}
|
|
959
|
+
|
|
960
|
+
begin
|
|
961
|
+
# Fetch a publicly shared note.
|
|
962
|
+
result = api_instance.get_public_note(token, opts)
|
|
963
|
+
p result
|
|
964
|
+
rescue Spatio::ApiError => e
|
|
965
|
+
puts "Error when calling NotesApi->get_public_note: #{e}"
|
|
966
|
+
end
|
|
967
|
+
```
|
|
968
|
+
|
|
969
|
+
#### Using the get_public_note_with_http_info variant
|
|
970
|
+
|
|
971
|
+
This returns an Array which contains the response data, status code and headers.
|
|
972
|
+
|
|
973
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_public_note_with_http_info(token, opts)
|
|
974
|
+
|
|
975
|
+
```ruby
|
|
976
|
+
begin
|
|
977
|
+
# Fetch a publicly shared note.
|
|
978
|
+
data, status_code, headers = api_instance.get_public_note_with_http_info(token, opts)
|
|
979
|
+
p status_code # => 2xx
|
|
980
|
+
p headers # => { ... }
|
|
981
|
+
p data # => Hash<String, Object>
|
|
982
|
+
rescue Spatio::ApiError => e
|
|
983
|
+
puts "Error when calling NotesApi->get_public_note_with_http_info: #{e}"
|
|
984
|
+
end
|
|
985
|
+
```
|
|
986
|
+
|
|
987
|
+
### Parameters
|
|
988
|
+
|
|
989
|
+
| Name | Type | Description | Notes |
|
|
990
|
+
| ---- | ---- | ----------- | ----- |
|
|
991
|
+
| **token** | **String** | Opaque public-share token. | |
|
|
992
|
+
| **password** | **String** | Optional viewer password. | [optional] |
|
|
993
|
+
|
|
994
|
+
### Return type
|
|
995
|
+
|
|
996
|
+
**Hash<String, Object>**
|
|
997
|
+
|
|
998
|
+
### Authorization
|
|
999
|
+
|
|
1000
|
+
No authorization required
|
|
1001
|
+
|
|
1002
|
+
### HTTP request headers
|
|
1003
|
+
|
|
1004
|
+
- **Content-Type**: Not defined
|
|
1005
|
+
- **Accept**: application/json
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
## list_blocks
|
|
1009
|
+
|
|
1010
|
+
> <BlockListResponse> list_blocks(id, opts)
|
|
1011
|
+
|
|
1012
|
+
List blocks under a note.
|
|
1013
|
+
|
|
1014
|
+
Returns the block tree for a note, paginated. Block listing always targets a single account (the one that owns the note) so it does not fan out — the response is a plain `{ blocks, total }`.
|
|
1015
|
+
|
|
1016
|
+
### Examples
|
|
1017
|
+
|
|
1018
|
+
```ruby
|
|
1019
|
+
require 'time'
|
|
1020
|
+
require 'spatio-sdk'
|
|
1021
|
+
# setup authorization
|
|
1022
|
+
Spatio.configure do |config|
|
|
1023
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1024
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1025
|
+
end
|
|
1026
|
+
|
|
1027
|
+
api_instance = Spatio::NotesApi.new
|
|
1028
|
+
id = 'id_example' # String | Note id.
|
|
1029
|
+
opts = {
|
|
1030
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1031
|
+
x_workspace_id: 'x_workspace_id_example', # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
1032
|
+
parent_id: 'parent_id_example', # String | Filter to children of this block id. Omit to list root-level blocks.
|
|
1033
|
+
limit: 56, # Integer |
|
|
1034
|
+
offset: 56 # Integer |
|
|
1035
|
+
}
|
|
1036
|
+
|
|
1037
|
+
begin
|
|
1038
|
+
# List blocks under a note.
|
|
1039
|
+
result = api_instance.list_blocks(id, opts)
|
|
1040
|
+
p result
|
|
1041
|
+
rescue Spatio::ApiError => e
|
|
1042
|
+
puts "Error when calling NotesApi->list_blocks: #{e}"
|
|
1043
|
+
end
|
|
1044
|
+
```
|
|
1045
|
+
|
|
1046
|
+
#### Using the list_blocks_with_http_info variant
|
|
1047
|
+
|
|
1048
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1049
|
+
|
|
1050
|
+
> <Array(<BlockListResponse>, Integer, Hash)> list_blocks_with_http_info(id, opts)
|
|
1051
|
+
|
|
1052
|
+
```ruby
|
|
1053
|
+
begin
|
|
1054
|
+
# List blocks under a note.
|
|
1055
|
+
data, status_code, headers = api_instance.list_blocks_with_http_info(id, opts)
|
|
1056
|
+
p status_code # => 2xx
|
|
1057
|
+
p headers # => { ... }
|
|
1058
|
+
p data # => <BlockListResponse>
|
|
1059
|
+
rescue Spatio::ApiError => e
|
|
1060
|
+
puts "Error when calling NotesApi->list_blocks_with_http_info: #{e}"
|
|
1061
|
+
end
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
### Parameters
|
|
1065
|
+
|
|
1066
|
+
| Name | Type | Description | Notes |
|
|
1067
|
+
| ---- | ---- | ----------- | ----- |
|
|
1068
|
+
| **id** | **String** | Note id. | |
|
|
1069
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1070
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
1071
|
+
| **parent_id** | **String** | Filter to children of this block id. Omit to list root-level blocks. | [optional] |
|
|
1072
|
+
| **limit** | **Integer** | | [optional][default to 100] |
|
|
1073
|
+
| **offset** | **Integer** | | [optional][default to 0] |
|
|
1074
|
+
|
|
1075
|
+
### Return type
|
|
1076
|
+
|
|
1077
|
+
[**BlockListResponse**](BlockListResponse.md)
|
|
1078
|
+
|
|
1079
|
+
### Authorization
|
|
1080
|
+
|
|
1081
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1082
|
+
|
|
1083
|
+
### HTTP request headers
|
|
1084
|
+
|
|
1085
|
+
- **Content-Type**: Not defined
|
|
1086
|
+
- **Accept**: application/json
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
## list_note_comments
|
|
1090
|
+
|
|
1091
|
+
> <CommentListResponse> list_note_comments(id, opts)
|
|
1092
|
+
|
|
1093
|
+
List comments on a note.
|
|
1094
|
+
|
|
1095
|
+
Returns active (non-deleted) comments. When `?accountId=` targets an external provider that supports comments (e.g. Notion), the provider is queried directly; otherwise the native store is used.
|
|
1096
|
+
|
|
1097
|
+
### Examples
|
|
1098
|
+
|
|
1099
|
+
```ruby
|
|
1100
|
+
require 'time'
|
|
1101
|
+
require 'spatio-sdk'
|
|
1102
|
+
# setup authorization
|
|
1103
|
+
Spatio.configure do |config|
|
|
1104
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1105
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1106
|
+
end
|
|
1107
|
+
|
|
1108
|
+
api_instance = Spatio::NotesApi.new
|
|
1109
|
+
id = 'id_example' # String | Note id.
|
|
1110
|
+
opts = {
|
|
1111
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1112
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
1113
|
+
}
|
|
1114
|
+
|
|
1115
|
+
begin
|
|
1116
|
+
# List comments on a note.
|
|
1117
|
+
result = api_instance.list_note_comments(id, opts)
|
|
1118
|
+
p result
|
|
1119
|
+
rescue Spatio::ApiError => e
|
|
1120
|
+
puts "Error when calling NotesApi->list_note_comments: #{e}"
|
|
1121
|
+
end
|
|
1122
|
+
```
|
|
1123
|
+
|
|
1124
|
+
#### Using the list_note_comments_with_http_info variant
|
|
1125
|
+
|
|
1126
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1127
|
+
|
|
1128
|
+
> <Array(<CommentListResponse>, Integer, Hash)> list_note_comments_with_http_info(id, opts)
|
|
1129
|
+
|
|
1130
|
+
```ruby
|
|
1131
|
+
begin
|
|
1132
|
+
# List comments on a note.
|
|
1133
|
+
data, status_code, headers = api_instance.list_note_comments_with_http_info(id, opts)
|
|
1134
|
+
p status_code # => 2xx
|
|
1135
|
+
p headers # => { ... }
|
|
1136
|
+
p data # => <CommentListResponse>
|
|
1137
|
+
rescue Spatio::ApiError => e
|
|
1138
|
+
puts "Error when calling NotesApi->list_note_comments_with_http_info: #{e}"
|
|
1139
|
+
end
|
|
1140
|
+
```
|
|
1141
|
+
|
|
1142
|
+
### Parameters
|
|
1143
|
+
|
|
1144
|
+
| Name | Type | Description | Notes |
|
|
1145
|
+
| ---- | ---- | ----------- | ----- |
|
|
1146
|
+
| **id** | **String** | Note id. | |
|
|
1147
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1148
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
1149
|
+
|
|
1150
|
+
### Return type
|
|
1151
|
+
|
|
1152
|
+
[**CommentListResponse**](CommentListResponse.md)
|
|
1153
|
+
|
|
1154
|
+
### Authorization
|
|
1155
|
+
|
|
1156
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1157
|
+
|
|
1158
|
+
### HTTP request headers
|
|
1159
|
+
|
|
1160
|
+
- **Content-Type**: Not defined
|
|
1161
|
+
- **Accept**: application/json
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
## list_notes
|
|
1165
|
+
|
|
1166
|
+
> <NoteListEnvelope> list_notes(opts)
|
|
1167
|
+
|
|
1168
|
+
List notes across connected accounts.
|
|
1169
|
+
|
|
1170
|
+
Fan-out list. Returns every note visible to the caller across every connected notes provider, paginated by `limit` / `offset`. Pass `?accountId=` or `?provider=` to scope to a single source.
|
|
1171
|
+
|
|
1172
|
+
### Examples
|
|
1173
|
+
|
|
1174
|
+
```ruby
|
|
1175
|
+
require 'time'
|
|
1176
|
+
require 'spatio-sdk'
|
|
1177
|
+
# setup authorization
|
|
1178
|
+
Spatio.configure do |config|
|
|
1179
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1180
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1181
|
+
end
|
|
1182
|
+
|
|
1183
|
+
api_instance = Spatio::NotesApi.new
|
|
1184
|
+
opts = {
|
|
1185
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1186
|
+
provider: 'provider_example', # String | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`.
|
|
1187
|
+
x_workspace_id: 'x_workspace_id_example', # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
1188
|
+
archived: true, # Boolean | When `true`, return archived notes instead of active ones.
|
|
1189
|
+
parent_id: 'parent_id_example', # String | Filter to notes nested under this parent note id.
|
|
1190
|
+
tags: ['inner_example'], # Array<String> | Repeatable. Filter to notes carrying every tag listed.
|
|
1191
|
+
limit: 56, # Integer | Max items to return. Defaults to 50.
|
|
1192
|
+
offset: 56, # Integer | Number of items to skip.
|
|
1193
|
+
sort_by: 'sort_by_example', # String | Sort field. Provider-dependent; the native provider supports `updated_at`, `created_at`, `title`.
|
|
1194
|
+
sort_order: 'asc' # String |
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1197
|
+
begin
|
|
1198
|
+
# List notes across connected accounts.
|
|
1199
|
+
result = api_instance.list_notes(opts)
|
|
1200
|
+
p result
|
|
1201
|
+
rescue Spatio::ApiError => e
|
|
1202
|
+
puts "Error when calling NotesApi->list_notes: #{e}"
|
|
1203
|
+
end
|
|
1204
|
+
```
|
|
1205
|
+
|
|
1206
|
+
#### Using the list_notes_with_http_info variant
|
|
1207
|
+
|
|
1208
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1209
|
+
|
|
1210
|
+
> <Array(<NoteListEnvelope>, Integer, Hash)> list_notes_with_http_info(opts)
|
|
1211
|
+
|
|
1212
|
+
```ruby
|
|
1213
|
+
begin
|
|
1214
|
+
# List notes across connected accounts.
|
|
1215
|
+
data, status_code, headers = api_instance.list_notes_with_http_info(opts)
|
|
1216
|
+
p status_code # => 2xx
|
|
1217
|
+
p headers # => { ... }
|
|
1218
|
+
p data # => <NoteListEnvelope>
|
|
1219
|
+
rescue Spatio::ApiError => e
|
|
1220
|
+
puts "Error when calling NotesApi->list_notes_with_http_info: #{e}"
|
|
1221
|
+
end
|
|
1222
|
+
```
|
|
1223
|
+
|
|
1224
|
+
### Parameters
|
|
1225
|
+
|
|
1226
|
+
| Name | Type | Description | Notes |
|
|
1227
|
+
| ---- | ---- | ----------- | ----- |
|
|
1228
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1229
|
+
| **provider** | **String** | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`. | [optional] |
|
|
1230
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
1231
|
+
| **archived** | **Boolean** | When `true`, return archived notes instead of active ones. | [optional][default to false] |
|
|
1232
|
+
| **parent_id** | **String** | Filter to notes nested under this parent note id. | [optional] |
|
|
1233
|
+
| **tags** | [**Array<String>**](String.md) | Repeatable. Filter to notes carrying every tag listed. | [optional] |
|
|
1234
|
+
| **limit** | **Integer** | Max items to return. Defaults to 50. | [optional][default to 50] |
|
|
1235
|
+
| **offset** | **Integer** | Number of items to skip. | [optional][default to 0] |
|
|
1236
|
+
| **sort_by** | **String** | Sort field. Provider-dependent; the native provider supports `updated_at`, `created_at`, `title`. | [optional][default to 'updated_at'] |
|
|
1237
|
+
| **sort_order** | **String** | | [optional][default to 'desc'] |
|
|
1238
|
+
|
|
1239
|
+
### Return type
|
|
1240
|
+
|
|
1241
|
+
[**NoteListEnvelope**](NoteListEnvelope.md)
|
|
1242
|
+
|
|
1243
|
+
### Authorization
|
|
1244
|
+
|
|
1245
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1246
|
+
|
|
1247
|
+
### HTTP request headers
|
|
1248
|
+
|
|
1249
|
+
- **Content-Type**: Not defined
|
|
1250
|
+
- **Accept**: application/json
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
## move_block
|
|
1254
|
+
|
|
1255
|
+
> <SuccessFlag> move_block(id, move_block_request, opts)
|
|
1256
|
+
|
|
1257
|
+
Reparent or reorder a block.
|
|
1258
|
+
|
|
1259
|
+
### Examples
|
|
1260
|
+
|
|
1261
|
+
```ruby
|
|
1262
|
+
require 'time'
|
|
1263
|
+
require 'spatio-sdk'
|
|
1264
|
+
# setup authorization
|
|
1265
|
+
Spatio.configure do |config|
|
|
1266
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1267
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1268
|
+
end
|
|
1269
|
+
|
|
1270
|
+
api_instance = Spatio::NotesApi.new
|
|
1271
|
+
id = 'id_example' # String | Block id.
|
|
1272
|
+
move_block_request = Spatio::MoveBlockRequest.new({position: 37}) # MoveBlockRequest |
|
|
1273
|
+
opts = {
|
|
1274
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1275
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
1276
|
+
}
|
|
1277
|
+
|
|
1278
|
+
begin
|
|
1279
|
+
# Reparent or reorder a block.
|
|
1280
|
+
result = api_instance.move_block(id, move_block_request, opts)
|
|
1281
|
+
p result
|
|
1282
|
+
rescue Spatio::ApiError => e
|
|
1283
|
+
puts "Error when calling NotesApi->move_block: #{e}"
|
|
1284
|
+
end
|
|
1285
|
+
```
|
|
1286
|
+
|
|
1287
|
+
#### Using the move_block_with_http_info variant
|
|
1288
|
+
|
|
1289
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1290
|
+
|
|
1291
|
+
> <Array(<SuccessFlag>, Integer, Hash)> move_block_with_http_info(id, move_block_request, opts)
|
|
1292
|
+
|
|
1293
|
+
```ruby
|
|
1294
|
+
begin
|
|
1295
|
+
# Reparent or reorder a block.
|
|
1296
|
+
data, status_code, headers = api_instance.move_block_with_http_info(id, move_block_request, opts)
|
|
1297
|
+
p status_code # => 2xx
|
|
1298
|
+
p headers # => { ... }
|
|
1299
|
+
p data # => <SuccessFlag>
|
|
1300
|
+
rescue Spatio::ApiError => e
|
|
1301
|
+
puts "Error when calling NotesApi->move_block_with_http_info: #{e}"
|
|
1302
|
+
end
|
|
1303
|
+
```
|
|
1304
|
+
|
|
1305
|
+
### Parameters
|
|
1306
|
+
|
|
1307
|
+
| Name | Type | Description | Notes |
|
|
1308
|
+
| ---- | ---- | ----------- | ----- |
|
|
1309
|
+
| **id** | **String** | Block id. | |
|
|
1310
|
+
| **move_block_request** | [**MoveBlockRequest**](MoveBlockRequest.md) | | |
|
|
1311
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1312
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
1313
|
+
|
|
1314
|
+
### Return type
|
|
1315
|
+
|
|
1316
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
1317
|
+
|
|
1318
|
+
### Authorization
|
|
1319
|
+
|
|
1320
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1321
|
+
|
|
1322
|
+
### HTTP request headers
|
|
1323
|
+
|
|
1324
|
+
- **Content-Type**: application/json
|
|
1325
|
+
- **Accept**: application/json
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
## rotate_note_share_token
|
|
1329
|
+
|
|
1330
|
+
> <ShareSettings> rotate_note_share_token(id, opts)
|
|
1331
|
+
|
|
1332
|
+
Rotate the share token, invalidating any outstanding URLs.
|
|
1333
|
+
|
|
1334
|
+
### Examples
|
|
1335
|
+
|
|
1336
|
+
```ruby
|
|
1337
|
+
require 'time'
|
|
1338
|
+
require 'spatio-sdk'
|
|
1339
|
+
# setup authorization
|
|
1340
|
+
Spatio.configure do |config|
|
|
1341
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1342
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1343
|
+
end
|
|
1344
|
+
|
|
1345
|
+
api_instance = Spatio::NotesApi.new
|
|
1346
|
+
id = 'id_example' # String | Note id.
|
|
1347
|
+
opts = {
|
|
1348
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1349
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
1350
|
+
}
|
|
1351
|
+
|
|
1352
|
+
begin
|
|
1353
|
+
# Rotate the share token, invalidating any outstanding URLs.
|
|
1354
|
+
result = api_instance.rotate_note_share_token(id, opts)
|
|
1355
|
+
p result
|
|
1356
|
+
rescue Spatio::ApiError => e
|
|
1357
|
+
puts "Error when calling NotesApi->rotate_note_share_token: #{e}"
|
|
1358
|
+
end
|
|
1359
|
+
```
|
|
1360
|
+
|
|
1361
|
+
#### Using the rotate_note_share_token_with_http_info variant
|
|
1362
|
+
|
|
1363
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1364
|
+
|
|
1365
|
+
> <Array(<ShareSettings>, Integer, Hash)> rotate_note_share_token_with_http_info(id, opts)
|
|
1366
|
+
|
|
1367
|
+
```ruby
|
|
1368
|
+
begin
|
|
1369
|
+
# Rotate the share token, invalidating any outstanding URLs.
|
|
1370
|
+
data, status_code, headers = api_instance.rotate_note_share_token_with_http_info(id, opts)
|
|
1371
|
+
p status_code # => 2xx
|
|
1372
|
+
p headers # => { ... }
|
|
1373
|
+
p data # => <ShareSettings>
|
|
1374
|
+
rescue Spatio::ApiError => e
|
|
1375
|
+
puts "Error when calling NotesApi->rotate_note_share_token_with_http_info: #{e}"
|
|
1376
|
+
end
|
|
1377
|
+
```
|
|
1378
|
+
|
|
1379
|
+
### Parameters
|
|
1380
|
+
|
|
1381
|
+
| Name | Type | Description | Notes |
|
|
1382
|
+
| ---- | ---- | ----------- | ----- |
|
|
1383
|
+
| **id** | **String** | Note id. | |
|
|
1384
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1385
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
1386
|
+
|
|
1387
|
+
### Return type
|
|
1388
|
+
|
|
1389
|
+
[**ShareSettings**](ShareSettings.md)
|
|
1390
|
+
|
|
1391
|
+
### Authorization
|
|
1392
|
+
|
|
1393
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1394
|
+
|
|
1395
|
+
### HTTP request headers
|
|
1396
|
+
|
|
1397
|
+
- **Content-Type**: Not defined
|
|
1398
|
+
- **Accept**: application/json
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
## update_block
|
|
1402
|
+
|
|
1403
|
+
> <Block> update_block(id, update_block_request, opts)
|
|
1404
|
+
|
|
1405
|
+
Update a block (partial).
|
|
1406
|
+
|
|
1407
|
+
### Examples
|
|
1408
|
+
|
|
1409
|
+
```ruby
|
|
1410
|
+
require 'time'
|
|
1411
|
+
require 'spatio-sdk'
|
|
1412
|
+
# setup authorization
|
|
1413
|
+
Spatio.configure do |config|
|
|
1414
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1415
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1416
|
+
end
|
|
1417
|
+
|
|
1418
|
+
api_instance = Spatio::NotesApi.new
|
|
1419
|
+
id = 'id_example' # String | Block id.
|
|
1420
|
+
update_block_request = Spatio::UpdateBlockRequest.new # UpdateBlockRequest |
|
|
1421
|
+
opts = {
|
|
1422
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1423
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
1424
|
+
}
|
|
1425
|
+
|
|
1426
|
+
begin
|
|
1427
|
+
# Update a block (partial).
|
|
1428
|
+
result = api_instance.update_block(id, update_block_request, opts)
|
|
1429
|
+
p result
|
|
1430
|
+
rescue Spatio::ApiError => e
|
|
1431
|
+
puts "Error when calling NotesApi->update_block: #{e}"
|
|
1432
|
+
end
|
|
1433
|
+
```
|
|
1434
|
+
|
|
1435
|
+
#### Using the update_block_with_http_info variant
|
|
1436
|
+
|
|
1437
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1438
|
+
|
|
1439
|
+
> <Array(<Block>, Integer, Hash)> update_block_with_http_info(id, update_block_request, opts)
|
|
1440
|
+
|
|
1441
|
+
```ruby
|
|
1442
|
+
begin
|
|
1443
|
+
# Update a block (partial).
|
|
1444
|
+
data, status_code, headers = api_instance.update_block_with_http_info(id, update_block_request, opts)
|
|
1445
|
+
p status_code # => 2xx
|
|
1446
|
+
p headers # => { ... }
|
|
1447
|
+
p data # => <Block>
|
|
1448
|
+
rescue Spatio::ApiError => e
|
|
1449
|
+
puts "Error when calling NotesApi->update_block_with_http_info: #{e}"
|
|
1450
|
+
end
|
|
1451
|
+
```
|
|
1452
|
+
|
|
1453
|
+
### Parameters
|
|
1454
|
+
|
|
1455
|
+
| Name | Type | Description | Notes |
|
|
1456
|
+
| ---- | ---- | ----------- | ----- |
|
|
1457
|
+
| **id** | **String** | Block id. | |
|
|
1458
|
+
| **update_block_request** | [**UpdateBlockRequest**](UpdateBlockRequest.md) | | |
|
|
1459
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1460
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
1461
|
+
|
|
1462
|
+
### Return type
|
|
1463
|
+
|
|
1464
|
+
[**Block**](Block.md)
|
|
1465
|
+
|
|
1466
|
+
### Authorization
|
|
1467
|
+
|
|
1468
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1469
|
+
|
|
1470
|
+
### HTTP request headers
|
|
1471
|
+
|
|
1472
|
+
- **Content-Type**: application/json
|
|
1473
|
+
- **Accept**: application/json
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
## update_note
|
|
1477
|
+
|
|
1478
|
+
> <Note> update_note(id, update_note_request, opts)
|
|
1479
|
+
|
|
1480
|
+
Update a note (partial).
|
|
1481
|
+
|
|
1482
|
+
### Examples
|
|
1483
|
+
|
|
1484
|
+
```ruby
|
|
1485
|
+
require 'time'
|
|
1486
|
+
require 'spatio-sdk'
|
|
1487
|
+
# setup authorization
|
|
1488
|
+
Spatio.configure do |config|
|
|
1489
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1490
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1491
|
+
end
|
|
1492
|
+
|
|
1493
|
+
api_instance = Spatio::NotesApi.new
|
|
1494
|
+
id = 'id_example' # String | Note id.
|
|
1495
|
+
update_note_request = Spatio::UpdateNoteRequest.new # UpdateNoteRequest |
|
|
1496
|
+
opts = {
|
|
1497
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1498
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
1499
|
+
}
|
|
1500
|
+
|
|
1501
|
+
begin
|
|
1502
|
+
# Update a note (partial).
|
|
1503
|
+
result = api_instance.update_note(id, update_note_request, opts)
|
|
1504
|
+
p result
|
|
1505
|
+
rescue Spatio::ApiError => e
|
|
1506
|
+
puts "Error when calling NotesApi->update_note: #{e}"
|
|
1507
|
+
end
|
|
1508
|
+
```
|
|
1509
|
+
|
|
1510
|
+
#### Using the update_note_with_http_info variant
|
|
1511
|
+
|
|
1512
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1513
|
+
|
|
1514
|
+
> <Array(<Note>, Integer, Hash)> update_note_with_http_info(id, update_note_request, opts)
|
|
1515
|
+
|
|
1516
|
+
```ruby
|
|
1517
|
+
begin
|
|
1518
|
+
# Update a note (partial).
|
|
1519
|
+
data, status_code, headers = api_instance.update_note_with_http_info(id, update_note_request, opts)
|
|
1520
|
+
p status_code # => 2xx
|
|
1521
|
+
p headers # => { ... }
|
|
1522
|
+
p data # => <Note>
|
|
1523
|
+
rescue Spatio::ApiError => e
|
|
1524
|
+
puts "Error when calling NotesApi->update_note_with_http_info: #{e}"
|
|
1525
|
+
end
|
|
1526
|
+
```
|
|
1527
|
+
|
|
1528
|
+
### Parameters
|
|
1529
|
+
|
|
1530
|
+
| Name | Type | Description | Notes |
|
|
1531
|
+
| ---- | ---- | ----------- | ----- |
|
|
1532
|
+
| **id** | **String** | Note id. | |
|
|
1533
|
+
| **update_note_request** | [**UpdateNoteRequest**](UpdateNoteRequest.md) | | |
|
|
1534
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1535
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
1536
|
+
|
|
1537
|
+
### Return type
|
|
1538
|
+
|
|
1539
|
+
[**Note**](Note.md)
|
|
1540
|
+
|
|
1541
|
+
### Authorization
|
|
1542
|
+
|
|
1543
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1544
|
+
|
|
1545
|
+
### HTTP request headers
|
|
1546
|
+
|
|
1547
|
+
- **Content-Type**: application/json
|
|
1548
|
+
- **Accept**: application/json
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
## update_note_comment
|
|
1552
|
+
|
|
1553
|
+
> <CommentMutationResponse> update_note_comment(id, comment_id, update_comment_request, opts)
|
|
1554
|
+
|
|
1555
|
+
Edit a comment.
|
|
1556
|
+
|
|
1557
|
+
Only the comment author can edit. The note owner can delete via `DELETE` but cannot rewrite.
|
|
1558
|
+
|
|
1559
|
+
### Examples
|
|
1560
|
+
|
|
1561
|
+
```ruby
|
|
1562
|
+
require 'time'
|
|
1563
|
+
require 'spatio-sdk'
|
|
1564
|
+
# setup authorization
|
|
1565
|
+
Spatio.configure do |config|
|
|
1566
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1567
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1568
|
+
end
|
|
1569
|
+
|
|
1570
|
+
api_instance = Spatio::NotesApi.new
|
|
1571
|
+
id = 'id_example' # String | Note id.
|
|
1572
|
+
comment_id = 'comment_id_example' # String | Comment id.
|
|
1573
|
+
update_comment_request = Spatio::UpdateCommentRequest.new # UpdateCommentRequest |
|
|
1574
|
+
opts = {
|
|
1575
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1576
|
+
x_workspace_id: 'x_workspace_id_example' # String | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
|
|
1577
|
+
}
|
|
1578
|
+
|
|
1579
|
+
begin
|
|
1580
|
+
# Edit a comment.
|
|
1581
|
+
result = api_instance.update_note_comment(id, comment_id, update_comment_request, opts)
|
|
1582
|
+
p result
|
|
1583
|
+
rescue Spatio::ApiError => e
|
|
1584
|
+
puts "Error when calling NotesApi->update_note_comment: #{e}"
|
|
1585
|
+
end
|
|
1586
|
+
```
|
|
1587
|
+
|
|
1588
|
+
#### Using the update_note_comment_with_http_info variant
|
|
1589
|
+
|
|
1590
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1591
|
+
|
|
1592
|
+
> <Array(<CommentMutationResponse>, Integer, Hash)> update_note_comment_with_http_info(id, comment_id, update_comment_request, opts)
|
|
1593
|
+
|
|
1594
|
+
```ruby
|
|
1595
|
+
begin
|
|
1596
|
+
# Edit a comment.
|
|
1597
|
+
data, status_code, headers = api_instance.update_note_comment_with_http_info(id, comment_id, update_comment_request, opts)
|
|
1598
|
+
p status_code # => 2xx
|
|
1599
|
+
p headers # => { ... }
|
|
1600
|
+
p data # => <CommentMutationResponse>
|
|
1601
|
+
rescue Spatio::ApiError => e
|
|
1602
|
+
puts "Error when calling NotesApi->update_note_comment_with_http_info: #{e}"
|
|
1603
|
+
end
|
|
1604
|
+
```
|
|
1605
|
+
|
|
1606
|
+
### Parameters
|
|
1607
|
+
|
|
1608
|
+
| Name | Type | Description | Notes |
|
|
1609
|
+
| ---- | ---- | ----------- | ----- |
|
|
1610
|
+
| **id** | **String** | Note id. | |
|
|
1611
|
+
| **comment_id** | **String** | Comment id. | |
|
|
1612
|
+
| **update_comment_request** | [**UpdateCommentRequest**](UpdateCommentRequest.md) | | |
|
|
1613
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1614
|
+
| **x_workspace_id** | **String** | Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly. | [optional] |
|
|
1615
|
+
|
|
1616
|
+
### Return type
|
|
1617
|
+
|
|
1618
|
+
[**CommentMutationResponse**](CommentMutationResponse.md)
|
|
1619
|
+
|
|
1620
|
+
### Authorization
|
|
1621
|
+
|
|
1622
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1623
|
+
|
|
1624
|
+
### HTTP request headers
|
|
1625
|
+
|
|
1626
|
+
- **Content-Type**: application/json
|
|
1627
|
+
- **Accept**: application/json
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
## workspace_create_note
|
|
1631
|
+
|
|
1632
|
+
> Hash<String, Object> workspace_create_note(org, workspace, request_body)
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
### Examples
|
|
1637
|
+
|
|
1638
|
+
```ruby
|
|
1639
|
+
require 'time'
|
|
1640
|
+
require 'spatio-sdk'
|
|
1641
|
+
# setup authorization
|
|
1642
|
+
Spatio.configure do |config|
|
|
1643
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1644
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1645
|
+
end
|
|
1646
|
+
|
|
1647
|
+
api_instance = Spatio::NotesApi.new
|
|
1648
|
+
org = 'org_example' # String |
|
|
1649
|
+
workspace = 'workspace_example' # String |
|
|
1650
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1651
|
+
|
|
1652
|
+
begin
|
|
1653
|
+
|
|
1654
|
+
result = api_instance.workspace_create_note(org, workspace, request_body)
|
|
1655
|
+
p result
|
|
1656
|
+
rescue Spatio::ApiError => e
|
|
1657
|
+
puts "Error when calling NotesApi->workspace_create_note: #{e}"
|
|
1658
|
+
end
|
|
1659
|
+
```
|
|
1660
|
+
|
|
1661
|
+
#### Using the workspace_create_note_with_http_info variant
|
|
1662
|
+
|
|
1663
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1664
|
+
|
|
1665
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_create_note_with_http_info(org, workspace, request_body)
|
|
1666
|
+
|
|
1667
|
+
```ruby
|
|
1668
|
+
begin
|
|
1669
|
+
|
|
1670
|
+
data, status_code, headers = api_instance.workspace_create_note_with_http_info(org, workspace, request_body)
|
|
1671
|
+
p status_code # => 2xx
|
|
1672
|
+
p headers # => { ... }
|
|
1673
|
+
p data # => Hash<String, Object>
|
|
1674
|
+
rescue Spatio::ApiError => e
|
|
1675
|
+
puts "Error when calling NotesApi->workspace_create_note_with_http_info: #{e}"
|
|
1676
|
+
end
|
|
1677
|
+
```
|
|
1678
|
+
|
|
1679
|
+
### Parameters
|
|
1680
|
+
|
|
1681
|
+
| Name | Type | Description | Notes |
|
|
1682
|
+
| ---- | ---- | ----------- | ----- |
|
|
1683
|
+
| **org** | **String** | | |
|
|
1684
|
+
| **workspace** | **String** | | |
|
|
1685
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1686
|
+
|
|
1687
|
+
### Return type
|
|
1688
|
+
|
|
1689
|
+
**Hash<String, Object>**
|
|
1690
|
+
|
|
1691
|
+
### Authorization
|
|
1692
|
+
|
|
1693
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1694
|
+
|
|
1695
|
+
### HTTP request headers
|
|
1696
|
+
|
|
1697
|
+
- **Content-Type**: application/json
|
|
1698
|
+
- **Accept**: application/json
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
## workspace_create_note_block
|
|
1702
|
+
|
|
1703
|
+
> Hash<String, Object> workspace_create_note_block(org, workspace, id, request_body)
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
### Examples
|
|
1708
|
+
|
|
1709
|
+
```ruby
|
|
1710
|
+
require 'time'
|
|
1711
|
+
require 'spatio-sdk'
|
|
1712
|
+
# setup authorization
|
|
1713
|
+
Spatio.configure do |config|
|
|
1714
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1715
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1716
|
+
end
|
|
1717
|
+
|
|
1718
|
+
api_instance = Spatio::NotesApi.new
|
|
1719
|
+
org = 'org_example' # String |
|
|
1720
|
+
workspace = 'workspace_example' # String |
|
|
1721
|
+
id = 'id_example' # String |
|
|
1722
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1723
|
+
|
|
1724
|
+
begin
|
|
1725
|
+
|
|
1726
|
+
result = api_instance.workspace_create_note_block(org, workspace, id, request_body)
|
|
1727
|
+
p result
|
|
1728
|
+
rescue Spatio::ApiError => e
|
|
1729
|
+
puts "Error when calling NotesApi->workspace_create_note_block: #{e}"
|
|
1730
|
+
end
|
|
1731
|
+
```
|
|
1732
|
+
|
|
1733
|
+
#### Using the workspace_create_note_block_with_http_info variant
|
|
1734
|
+
|
|
1735
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1736
|
+
|
|
1737
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_create_note_block_with_http_info(org, workspace, id, request_body)
|
|
1738
|
+
|
|
1739
|
+
```ruby
|
|
1740
|
+
begin
|
|
1741
|
+
|
|
1742
|
+
data, status_code, headers = api_instance.workspace_create_note_block_with_http_info(org, workspace, id, request_body)
|
|
1743
|
+
p status_code # => 2xx
|
|
1744
|
+
p headers # => { ... }
|
|
1745
|
+
p data # => Hash<String, Object>
|
|
1746
|
+
rescue Spatio::ApiError => e
|
|
1747
|
+
puts "Error when calling NotesApi->workspace_create_note_block_with_http_info: #{e}"
|
|
1748
|
+
end
|
|
1749
|
+
```
|
|
1750
|
+
|
|
1751
|
+
### Parameters
|
|
1752
|
+
|
|
1753
|
+
| Name | Type | Description | Notes |
|
|
1754
|
+
| ---- | ---- | ----------- | ----- |
|
|
1755
|
+
| **org** | **String** | | |
|
|
1756
|
+
| **workspace** | **String** | | |
|
|
1757
|
+
| **id** | **String** | | |
|
|
1758
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1759
|
+
|
|
1760
|
+
### Return type
|
|
1761
|
+
|
|
1762
|
+
**Hash<String, Object>**
|
|
1763
|
+
|
|
1764
|
+
### Authorization
|
|
1765
|
+
|
|
1766
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1767
|
+
|
|
1768
|
+
### HTTP request headers
|
|
1769
|
+
|
|
1770
|
+
- **Content-Type**: application/json
|
|
1771
|
+
- **Accept**: application/json
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
## workspace_delete_note
|
|
1775
|
+
|
|
1776
|
+
> workspace_delete_note(org, workspace, id)
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
### Examples
|
|
1781
|
+
|
|
1782
|
+
```ruby
|
|
1783
|
+
require 'time'
|
|
1784
|
+
require 'spatio-sdk'
|
|
1785
|
+
# setup authorization
|
|
1786
|
+
Spatio.configure do |config|
|
|
1787
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1788
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1789
|
+
end
|
|
1790
|
+
|
|
1791
|
+
api_instance = Spatio::NotesApi.new
|
|
1792
|
+
org = 'org_example' # String |
|
|
1793
|
+
workspace = 'workspace_example' # String |
|
|
1794
|
+
id = 'id_example' # String |
|
|
1795
|
+
|
|
1796
|
+
begin
|
|
1797
|
+
|
|
1798
|
+
api_instance.workspace_delete_note(org, workspace, id)
|
|
1799
|
+
rescue Spatio::ApiError => e
|
|
1800
|
+
puts "Error when calling NotesApi->workspace_delete_note: #{e}"
|
|
1801
|
+
end
|
|
1802
|
+
```
|
|
1803
|
+
|
|
1804
|
+
#### Using the workspace_delete_note_with_http_info variant
|
|
1805
|
+
|
|
1806
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1807
|
+
|
|
1808
|
+
> <Array(nil, Integer, Hash)> workspace_delete_note_with_http_info(org, workspace, id)
|
|
1809
|
+
|
|
1810
|
+
```ruby
|
|
1811
|
+
begin
|
|
1812
|
+
|
|
1813
|
+
data, status_code, headers = api_instance.workspace_delete_note_with_http_info(org, workspace, id)
|
|
1814
|
+
p status_code # => 2xx
|
|
1815
|
+
p headers # => { ... }
|
|
1816
|
+
p data # => nil
|
|
1817
|
+
rescue Spatio::ApiError => e
|
|
1818
|
+
puts "Error when calling NotesApi->workspace_delete_note_with_http_info: #{e}"
|
|
1819
|
+
end
|
|
1820
|
+
```
|
|
1821
|
+
|
|
1822
|
+
### Parameters
|
|
1823
|
+
|
|
1824
|
+
| Name | Type | Description | Notes |
|
|
1825
|
+
| ---- | ---- | ----------- | ----- |
|
|
1826
|
+
| **org** | **String** | | |
|
|
1827
|
+
| **workspace** | **String** | | |
|
|
1828
|
+
| **id** | **String** | | |
|
|
1829
|
+
|
|
1830
|
+
### Return type
|
|
1831
|
+
|
|
1832
|
+
nil (empty response body)
|
|
1833
|
+
|
|
1834
|
+
### Authorization
|
|
1835
|
+
|
|
1836
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1837
|
+
|
|
1838
|
+
### HTTP request headers
|
|
1839
|
+
|
|
1840
|
+
- **Content-Type**: Not defined
|
|
1841
|
+
- **Accept**: application/json
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
## workspace_delete_note_block
|
|
1845
|
+
|
|
1846
|
+
> workspace_delete_note_block(org, workspace, id)
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
### Examples
|
|
1851
|
+
|
|
1852
|
+
```ruby
|
|
1853
|
+
require 'time'
|
|
1854
|
+
require 'spatio-sdk'
|
|
1855
|
+
# setup authorization
|
|
1856
|
+
Spatio.configure do |config|
|
|
1857
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1858
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1859
|
+
end
|
|
1860
|
+
|
|
1861
|
+
api_instance = Spatio::NotesApi.new
|
|
1862
|
+
org = 'org_example' # String |
|
|
1863
|
+
workspace = 'workspace_example' # String |
|
|
1864
|
+
id = 'id_example' # String |
|
|
1865
|
+
|
|
1866
|
+
begin
|
|
1867
|
+
|
|
1868
|
+
api_instance.workspace_delete_note_block(org, workspace, id)
|
|
1869
|
+
rescue Spatio::ApiError => e
|
|
1870
|
+
puts "Error when calling NotesApi->workspace_delete_note_block: #{e}"
|
|
1871
|
+
end
|
|
1872
|
+
```
|
|
1873
|
+
|
|
1874
|
+
#### Using the workspace_delete_note_block_with_http_info variant
|
|
1875
|
+
|
|
1876
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1877
|
+
|
|
1878
|
+
> <Array(nil, Integer, Hash)> workspace_delete_note_block_with_http_info(org, workspace, id)
|
|
1879
|
+
|
|
1880
|
+
```ruby
|
|
1881
|
+
begin
|
|
1882
|
+
|
|
1883
|
+
data, status_code, headers = api_instance.workspace_delete_note_block_with_http_info(org, workspace, id)
|
|
1884
|
+
p status_code # => 2xx
|
|
1885
|
+
p headers # => { ... }
|
|
1886
|
+
p data # => nil
|
|
1887
|
+
rescue Spatio::ApiError => e
|
|
1888
|
+
puts "Error when calling NotesApi->workspace_delete_note_block_with_http_info: #{e}"
|
|
1889
|
+
end
|
|
1890
|
+
```
|
|
1891
|
+
|
|
1892
|
+
### Parameters
|
|
1893
|
+
|
|
1894
|
+
| Name | Type | Description | Notes |
|
|
1895
|
+
| ---- | ---- | ----------- | ----- |
|
|
1896
|
+
| **org** | **String** | | |
|
|
1897
|
+
| **workspace** | **String** | | |
|
|
1898
|
+
| **id** | **String** | | |
|
|
1899
|
+
|
|
1900
|
+
### Return type
|
|
1901
|
+
|
|
1902
|
+
nil (empty response body)
|
|
1903
|
+
|
|
1904
|
+
### Authorization
|
|
1905
|
+
|
|
1906
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1907
|
+
|
|
1908
|
+
### HTTP request headers
|
|
1909
|
+
|
|
1910
|
+
- **Content-Type**: Not defined
|
|
1911
|
+
- **Accept**: application/json
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
## workspace_get_note
|
|
1915
|
+
|
|
1916
|
+
> Hash<String, Object> workspace_get_note(org, workspace, id)
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
### Examples
|
|
1921
|
+
|
|
1922
|
+
```ruby
|
|
1923
|
+
require 'time'
|
|
1924
|
+
require 'spatio-sdk'
|
|
1925
|
+
# setup authorization
|
|
1926
|
+
Spatio.configure do |config|
|
|
1927
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1928
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1929
|
+
end
|
|
1930
|
+
|
|
1931
|
+
api_instance = Spatio::NotesApi.new
|
|
1932
|
+
org = 'org_example' # String |
|
|
1933
|
+
workspace = 'workspace_example' # String |
|
|
1934
|
+
id = 'id_example' # String |
|
|
1935
|
+
|
|
1936
|
+
begin
|
|
1937
|
+
|
|
1938
|
+
result = api_instance.workspace_get_note(org, workspace, id)
|
|
1939
|
+
p result
|
|
1940
|
+
rescue Spatio::ApiError => e
|
|
1941
|
+
puts "Error when calling NotesApi->workspace_get_note: #{e}"
|
|
1942
|
+
end
|
|
1943
|
+
```
|
|
1944
|
+
|
|
1945
|
+
#### Using the workspace_get_note_with_http_info variant
|
|
1946
|
+
|
|
1947
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1948
|
+
|
|
1949
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_note_with_http_info(org, workspace, id)
|
|
1950
|
+
|
|
1951
|
+
```ruby
|
|
1952
|
+
begin
|
|
1953
|
+
|
|
1954
|
+
data, status_code, headers = api_instance.workspace_get_note_with_http_info(org, workspace, id)
|
|
1955
|
+
p status_code # => 2xx
|
|
1956
|
+
p headers # => { ... }
|
|
1957
|
+
p data # => Hash<String, Object>
|
|
1958
|
+
rescue Spatio::ApiError => e
|
|
1959
|
+
puts "Error when calling NotesApi->workspace_get_note_with_http_info: #{e}"
|
|
1960
|
+
end
|
|
1961
|
+
```
|
|
1962
|
+
|
|
1963
|
+
### Parameters
|
|
1964
|
+
|
|
1965
|
+
| Name | Type | Description | Notes |
|
|
1966
|
+
| ---- | ---- | ----------- | ----- |
|
|
1967
|
+
| **org** | **String** | | |
|
|
1968
|
+
| **workspace** | **String** | | |
|
|
1969
|
+
| **id** | **String** | | |
|
|
1970
|
+
|
|
1971
|
+
### Return type
|
|
1972
|
+
|
|
1973
|
+
**Hash<String, Object>**
|
|
1974
|
+
|
|
1975
|
+
### Authorization
|
|
1976
|
+
|
|
1977
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1978
|
+
|
|
1979
|
+
### HTTP request headers
|
|
1980
|
+
|
|
1981
|
+
- **Content-Type**: Not defined
|
|
1982
|
+
- **Accept**: application/json
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
## workspace_get_note_block
|
|
1986
|
+
|
|
1987
|
+
> Hash<String, Object> workspace_get_note_block(org, workspace, id)
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
### Examples
|
|
1992
|
+
|
|
1993
|
+
```ruby
|
|
1994
|
+
require 'time'
|
|
1995
|
+
require 'spatio-sdk'
|
|
1996
|
+
# setup authorization
|
|
1997
|
+
Spatio.configure do |config|
|
|
1998
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1999
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2000
|
+
end
|
|
2001
|
+
|
|
2002
|
+
api_instance = Spatio::NotesApi.new
|
|
2003
|
+
org = 'org_example' # String |
|
|
2004
|
+
workspace = 'workspace_example' # String |
|
|
2005
|
+
id = 'id_example' # String |
|
|
2006
|
+
|
|
2007
|
+
begin
|
|
2008
|
+
|
|
2009
|
+
result = api_instance.workspace_get_note_block(org, workspace, id)
|
|
2010
|
+
p result
|
|
2011
|
+
rescue Spatio::ApiError => e
|
|
2012
|
+
puts "Error when calling NotesApi->workspace_get_note_block: #{e}"
|
|
2013
|
+
end
|
|
2014
|
+
```
|
|
2015
|
+
|
|
2016
|
+
#### Using the workspace_get_note_block_with_http_info variant
|
|
2017
|
+
|
|
2018
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2019
|
+
|
|
2020
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_note_block_with_http_info(org, workspace, id)
|
|
2021
|
+
|
|
2022
|
+
```ruby
|
|
2023
|
+
begin
|
|
2024
|
+
|
|
2025
|
+
data, status_code, headers = api_instance.workspace_get_note_block_with_http_info(org, workspace, id)
|
|
2026
|
+
p status_code # => 2xx
|
|
2027
|
+
p headers # => { ... }
|
|
2028
|
+
p data # => Hash<String, Object>
|
|
2029
|
+
rescue Spatio::ApiError => e
|
|
2030
|
+
puts "Error when calling NotesApi->workspace_get_note_block_with_http_info: #{e}"
|
|
2031
|
+
end
|
|
2032
|
+
```
|
|
2033
|
+
|
|
2034
|
+
### Parameters
|
|
2035
|
+
|
|
2036
|
+
| Name | Type | Description | Notes |
|
|
2037
|
+
| ---- | ---- | ----------- | ----- |
|
|
2038
|
+
| **org** | **String** | | |
|
|
2039
|
+
| **workspace** | **String** | | |
|
|
2040
|
+
| **id** | **String** | | |
|
|
2041
|
+
|
|
2042
|
+
### Return type
|
|
2043
|
+
|
|
2044
|
+
**Hash<String, Object>**
|
|
2045
|
+
|
|
2046
|
+
### Authorization
|
|
2047
|
+
|
|
2048
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2049
|
+
|
|
2050
|
+
### HTTP request headers
|
|
2051
|
+
|
|
2052
|
+
- **Content-Type**: Not defined
|
|
2053
|
+
- **Accept**: application/json
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
## workspace_list_note_blocks
|
|
2057
|
+
|
|
2058
|
+
> Hash<String, Object> workspace_list_note_blocks(org, workspace, id)
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
### Examples
|
|
2063
|
+
|
|
2064
|
+
```ruby
|
|
2065
|
+
require 'time'
|
|
2066
|
+
require 'spatio-sdk'
|
|
2067
|
+
# setup authorization
|
|
2068
|
+
Spatio.configure do |config|
|
|
2069
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2070
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2071
|
+
end
|
|
2072
|
+
|
|
2073
|
+
api_instance = Spatio::NotesApi.new
|
|
2074
|
+
org = 'org_example' # String |
|
|
2075
|
+
workspace = 'workspace_example' # String |
|
|
2076
|
+
id = 'id_example' # String |
|
|
2077
|
+
|
|
2078
|
+
begin
|
|
2079
|
+
|
|
2080
|
+
result = api_instance.workspace_list_note_blocks(org, workspace, id)
|
|
2081
|
+
p result
|
|
2082
|
+
rescue Spatio::ApiError => e
|
|
2083
|
+
puts "Error when calling NotesApi->workspace_list_note_blocks: #{e}"
|
|
2084
|
+
end
|
|
2085
|
+
```
|
|
2086
|
+
|
|
2087
|
+
#### Using the workspace_list_note_blocks_with_http_info variant
|
|
2088
|
+
|
|
2089
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2090
|
+
|
|
2091
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_note_blocks_with_http_info(org, workspace, id)
|
|
2092
|
+
|
|
2093
|
+
```ruby
|
|
2094
|
+
begin
|
|
2095
|
+
|
|
2096
|
+
data, status_code, headers = api_instance.workspace_list_note_blocks_with_http_info(org, workspace, id)
|
|
2097
|
+
p status_code # => 2xx
|
|
2098
|
+
p headers # => { ... }
|
|
2099
|
+
p data # => Hash<String, Object>
|
|
2100
|
+
rescue Spatio::ApiError => e
|
|
2101
|
+
puts "Error when calling NotesApi->workspace_list_note_blocks_with_http_info: #{e}"
|
|
2102
|
+
end
|
|
2103
|
+
```
|
|
2104
|
+
|
|
2105
|
+
### Parameters
|
|
2106
|
+
|
|
2107
|
+
| Name | Type | Description | Notes |
|
|
2108
|
+
| ---- | ---- | ----------- | ----- |
|
|
2109
|
+
| **org** | **String** | | |
|
|
2110
|
+
| **workspace** | **String** | | |
|
|
2111
|
+
| **id** | **String** | | |
|
|
2112
|
+
|
|
2113
|
+
### Return type
|
|
2114
|
+
|
|
2115
|
+
**Hash<String, Object>**
|
|
2116
|
+
|
|
2117
|
+
### Authorization
|
|
2118
|
+
|
|
2119
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2120
|
+
|
|
2121
|
+
### HTTP request headers
|
|
2122
|
+
|
|
2123
|
+
- **Content-Type**: Not defined
|
|
2124
|
+
- **Accept**: application/json
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
## workspace_list_notes
|
|
2128
|
+
|
|
2129
|
+
> Hash<String, Object> workspace_list_notes(org, workspace)
|
|
2130
|
+
|
|
2131
|
+
|
|
2132
|
+
|
|
2133
|
+
### Examples
|
|
2134
|
+
|
|
2135
|
+
```ruby
|
|
2136
|
+
require 'time'
|
|
2137
|
+
require 'spatio-sdk'
|
|
2138
|
+
# setup authorization
|
|
2139
|
+
Spatio.configure do |config|
|
|
2140
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2141
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2142
|
+
end
|
|
2143
|
+
|
|
2144
|
+
api_instance = Spatio::NotesApi.new
|
|
2145
|
+
org = 'org_example' # String |
|
|
2146
|
+
workspace = 'workspace_example' # String |
|
|
2147
|
+
|
|
2148
|
+
begin
|
|
2149
|
+
|
|
2150
|
+
result = api_instance.workspace_list_notes(org, workspace)
|
|
2151
|
+
p result
|
|
2152
|
+
rescue Spatio::ApiError => e
|
|
2153
|
+
puts "Error when calling NotesApi->workspace_list_notes: #{e}"
|
|
2154
|
+
end
|
|
2155
|
+
```
|
|
2156
|
+
|
|
2157
|
+
#### Using the workspace_list_notes_with_http_info variant
|
|
2158
|
+
|
|
2159
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2160
|
+
|
|
2161
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_notes_with_http_info(org, workspace)
|
|
2162
|
+
|
|
2163
|
+
```ruby
|
|
2164
|
+
begin
|
|
2165
|
+
|
|
2166
|
+
data, status_code, headers = api_instance.workspace_list_notes_with_http_info(org, workspace)
|
|
2167
|
+
p status_code # => 2xx
|
|
2168
|
+
p headers # => { ... }
|
|
2169
|
+
p data # => Hash<String, Object>
|
|
2170
|
+
rescue Spatio::ApiError => e
|
|
2171
|
+
puts "Error when calling NotesApi->workspace_list_notes_with_http_info: #{e}"
|
|
2172
|
+
end
|
|
2173
|
+
```
|
|
2174
|
+
|
|
2175
|
+
### Parameters
|
|
2176
|
+
|
|
2177
|
+
| Name | Type | Description | Notes |
|
|
2178
|
+
| ---- | ---- | ----------- | ----- |
|
|
2179
|
+
| **org** | **String** | | |
|
|
2180
|
+
| **workspace** | **String** | | |
|
|
2181
|
+
|
|
2182
|
+
### Return type
|
|
2183
|
+
|
|
2184
|
+
**Hash<String, Object>**
|
|
2185
|
+
|
|
2186
|
+
### Authorization
|
|
2187
|
+
|
|
2188
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2189
|
+
|
|
2190
|
+
### HTTP request headers
|
|
2191
|
+
|
|
2192
|
+
- **Content-Type**: Not defined
|
|
2193
|
+
- **Accept**: application/json
|
|
2194
|
+
|
|
2195
|
+
|
|
2196
|
+
## workspace_move_note_block
|
|
2197
|
+
|
|
2198
|
+
> Hash<String, Object> workspace_move_note_block(org, workspace, id, request_body)
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
### Examples
|
|
2203
|
+
|
|
2204
|
+
```ruby
|
|
2205
|
+
require 'time'
|
|
2206
|
+
require 'spatio-sdk'
|
|
2207
|
+
# setup authorization
|
|
2208
|
+
Spatio.configure do |config|
|
|
2209
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2210
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2211
|
+
end
|
|
2212
|
+
|
|
2213
|
+
api_instance = Spatio::NotesApi.new
|
|
2214
|
+
org = 'org_example' # String |
|
|
2215
|
+
workspace = 'workspace_example' # String |
|
|
2216
|
+
id = 'id_example' # String |
|
|
2217
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2218
|
+
|
|
2219
|
+
begin
|
|
2220
|
+
|
|
2221
|
+
result = api_instance.workspace_move_note_block(org, workspace, id, request_body)
|
|
2222
|
+
p result
|
|
2223
|
+
rescue Spatio::ApiError => e
|
|
2224
|
+
puts "Error when calling NotesApi->workspace_move_note_block: #{e}"
|
|
2225
|
+
end
|
|
2226
|
+
```
|
|
2227
|
+
|
|
2228
|
+
#### Using the workspace_move_note_block_with_http_info variant
|
|
2229
|
+
|
|
2230
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2231
|
+
|
|
2232
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_move_note_block_with_http_info(org, workspace, id, request_body)
|
|
2233
|
+
|
|
2234
|
+
```ruby
|
|
2235
|
+
begin
|
|
2236
|
+
|
|
2237
|
+
data, status_code, headers = api_instance.workspace_move_note_block_with_http_info(org, workspace, id, request_body)
|
|
2238
|
+
p status_code # => 2xx
|
|
2239
|
+
p headers # => { ... }
|
|
2240
|
+
p data # => Hash<String, Object>
|
|
2241
|
+
rescue Spatio::ApiError => e
|
|
2242
|
+
puts "Error when calling NotesApi->workspace_move_note_block_with_http_info: #{e}"
|
|
2243
|
+
end
|
|
2244
|
+
```
|
|
2245
|
+
|
|
2246
|
+
### Parameters
|
|
2247
|
+
|
|
2248
|
+
| Name | Type | Description | Notes |
|
|
2249
|
+
| ---- | ---- | ----------- | ----- |
|
|
2250
|
+
| **org** | **String** | | |
|
|
2251
|
+
| **workspace** | **String** | | |
|
|
2252
|
+
| **id** | **String** | | |
|
|
2253
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2254
|
+
|
|
2255
|
+
### Return type
|
|
2256
|
+
|
|
2257
|
+
**Hash<String, Object>**
|
|
2258
|
+
|
|
2259
|
+
### Authorization
|
|
2260
|
+
|
|
2261
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2262
|
+
|
|
2263
|
+
### HTTP request headers
|
|
2264
|
+
|
|
2265
|
+
- **Content-Type**: application/json
|
|
2266
|
+
- **Accept**: application/json
|
|
2267
|
+
|
|
2268
|
+
|
|
2269
|
+
## workspace_update_note
|
|
2270
|
+
|
|
2271
|
+
> Hash<String, Object> workspace_update_note(org, workspace, id, request_body)
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
### Examples
|
|
2276
|
+
|
|
2277
|
+
```ruby
|
|
2278
|
+
require 'time'
|
|
2279
|
+
require 'spatio-sdk'
|
|
2280
|
+
# setup authorization
|
|
2281
|
+
Spatio.configure do |config|
|
|
2282
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2283
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2284
|
+
end
|
|
2285
|
+
|
|
2286
|
+
api_instance = Spatio::NotesApi.new
|
|
2287
|
+
org = 'org_example' # String |
|
|
2288
|
+
workspace = 'workspace_example' # String |
|
|
2289
|
+
id = 'id_example' # String |
|
|
2290
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2291
|
+
|
|
2292
|
+
begin
|
|
2293
|
+
|
|
2294
|
+
result = api_instance.workspace_update_note(org, workspace, id, request_body)
|
|
2295
|
+
p result
|
|
2296
|
+
rescue Spatio::ApiError => e
|
|
2297
|
+
puts "Error when calling NotesApi->workspace_update_note: #{e}"
|
|
2298
|
+
end
|
|
2299
|
+
```
|
|
2300
|
+
|
|
2301
|
+
#### Using the workspace_update_note_with_http_info variant
|
|
2302
|
+
|
|
2303
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2304
|
+
|
|
2305
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_update_note_with_http_info(org, workspace, id, request_body)
|
|
2306
|
+
|
|
2307
|
+
```ruby
|
|
2308
|
+
begin
|
|
2309
|
+
|
|
2310
|
+
data, status_code, headers = api_instance.workspace_update_note_with_http_info(org, workspace, id, request_body)
|
|
2311
|
+
p status_code # => 2xx
|
|
2312
|
+
p headers # => { ... }
|
|
2313
|
+
p data # => Hash<String, Object>
|
|
2314
|
+
rescue Spatio::ApiError => e
|
|
2315
|
+
puts "Error when calling NotesApi->workspace_update_note_with_http_info: #{e}"
|
|
2316
|
+
end
|
|
2317
|
+
```
|
|
2318
|
+
|
|
2319
|
+
### Parameters
|
|
2320
|
+
|
|
2321
|
+
| Name | Type | Description | Notes |
|
|
2322
|
+
| ---- | ---- | ----------- | ----- |
|
|
2323
|
+
| **org** | **String** | | |
|
|
2324
|
+
| **workspace** | **String** | | |
|
|
2325
|
+
| **id** | **String** | | |
|
|
2326
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2327
|
+
|
|
2328
|
+
### Return type
|
|
2329
|
+
|
|
2330
|
+
**Hash<String, Object>**
|
|
2331
|
+
|
|
2332
|
+
### Authorization
|
|
2333
|
+
|
|
2334
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2335
|
+
|
|
2336
|
+
### HTTP request headers
|
|
2337
|
+
|
|
2338
|
+
- **Content-Type**: application/json
|
|
2339
|
+
- **Accept**: application/json
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
## workspace_update_note_block
|
|
2343
|
+
|
|
2344
|
+
> Hash<String, Object> workspace_update_note_block(org, workspace, id, request_body)
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
### Examples
|
|
2349
|
+
|
|
2350
|
+
```ruby
|
|
2351
|
+
require 'time'
|
|
2352
|
+
require 'spatio-sdk'
|
|
2353
|
+
# setup authorization
|
|
2354
|
+
Spatio.configure do |config|
|
|
2355
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2356
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2357
|
+
end
|
|
2358
|
+
|
|
2359
|
+
api_instance = Spatio::NotesApi.new
|
|
2360
|
+
org = 'org_example' # String |
|
|
2361
|
+
workspace = 'workspace_example' # String |
|
|
2362
|
+
id = 'id_example' # String |
|
|
2363
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2364
|
+
|
|
2365
|
+
begin
|
|
2366
|
+
|
|
2367
|
+
result = api_instance.workspace_update_note_block(org, workspace, id, request_body)
|
|
2368
|
+
p result
|
|
2369
|
+
rescue Spatio::ApiError => e
|
|
2370
|
+
puts "Error when calling NotesApi->workspace_update_note_block: #{e}"
|
|
2371
|
+
end
|
|
2372
|
+
```
|
|
2373
|
+
|
|
2374
|
+
#### Using the workspace_update_note_block_with_http_info variant
|
|
2375
|
+
|
|
2376
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2377
|
+
|
|
2378
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_update_note_block_with_http_info(org, workspace, id, request_body)
|
|
2379
|
+
|
|
2380
|
+
```ruby
|
|
2381
|
+
begin
|
|
2382
|
+
|
|
2383
|
+
data, status_code, headers = api_instance.workspace_update_note_block_with_http_info(org, workspace, id, request_body)
|
|
2384
|
+
p status_code # => 2xx
|
|
2385
|
+
p headers # => { ... }
|
|
2386
|
+
p data # => Hash<String, Object>
|
|
2387
|
+
rescue Spatio::ApiError => e
|
|
2388
|
+
puts "Error when calling NotesApi->workspace_update_note_block_with_http_info: #{e}"
|
|
2389
|
+
end
|
|
2390
|
+
```
|
|
2391
|
+
|
|
2392
|
+
### Parameters
|
|
2393
|
+
|
|
2394
|
+
| Name | Type | Description | Notes |
|
|
2395
|
+
| ---- | ---- | ----------- | ----- |
|
|
2396
|
+
| **org** | **String** | | |
|
|
2397
|
+
| **workspace** | **String** | | |
|
|
2398
|
+
| **id** | **String** | | |
|
|
2399
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2400
|
+
|
|
2401
|
+
### Return type
|
|
2402
|
+
|
|
2403
|
+
**Hash<String, Object>**
|
|
2404
|
+
|
|
2405
|
+
### Authorization
|
|
2406
|
+
|
|
2407
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2408
|
+
|
|
2409
|
+
### HTTP request headers
|
|
2410
|
+
|
|
2411
|
+
- **Content-Type**: application/json
|
|
2412
|
+
- **Accept**: application/json
|
|
2413
|
+
|