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
|
@@ -0,0 +1,2246 @@
|
|
|
1
|
+
# Spatio::DirectMessagesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spatio.app*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**add_dm_reaction**](DirectMessagesApi.md#add_dm_reaction) | **POST** /v1/direct-messages/messages/{messageId}/reactions | React to a DM message. |
|
|
8
|
+
| [**attach_to_dm_message**](DirectMessagesApi.md#attach_to_dm_message) | **POST** /v1/direct-messages/messages/{messageId}/attachments | Attach a file/image/etc. to an existing DM message. |
|
|
9
|
+
| [**execute_dm_action**](DirectMessagesApi.md#execute_dm_action) | **POST** /v1/direct-messages/execute | Dispatch a DM action by id. |
|
|
10
|
+
| [**forward_dm_message**](DirectMessagesApi.md#forward_dm_message) | **POST** /v1/direct-messages/messages/{messageId}/forward | Forward a DM message to another DM or channel. |
|
|
11
|
+
| [**get_dm_user**](DirectMessagesApi.md#get_dm_user) | **GET** /v1/direct-messages/users/{id} | Fetch one chat user. |
|
|
12
|
+
| [**list_direct_conversations_enriched**](DirectMessagesApi.md#list_direct_conversations_enriched) | **GET** /v1/direct-messages/conversations | Enriched DM conversation list with unread + pin + draft state. |
|
|
13
|
+
| [**list_direct_message_conversations**](DirectMessagesApi.md#list_direct_message_conversations) | **GET** /v1/direct-messages | List 1:1 and group DM conversations. |
|
|
14
|
+
| [**list_direct_messages**](DirectMessagesApi.md#list_direct_messages) | **GET** /v1/direct-messages/messages | List messages in a DM conversation. |
|
|
15
|
+
| [**list_dm_actions**](DirectMessagesApi.md#list_dm_actions) | **GET** /v1/direct-messages/actions | Discover the action catalog for DirectMessages. |
|
|
16
|
+
| [**list_dm_pinned_messages**](DirectMessagesApi.md#list_dm_pinned_messages) | **GET** /v1/direct-messages/{dmId}/pinned | List pinned messages in a DM conversation. |
|
|
17
|
+
| [**list_dm_thread_replies**](DirectMessagesApi.md#list_dm_thread_replies) | **GET** /v1/direct-messages/{dmId}/messages/{messageId}/replies | List replies in a DM message thread. |
|
|
18
|
+
| [**list_dm_users**](DirectMessagesApi.md#list_dm_users) | **GET** /v1/direct-messages/users | List chat users (DM contacts) across connected accounts. |
|
|
19
|
+
| [**mark_dm_read**](DirectMessagesApi.md#mark_dm_read) | **POST** /v1/direct-messages/{dmId}/read | Mark a DM message read. |
|
|
20
|
+
| [**mute_dm**](DirectMessagesApi.md#mute_dm) | **POST** /v1/direct-messages/{dmId}/mute | Mute a DM conversation (until a time, or forever). |
|
|
21
|
+
| [**pin_dm_conversation**](DirectMessagesApi.md#pin_dm_conversation) | **POST** /v1/direct-messages/{dmId}/pin | Pin a DM conversation to the top of the sidebar. |
|
|
22
|
+
| [**pin_dm_message**](DirectMessagesApi.md#pin_dm_message) | **POST** /v1/direct-messages/messages/{messageId}/pin | Pin a DM message. |
|
|
23
|
+
| [**post_dm_thread_reply**](DirectMessagesApi.md#post_dm_thread_reply) | **POST** /v1/direct-messages/{dmId}/messages/{messageId}/replies | Reply in a DM message thread. |
|
|
24
|
+
| [**remove_dm_reaction**](DirectMessagesApi.md#remove_dm_reaction) | **DELETE** /v1/direct-messages/messages/{messageId}/reactions/{emoji} | Remove a DM message reaction. |
|
|
25
|
+
| [**search_direct_messages**](DirectMessagesApi.md#search_direct_messages) | **GET** /v1/direct-messages/search | Search across DM messages. |
|
|
26
|
+
| [**send_direct_message**](DirectMessagesApi.md#send_direct_message) | **POST** /v1/direct-messages/messages | Send a DM. |
|
|
27
|
+
| [**set_dm_draft**](DirectMessagesApi.md#set_dm_draft) | **PUT** /v1/direct-messages/{dmId}/draft | Save the unsent draft text for a DM. |
|
|
28
|
+
| [**unpin_dm_conversation**](DirectMessagesApi.md#unpin_dm_conversation) | **DELETE** /v1/direct-messages/{dmId}/pin | Unpin a DM conversation. |
|
|
29
|
+
| [**unpin_dm_message**](DirectMessagesApi.md#unpin_dm_message) | **DELETE** /v1/direct-messages/messages/{messageId}/pin | Unpin a DM message. |
|
|
30
|
+
| [**workspace_execute_dm_action**](DirectMessagesApi.md#workspace_execute_dm_action) | **POST** /v1/organizations/{org}/workspaces/{workspace}/direct-messages/execute | |
|
|
31
|
+
| [**workspace_get_dm_user**](DirectMessagesApi.md#workspace_get_dm_user) | **GET** /v1/organizations/{org}/workspaces/{workspace}/direct-messages/users/{id} | |
|
|
32
|
+
| [**workspace_list_direct_messages**](DirectMessagesApi.md#workspace_list_direct_messages) | **GET** /v1/organizations/{org}/workspaces/{workspace}/direct-messages | |
|
|
33
|
+
| [**workspace_list_dm_actions**](DirectMessagesApi.md#workspace_list_dm_actions) | **GET** /v1/organizations/{org}/workspaces/{workspace}/direct-messages/actions | |
|
|
34
|
+
| [**workspace_list_dm_conversations**](DirectMessagesApi.md#workspace_list_dm_conversations) | **GET** /v1/organizations/{org}/workspaces/{workspace}/direct-messages/conversations | |
|
|
35
|
+
| [**workspace_list_dm_messages**](DirectMessagesApi.md#workspace_list_dm_messages) | **GET** /v1/organizations/{org}/workspaces/{workspace}/direct-messages/messages | |
|
|
36
|
+
| [**workspace_list_dm_users**](DirectMessagesApi.md#workspace_list_dm_users) | **GET** /v1/organizations/{org}/workspaces/{workspace}/direct-messages/users | |
|
|
37
|
+
| [**workspace_send_direct_message**](DirectMessagesApi.md#workspace_send_direct_message) | **POST** /v1/organizations/{org}/workspaces/{workspace}/direct-messages/messages | |
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
## add_dm_reaction
|
|
41
|
+
|
|
42
|
+
> <DMReactionResponse> add_dm_reaction(message_id, dm_reaction_request)
|
|
43
|
+
|
|
44
|
+
React to a DM message.
|
|
45
|
+
|
|
46
|
+
### Examples
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
require 'time'
|
|
50
|
+
require 'spatio-sdk'
|
|
51
|
+
# setup authorization
|
|
52
|
+
Spatio.configure do |config|
|
|
53
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
54
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
58
|
+
message_id = 'message_id_example' # String | Chat-message id.
|
|
59
|
+
dm_reaction_request = Spatio::DMReactionRequest.new({emoji: 'emoji_example'}) # DMReactionRequest |
|
|
60
|
+
|
|
61
|
+
begin
|
|
62
|
+
# React to a DM message.
|
|
63
|
+
result = api_instance.add_dm_reaction(message_id, dm_reaction_request)
|
|
64
|
+
p result
|
|
65
|
+
rescue Spatio::ApiError => e
|
|
66
|
+
puts "Error when calling DirectMessagesApi->add_dm_reaction: #{e}"
|
|
67
|
+
end
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
#### Using the add_dm_reaction_with_http_info variant
|
|
71
|
+
|
|
72
|
+
This returns an Array which contains the response data, status code and headers.
|
|
73
|
+
|
|
74
|
+
> <Array(<DMReactionResponse>, Integer, Hash)> add_dm_reaction_with_http_info(message_id, dm_reaction_request)
|
|
75
|
+
|
|
76
|
+
```ruby
|
|
77
|
+
begin
|
|
78
|
+
# React to a DM message.
|
|
79
|
+
data, status_code, headers = api_instance.add_dm_reaction_with_http_info(message_id, dm_reaction_request)
|
|
80
|
+
p status_code # => 2xx
|
|
81
|
+
p headers # => { ... }
|
|
82
|
+
p data # => <DMReactionResponse>
|
|
83
|
+
rescue Spatio::ApiError => e
|
|
84
|
+
puts "Error when calling DirectMessagesApi->add_dm_reaction_with_http_info: #{e}"
|
|
85
|
+
end
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Parameters
|
|
89
|
+
|
|
90
|
+
| Name | Type | Description | Notes |
|
|
91
|
+
| ---- | ---- | ----------- | ----- |
|
|
92
|
+
| **message_id** | **String** | Chat-message id. | |
|
|
93
|
+
| **dm_reaction_request** | [**DMReactionRequest**](DMReactionRequest.md) | | |
|
|
94
|
+
|
|
95
|
+
### Return type
|
|
96
|
+
|
|
97
|
+
[**DMReactionResponse**](DMReactionResponse.md)
|
|
98
|
+
|
|
99
|
+
### Authorization
|
|
100
|
+
|
|
101
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
102
|
+
|
|
103
|
+
### HTTP request headers
|
|
104
|
+
|
|
105
|
+
- **Content-Type**: application/json
|
|
106
|
+
- **Accept**: application/json
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
## attach_to_dm_message
|
|
110
|
+
|
|
111
|
+
> <DMMessageEnvelope> attach_to_dm_message(message_id, dm_attach_request)
|
|
112
|
+
|
|
113
|
+
Attach a file/image/etc. to an existing DM message.
|
|
114
|
+
|
|
115
|
+
### Examples
|
|
116
|
+
|
|
117
|
+
```ruby
|
|
118
|
+
require 'time'
|
|
119
|
+
require 'spatio-sdk'
|
|
120
|
+
# setup authorization
|
|
121
|
+
Spatio.configure do |config|
|
|
122
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
123
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
127
|
+
message_id = 'message_id_example' # String | Chat-message id.
|
|
128
|
+
dm_attach_request = Spatio::DMAttachRequest.new({kind: 'kind_example', url: 'url_example'}) # DMAttachRequest |
|
|
129
|
+
|
|
130
|
+
begin
|
|
131
|
+
# Attach a file/image/etc. to an existing DM message.
|
|
132
|
+
result = api_instance.attach_to_dm_message(message_id, dm_attach_request)
|
|
133
|
+
p result
|
|
134
|
+
rescue Spatio::ApiError => e
|
|
135
|
+
puts "Error when calling DirectMessagesApi->attach_to_dm_message: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
#### Using the attach_to_dm_message_with_http_info variant
|
|
140
|
+
|
|
141
|
+
This returns an Array which contains the response data, status code and headers.
|
|
142
|
+
|
|
143
|
+
> <Array(<DMMessageEnvelope>, Integer, Hash)> attach_to_dm_message_with_http_info(message_id, dm_attach_request)
|
|
144
|
+
|
|
145
|
+
```ruby
|
|
146
|
+
begin
|
|
147
|
+
# Attach a file/image/etc. to an existing DM message.
|
|
148
|
+
data, status_code, headers = api_instance.attach_to_dm_message_with_http_info(message_id, dm_attach_request)
|
|
149
|
+
p status_code # => 2xx
|
|
150
|
+
p headers # => { ... }
|
|
151
|
+
p data # => <DMMessageEnvelope>
|
|
152
|
+
rescue Spatio::ApiError => e
|
|
153
|
+
puts "Error when calling DirectMessagesApi->attach_to_dm_message_with_http_info: #{e}"
|
|
154
|
+
end
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Parameters
|
|
158
|
+
|
|
159
|
+
| Name | Type | Description | Notes |
|
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
|
161
|
+
| **message_id** | **String** | Chat-message id. | |
|
|
162
|
+
| **dm_attach_request** | [**DMAttachRequest**](DMAttachRequest.md) | | |
|
|
163
|
+
|
|
164
|
+
### Return type
|
|
165
|
+
|
|
166
|
+
[**DMMessageEnvelope**](DMMessageEnvelope.md)
|
|
167
|
+
|
|
168
|
+
### Authorization
|
|
169
|
+
|
|
170
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
171
|
+
|
|
172
|
+
### HTTP request headers
|
|
173
|
+
|
|
174
|
+
- **Content-Type**: application/json
|
|
175
|
+
- **Accept**: application/json
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
## execute_dm_action
|
|
179
|
+
|
|
180
|
+
> <ExecuteChatActionResponse> execute_dm_action(execute_chat_action_request)
|
|
181
|
+
|
|
182
|
+
Dispatch a DM action by id.
|
|
183
|
+
|
|
184
|
+
### Examples
|
|
185
|
+
|
|
186
|
+
```ruby
|
|
187
|
+
require 'time'
|
|
188
|
+
require 'spatio-sdk'
|
|
189
|
+
# setup authorization
|
|
190
|
+
Spatio.configure do |config|
|
|
191
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
192
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
196
|
+
execute_chat_action_request = Spatio::ExecuteChatActionRequest.new({action_id: 'action_id_example'}) # ExecuteChatActionRequest |
|
|
197
|
+
|
|
198
|
+
begin
|
|
199
|
+
# Dispatch a DM action by id.
|
|
200
|
+
result = api_instance.execute_dm_action(execute_chat_action_request)
|
|
201
|
+
p result
|
|
202
|
+
rescue Spatio::ApiError => e
|
|
203
|
+
puts "Error when calling DirectMessagesApi->execute_dm_action: #{e}"
|
|
204
|
+
end
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
#### Using the execute_dm_action_with_http_info variant
|
|
208
|
+
|
|
209
|
+
This returns an Array which contains the response data, status code and headers.
|
|
210
|
+
|
|
211
|
+
> <Array(<ExecuteChatActionResponse>, Integer, Hash)> execute_dm_action_with_http_info(execute_chat_action_request)
|
|
212
|
+
|
|
213
|
+
```ruby
|
|
214
|
+
begin
|
|
215
|
+
# Dispatch a DM action by id.
|
|
216
|
+
data, status_code, headers = api_instance.execute_dm_action_with_http_info(execute_chat_action_request)
|
|
217
|
+
p status_code # => 2xx
|
|
218
|
+
p headers # => { ... }
|
|
219
|
+
p data # => <ExecuteChatActionResponse>
|
|
220
|
+
rescue Spatio::ApiError => e
|
|
221
|
+
puts "Error when calling DirectMessagesApi->execute_dm_action_with_http_info: #{e}"
|
|
222
|
+
end
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
| Name | Type | Description | Notes |
|
|
228
|
+
| ---- | ---- | ----------- | ----- |
|
|
229
|
+
| **execute_chat_action_request** | [**ExecuteChatActionRequest**](ExecuteChatActionRequest.md) | | |
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
[**ExecuteChatActionResponse**](ExecuteChatActionResponse.md)
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: application/json
|
|
242
|
+
- **Accept**: application/json
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
## forward_dm_message
|
|
246
|
+
|
|
247
|
+
> <DMMessageEnvelope> forward_dm_message(message_id, dm_forward_request)
|
|
248
|
+
|
|
249
|
+
Forward a DM message to another DM or channel.
|
|
250
|
+
|
|
251
|
+
### Examples
|
|
252
|
+
|
|
253
|
+
```ruby
|
|
254
|
+
require 'time'
|
|
255
|
+
require 'spatio-sdk'
|
|
256
|
+
# setup authorization
|
|
257
|
+
Spatio.configure do |config|
|
|
258
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
259
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
263
|
+
message_id = 'message_id_example' # String | Chat-message id.
|
|
264
|
+
dm_forward_request = Spatio::DMForwardRequest.new # DMForwardRequest |
|
|
265
|
+
|
|
266
|
+
begin
|
|
267
|
+
# Forward a DM message to another DM or channel.
|
|
268
|
+
result = api_instance.forward_dm_message(message_id, dm_forward_request)
|
|
269
|
+
p result
|
|
270
|
+
rescue Spatio::ApiError => e
|
|
271
|
+
puts "Error when calling DirectMessagesApi->forward_dm_message: #{e}"
|
|
272
|
+
end
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
#### Using the forward_dm_message_with_http_info variant
|
|
276
|
+
|
|
277
|
+
This returns an Array which contains the response data, status code and headers.
|
|
278
|
+
|
|
279
|
+
> <Array(<DMMessageEnvelope>, Integer, Hash)> forward_dm_message_with_http_info(message_id, dm_forward_request)
|
|
280
|
+
|
|
281
|
+
```ruby
|
|
282
|
+
begin
|
|
283
|
+
# Forward a DM message to another DM or channel.
|
|
284
|
+
data, status_code, headers = api_instance.forward_dm_message_with_http_info(message_id, dm_forward_request)
|
|
285
|
+
p status_code # => 2xx
|
|
286
|
+
p headers # => { ... }
|
|
287
|
+
p data # => <DMMessageEnvelope>
|
|
288
|
+
rescue Spatio::ApiError => e
|
|
289
|
+
puts "Error when calling DirectMessagesApi->forward_dm_message_with_http_info: #{e}"
|
|
290
|
+
end
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### Parameters
|
|
294
|
+
|
|
295
|
+
| Name | Type | Description | Notes |
|
|
296
|
+
| ---- | ---- | ----------- | ----- |
|
|
297
|
+
| **message_id** | **String** | Chat-message id. | |
|
|
298
|
+
| **dm_forward_request** | [**DMForwardRequest**](DMForwardRequest.md) | | |
|
|
299
|
+
|
|
300
|
+
### Return type
|
|
301
|
+
|
|
302
|
+
[**DMMessageEnvelope**](DMMessageEnvelope.md)
|
|
303
|
+
|
|
304
|
+
### Authorization
|
|
305
|
+
|
|
306
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
307
|
+
|
|
308
|
+
### HTTP request headers
|
|
309
|
+
|
|
310
|
+
- **Content-Type**: application/json
|
|
311
|
+
- **Accept**: application/json
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
## get_dm_user
|
|
315
|
+
|
|
316
|
+
> <GetChatUserResponse> get_dm_user(id, opts)
|
|
317
|
+
|
|
318
|
+
Fetch one chat user.
|
|
319
|
+
|
|
320
|
+
### Examples
|
|
321
|
+
|
|
322
|
+
```ruby
|
|
323
|
+
require 'time'
|
|
324
|
+
require 'spatio-sdk'
|
|
325
|
+
# setup authorization
|
|
326
|
+
Spatio.configure do |config|
|
|
327
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
328
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
332
|
+
id = 'id_example' # String | Chat-user id (provider-scoped).
|
|
333
|
+
opts = {
|
|
334
|
+
account_id: 'account_id_example' # String |
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
begin
|
|
338
|
+
# Fetch one chat user.
|
|
339
|
+
result = api_instance.get_dm_user(id, opts)
|
|
340
|
+
p result
|
|
341
|
+
rescue Spatio::ApiError => e
|
|
342
|
+
puts "Error when calling DirectMessagesApi->get_dm_user: #{e}"
|
|
343
|
+
end
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
#### Using the get_dm_user_with_http_info variant
|
|
347
|
+
|
|
348
|
+
This returns an Array which contains the response data, status code and headers.
|
|
349
|
+
|
|
350
|
+
> <Array(<GetChatUserResponse>, Integer, Hash)> get_dm_user_with_http_info(id, opts)
|
|
351
|
+
|
|
352
|
+
```ruby
|
|
353
|
+
begin
|
|
354
|
+
# Fetch one chat user.
|
|
355
|
+
data, status_code, headers = api_instance.get_dm_user_with_http_info(id, opts)
|
|
356
|
+
p status_code # => 2xx
|
|
357
|
+
p headers # => { ... }
|
|
358
|
+
p data # => <GetChatUserResponse>
|
|
359
|
+
rescue Spatio::ApiError => e
|
|
360
|
+
puts "Error when calling DirectMessagesApi->get_dm_user_with_http_info: #{e}"
|
|
361
|
+
end
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### Parameters
|
|
365
|
+
|
|
366
|
+
| Name | Type | Description | Notes |
|
|
367
|
+
| ---- | ---- | ----------- | ----- |
|
|
368
|
+
| **id** | **String** | Chat-user id (provider-scoped). | |
|
|
369
|
+
| **account_id** | **String** | | [optional] |
|
|
370
|
+
|
|
371
|
+
### Return type
|
|
372
|
+
|
|
373
|
+
[**GetChatUserResponse**](GetChatUserResponse.md)
|
|
374
|
+
|
|
375
|
+
### Authorization
|
|
376
|
+
|
|
377
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
378
|
+
|
|
379
|
+
### HTTP request headers
|
|
380
|
+
|
|
381
|
+
- **Content-Type**: Not defined
|
|
382
|
+
- **Accept**: application/json
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
## list_direct_conversations_enriched
|
|
386
|
+
|
|
387
|
+
> Hash<String, Object> list_direct_conversations_enriched(opts)
|
|
388
|
+
|
|
389
|
+
Enriched DM conversation list with unread + pin + draft state.
|
|
390
|
+
|
|
391
|
+
Native fast-path. Returns conversations augmented with the DM-feature state (unread counts, pinned/muted flags, saved drafts) the renderer's DM UI consumes. The shape is provider-specific and treated as opaque.
|
|
392
|
+
|
|
393
|
+
### Examples
|
|
394
|
+
|
|
395
|
+
```ruby
|
|
396
|
+
require 'time'
|
|
397
|
+
require 'spatio-sdk'
|
|
398
|
+
# setup authorization
|
|
399
|
+
Spatio.configure do |config|
|
|
400
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
401
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
402
|
+
end
|
|
403
|
+
|
|
404
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
405
|
+
opts = {
|
|
406
|
+
account_id: 'account_id_example', # String |
|
|
407
|
+
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.
|
|
408
|
+
}
|
|
409
|
+
|
|
410
|
+
begin
|
|
411
|
+
# Enriched DM conversation list with unread + pin + draft state.
|
|
412
|
+
result = api_instance.list_direct_conversations_enriched(opts)
|
|
413
|
+
p result
|
|
414
|
+
rescue Spatio::ApiError => e
|
|
415
|
+
puts "Error when calling DirectMessagesApi->list_direct_conversations_enriched: #{e}"
|
|
416
|
+
end
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
#### Using the list_direct_conversations_enriched_with_http_info variant
|
|
420
|
+
|
|
421
|
+
This returns an Array which contains the response data, status code and headers.
|
|
422
|
+
|
|
423
|
+
> <Array(Hash<String, Object>, Integer, Hash)> list_direct_conversations_enriched_with_http_info(opts)
|
|
424
|
+
|
|
425
|
+
```ruby
|
|
426
|
+
begin
|
|
427
|
+
# Enriched DM conversation list with unread + pin + draft state.
|
|
428
|
+
data, status_code, headers = api_instance.list_direct_conversations_enriched_with_http_info(opts)
|
|
429
|
+
p status_code # => 2xx
|
|
430
|
+
p headers # => { ... }
|
|
431
|
+
p data # => Hash<String, Object>
|
|
432
|
+
rescue Spatio::ApiError => e
|
|
433
|
+
puts "Error when calling DirectMessagesApi->list_direct_conversations_enriched_with_http_info: #{e}"
|
|
434
|
+
end
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
### Parameters
|
|
438
|
+
|
|
439
|
+
| Name | Type | Description | Notes |
|
|
440
|
+
| ---- | ---- | ----------- | ----- |
|
|
441
|
+
| **account_id** | **String** | | [optional] |
|
|
442
|
+
| **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] |
|
|
443
|
+
|
|
444
|
+
### Return type
|
|
445
|
+
|
|
446
|
+
**Hash<String, Object>**
|
|
447
|
+
|
|
448
|
+
### Authorization
|
|
449
|
+
|
|
450
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
451
|
+
|
|
452
|
+
### HTTP request headers
|
|
453
|
+
|
|
454
|
+
- **Content-Type**: Not defined
|
|
455
|
+
- **Accept**: application/json
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
## list_direct_message_conversations
|
|
459
|
+
|
|
460
|
+
> <ListChannelsResponse> list_direct_message_conversations(opts)
|
|
461
|
+
|
|
462
|
+
List 1:1 and group DM conversations.
|
|
463
|
+
|
|
464
|
+
Returns DM-type conversations only (`type: im | mpim`). Channel-type conversations are surfaced via `/v1/channels`.
|
|
465
|
+
|
|
466
|
+
### Examples
|
|
467
|
+
|
|
468
|
+
```ruby
|
|
469
|
+
require 'time'
|
|
470
|
+
require 'spatio-sdk'
|
|
471
|
+
# setup authorization
|
|
472
|
+
Spatio.configure do |config|
|
|
473
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
474
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
475
|
+
end
|
|
476
|
+
|
|
477
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
478
|
+
opts = {
|
|
479
|
+
account_ids: ['inner_example'], # Array<String> | Repeatable. Restrict to these connected-account row ids. Mutually orthogonal to `providers` — when both are set the intersection is used.
|
|
480
|
+
providers: ['inner_example'], # Array<String> | Repeatable. Restrict to these provider ids (`gmail`, `outlook`).
|
|
481
|
+
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.
|
|
482
|
+
limit: 56, # Integer |
|
|
483
|
+
cursor: 'cursor_example', # String |
|
|
484
|
+
include_archived: true # Boolean |
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
begin
|
|
488
|
+
# List 1:1 and group DM conversations.
|
|
489
|
+
result = api_instance.list_direct_message_conversations(opts)
|
|
490
|
+
p result
|
|
491
|
+
rescue Spatio::ApiError => e
|
|
492
|
+
puts "Error when calling DirectMessagesApi->list_direct_message_conversations: #{e}"
|
|
493
|
+
end
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
#### Using the list_direct_message_conversations_with_http_info variant
|
|
497
|
+
|
|
498
|
+
This returns an Array which contains the response data, status code and headers.
|
|
499
|
+
|
|
500
|
+
> <Array(<ListChannelsResponse>, Integer, Hash)> list_direct_message_conversations_with_http_info(opts)
|
|
501
|
+
|
|
502
|
+
```ruby
|
|
503
|
+
begin
|
|
504
|
+
# List 1:1 and group DM conversations.
|
|
505
|
+
data, status_code, headers = api_instance.list_direct_message_conversations_with_http_info(opts)
|
|
506
|
+
p status_code # => 2xx
|
|
507
|
+
p headers # => { ... }
|
|
508
|
+
p data # => <ListChannelsResponse>
|
|
509
|
+
rescue Spatio::ApiError => e
|
|
510
|
+
puts "Error when calling DirectMessagesApi->list_direct_message_conversations_with_http_info: #{e}"
|
|
511
|
+
end
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### Parameters
|
|
515
|
+
|
|
516
|
+
| Name | Type | Description | Notes |
|
|
517
|
+
| ---- | ---- | ----------- | ----- |
|
|
518
|
+
| **account_ids** | [**Array<String>**](String.md) | Repeatable. Restrict to these connected-account row ids. Mutually orthogonal to `providers` — when both are set the intersection is used. | [optional] |
|
|
519
|
+
| **providers** | [**Array<String>**](String.md) | Repeatable. Restrict to these provider ids (`gmail`, `outlook`). | [optional] |
|
|
520
|
+
| **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] |
|
|
521
|
+
| **limit** | **Integer** | | [optional] |
|
|
522
|
+
| **cursor** | **String** | | [optional] |
|
|
523
|
+
| **include_archived** | **Boolean** | | [optional][default to false] |
|
|
524
|
+
|
|
525
|
+
### Return type
|
|
526
|
+
|
|
527
|
+
[**ListChannelsResponse**](ListChannelsResponse.md)
|
|
528
|
+
|
|
529
|
+
### Authorization
|
|
530
|
+
|
|
531
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
532
|
+
|
|
533
|
+
### HTTP request headers
|
|
534
|
+
|
|
535
|
+
- **Content-Type**: Not defined
|
|
536
|
+
- **Accept**: application/json
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
## list_direct_messages
|
|
540
|
+
|
|
541
|
+
> <ListMessagesResponse> list_direct_messages(channel, opts)
|
|
542
|
+
|
|
543
|
+
List messages in a DM conversation.
|
|
544
|
+
|
|
545
|
+
### Examples
|
|
546
|
+
|
|
547
|
+
```ruby
|
|
548
|
+
require 'time'
|
|
549
|
+
require 'spatio-sdk'
|
|
550
|
+
# setup authorization
|
|
551
|
+
Spatio.configure do |config|
|
|
552
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
553
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
554
|
+
end
|
|
555
|
+
|
|
556
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
557
|
+
channel = 'channel_example' # String | DM conversation id.
|
|
558
|
+
opts = {
|
|
559
|
+
account_id: 'account_id_example', # String |
|
|
560
|
+
account_ids: ['inner_example'], # Array<String> | Repeatable. Restrict to these connected-account row ids. Mutually orthogonal to `providers` — when both are set the intersection is used.
|
|
561
|
+
providers: ['inner_example'], # Array<String> | Repeatable. Restrict to these provider ids (`gmail`, `outlook`).
|
|
562
|
+
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.
|
|
563
|
+
limit: 56, # Integer |
|
|
564
|
+
cursor: 'cursor_example', # String |
|
|
565
|
+
oldest_first: true # Boolean |
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
begin
|
|
569
|
+
# List messages in a DM conversation.
|
|
570
|
+
result = api_instance.list_direct_messages(channel, opts)
|
|
571
|
+
p result
|
|
572
|
+
rescue Spatio::ApiError => e
|
|
573
|
+
puts "Error when calling DirectMessagesApi->list_direct_messages: #{e}"
|
|
574
|
+
end
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
#### Using the list_direct_messages_with_http_info variant
|
|
578
|
+
|
|
579
|
+
This returns an Array which contains the response data, status code and headers.
|
|
580
|
+
|
|
581
|
+
> <Array(<ListMessagesResponse>, Integer, Hash)> list_direct_messages_with_http_info(channel, opts)
|
|
582
|
+
|
|
583
|
+
```ruby
|
|
584
|
+
begin
|
|
585
|
+
# List messages in a DM conversation.
|
|
586
|
+
data, status_code, headers = api_instance.list_direct_messages_with_http_info(channel, opts)
|
|
587
|
+
p status_code # => 2xx
|
|
588
|
+
p headers # => { ... }
|
|
589
|
+
p data # => <ListMessagesResponse>
|
|
590
|
+
rescue Spatio::ApiError => e
|
|
591
|
+
puts "Error when calling DirectMessagesApi->list_direct_messages_with_http_info: #{e}"
|
|
592
|
+
end
|
|
593
|
+
```
|
|
594
|
+
|
|
595
|
+
### Parameters
|
|
596
|
+
|
|
597
|
+
| Name | Type | Description | Notes |
|
|
598
|
+
| ---- | ---- | ----------- | ----- |
|
|
599
|
+
| **channel** | **String** | DM conversation id. | |
|
|
600
|
+
| **account_id** | **String** | | [optional] |
|
|
601
|
+
| **account_ids** | [**Array<String>**](String.md) | Repeatable. Restrict to these connected-account row ids. Mutually orthogonal to `providers` — when both are set the intersection is used. | [optional] |
|
|
602
|
+
| **providers** | [**Array<String>**](String.md) | Repeatable. Restrict to these provider ids (`gmail`, `outlook`). | [optional] |
|
|
603
|
+
| **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] |
|
|
604
|
+
| **limit** | **Integer** | | [optional] |
|
|
605
|
+
| **cursor** | **String** | | [optional] |
|
|
606
|
+
| **oldest_first** | **Boolean** | | [optional] |
|
|
607
|
+
|
|
608
|
+
### Return type
|
|
609
|
+
|
|
610
|
+
[**ListMessagesResponse**](ListMessagesResponse.md)
|
|
611
|
+
|
|
612
|
+
### Authorization
|
|
613
|
+
|
|
614
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
615
|
+
|
|
616
|
+
### HTTP request headers
|
|
617
|
+
|
|
618
|
+
- **Content-Type**: Not defined
|
|
619
|
+
- **Accept**: application/json
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
## list_dm_actions
|
|
623
|
+
|
|
624
|
+
> <ChatActionsList> list_dm_actions
|
|
625
|
+
|
|
626
|
+
Discover the action catalog for DirectMessages.
|
|
627
|
+
|
|
628
|
+
### Examples
|
|
629
|
+
|
|
630
|
+
```ruby
|
|
631
|
+
require 'time'
|
|
632
|
+
require 'spatio-sdk'
|
|
633
|
+
# setup authorization
|
|
634
|
+
Spatio.configure do |config|
|
|
635
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
636
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
637
|
+
end
|
|
638
|
+
|
|
639
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
640
|
+
|
|
641
|
+
begin
|
|
642
|
+
# Discover the action catalog for DirectMessages.
|
|
643
|
+
result = api_instance.list_dm_actions
|
|
644
|
+
p result
|
|
645
|
+
rescue Spatio::ApiError => e
|
|
646
|
+
puts "Error when calling DirectMessagesApi->list_dm_actions: #{e}"
|
|
647
|
+
end
|
|
648
|
+
```
|
|
649
|
+
|
|
650
|
+
#### Using the list_dm_actions_with_http_info variant
|
|
651
|
+
|
|
652
|
+
This returns an Array which contains the response data, status code and headers.
|
|
653
|
+
|
|
654
|
+
> <Array(<ChatActionsList>, Integer, Hash)> list_dm_actions_with_http_info
|
|
655
|
+
|
|
656
|
+
```ruby
|
|
657
|
+
begin
|
|
658
|
+
# Discover the action catalog for DirectMessages.
|
|
659
|
+
data, status_code, headers = api_instance.list_dm_actions_with_http_info
|
|
660
|
+
p status_code # => 2xx
|
|
661
|
+
p headers # => { ... }
|
|
662
|
+
p data # => <ChatActionsList>
|
|
663
|
+
rescue Spatio::ApiError => e
|
|
664
|
+
puts "Error when calling DirectMessagesApi->list_dm_actions_with_http_info: #{e}"
|
|
665
|
+
end
|
|
666
|
+
```
|
|
667
|
+
|
|
668
|
+
### Parameters
|
|
669
|
+
|
|
670
|
+
This endpoint does not need any parameter.
|
|
671
|
+
|
|
672
|
+
### Return type
|
|
673
|
+
|
|
674
|
+
[**ChatActionsList**](ChatActionsList.md)
|
|
675
|
+
|
|
676
|
+
### Authorization
|
|
677
|
+
|
|
678
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
679
|
+
|
|
680
|
+
### HTTP request headers
|
|
681
|
+
|
|
682
|
+
- **Content-Type**: Not defined
|
|
683
|
+
- **Accept**: application/json
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
## list_dm_pinned_messages
|
|
687
|
+
|
|
688
|
+
> <DMPinnedList> list_dm_pinned_messages(dm_id, opts)
|
|
689
|
+
|
|
690
|
+
List pinned messages in a DM conversation.
|
|
691
|
+
|
|
692
|
+
### Examples
|
|
693
|
+
|
|
694
|
+
```ruby
|
|
695
|
+
require 'time'
|
|
696
|
+
require 'spatio-sdk'
|
|
697
|
+
# setup authorization
|
|
698
|
+
Spatio.configure do |config|
|
|
699
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
700
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
701
|
+
end
|
|
702
|
+
|
|
703
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
704
|
+
dm_id = 'dm_id_example' # String | Direct-message conversation id.
|
|
705
|
+
opts = {
|
|
706
|
+
account_id: 'account_id_example' # String |
|
|
707
|
+
}
|
|
708
|
+
|
|
709
|
+
begin
|
|
710
|
+
# List pinned messages in a DM conversation.
|
|
711
|
+
result = api_instance.list_dm_pinned_messages(dm_id, opts)
|
|
712
|
+
p result
|
|
713
|
+
rescue Spatio::ApiError => e
|
|
714
|
+
puts "Error when calling DirectMessagesApi->list_dm_pinned_messages: #{e}"
|
|
715
|
+
end
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
#### Using the list_dm_pinned_messages_with_http_info variant
|
|
719
|
+
|
|
720
|
+
This returns an Array which contains the response data, status code and headers.
|
|
721
|
+
|
|
722
|
+
> <Array(<DMPinnedList>, Integer, Hash)> list_dm_pinned_messages_with_http_info(dm_id, opts)
|
|
723
|
+
|
|
724
|
+
```ruby
|
|
725
|
+
begin
|
|
726
|
+
# List pinned messages in a DM conversation.
|
|
727
|
+
data, status_code, headers = api_instance.list_dm_pinned_messages_with_http_info(dm_id, opts)
|
|
728
|
+
p status_code # => 2xx
|
|
729
|
+
p headers # => { ... }
|
|
730
|
+
p data # => <DMPinnedList>
|
|
731
|
+
rescue Spatio::ApiError => e
|
|
732
|
+
puts "Error when calling DirectMessagesApi->list_dm_pinned_messages_with_http_info: #{e}"
|
|
733
|
+
end
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
### Parameters
|
|
737
|
+
|
|
738
|
+
| Name | Type | Description | Notes |
|
|
739
|
+
| ---- | ---- | ----------- | ----- |
|
|
740
|
+
| **dm_id** | **String** | Direct-message conversation id. | |
|
|
741
|
+
| **account_id** | **String** | | [optional] |
|
|
742
|
+
|
|
743
|
+
### Return type
|
|
744
|
+
|
|
745
|
+
[**DMPinnedList**](DMPinnedList.md)
|
|
746
|
+
|
|
747
|
+
### Authorization
|
|
748
|
+
|
|
749
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
750
|
+
|
|
751
|
+
### HTTP request headers
|
|
752
|
+
|
|
753
|
+
- **Content-Type**: Not defined
|
|
754
|
+
- **Accept**: application/json
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
## list_dm_thread_replies
|
|
758
|
+
|
|
759
|
+
> Hash<String, Object> list_dm_thread_replies(dm_id, message_id, opts)
|
|
760
|
+
|
|
761
|
+
List replies in a DM message thread.
|
|
762
|
+
|
|
763
|
+
### Examples
|
|
764
|
+
|
|
765
|
+
```ruby
|
|
766
|
+
require 'time'
|
|
767
|
+
require 'spatio-sdk'
|
|
768
|
+
# setup authorization
|
|
769
|
+
Spatio.configure do |config|
|
|
770
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
771
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
772
|
+
end
|
|
773
|
+
|
|
774
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
775
|
+
dm_id = 'dm_id_example' # String | Direct-message conversation id.
|
|
776
|
+
message_id = 'message_id_example' # String | Chat-message id.
|
|
777
|
+
opts = {
|
|
778
|
+
account_id: 'account_id_example' # String |
|
|
779
|
+
}
|
|
780
|
+
|
|
781
|
+
begin
|
|
782
|
+
# List replies in a DM message thread.
|
|
783
|
+
result = api_instance.list_dm_thread_replies(dm_id, message_id, opts)
|
|
784
|
+
p result
|
|
785
|
+
rescue Spatio::ApiError => e
|
|
786
|
+
puts "Error when calling DirectMessagesApi->list_dm_thread_replies: #{e}"
|
|
787
|
+
end
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
#### Using the list_dm_thread_replies_with_http_info variant
|
|
791
|
+
|
|
792
|
+
This returns an Array which contains the response data, status code and headers.
|
|
793
|
+
|
|
794
|
+
> <Array(Hash<String, Object>, Integer, Hash)> list_dm_thread_replies_with_http_info(dm_id, message_id, opts)
|
|
795
|
+
|
|
796
|
+
```ruby
|
|
797
|
+
begin
|
|
798
|
+
# List replies in a DM message thread.
|
|
799
|
+
data, status_code, headers = api_instance.list_dm_thread_replies_with_http_info(dm_id, message_id, opts)
|
|
800
|
+
p status_code # => 2xx
|
|
801
|
+
p headers # => { ... }
|
|
802
|
+
p data # => Hash<String, Object>
|
|
803
|
+
rescue Spatio::ApiError => e
|
|
804
|
+
puts "Error when calling DirectMessagesApi->list_dm_thread_replies_with_http_info: #{e}"
|
|
805
|
+
end
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
### Parameters
|
|
809
|
+
|
|
810
|
+
| Name | Type | Description | Notes |
|
|
811
|
+
| ---- | ---- | ----------- | ----- |
|
|
812
|
+
| **dm_id** | **String** | Direct-message conversation id. | |
|
|
813
|
+
| **message_id** | **String** | Chat-message id. | |
|
|
814
|
+
| **account_id** | **String** | | [optional] |
|
|
815
|
+
|
|
816
|
+
### Return type
|
|
817
|
+
|
|
818
|
+
**Hash<String, Object>**
|
|
819
|
+
|
|
820
|
+
### Authorization
|
|
821
|
+
|
|
822
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
823
|
+
|
|
824
|
+
### HTTP request headers
|
|
825
|
+
|
|
826
|
+
- **Content-Type**: Not defined
|
|
827
|
+
- **Accept**: application/json
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
## list_dm_users
|
|
831
|
+
|
|
832
|
+
> <ListChatUsersResponse> list_dm_users(opts)
|
|
833
|
+
|
|
834
|
+
List chat users (DM contacts) across connected accounts.
|
|
835
|
+
|
|
836
|
+
### Examples
|
|
837
|
+
|
|
838
|
+
```ruby
|
|
839
|
+
require 'time'
|
|
840
|
+
require 'spatio-sdk'
|
|
841
|
+
# setup authorization
|
|
842
|
+
Spatio.configure do |config|
|
|
843
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
844
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
845
|
+
end
|
|
846
|
+
|
|
847
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
848
|
+
opts = {
|
|
849
|
+
account_ids: ['inner_example'], # Array<String> | Repeatable. Restrict to these connected-account row ids. Mutually orthogonal to `providers` — when both are set the intersection is used.
|
|
850
|
+
providers: ['inner_example'], # Array<String> | Repeatable. Restrict to these provider ids (`gmail`, `outlook`).
|
|
851
|
+
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.
|
|
852
|
+
limit: 56, # Integer |
|
|
853
|
+
cursor: 'cursor_example' # String |
|
|
854
|
+
}
|
|
855
|
+
|
|
856
|
+
begin
|
|
857
|
+
# List chat users (DM contacts) across connected accounts.
|
|
858
|
+
result = api_instance.list_dm_users(opts)
|
|
859
|
+
p result
|
|
860
|
+
rescue Spatio::ApiError => e
|
|
861
|
+
puts "Error when calling DirectMessagesApi->list_dm_users: #{e}"
|
|
862
|
+
end
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
#### Using the list_dm_users_with_http_info variant
|
|
866
|
+
|
|
867
|
+
This returns an Array which contains the response data, status code and headers.
|
|
868
|
+
|
|
869
|
+
> <Array(<ListChatUsersResponse>, Integer, Hash)> list_dm_users_with_http_info(opts)
|
|
870
|
+
|
|
871
|
+
```ruby
|
|
872
|
+
begin
|
|
873
|
+
# List chat users (DM contacts) across connected accounts.
|
|
874
|
+
data, status_code, headers = api_instance.list_dm_users_with_http_info(opts)
|
|
875
|
+
p status_code # => 2xx
|
|
876
|
+
p headers # => { ... }
|
|
877
|
+
p data # => <ListChatUsersResponse>
|
|
878
|
+
rescue Spatio::ApiError => e
|
|
879
|
+
puts "Error when calling DirectMessagesApi->list_dm_users_with_http_info: #{e}"
|
|
880
|
+
end
|
|
881
|
+
```
|
|
882
|
+
|
|
883
|
+
### Parameters
|
|
884
|
+
|
|
885
|
+
| Name | Type | Description | Notes |
|
|
886
|
+
| ---- | ---- | ----------- | ----- |
|
|
887
|
+
| **account_ids** | [**Array<String>**](String.md) | Repeatable. Restrict to these connected-account row ids. Mutually orthogonal to `providers` — when both are set the intersection is used. | [optional] |
|
|
888
|
+
| **providers** | [**Array<String>**](String.md) | Repeatable. Restrict to these provider ids (`gmail`, `outlook`). | [optional] |
|
|
889
|
+
| **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] |
|
|
890
|
+
| **limit** | **Integer** | | [optional] |
|
|
891
|
+
| **cursor** | **String** | | [optional] |
|
|
892
|
+
|
|
893
|
+
### Return type
|
|
894
|
+
|
|
895
|
+
[**ListChatUsersResponse**](ListChatUsersResponse.md)
|
|
896
|
+
|
|
897
|
+
### Authorization
|
|
898
|
+
|
|
899
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
900
|
+
|
|
901
|
+
### HTTP request headers
|
|
902
|
+
|
|
903
|
+
- **Content-Type**: Not defined
|
|
904
|
+
- **Accept**: application/json
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
## mark_dm_read
|
|
908
|
+
|
|
909
|
+
> <SuccessFlag> mark_dm_read(dm_id, dm_mark_read_request)
|
|
910
|
+
|
|
911
|
+
Mark a DM message read.
|
|
912
|
+
|
|
913
|
+
### Examples
|
|
914
|
+
|
|
915
|
+
```ruby
|
|
916
|
+
require 'time'
|
|
917
|
+
require 'spatio-sdk'
|
|
918
|
+
# setup authorization
|
|
919
|
+
Spatio.configure do |config|
|
|
920
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
921
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
922
|
+
end
|
|
923
|
+
|
|
924
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
925
|
+
dm_id = 'dm_id_example' # String | Direct-message conversation id.
|
|
926
|
+
dm_mark_read_request = Spatio::DMMarkReadRequest.new({message_id: 'message_id_example'}) # DMMarkReadRequest |
|
|
927
|
+
|
|
928
|
+
begin
|
|
929
|
+
# Mark a DM message read.
|
|
930
|
+
result = api_instance.mark_dm_read(dm_id, dm_mark_read_request)
|
|
931
|
+
p result
|
|
932
|
+
rescue Spatio::ApiError => e
|
|
933
|
+
puts "Error when calling DirectMessagesApi->mark_dm_read: #{e}"
|
|
934
|
+
end
|
|
935
|
+
```
|
|
936
|
+
|
|
937
|
+
#### Using the mark_dm_read_with_http_info variant
|
|
938
|
+
|
|
939
|
+
This returns an Array which contains the response data, status code and headers.
|
|
940
|
+
|
|
941
|
+
> <Array(<SuccessFlag>, Integer, Hash)> mark_dm_read_with_http_info(dm_id, dm_mark_read_request)
|
|
942
|
+
|
|
943
|
+
```ruby
|
|
944
|
+
begin
|
|
945
|
+
# Mark a DM message read.
|
|
946
|
+
data, status_code, headers = api_instance.mark_dm_read_with_http_info(dm_id, dm_mark_read_request)
|
|
947
|
+
p status_code # => 2xx
|
|
948
|
+
p headers # => { ... }
|
|
949
|
+
p data # => <SuccessFlag>
|
|
950
|
+
rescue Spatio::ApiError => e
|
|
951
|
+
puts "Error when calling DirectMessagesApi->mark_dm_read_with_http_info: #{e}"
|
|
952
|
+
end
|
|
953
|
+
```
|
|
954
|
+
|
|
955
|
+
### Parameters
|
|
956
|
+
|
|
957
|
+
| Name | Type | Description | Notes |
|
|
958
|
+
| ---- | ---- | ----------- | ----- |
|
|
959
|
+
| **dm_id** | **String** | Direct-message conversation id. | |
|
|
960
|
+
| **dm_mark_read_request** | [**DMMarkReadRequest**](DMMarkReadRequest.md) | | |
|
|
961
|
+
|
|
962
|
+
### Return type
|
|
963
|
+
|
|
964
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
965
|
+
|
|
966
|
+
### Authorization
|
|
967
|
+
|
|
968
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
969
|
+
|
|
970
|
+
### HTTP request headers
|
|
971
|
+
|
|
972
|
+
- **Content-Type**: application/json
|
|
973
|
+
- **Accept**: application/json
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
## mute_dm
|
|
977
|
+
|
|
978
|
+
> <DMMuteResponse> mute_dm(dm_id, dm_mute_request)
|
|
979
|
+
|
|
980
|
+
Mute a DM conversation (until a time, or forever).
|
|
981
|
+
|
|
982
|
+
### Examples
|
|
983
|
+
|
|
984
|
+
```ruby
|
|
985
|
+
require 'time'
|
|
986
|
+
require 'spatio-sdk'
|
|
987
|
+
# setup authorization
|
|
988
|
+
Spatio.configure do |config|
|
|
989
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
990
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
991
|
+
end
|
|
992
|
+
|
|
993
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
994
|
+
dm_id = 'dm_id_example' # String | Direct-message conversation id.
|
|
995
|
+
dm_mute_request = Spatio::DMMuteRequest.new # DMMuteRequest |
|
|
996
|
+
|
|
997
|
+
begin
|
|
998
|
+
# Mute a DM conversation (until a time, or forever).
|
|
999
|
+
result = api_instance.mute_dm(dm_id, dm_mute_request)
|
|
1000
|
+
p result
|
|
1001
|
+
rescue Spatio::ApiError => e
|
|
1002
|
+
puts "Error when calling DirectMessagesApi->mute_dm: #{e}"
|
|
1003
|
+
end
|
|
1004
|
+
```
|
|
1005
|
+
|
|
1006
|
+
#### Using the mute_dm_with_http_info variant
|
|
1007
|
+
|
|
1008
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1009
|
+
|
|
1010
|
+
> <Array(<DMMuteResponse>, Integer, Hash)> mute_dm_with_http_info(dm_id, dm_mute_request)
|
|
1011
|
+
|
|
1012
|
+
```ruby
|
|
1013
|
+
begin
|
|
1014
|
+
# Mute a DM conversation (until a time, or forever).
|
|
1015
|
+
data, status_code, headers = api_instance.mute_dm_with_http_info(dm_id, dm_mute_request)
|
|
1016
|
+
p status_code # => 2xx
|
|
1017
|
+
p headers # => { ... }
|
|
1018
|
+
p data # => <DMMuteResponse>
|
|
1019
|
+
rescue Spatio::ApiError => e
|
|
1020
|
+
puts "Error when calling DirectMessagesApi->mute_dm_with_http_info: #{e}"
|
|
1021
|
+
end
|
|
1022
|
+
```
|
|
1023
|
+
|
|
1024
|
+
### Parameters
|
|
1025
|
+
|
|
1026
|
+
| Name | Type | Description | Notes |
|
|
1027
|
+
| ---- | ---- | ----------- | ----- |
|
|
1028
|
+
| **dm_id** | **String** | Direct-message conversation id. | |
|
|
1029
|
+
| **dm_mute_request** | [**DMMuteRequest**](DMMuteRequest.md) | | |
|
|
1030
|
+
|
|
1031
|
+
### Return type
|
|
1032
|
+
|
|
1033
|
+
[**DMMuteResponse**](DMMuteResponse.md)
|
|
1034
|
+
|
|
1035
|
+
### Authorization
|
|
1036
|
+
|
|
1037
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1038
|
+
|
|
1039
|
+
### HTTP request headers
|
|
1040
|
+
|
|
1041
|
+
- **Content-Type**: application/json
|
|
1042
|
+
- **Accept**: application/json
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
## pin_dm_conversation
|
|
1046
|
+
|
|
1047
|
+
> <SuccessFlag> pin_dm_conversation(dm_id, opts)
|
|
1048
|
+
|
|
1049
|
+
Pin a DM conversation to the top of the sidebar.
|
|
1050
|
+
|
|
1051
|
+
### Examples
|
|
1052
|
+
|
|
1053
|
+
```ruby
|
|
1054
|
+
require 'time'
|
|
1055
|
+
require 'spatio-sdk'
|
|
1056
|
+
# setup authorization
|
|
1057
|
+
Spatio.configure do |config|
|
|
1058
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1059
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1060
|
+
end
|
|
1061
|
+
|
|
1062
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1063
|
+
dm_id = 'dm_id_example' # String | Direct-message conversation id.
|
|
1064
|
+
opts = {
|
|
1065
|
+
account_id: 'account_id_example' # String |
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
begin
|
|
1069
|
+
# Pin a DM conversation to the top of the sidebar.
|
|
1070
|
+
result = api_instance.pin_dm_conversation(dm_id, opts)
|
|
1071
|
+
p result
|
|
1072
|
+
rescue Spatio::ApiError => e
|
|
1073
|
+
puts "Error when calling DirectMessagesApi->pin_dm_conversation: #{e}"
|
|
1074
|
+
end
|
|
1075
|
+
```
|
|
1076
|
+
|
|
1077
|
+
#### Using the pin_dm_conversation_with_http_info variant
|
|
1078
|
+
|
|
1079
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1080
|
+
|
|
1081
|
+
> <Array(<SuccessFlag>, Integer, Hash)> pin_dm_conversation_with_http_info(dm_id, opts)
|
|
1082
|
+
|
|
1083
|
+
```ruby
|
|
1084
|
+
begin
|
|
1085
|
+
# Pin a DM conversation to the top of the sidebar.
|
|
1086
|
+
data, status_code, headers = api_instance.pin_dm_conversation_with_http_info(dm_id, opts)
|
|
1087
|
+
p status_code # => 2xx
|
|
1088
|
+
p headers # => { ... }
|
|
1089
|
+
p data # => <SuccessFlag>
|
|
1090
|
+
rescue Spatio::ApiError => e
|
|
1091
|
+
puts "Error when calling DirectMessagesApi->pin_dm_conversation_with_http_info: #{e}"
|
|
1092
|
+
end
|
|
1093
|
+
```
|
|
1094
|
+
|
|
1095
|
+
### Parameters
|
|
1096
|
+
|
|
1097
|
+
| Name | Type | Description | Notes |
|
|
1098
|
+
| ---- | ---- | ----------- | ----- |
|
|
1099
|
+
| **dm_id** | **String** | Direct-message conversation id. | |
|
|
1100
|
+
| **account_id** | **String** | | [optional] |
|
|
1101
|
+
|
|
1102
|
+
### Return type
|
|
1103
|
+
|
|
1104
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
1105
|
+
|
|
1106
|
+
### Authorization
|
|
1107
|
+
|
|
1108
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1109
|
+
|
|
1110
|
+
### HTTP request headers
|
|
1111
|
+
|
|
1112
|
+
- **Content-Type**: Not defined
|
|
1113
|
+
- **Accept**: application/json
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
## pin_dm_message
|
|
1117
|
+
|
|
1118
|
+
> <SuccessFlag> pin_dm_message(message_id, opts)
|
|
1119
|
+
|
|
1120
|
+
Pin a DM message.
|
|
1121
|
+
|
|
1122
|
+
### Examples
|
|
1123
|
+
|
|
1124
|
+
```ruby
|
|
1125
|
+
require 'time'
|
|
1126
|
+
require 'spatio-sdk'
|
|
1127
|
+
# setup authorization
|
|
1128
|
+
Spatio.configure do |config|
|
|
1129
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1130
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1131
|
+
end
|
|
1132
|
+
|
|
1133
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1134
|
+
message_id = 'message_id_example' # String | Chat-message id.
|
|
1135
|
+
opts = {
|
|
1136
|
+
channel_membership_request: Spatio::ChannelMembershipRequest.new # ChannelMembershipRequest |
|
|
1137
|
+
}
|
|
1138
|
+
|
|
1139
|
+
begin
|
|
1140
|
+
# Pin a DM message.
|
|
1141
|
+
result = api_instance.pin_dm_message(message_id, opts)
|
|
1142
|
+
p result
|
|
1143
|
+
rescue Spatio::ApiError => e
|
|
1144
|
+
puts "Error when calling DirectMessagesApi->pin_dm_message: #{e}"
|
|
1145
|
+
end
|
|
1146
|
+
```
|
|
1147
|
+
|
|
1148
|
+
#### Using the pin_dm_message_with_http_info variant
|
|
1149
|
+
|
|
1150
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1151
|
+
|
|
1152
|
+
> <Array(<SuccessFlag>, Integer, Hash)> pin_dm_message_with_http_info(message_id, opts)
|
|
1153
|
+
|
|
1154
|
+
```ruby
|
|
1155
|
+
begin
|
|
1156
|
+
# Pin a DM message.
|
|
1157
|
+
data, status_code, headers = api_instance.pin_dm_message_with_http_info(message_id, opts)
|
|
1158
|
+
p status_code # => 2xx
|
|
1159
|
+
p headers # => { ... }
|
|
1160
|
+
p data # => <SuccessFlag>
|
|
1161
|
+
rescue Spatio::ApiError => e
|
|
1162
|
+
puts "Error when calling DirectMessagesApi->pin_dm_message_with_http_info: #{e}"
|
|
1163
|
+
end
|
|
1164
|
+
```
|
|
1165
|
+
|
|
1166
|
+
### Parameters
|
|
1167
|
+
|
|
1168
|
+
| Name | Type | Description | Notes |
|
|
1169
|
+
| ---- | ---- | ----------- | ----- |
|
|
1170
|
+
| **message_id** | **String** | Chat-message id. | |
|
|
1171
|
+
| **channel_membership_request** | [**ChannelMembershipRequest**](ChannelMembershipRequest.md) | | [optional] |
|
|
1172
|
+
|
|
1173
|
+
### Return type
|
|
1174
|
+
|
|
1175
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
1176
|
+
|
|
1177
|
+
### Authorization
|
|
1178
|
+
|
|
1179
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1180
|
+
|
|
1181
|
+
### HTTP request headers
|
|
1182
|
+
|
|
1183
|
+
- **Content-Type**: application/json
|
|
1184
|
+
- **Accept**: application/json
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
## post_dm_thread_reply
|
|
1188
|
+
|
|
1189
|
+
> <DMMessageEnvelope> post_dm_thread_reply(dm_id, message_id, dm_thread_reply_request, opts)
|
|
1190
|
+
|
|
1191
|
+
Reply in a DM message thread.
|
|
1192
|
+
|
|
1193
|
+
### Examples
|
|
1194
|
+
|
|
1195
|
+
```ruby
|
|
1196
|
+
require 'time'
|
|
1197
|
+
require 'spatio-sdk'
|
|
1198
|
+
# setup authorization
|
|
1199
|
+
Spatio.configure do |config|
|
|
1200
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1201
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1202
|
+
end
|
|
1203
|
+
|
|
1204
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1205
|
+
dm_id = 'dm_id_example' # String | Direct-message conversation id.
|
|
1206
|
+
message_id = 'message_id_example' # String | Chat-message id.
|
|
1207
|
+
dm_thread_reply_request = Spatio::DMThreadReplyRequest.new({content: 'content_example'}) # DMThreadReplyRequest |
|
|
1208
|
+
opts = {
|
|
1209
|
+
account_id: 'account_id_example' # String |
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1212
|
+
begin
|
|
1213
|
+
# Reply in a DM message thread.
|
|
1214
|
+
result = api_instance.post_dm_thread_reply(dm_id, message_id, dm_thread_reply_request, opts)
|
|
1215
|
+
p result
|
|
1216
|
+
rescue Spatio::ApiError => e
|
|
1217
|
+
puts "Error when calling DirectMessagesApi->post_dm_thread_reply: #{e}"
|
|
1218
|
+
end
|
|
1219
|
+
```
|
|
1220
|
+
|
|
1221
|
+
#### Using the post_dm_thread_reply_with_http_info variant
|
|
1222
|
+
|
|
1223
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1224
|
+
|
|
1225
|
+
> <Array(<DMMessageEnvelope>, Integer, Hash)> post_dm_thread_reply_with_http_info(dm_id, message_id, dm_thread_reply_request, opts)
|
|
1226
|
+
|
|
1227
|
+
```ruby
|
|
1228
|
+
begin
|
|
1229
|
+
# Reply in a DM message thread.
|
|
1230
|
+
data, status_code, headers = api_instance.post_dm_thread_reply_with_http_info(dm_id, message_id, dm_thread_reply_request, opts)
|
|
1231
|
+
p status_code # => 2xx
|
|
1232
|
+
p headers # => { ... }
|
|
1233
|
+
p data # => <DMMessageEnvelope>
|
|
1234
|
+
rescue Spatio::ApiError => e
|
|
1235
|
+
puts "Error when calling DirectMessagesApi->post_dm_thread_reply_with_http_info: #{e}"
|
|
1236
|
+
end
|
|
1237
|
+
```
|
|
1238
|
+
|
|
1239
|
+
### Parameters
|
|
1240
|
+
|
|
1241
|
+
| Name | Type | Description | Notes |
|
|
1242
|
+
| ---- | ---- | ----------- | ----- |
|
|
1243
|
+
| **dm_id** | **String** | Direct-message conversation id. | |
|
|
1244
|
+
| **message_id** | **String** | Chat-message id. | |
|
|
1245
|
+
| **dm_thread_reply_request** | [**DMThreadReplyRequest**](DMThreadReplyRequest.md) | | |
|
|
1246
|
+
| **account_id** | **String** | | [optional] |
|
|
1247
|
+
|
|
1248
|
+
### Return type
|
|
1249
|
+
|
|
1250
|
+
[**DMMessageEnvelope**](DMMessageEnvelope.md)
|
|
1251
|
+
|
|
1252
|
+
### Authorization
|
|
1253
|
+
|
|
1254
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1255
|
+
|
|
1256
|
+
### HTTP request headers
|
|
1257
|
+
|
|
1258
|
+
- **Content-Type**: application/json
|
|
1259
|
+
- **Accept**: application/json
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
## remove_dm_reaction
|
|
1263
|
+
|
|
1264
|
+
> <DMReactionResponse> remove_dm_reaction(message_id, emoji, opts)
|
|
1265
|
+
|
|
1266
|
+
Remove a DM message reaction.
|
|
1267
|
+
|
|
1268
|
+
### Examples
|
|
1269
|
+
|
|
1270
|
+
```ruby
|
|
1271
|
+
require 'time'
|
|
1272
|
+
require 'spatio-sdk'
|
|
1273
|
+
# setup authorization
|
|
1274
|
+
Spatio.configure do |config|
|
|
1275
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1276
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1277
|
+
end
|
|
1278
|
+
|
|
1279
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1280
|
+
message_id = 'message_id_example' # String | Chat-message id.
|
|
1281
|
+
emoji = 'emoji_example' # String | Reaction emoji (e.g. `+1`, `eyes`, `pepper`).
|
|
1282
|
+
opts = {
|
|
1283
|
+
account_id: 'account_id_example' # String |
|
|
1284
|
+
}
|
|
1285
|
+
|
|
1286
|
+
begin
|
|
1287
|
+
# Remove a DM message reaction.
|
|
1288
|
+
result = api_instance.remove_dm_reaction(message_id, emoji, opts)
|
|
1289
|
+
p result
|
|
1290
|
+
rescue Spatio::ApiError => e
|
|
1291
|
+
puts "Error when calling DirectMessagesApi->remove_dm_reaction: #{e}"
|
|
1292
|
+
end
|
|
1293
|
+
```
|
|
1294
|
+
|
|
1295
|
+
#### Using the remove_dm_reaction_with_http_info variant
|
|
1296
|
+
|
|
1297
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1298
|
+
|
|
1299
|
+
> <Array(<DMReactionResponse>, Integer, Hash)> remove_dm_reaction_with_http_info(message_id, emoji, opts)
|
|
1300
|
+
|
|
1301
|
+
```ruby
|
|
1302
|
+
begin
|
|
1303
|
+
# Remove a DM message reaction.
|
|
1304
|
+
data, status_code, headers = api_instance.remove_dm_reaction_with_http_info(message_id, emoji, opts)
|
|
1305
|
+
p status_code # => 2xx
|
|
1306
|
+
p headers # => { ... }
|
|
1307
|
+
p data # => <DMReactionResponse>
|
|
1308
|
+
rescue Spatio::ApiError => e
|
|
1309
|
+
puts "Error when calling DirectMessagesApi->remove_dm_reaction_with_http_info: #{e}"
|
|
1310
|
+
end
|
|
1311
|
+
```
|
|
1312
|
+
|
|
1313
|
+
### Parameters
|
|
1314
|
+
|
|
1315
|
+
| Name | Type | Description | Notes |
|
|
1316
|
+
| ---- | ---- | ----------- | ----- |
|
|
1317
|
+
| **message_id** | **String** | Chat-message id. | |
|
|
1318
|
+
| **emoji** | **String** | Reaction emoji (e.g. `+1`, `eyes`, `pepper`). | |
|
|
1319
|
+
| **account_id** | **String** | | [optional] |
|
|
1320
|
+
|
|
1321
|
+
### Return type
|
|
1322
|
+
|
|
1323
|
+
[**DMReactionResponse**](DMReactionResponse.md)
|
|
1324
|
+
|
|
1325
|
+
### Authorization
|
|
1326
|
+
|
|
1327
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1328
|
+
|
|
1329
|
+
### HTTP request headers
|
|
1330
|
+
|
|
1331
|
+
- **Content-Type**: Not defined
|
|
1332
|
+
- **Accept**: application/json
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
## search_direct_messages
|
|
1336
|
+
|
|
1337
|
+
> <DMSearchResults> search_direct_messages(q, opts)
|
|
1338
|
+
|
|
1339
|
+
Search across DM messages.
|
|
1340
|
+
|
|
1341
|
+
### Examples
|
|
1342
|
+
|
|
1343
|
+
```ruby
|
|
1344
|
+
require 'time'
|
|
1345
|
+
require 'spatio-sdk'
|
|
1346
|
+
# setup authorization
|
|
1347
|
+
Spatio.configure do |config|
|
|
1348
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1349
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1350
|
+
end
|
|
1351
|
+
|
|
1352
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1353
|
+
q = 'q_example' # String | Free-form query string.
|
|
1354
|
+
opts = {
|
|
1355
|
+
limit: 56, # Integer |
|
|
1356
|
+
dm_id: 'dm_id_example', # String | Restrict to one conversation.
|
|
1357
|
+
user: 'user_example', # String | Restrict to messages from this user id.
|
|
1358
|
+
account_id: 'account_id_example' # String |
|
|
1359
|
+
}
|
|
1360
|
+
|
|
1361
|
+
begin
|
|
1362
|
+
# Search across DM messages.
|
|
1363
|
+
result = api_instance.search_direct_messages(q, opts)
|
|
1364
|
+
p result
|
|
1365
|
+
rescue Spatio::ApiError => e
|
|
1366
|
+
puts "Error when calling DirectMessagesApi->search_direct_messages: #{e}"
|
|
1367
|
+
end
|
|
1368
|
+
```
|
|
1369
|
+
|
|
1370
|
+
#### Using the search_direct_messages_with_http_info variant
|
|
1371
|
+
|
|
1372
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1373
|
+
|
|
1374
|
+
> <Array(<DMSearchResults>, Integer, Hash)> search_direct_messages_with_http_info(q, opts)
|
|
1375
|
+
|
|
1376
|
+
```ruby
|
|
1377
|
+
begin
|
|
1378
|
+
# Search across DM messages.
|
|
1379
|
+
data, status_code, headers = api_instance.search_direct_messages_with_http_info(q, opts)
|
|
1380
|
+
p status_code # => 2xx
|
|
1381
|
+
p headers # => { ... }
|
|
1382
|
+
p data # => <DMSearchResults>
|
|
1383
|
+
rescue Spatio::ApiError => e
|
|
1384
|
+
puts "Error when calling DirectMessagesApi->search_direct_messages_with_http_info: #{e}"
|
|
1385
|
+
end
|
|
1386
|
+
```
|
|
1387
|
+
|
|
1388
|
+
### Parameters
|
|
1389
|
+
|
|
1390
|
+
| Name | Type | Description | Notes |
|
|
1391
|
+
| ---- | ---- | ----------- | ----- |
|
|
1392
|
+
| **q** | **String** | Free-form query string. | |
|
|
1393
|
+
| **limit** | **Integer** | | [optional] |
|
|
1394
|
+
| **dm_id** | **String** | Restrict to one conversation. | [optional] |
|
|
1395
|
+
| **user** | **String** | Restrict to messages from this user id. | [optional] |
|
|
1396
|
+
| **account_id** | **String** | | [optional] |
|
|
1397
|
+
|
|
1398
|
+
### Return type
|
|
1399
|
+
|
|
1400
|
+
[**DMSearchResults**](DMSearchResults.md)
|
|
1401
|
+
|
|
1402
|
+
### Authorization
|
|
1403
|
+
|
|
1404
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1405
|
+
|
|
1406
|
+
### HTTP request headers
|
|
1407
|
+
|
|
1408
|
+
- **Content-Type**: Not defined
|
|
1409
|
+
- **Accept**: application/json
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
## send_direct_message
|
|
1413
|
+
|
|
1414
|
+
> <SendChatMessageResponse> send_direct_message(send_chat_message_request)
|
|
1415
|
+
|
|
1416
|
+
Send a DM.
|
|
1417
|
+
|
|
1418
|
+
### Examples
|
|
1419
|
+
|
|
1420
|
+
```ruby
|
|
1421
|
+
require 'time'
|
|
1422
|
+
require 'spatio-sdk'
|
|
1423
|
+
# setup authorization
|
|
1424
|
+
Spatio.configure do |config|
|
|
1425
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1426
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1427
|
+
end
|
|
1428
|
+
|
|
1429
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1430
|
+
send_chat_message_request = Spatio::SendChatMessageRequest.new({channel: 'channel_example', text: 'text_example'}) # SendChatMessageRequest |
|
|
1431
|
+
|
|
1432
|
+
begin
|
|
1433
|
+
# Send a DM.
|
|
1434
|
+
result = api_instance.send_direct_message(send_chat_message_request)
|
|
1435
|
+
p result
|
|
1436
|
+
rescue Spatio::ApiError => e
|
|
1437
|
+
puts "Error when calling DirectMessagesApi->send_direct_message: #{e}"
|
|
1438
|
+
end
|
|
1439
|
+
```
|
|
1440
|
+
|
|
1441
|
+
#### Using the send_direct_message_with_http_info variant
|
|
1442
|
+
|
|
1443
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1444
|
+
|
|
1445
|
+
> <Array(<SendChatMessageResponse>, Integer, Hash)> send_direct_message_with_http_info(send_chat_message_request)
|
|
1446
|
+
|
|
1447
|
+
```ruby
|
|
1448
|
+
begin
|
|
1449
|
+
# Send a DM.
|
|
1450
|
+
data, status_code, headers = api_instance.send_direct_message_with_http_info(send_chat_message_request)
|
|
1451
|
+
p status_code # => 2xx
|
|
1452
|
+
p headers # => { ... }
|
|
1453
|
+
p data # => <SendChatMessageResponse>
|
|
1454
|
+
rescue Spatio::ApiError => e
|
|
1455
|
+
puts "Error when calling DirectMessagesApi->send_direct_message_with_http_info: #{e}"
|
|
1456
|
+
end
|
|
1457
|
+
```
|
|
1458
|
+
|
|
1459
|
+
### Parameters
|
|
1460
|
+
|
|
1461
|
+
| Name | Type | Description | Notes |
|
|
1462
|
+
| ---- | ---- | ----------- | ----- |
|
|
1463
|
+
| **send_chat_message_request** | [**SendChatMessageRequest**](SendChatMessageRequest.md) | | |
|
|
1464
|
+
|
|
1465
|
+
### Return type
|
|
1466
|
+
|
|
1467
|
+
[**SendChatMessageResponse**](SendChatMessageResponse.md)
|
|
1468
|
+
|
|
1469
|
+
### Authorization
|
|
1470
|
+
|
|
1471
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1472
|
+
|
|
1473
|
+
### HTTP request headers
|
|
1474
|
+
|
|
1475
|
+
- **Content-Type**: application/json
|
|
1476
|
+
- **Accept**: application/json
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
## set_dm_draft
|
|
1480
|
+
|
|
1481
|
+
> <SuccessFlag> set_dm_draft(dm_id, dm_set_draft_request)
|
|
1482
|
+
|
|
1483
|
+
Save the unsent draft text for a DM.
|
|
1484
|
+
|
|
1485
|
+
### Examples
|
|
1486
|
+
|
|
1487
|
+
```ruby
|
|
1488
|
+
require 'time'
|
|
1489
|
+
require 'spatio-sdk'
|
|
1490
|
+
# setup authorization
|
|
1491
|
+
Spatio.configure do |config|
|
|
1492
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1493
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1494
|
+
end
|
|
1495
|
+
|
|
1496
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1497
|
+
dm_id = 'dm_id_example' # String | Direct-message conversation id.
|
|
1498
|
+
dm_set_draft_request = Spatio::DMSetDraftRequest.new({text: 'text_example'}) # DMSetDraftRequest |
|
|
1499
|
+
|
|
1500
|
+
begin
|
|
1501
|
+
# Save the unsent draft text for a DM.
|
|
1502
|
+
result = api_instance.set_dm_draft(dm_id, dm_set_draft_request)
|
|
1503
|
+
p result
|
|
1504
|
+
rescue Spatio::ApiError => e
|
|
1505
|
+
puts "Error when calling DirectMessagesApi->set_dm_draft: #{e}"
|
|
1506
|
+
end
|
|
1507
|
+
```
|
|
1508
|
+
|
|
1509
|
+
#### Using the set_dm_draft_with_http_info variant
|
|
1510
|
+
|
|
1511
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1512
|
+
|
|
1513
|
+
> <Array(<SuccessFlag>, Integer, Hash)> set_dm_draft_with_http_info(dm_id, dm_set_draft_request)
|
|
1514
|
+
|
|
1515
|
+
```ruby
|
|
1516
|
+
begin
|
|
1517
|
+
# Save the unsent draft text for a DM.
|
|
1518
|
+
data, status_code, headers = api_instance.set_dm_draft_with_http_info(dm_id, dm_set_draft_request)
|
|
1519
|
+
p status_code # => 2xx
|
|
1520
|
+
p headers # => { ... }
|
|
1521
|
+
p data # => <SuccessFlag>
|
|
1522
|
+
rescue Spatio::ApiError => e
|
|
1523
|
+
puts "Error when calling DirectMessagesApi->set_dm_draft_with_http_info: #{e}"
|
|
1524
|
+
end
|
|
1525
|
+
```
|
|
1526
|
+
|
|
1527
|
+
### Parameters
|
|
1528
|
+
|
|
1529
|
+
| Name | Type | Description | Notes |
|
|
1530
|
+
| ---- | ---- | ----------- | ----- |
|
|
1531
|
+
| **dm_id** | **String** | Direct-message conversation id. | |
|
|
1532
|
+
| **dm_set_draft_request** | [**DMSetDraftRequest**](DMSetDraftRequest.md) | | |
|
|
1533
|
+
|
|
1534
|
+
### Return type
|
|
1535
|
+
|
|
1536
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
1537
|
+
|
|
1538
|
+
### Authorization
|
|
1539
|
+
|
|
1540
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1541
|
+
|
|
1542
|
+
### HTTP request headers
|
|
1543
|
+
|
|
1544
|
+
- **Content-Type**: application/json
|
|
1545
|
+
- **Accept**: application/json
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
## unpin_dm_conversation
|
|
1549
|
+
|
|
1550
|
+
> <SuccessFlag> unpin_dm_conversation(dm_id, opts)
|
|
1551
|
+
|
|
1552
|
+
Unpin a DM conversation.
|
|
1553
|
+
|
|
1554
|
+
### Examples
|
|
1555
|
+
|
|
1556
|
+
```ruby
|
|
1557
|
+
require 'time'
|
|
1558
|
+
require 'spatio-sdk'
|
|
1559
|
+
# setup authorization
|
|
1560
|
+
Spatio.configure do |config|
|
|
1561
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1562
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1563
|
+
end
|
|
1564
|
+
|
|
1565
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1566
|
+
dm_id = 'dm_id_example' # String | Direct-message conversation id.
|
|
1567
|
+
opts = {
|
|
1568
|
+
account_id: 'account_id_example' # String |
|
|
1569
|
+
}
|
|
1570
|
+
|
|
1571
|
+
begin
|
|
1572
|
+
# Unpin a DM conversation.
|
|
1573
|
+
result = api_instance.unpin_dm_conversation(dm_id, opts)
|
|
1574
|
+
p result
|
|
1575
|
+
rescue Spatio::ApiError => e
|
|
1576
|
+
puts "Error when calling DirectMessagesApi->unpin_dm_conversation: #{e}"
|
|
1577
|
+
end
|
|
1578
|
+
```
|
|
1579
|
+
|
|
1580
|
+
#### Using the unpin_dm_conversation_with_http_info variant
|
|
1581
|
+
|
|
1582
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1583
|
+
|
|
1584
|
+
> <Array(<SuccessFlag>, Integer, Hash)> unpin_dm_conversation_with_http_info(dm_id, opts)
|
|
1585
|
+
|
|
1586
|
+
```ruby
|
|
1587
|
+
begin
|
|
1588
|
+
# Unpin a DM conversation.
|
|
1589
|
+
data, status_code, headers = api_instance.unpin_dm_conversation_with_http_info(dm_id, opts)
|
|
1590
|
+
p status_code # => 2xx
|
|
1591
|
+
p headers # => { ... }
|
|
1592
|
+
p data # => <SuccessFlag>
|
|
1593
|
+
rescue Spatio::ApiError => e
|
|
1594
|
+
puts "Error when calling DirectMessagesApi->unpin_dm_conversation_with_http_info: #{e}"
|
|
1595
|
+
end
|
|
1596
|
+
```
|
|
1597
|
+
|
|
1598
|
+
### Parameters
|
|
1599
|
+
|
|
1600
|
+
| Name | Type | Description | Notes |
|
|
1601
|
+
| ---- | ---- | ----------- | ----- |
|
|
1602
|
+
| **dm_id** | **String** | Direct-message conversation id. | |
|
|
1603
|
+
| **account_id** | **String** | | [optional] |
|
|
1604
|
+
|
|
1605
|
+
### Return type
|
|
1606
|
+
|
|
1607
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
1608
|
+
|
|
1609
|
+
### Authorization
|
|
1610
|
+
|
|
1611
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1612
|
+
|
|
1613
|
+
### HTTP request headers
|
|
1614
|
+
|
|
1615
|
+
- **Content-Type**: Not defined
|
|
1616
|
+
- **Accept**: application/json
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
## unpin_dm_message
|
|
1620
|
+
|
|
1621
|
+
> <SuccessFlag> unpin_dm_message(message_id, opts)
|
|
1622
|
+
|
|
1623
|
+
Unpin a DM message.
|
|
1624
|
+
|
|
1625
|
+
### Examples
|
|
1626
|
+
|
|
1627
|
+
```ruby
|
|
1628
|
+
require 'time'
|
|
1629
|
+
require 'spatio-sdk'
|
|
1630
|
+
# setup authorization
|
|
1631
|
+
Spatio.configure do |config|
|
|
1632
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1633
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1634
|
+
end
|
|
1635
|
+
|
|
1636
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1637
|
+
message_id = 'message_id_example' # String | Chat-message id.
|
|
1638
|
+
opts = {
|
|
1639
|
+
account_id: 'account_id_example' # String |
|
|
1640
|
+
}
|
|
1641
|
+
|
|
1642
|
+
begin
|
|
1643
|
+
# Unpin a DM message.
|
|
1644
|
+
result = api_instance.unpin_dm_message(message_id, opts)
|
|
1645
|
+
p result
|
|
1646
|
+
rescue Spatio::ApiError => e
|
|
1647
|
+
puts "Error when calling DirectMessagesApi->unpin_dm_message: #{e}"
|
|
1648
|
+
end
|
|
1649
|
+
```
|
|
1650
|
+
|
|
1651
|
+
#### Using the unpin_dm_message_with_http_info variant
|
|
1652
|
+
|
|
1653
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1654
|
+
|
|
1655
|
+
> <Array(<SuccessFlag>, Integer, Hash)> unpin_dm_message_with_http_info(message_id, opts)
|
|
1656
|
+
|
|
1657
|
+
```ruby
|
|
1658
|
+
begin
|
|
1659
|
+
# Unpin a DM message.
|
|
1660
|
+
data, status_code, headers = api_instance.unpin_dm_message_with_http_info(message_id, opts)
|
|
1661
|
+
p status_code # => 2xx
|
|
1662
|
+
p headers # => { ... }
|
|
1663
|
+
p data # => <SuccessFlag>
|
|
1664
|
+
rescue Spatio::ApiError => e
|
|
1665
|
+
puts "Error when calling DirectMessagesApi->unpin_dm_message_with_http_info: #{e}"
|
|
1666
|
+
end
|
|
1667
|
+
```
|
|
1668
|
+
|
|
1669
|
+
### Parameters
|
|
1670
|
+
|
|
1671
|
+
| Name | Type | Description | Notes |
|
|
1672
|
+
| ---- | ---- | ----------- | ----- |
|
|
1673
|
+
| **message_id** | **String** | Chat-message id. | |
|
|
1674
|
+
| **account_id** | **String** | | [optional] |
|
|
1675
|
+
|
|
1676
|
+
### Return type
|
|
1677
|
+
|
|
1678
|
+
[**SuccessFlag**](SuccessFlag.md)
|
|
1679
|
+
|
|
1680
|
+
### Authorization
|
|
1681
|
+
|
|
1682
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1683
|
+
|
|
1684
|
+
### HTTP request headers
|
|
1685
|
+
|
|
1686
|
+
- **Content-Type**: Not defined
|
|
1687
|
+
- **Accept**: application/json
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
## workspace_execute_dm_action
|
|
1691
|
+
|
|
1692
|
+
> Hash<String, Object> workspace_execute_dm_action(org, workspace, request_body)
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
### Examples
|
|
1697
|
+
|
|
1698
|
+
```ruby
|
|
1699
|
+
require 'time'
|
|
1700
|
+
require 'spatio-sdk'
|
|
1701
|
+
# setup authorization
|
|
1702
|
+
Spatio.configure do |config|
|
|
1703
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1704
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1705
|
+
end
|
|
1706
|
+
|
|
1707
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1708
|
+
org = 'org_example' # String |
|
|
1709
|
+
workspace = 'workspace_example' # String |
|
|
1710
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1711
|
+
|
|
1712
|
+
begin
|
|
1713
|
+
|
|
1714
|
+
result = api_instance.workspace_execute_dm_action(org, workspace, request_body)
|
|
1715
|
+
p result
|
|
1716
|
+
rescue Spatio::ApiError => e
|
|
1717
|
+
puts "Error when calling DirectMessagesApi->workspace_execute_dm_action: #{e}"
|
|
1718
|
+
end
|
|
1719
|
+
```
|
|
1720
|
+
|
|
1721
|
+
#### Using the workspace_execute_dm_action_with_http_info variant
|
|
1722
|
+
|
|
1723
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1724
|
+
|
|
1725
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_execute_dm_action_with_http_info(org, workspace, request_body)
|
|
1726
|
+
|
|
1727
|
+
```ruby
|
|
1728
|
+
begin
|
|
1729
|
+
|
|
1730
|
+
data, status_code, headers = api_instance.workspace_execute_dm_action_with_http_info(org, workspace, request_body)
|
|
1731
|
+
p status_code # => 2xx
|
|
1732
|
+
p headers # => { ... }
|
|
1733
|
+
p data # => Hash<String, Object>
|
|
1734
|
+
rescue Spatio::ApiError => e
|
|
1735
|
+
puts "Error when calling DirectMessagesApi->workspace_execute_dm_action_with_http_info: #{e}"
|
|
1736
|
+
end
|
|
1737
|
+
```
|
|
1738
|
+
|
|
1739
|
+
### Parameters
|
|
1740
|
+
|
|
1741
|
+
| Name | Type | Description | Notes |
|
|
1742
|
+
| ---- | ---- | ----------- | ----- |
|
|
1743
|
+
| **org** | **String** | | |
|
|
1744
|
+
| **workspace** | **String** | | |
|
|
1745
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1746
|
+
|
|
1747
|
+
### Return type
|
|
1748
|
+
|
|
1749
|
+
**Hash<String, Object>**
|
|
1750
|
+
|
|
1751
|
+
### Authorization
|
|
1752
|
+
|
|
1753
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1754
|
+
|
|
1755
|
+
### HTTP request headers
|
|
1756
|
+
|
|
1757
|
+
- **Content-Type**: application/json
|
|
1758
|
+
- **Accept**: application/json
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
## workspace_get_dm_user
|
|
1762
|
+
|
|
1763
|
+
> Hash<String, Object> workspace_get_dm_user(org, workspace, id)
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
### Examples
|
|
1768
|
+
|
|
1769
|
+
```ruby
|
|
1770
|
+
require 'time'
|
|
1771
|
+
require 'spatio-sdk'
|
|
1772
|
+
# setup authorization
|
|
1773
|
+
Spatio.configure do |config|
|
|
1774
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1775
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1776
|
+
end
|
|
1777
|
+
|
|
1778
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1779
|
+
org = 'org_example' # String |
|
|
1780
|
+
workspace = 'workspace_example' # String |
|
|
1781
|
+
id = 'id_example' # String |
|
|
1782
|
+
|
|
1783
|
+
begin
|
|
1784
|
+
|
|
1785
|
+
result = api_instance.workspace_get_dm_user(org, workspace, id)
|
|
1786
|
+
p result
|
|
1787
|
+
rescue Spatio::ApiError => e
|
|
1788
|
+
puts "Error when calling DirectMessagesApi->workspace_get_dm_user: #{e}"
|
|
1789
|
+
end
|
|
1790
|
+
```
|
|
1791
|
+
|
|
1792
|
+
#### Using the workspace_get_dm_user_with_http_info variant
|
|
1793
|
+
|
|
1794
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1795
|
+
|
|
1796
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_dm_user_with_http_info(org, workspace, id)
|
|
1797
|
+
|
|
1798
|
+
```ruby
|
|
1799
|
+
begin
|
|
1800
|
+
|
|
1801
|
+
data, status_code, headers = api_instance.workspace_get_dm_user_with_http_info(org, workspace, id)
|
|
1802
|
+
p status_code # => 2xx
|
|
1803
|
+
p headers # => { ... }
|
|
1804
|
+
p data # => Hash<String, Object>
|
|
1805
|
+
rescue Spatio::ApiError => e
|
|
1806
|
+
puts "Error when calling DirectMessagesApi->workspace_get_dm_user_with_http_info: #{e}"
|
|
1807
|
+
end
|
|
1808
|
+
```
|
|
1809
|
+
|
|
1810
|
+
### Parameters
|
|
1811
|
+
|
|
1812
|
+
| Name | Type | Description | Notes |
|
|
1813
|
+
| ---- | ---- | ----------- | ----- |
|
|
1814
|
+
| **org** | **String** | | |
|
|
1815
|
+
| **workspace** | **String** | | |
|
|
1816
|
+
| **id** | **String** | | |
|
|
1817
|
+
|
|
1818
|
+
### Return type
|
|
1819
|
+
|
|
1820
|
+
**Hash<String, Object>**
|
|
1821
|
+
|
|
1822
|
+
### Authorization
|
|
1823
|
+
|
|
1824
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1825
|
+
|
|
1826
|
+
### HTTP request headers
|
|
1827
|
+
|
|
1828
|
+
- **Content-Type**: Not defined
|
|
1829
|
+
- **Accept**: application/json
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
## workspace_list_direct_messages
|
|
1833
|
+
|
|
1834
|
+
> Hash<String, Object> workspace_list_direct_messages(org, workspace)
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
### Examples
|
|
1839
|
+
|
|
1840
|
+
```ruby
|
|
1841
|
+
require 'time'
|
|
1842
|
+
require 'spatio-sdk'
|
|
1843
|
+
# setup authorization
|
|
1844
|
+
Spatio.configure do |config|
|
|
1845
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1846
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1847
|
+
end
|
|
1848
|
+
|
|
1849
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1850
|
+
org = 'org_example' # String |
|
|
1851
|
+
workspace = 'workspace_example' # String |
|
|
1852
|
+
|
|
1853
|
+
begin
|
|
1854
|
+
|
|
1855
|
+
result = api_instance.workspace_list_direct_messages(org, workspace)
|
|
1856
|
+
p result
|
|
1857
|
+
rescue Spatio::ApiError => e
|
|
1858
|
+
puts "Error when calling DirectMessagesApi->workspace_list_direct_messages: #{e}"
|
|
1859
|
+
end
|
|
1860
|
+
```
|
|
1861
|
+
|
|
1862
|
+
#### Using the workspace_list_direct_messages_with_http_info variant
|
|
1863
|
+
|
|
1864
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1865
|
+
|
|
1866
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_direct_messages_with_http_info(org, workspace)
|
|
1867
|
+
|
|
1868
|
+
```ruby
|
|
1869
|
+
begin
|
|
1870
|
+
|
|
1871
|
+
data, status_code, headers = api_instance.workspace_list_direct_messages_with_http_info(org, workspace)
|
|
1872
|
+
p status_code # => 2xx
|
|
1873
|
+
p headers # => { ... }
|
|
1874
|
+
p data # => Hash<String, Object>
|
|
1875
|
+
rescue Spatio::ApiError => e
|
|
1876
|
+
puts "Error when calling DirectMessagesApi->workspace_list_direct_messages_with_http_info: #{e}"
|
|
1877
|
+
end
|
|
1878
|
+
```
|
|
1879
|
+
|
|
1880
|
+
### Parameters
|
|
1881
|
+
|
|
1882
|
+
| Name | Type | Description | Notes |
|
|
1883
|
+
| ---- | ---- | ----------- | ----- |
|
|
1884
|
+
| **org** | **String** | | |
|
|
1885
|
+
| **workspace** | **String** | | |
|
|
1886
|
+
|
|
1887
|
+
### Return type
|
|
1888
|
+
|
|
1889
|
+
**Hash<String, Object>**
|
|
1890
|
+
|
|
1891
|
+
### Authorization
|
|
1892
|
+
|
|
1893
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1894
|
+
|
|
1895
|
+
### HTTP request headers
|
|
1896
|
+
|
|
1897
|
+
- **Content-Type**: Not defined
|
|
1898
|
+
- **Accept**: application/json
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
## workspace_list_dm_actions
|
|
1902
|
+
|
|
1903
|
+
> Hash<String, Object> workspace_list_dm_actions(org, workspace)
|
|
1904
|
+
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
### Examples
|
|
1908
|
+
|
|
1909
|
+
```ruby
|
|
1910
|
+
require 'time'
|
|
1911
|
+
require 'spatio-sdk'
|
|
1912
|
+
# setup authorization
|
|
1913
|
+
Spatio.configure do |config|
|
|
1914
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1915
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1916
|
+
end
|
|
1917
|
+
|
|
1918
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1919
|
+
org = 'org_example' # String |
|
|
1920
|
+
workspace = 'workspace_example' # String |
|
|
1921
|
+
|
|
1922
|
+
begin
|
|
1923
|
+
|
|
1924
|
+
result = api_instance.workspace_list_dm_actions(org, workspace)
|
|
1925
|
+
p result
|
|
1926
|
+
rescue Spatio::ApiError => e
|
|
1927
|
+
puts "Error when calling DirectMessagesApi->workspace_list_dm_actions: #{e}"
|
|
1928
|
+
end
|
|
1929
|
+
```
|
|
1930
|
+
|
|
1931
|
+
#### Using the workspace_list_dm_actions_with_http_info variant
|
|
1932
|
+
|
|
1933
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1934
|
+
|
|
1935
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_dm_actions_with_http_info(org, workspace)
|
|
1936
|
+
|
|
1937
|
+
```ruby
|
|
1938
|
+
begin
|
|
1939
|
+
|
|
1940
|
+
data, status_code, headers = api_instance.workspace_list_dm_actions_with_http_info(org, workspace)
|
|
1941
|
+
p status_code # => 2xx
|
|
1942
|
+
p headers # => { ... }
|
|
1943
|
+
p data # => Hash<String, Object>
|
|
1944
|
+
rescue Spatio::ApiError => e
|
|
1945
|
+
puts "Error when calling DirectMessagesApi->workspace_list_dm_actions_with_http_info: #{e}"
|
|
1946
|
+
end
|
|
1947
|
+
```
|
|
1948
|
+
|
|
1949
|
+
### Parameters
|
|
1950
|
+
|
|
1951
|
+
| Name | Type | Description | Notes |
|
|
1952
|
+
| ---- | ---- | ----------- | ----- |
|
|
1953
|
+
| **org** | **String** | | |
|
|
1954
|
+
| **workspace** | **String** | | |
|
|
1955
|
+
|
|
1956
|
+
### Return type
|
|
1957
|
+
|
|
1958
|
+
**Hash<String, Object>**
|
|
1959
|
+
|
|
1960
|
+
### Authorization
|
|
1961
|
+
|
|
1962
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1963
|
+
|
|
1964
|
+
### HTTP request headers
|
|
1965
|
+
|
|
1966
|
+
- **Content-Type**: Not defined
|
|
1967
|
+
- **Accept**: application/json
|
|
1968
|
+
|
|
1969
|
+
|
|
1970
|
+
## workspace_list_dm_conversations
|
|
1971
|
+
|
|
1972
|
+
> Hash<String, Object> workspace_list_dm_conversations(org, workspace)
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
### Examples
|
|
1977
|
+
|
|
1978
|
+
```ruby
|
|
1979
|
+
require 'time'
|
|
1980
|
+
require 'spatio-sdk'
|
|
1981
|
+
# setup authorization
|
|
1982
|
+
Spatio.configure do |config|
|
|
1983
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1984
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1985
|
+
end
|
|
1986
|
+
|
|
1987
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
1988
|
+
org = 'org_example' # String |
|
|
1989
|
+
workspace = 'workspace_example' # String |
|
|
1990
|
+
|
|
1991
|
+
begin
|
|
1992
|
+
|
|
1993
|
+
result = api_instance.workspace_list_dm_conversations(org, workspace)
|
|
1994
|
+
p result
|
|
1995
|
+
rescue Spatio::ApiError => e
|
|
1996
|
+
puts "Error when calling DirectMessagesApi->workspace_list_dm_conversations: #{e}"
|
|
1997
|
+
end
|
|
1998
|
+
```
|
|
1999
|
+
|
|
2000
|
+
#### Using the workspace_list_dm_conversations_with_http_info variant
|
|
2001
|
+
|
|
2002
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2003
|
+
|
|
2004
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_dm_conversations_with_http_info(org, workspace)
|
|
2005
|
+
|
|
2006
|
+
```ruby
|
|
2007
|
+
begin
|
|
2008
|
+
|
|
2009
|
+
data, status_code, headers = api_instance.workspace_list_dm_conversations_with_http_info(org, workspace)
|
|
2010
|
+
p status_code # => 2xx
|
|
2011
|
+
p headers # => { ... }
|
|
2012
|
+
p data # => Hash<String, Object>
|
|
2013
|
+
rescue Spatio::ApiError => e
|
|
2014
|
+
puts "Error when calling DirectMessagesApi->workspace_list_dm_conversations_with_http_info: #{e}"
|
|
2015
|
+
end
|
|
2016
|
+
```
|
|
2017
|
+
|
|
2018
|
+
### Parameters
|
|
2019
|
+
|
|
2020
|
+
| Name | Type | Description | Notes |
|
|
2021
|
+
| ---- | ---- | ----------- | ----- |
|
|
2022
|
+
| **org** | **String** | | |
|
|
2023
|
+
| **workspace** | **String** | | |
|
|
2024
|
+
|
|
2025
|
+
### Return type
|
|
2026
|
+
|
|
2027
|
+
**Hash<String, Object>**
|
|
2028
|
+
|
|
2029
|
+
### Authorization
|
|
2030
|
+
|
|
2031
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2032
|
+
|
|
2033
|
+
### HTTP request headers
|
|
2034
|
+
|
|
2035
|
+
- **Content-Type**: Not defined
|
|
2036
|
+
- **Accept**: application/json
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
## workspace_list_dm_messages
|
|
2040
|
+
|
|
2041
|
+
> Hash<String, Object> workspace_list_dm_messages(org, workspace)
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
|
|
2045
|
+
### Examples
|
|
2046
|
+
|
|
2047
|
+
```ruby
|
|
2048
|
+
require 'time'
|
|
2049
|
+
require 'spatio-sdk'
|
|
2050
|
+
# setup authorization
|
|
2051
|
+
Spatio.configure do |config|
|
|
2052
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2053
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2054
|
+
end
|
|
2055
|
+
|
|
2056
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
2057
|
+
org = 'org_example' # String |
|
|
2058
|
+
workspace = 'workspace_example' # String |
|
|
2059
|
+
|
|
2060
|
+
begin
|
|
2061
|
+
|
|
2062
|
+
result = api_instance.workspace_list_dm_messages(org, workspace)
|
|
2063
|
+
p result
|
|
2064
|
+
rescue Spatio::ApiError => e
|
|
2065
|
+
puts "Error when calling DirectMessagesApi->workspace_list_dm_messages: #{e}"
|
|
2066
|
+
end
|
|
2067
|
+
```
|
|
2068
|
+
|
|
2069
|
+
#### Using the workspace_list_dm_messages_with_http_info variant
|
|
2070
|
+
|
|
2071
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2072
|
+
|
|
2073
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_dm_messages_with_http_info(org, workspace)
|
|
2074
|
+
|
|
2075
|
+
```ruby
|
|
2076
|
+
begin
|
|
2077
|
+
|
|
2078
|
+
data, status_code, headers = api_instance.workspace_list_dm_messages_with_http_info(org, workspace)
|
|
2079
|
+
p status_code # => 2xx
|
|
2080
|
+
p headers # => { ... }
|
|
2081
|
+
p data # => Hash<String, Object>
|
|
2082
|
+
rescue Spatio::ApiError => e
|
|
2083
|
+
puts "Error when calling DirectMessagesApi->workspace_list_dm_messages_with_http_info: #{e}"
|
|
2084
|
+
end
|
|
2085
|
+
```
|
|
2086
|
+
|
|
2087
|
+
### Parameters
|
|
2088
|
+
|
|
2089
|
+
| Name | Type | Description | Notes |
|
|
2090
|
+
| ---- | ---- | ----------- | ----- |
|
|
2091
|
+
| **org** | **String** | | |
|
|
2092
|
+
| **workspace** | **String** | | |
|
|
2093
|
+
|
|
2094
|
+
### Return type
|
|
2095
|
+
|
|
2096
|
+
**Hash<String, Object>**
|
|
2097
|
+
|
|
2098
|
+
### Authorization
|
|
2099
|
+
|
|
2100
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2101
|
+
|
|
2102
|
+
### HTTP request headers
|
|
2103
|
+
|
|
2104
|
+
- **Content-Type**: Not defined
|
|
2105
|
+
- **Accept**: application/json
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
## workspace_list_dm_users
|
|
2109
|
+
|
|
2110
|
+
> Hash<String, Object> workspace_list_dm_users(org, workspace)
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
### Examples
|
|
2115
|
+
|
|
2116
|
+
```ruby
|
|
2117
|
+
require 'time'
|
|
2118
|
+
require 'spatio-sdk'
|
|
2119
|
+
# setup authorization
|
|
2120
|
+
Spatio.configure do |config|
|
|
2121
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2122
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2123
|
+
end
|
|
2124
|
+
|
|
2125
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
2126
|
+
org = 'org_example' # String |
|
|
2127
|
+
workspace = 'workspace_example' # String |
|
|
2128
|
+
|
|
2129
|
+
begin
|
|
2130
|
+
|
|
2131
|
+
result = api_instance.workspace_list_dm_users(org, workspace)
|
|
2132
|
+
p result
|
|
2133
|
+
rescue Spatio::ApiError => e
|
|
2134
|
+
puts "Error when calling DirectMessagesApi->workspace_list_dm_users: #{e}"
|
|
2135
|
+
end
|
|
2136
|
+
```
|
|
2137
|
+
|
|
2138
|
+
#### Using the workspace_list_dm_users_with_http_info variant
|
|
2139
|
+
|
|
2140
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2141
|
+
|
|
2142
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_dm_users_with_http_info(org, workspace)
|
|
2143
|
+
|
|
2144
|
+
```ruby
|
|
2145
|
+
begin
|
|
2146
|
+
|
|
2147
|
+
data, status_code, headers = api_instance.workspace_list_dm_users_with_http_info(org, workspace)
|
|
2148
|
+
p status_code # => 2xx
|
|
2149
|
+
p headers # => { ... }
|
|
2150
|
+
p data # => Hash<String, Object>
|
|
2151
|
+
rescue Spatio::ApiError => e
|
|
2152
|
+
puts "Error when calling DirectMessagesApi->workspace_list_dm_users_with_http_info: #{e}"
|
|
2153
|
+
end
|
|
2154
|
+
```
|
|
2155
|
+
|
|
2156
|
+
### Parameters
|
|
2157
|
+
|
|
2158
|
+
| Name | Type | Description | Notes |
|
|
2159
|
+
| ---- | ---- | ----------- | ----- |
|
|
2160
|
+
| **org** | **String** | | |
|
|
2161
|
+
| **workspace** | **String** | | |
|
|
2162
|
+
|
|
2163
|
+
### Return type
|
|
2164
|
+
|
|
2165
|
+
**Hash<String, Object>**
|
|
2166
|
+
|
|
2167
|
+
### Authorization
|
|
2168
|
+
|
|
2169
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2170
|
+
|
|
2171
|
+
### HTTP request headers
|
|
2172
|
+
|
|
2173
|
+
- **Content-Type**: Not defined
|
|
2174
|
+
- **Accept**: application/json
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
## workspace_send_direct_message
|
|
2178
|
+
|
|
2179
|
+
> Hash<String, Object> workspace_send_direct_message(org, workspace, request_body)
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
### Examples
|
|
2184
|
+
|
|
2185
|
+
```ruby
|
|
2186
|
+
require 'time'
|
|
2187
|
+
require 'spatio-sdk'
|
|
2188
|
+
# setup authorization
|
|
2189
|
+
Spatio.configure do |config|
|
|
2190
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2191
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2192
|
+
end
|
|
2193
|
+
|
|
2194
|
+
api_instance = Spatio::DirectMessagesApi.new
|
|
2195
|
+
org = 'org_example' # String |
|
|
2196
|
+
workspace = 'workspace_example' # String |
|
|
2197
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2198
|
+
|
|
2199
|
+
begin
|
|
2200
|
+
|
|
2201
|
+
result = api_instance.workspace_send_direct_message(org, workspace, request_body)
|
|
2202
|
+
p result
|
|
2203
|
+
rescue Spatio::ApiError => e
|
|
2204
|
+
puts "Error when calling DirectMessagesApi->workspace_send_direct_message: #{e}"
|
|
2205
|
+
end
|
|
2206
|
+
```
|
|
2207
|
+
|
|
2208
|
+
#### Using the workspace_send_direct_message_with_http_info variant
|
|
2209
|
+
|
|
2210
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2211
|
+
|
|
2212
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_send_direct_message_with_http_info(org, workspace, request_body)
|
|
2213
|
+
|
|
2214
|
+
```ruby
|
|
2215
|
+
begin
|
|
2216
|
+
|
|
2217
|
+
data, status_code, headers = api_instance.workspace_send_direct_message_with_http_info(org, workspace, request_body)
|
|
2218
|
+
p status_code # => 2xx
|
|
2219
|
+
p headers # => { ... }
|
|
2220
|
+
p data # => Hash<String, Object>
|
|
2221
|
+
rescue Spatio::ApiError => e
|
|
2222
|
+
puts "Error when calling DirectMessagesApi->workspace_send_direct_message_with_http_info: #{e}"
|
|
2223
|
+
end
|
|
2224
|
+
```
|
|
2225
|
+
|
|
2226
|
+
### Parameters
|
|
2227
|
+
|
|
2228
|
+
| Name | Type | Description | Notes |
|
|
2229
|
+
| ---- | ---- | ----------- | ----- |
|
|
2230
|
+
| **org** | **String** | | |
|
|
2231
|
+
| **workspace** | **String** | | |
|
|
2232
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2233
|
+
|
|
2234
|
+
### Return type
|
|
2235
|
+
|
|
2236
|
+
**Hash<String, Object>**
|
|
2237
|
+
|
|
2238
|
+
### Authorization
|
|
2239
|
+
|
|
2240
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2241
|
+
|
|
2242
|
+
### HTTP request headers
|
|
2243
|
+
|
|
2244
|
+
- **Content-Type**: application/json
|
|
2245
|
+
- **Accept**: application/json
|
|
2246
|
+
|