spatio-sdk 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +31 -0
- data/Rakefile +10 -0
- data/docs/AcceptOrganizationInvitationRequest.md +18 -0
- data/docs/AccountApi.md +793 -0
- data/docs/AccountChoice.md +22 -0
- data/docs/AccountError.md +20 -0
- data/docs/AccountListResponse.md +22 -0
- data/docs/AccountPlan.md +24 -0
- data/docs/AccountStatus.md +28 -0
- data/docs/AccountTierDetails.md +46 -0
- data/docs/AccountUsage.md +32 -0
- data/docs/ActionDescriptor.md +32 -0
- data/docs/ActionsApi.md +409 -0
- data/docs/AddOrganizationMemberRequest.md +22 -0
- data/docs/AddWorkspaceMemberRequest.md +20 -0
- data/docs/Agent.md +40 -0
- data/docs/AgentConversation.md +28 -0
- data/docs/AgentConversationListResponse.md +20 -0
- data/docs/AgentListResponse.md +24 -0
- data/docs/AgentMessage.md +28 -0
- data/docs/AgentMessageListResponse.md +20 -0
- data/docs/AgentSessionContext.md +24 -0
- data/docs/AgentTaskUsage.md +26 -0
- data/docs/AgentsApi.md +884 -0
- data/docs/AmbiguousAccountError.md +22 -0
- data/docs/ApiError.md +20 -0
- data/docs/App.md +32 -0
- data/docs/AppFileContentResponse.md +20 -0
- data/docs/AppFileListResponse.md +18 -0
- data/docs/AppListResponse.md +20 -0
- data/docs/AppsApi.md +984 -0
- data/docs/AssignContactCategoryRequest.md +18 -0
- data/docs/Attachment.md +26 -0
- data/docs/AttachmentInput.md +24 -0
- data/docs/AttachmentMeta.md +24 -0
- data/docs/Attendee.md +30 -0
- data/docs/AttendeeRole.md +15 -0
- data/docs/AttendeeStatus.md +15 -0
- data/docs/Block.md +36 -0
- data/docs/BlockContent.md +38 -0
- data/docs/BlockListResponse.md +20 -0
- data/docs/BlockType.md +15 -0
- data/docs/BulkArchiveRequest.md +20 -0
- data/docs/BulkArchiveResponse.md +22 -0
- data/docs/BulkArchiveResponseFailedInner.md +20 -0
- data/docs/BulkDeleteEmailsRequest.md +22 -0
- data/docs/BulkDeleteEmailsResponse.md +22 -0
- data/docs/BulkDeleteFilesRequest.md +24 -0
- data/docs/BulkDeleteTasksRequest.md +24 -0
- data/docs/BulkDeleteTasksResponse.md +24 -0
- data/docs/BulkDeleteTasksResponseFailedInner.md +20 -0
- data/docs/BulkFilesResponse.md +24 -0
- data/docs/BulkFilesResponseFailedInner.md +20 -0
- data/docs/BulkMarkReadRequest.md +22 -0
- data/docs/BulkMarkReadResponse.md +20 -0
- data/docs/BulkMarkReadResponseFailedInner.md +20 -0
- data/docs/BulkMoveFilesRequest.md +26 -0
- data/docs/BulkUpdateTasksRequest.md +24 -0
- data/docs/BulkUpdateTasksResponse.md +24 -0
- data/docs/CalendarAccountError.md +24 -0
- data/docs/CalendarApi.md +1031 -0
- data/docs/CalendarCapabilitiesResponse.md +22 -0
- data/docs/CalendarOperationResult.md +24 -0
- data/docs/CalendarProviderInfo.md +26 -0
- data/docs/CalendarProvidersInfo.md +18 -0
- data/docs/CalendarSyncResponse.md +26 -0
- data/docs/CallListResponse.md +20 -0
- data/docs/CallRecording.md +30 -0
- data/docs/CallRecordingListResponse.md +18 -0
- data/docs/CallsApi.md +2096 -0
- data/docs/Cell.md +22 -0
- data/docs/ChangePasswordRequest.md +20 -0
- data/docs/Channel.md +38 -0
- data/docs/ChannelMembershipRequest.md +18 -0
- data/docs/ChannelsApi.md +1170 -0
- data/docs/ChatActionDefinition.md +34 -0
- data/docs/ChatActionsList.md +18 -0
- data/docs/ChatMessage.md +36 -0
- data/docs/ChatUser.md +34 -0
- data/docs/ChunkedFileManifest.md +34 -0
- data/docs/ClientRegistrationRequest.md +36 -0
- data/docs/ClientRegistrationResponse.md +38 -0
- data/docs/Comment.md +32 -0
- data/docs/CommentAuthor.md +24 -0
- data/docs/CommentListResponse.md +20 -0
- data/docs/CommentMutationResponse.md +20 -0
- data/docs/CommentResponse.md +18 -0
- data/docs/CommitChunkedUploadRequest.md +18 -0
- data/docs/CommitChunkedUploadResponse.md +36 -0
- data/docs/ConferenceData.md +28 -0
- data/docs/ConnectedAppItem.md +34 -0
- data/docs/ConnectedAppsListResponse.md +18 -0
- data/docs/ConnectionAccountListResponse.md +22 -0
- data/docs/ConnectionListResponse.md +20 -0
- data/docs/ConnectionsApi.md +748 -0
- data/docs/ConsumeAgentTaskResponse.md +26 -0
- data/docs/Contact.md +46 -0
- data/docs/ContactCategory.md +26 -0
- data/docs/ContactCategoryListResponse.md +18 -0
- data/docs/ContactListResponse.md +22 -0
- data/docs/ContactProvider.md +26 -0
- data/docs/ContactProviderListResponse.md +18 -0
- data/docs/ContactsApi.md +830 -0
- data/docs/Conversation.md +42 -0
- data/docs/ConversationMessage.md +28 -0
- data/docs/ConversationsApi.md +636 -0
- data/docs/CoreAction.md +30 -0
- data/docs/CoreActionListResponse.md +20 -0
- data/docs/CreateAgentConversationRequest.md +22 -0
- data/docs/CreateAgentMessageRequest.md +22 -0
- data/docs/CreateAgentRequest.md +30 -0
- data/docs/CreateAppRequest.md +26 -0
- data/docs/CreateBlockRequest.md +26 -0
- data/docs/CreateCalendarEvent201Response.md +24 -0
- data/docs/CreateCallRequest.md +24 -0
- data/docs/CreateChannelRequest.md +24 -0
- data/docs/CreateChannelResponse.md +20 -0
- data/docs/CreateCommentRequest.md +24 -0
- data/docs/CreateContactCategoryRequest.md +22 -0
- data/docs/CreateContactRequest.md +32 -0
- data/docs/CreateConversationRequest.md +26 -0
- data/docs/CreateDraftRequest.md +38 -0
- data/docs/CreateEmailFolderRequest.md +20 -0
- data/docs/CreateEventRequest.md +26 -0
- data/docs/CreateFolderRequest.md +26 -0
- data/docs/CreateLabelRequest.md +26 -0
- data/docs/CreateLabelResponse.md +20 -0
- data/docs/CreateMeetingRoomRequest.md +20 -0
- data/docs/CreateNote400Response.md +49 -0
- data/docs/CreateNoteRequest.md +32 -0
- data/docs/CreateOrganizationInvitationRequest.md +22 -0
- data/docs/CreateOrganizationRequest.md +28 -0
- data/docs/CreatePATRequest.md +26 -0
- data/docs/CreatePATResponse.md +20 -0
- data/docs/CreatePresentationRequest.md +26 -0
- data/docs/CreateRecordRequest.md +26 -0
- data/docs/CreateRecordTypeRequest.md +28 -0
- data/docs/CreateRoutineRequest.md +26 -0
- data/docs/CreateRowRequest.md +20 -0
- data/docs/CreateSheetRequest.md +30 -0
- data/docs/CreateSlideElementRequest.md +32 -0
- data/docs/CreateSlideRequest.md +34 -0
- data/docs/CreateTaskRequest.md +44 -0
- data/docs/CreateWorkspaceInvitationRequest.md +20 -0
- data/docs/CreateWorkspaceRequest.md +24 -0
- data/docs/DMAttachRequest.md +34 -0
- data/docs/DMForwardRequest.md +22 -0
- data/docs/DMMarkReadRequest.md +20 -0
- data/docs/DMMessageEnvelope.md +18 -0
- data/docs/DMMuteRequest.md +22 -0
- data/docs/DMMuteResponse.md +18 -0
- data/docs/DMPinnedList.md +18 -0
- data/docs/DMReactionRequest.md +20 -0
- data/docs/DMReactionResponse.md +18 -0
- data/docs/DMSearchResults.md +18 -0
- data/docs/DMSetDraftRequest.md +20 -0
- data/docs/DMThreadReplyRequest.md +20 -0
- data/docs/DirectMessagesApi.md +2246 -0
- data/docs/DisconnectConnectionRequest.md +20 -0
- data/docs/DiscoveryDocument.md +52 -0
- data/docs/DownloadFileResponse.md +20 -0
- data/docs/Draft.md +40 -0
- data/docs/DraftResponse.md +20 -0
- data/docs/Email.md +56 -0
- data/docs/EmailFolder.md +26 -0
- data/docs/EmailFolderListResponse.md +18 -0
- data/docs/EnableShareRequest.md +20 -0
- data/docs/ExecuteActionRequest.md +22 -0
- data/docs/ExecuteActionResponse.md +22 -0
- data/docs/ExecuteChatActionRequest.md +20 -0
- data/docs/ExecuteChatActionResponse.md +20 -0
- data/docs/ExportPDFR2Response.md +24 -0
- data/docs/ExportPDFRequest.md +20 -0
- data/docs/ExportPDFRequestRasterizedSlidesInner.md +20 -0
- data/docs/ExtractTextResult.md +24 -0
- data/docs/FederatedSearch200Response.md +28 -0
- data/docs/FederatedSearch200ResponseItemsInner.md +38 -0
- data/docs/FederatedSearch200ResponsePerPlatformValue.md +20 -0
- data/docs/FederatedSearchRequest.md +32 -0
- data/docs/FileListEnvelope.md +20 -0
- data/docs/FilesAndFoldersResponse.md +28 -0
- data/docs/FilesApi.md +2471 -0
- data/docs/Folder.md +32 -0
- data/docs/FolderListEnvelope.md +20 -0
- data/docs/FoldersApi.md +415 -0
- data/docs/GetChatUserResponse.md +20 -0
- data/docs/GetDomainLogo200Response.md +20 -0
- data/docs/GetEmailResponse.md +20 -0
- data/docs/GetThreadResponse.md +20 -0
- data/docs/InboxApi.md +424 -0
- data/docs/InboxCounts.md +22 -0
- data/docs/InboxItem.md +38 -0
- data/docs/InboxListResponse.md +22 -0
- data/docs/InitChunkedUploadRequest.md +30 -0
- data/docs/InitChunkedUploadResponse.md +26 -0
- data/docs/InstallConnectionRequest.md +22 -0
- data/docs/IntrospectionResponse.md +30 -0
- data/docs/IssueCollaborationToken200Response.md +26 -0
- data/docs/IssueCollaborationTokenRequest.md +18 -0
- data/docs/JWK.md +28 -0
- data/docs/JWKS.md +18 -0
- data/docs/KeyBinding.md +38 -0
- data/docs/KeyBindingListResponse.md +18 -0
- data/docs/KeybindingsApi.md +406 -0
- data/docs/Label.md +28 -0
- data/docs/LabelColor.md +20 -0
- data/docs/LinkRepoTaskRequest.md +18 -0
- data/docs/ListCalendarEvents200Response.md +24 -0
- data/docs/ListChannelsResponse.md +24 -0
- data/docs/ListChatUsersResponse.md +24 -0
- data/docs/ListDraftsResponse.md +24 -0
- data/docs/ListEmailsResponse.md +24 -0
- data/docs/ListEventsData.md +24 -0
- data/docs/ListLabelsResponse.md +20 -0
- data/docs/ListMessagesResponse.md +24 -0
- data/docs/LogosApi.md +211 -0
- data/docs/MailApi.md +3803 -0
- data/docs/MeetingRoom.md +24 -0
- data/docs/MiscApi.md +1213 -0
- data/docs/ModelsApi.md +483 -0
- data/docs/MoveBlockRequest.md +20 -0
- data/docs/MoveEmailsRequest.md +18 -0
- data/docs/MoveFileRequest.md +18 -0
- data/docs/MoveFileResponse.md +18 -0
- data/docs/NativeDMApi.md +1448 -0
- data/docs/NavigationApi.md +72 -0
- data/docs/Note.md +44 -0
- data/docs/NoteListEnvelope.md +20 -0
- data/docs/NotesApi.md +2413 -0
- data/docs/NotificationsApi.md +140 -0
- data/docs/OAuthApi.md +676 -0
- data/docs/OAuthError.md +20 -0
- data/docs/Organization.md +38 -0
- data/docs/OrganizationDetailLegacy.md +38 -0
- data/docs/OrganizationInvitation.md +38 -0
- data/docs/OrganizationInvitationListResponse.md +18 -0
- data/docs/OrganizationListResponse.md +18 -0
- data/docs/OrganizationMember.md +28 -0
- data/docs/OrganizationMemberInvitedBy.md +49 -0
- data/docs/OrganizationMemberListResponse.md +20 -0
- data/docs/OrganizationWorkspacesInner.md +22 -0
- data/docs/OrganizationsApi.md +1956 -0
- data/docs/PATListResponse.md +20 -0
- data/docs/PATScopesResponse.md +18 -0
- data/docs/PasswordRequiredError.md +24 -0
- data/docs/PersonalAccessToken.md +34 -0
- data/docs/PersonalAccessTokensApi.md +629 -0
- data/docs/PlatformsApi.md +1032 -0
- data/docs/PreconfiguredAgent.md +30 -0
- data/docs/Presentation.md +38 -0
- data/docs/PresentationListEnvelope.md +20 -0
- data/docs/ProposeRecommendationRequest.md +28 -0
- data/docs/PublicInvitationPayload.md +40 -0
- data/docs/QuotaExceededError.md +20 -0
- data/docs/RealtimeApi.md +79 -0
- data/docs/Recommendation.md +38 -0
- data/docs/RecommendationListResponse.md +18 -0
- data/docs/RecommendationsApi.md +354 -0
- data/docs/Record.md +32 -0
- data/docs/RecordListResponse.md +22 -0
- data/docs/RecordType.md +34 -0
- data/docs/RecordTypeListResponse.md +18 -0
- data/docs/RecordsApi.md +560 -0
- data/docs/RefreshConnectionRequest.md +20 -0
- data/docs/Reminder.md +20 -0
- data/docs/ReminderMethod.md +15 -0
- data/docs/ReplyEmailRequest.md +30 -0
- data/docs/RepoApi.md +2071 -0
- data/docs/ResourcesApi.md +220 -0
- data/docs/RevokeOtherSessionsResponse.md +18 -0
- data/docs/RichTextObject.md +24 -0
- data/docs/Routine.md +34 -0
- data/docs/RoutineListResponse.md +18 -0
- data/docs/RoutineRun.md +30 -0
- data/docs/RoutineRunCompleteRequest.md +20 -0
- data/docs/RoutineRunListResponse.md +18 -0
- data/docs/RoutineRunProgressRequest.md +20 -0
- data/docs/RoutinesApi.md +696 -0
- data/docs/Row.md +20 -0
- data/docs/RowList.md +20 -0
- data/docs/SaveMessageRequest.md +22 -0
- data/docs/SearchApi.md +77 -0
- data/docs/SearchEmailsResponse.md +24 -0
- data/docs/SearchFilesResponse.md +24 -0
- data/docs/SendChatMessageRequest.md +26 -0
- data/docs/SendChatMessageResponse.md +28 -0
- data/docs/SendEmailRequest.md +36 -0
- data/docs/SendEmailResponse.md +26 -0
- data/docs/Session.md +38 -0
- data/docs/SessionListResponse.md +18 -0
- data/docs/SettingsApi.md +745 -0
- data/docs/ShareSettings.md +26 -0
- data/docs/Sheet.md +48 -0
- data/docs/SheetListEnvelope.md +20 -0
- data/docs/SheetsApi.md +785 -0
- data/docs/SignInMethods.md +22 -0
- data/docs/SignInMethodsProvidersInner.md +24 -0
- data/docs/Slide.md +44 -0
- data/docs/SlideElement.md +40 -0
- data/docs/SlideElementList.md +20 -0
- data/docs/SlideList.md +20 -0
- data/docs/SlidesApi.md +1697 -0
- data/docs/SpatioCall.md +38 -0
- data/docs/SpatioConnection.md +38 -0
- data/docs/SpatioEvent.md +86 -0
- data/docs/SpatioFile.md +40 -0
- data/docs/SpatioThread.md +24 -0
- data/docs/SuccessFlag.md +18 -0
- data/docs/Task.md +58 -0
- data/docs/TaskComment.md +28 -0
- data/docs/TaskCommentAuthor.md +24 -0
- data/docs/TaskCommentList.md +20 -0
- data/docs/TaskCommentMutationResponse.md +20 -0
- data/docs/TaskCommentRequest.md +18 -0
- data/docs/TaskListEnvelope.md +20 -0
- data/docs/TaskProvidersInfo.md +20 -0
- data/docs/TaskProvidersInfoPlatform.md +20 -0
- data/docs/TasksApi.md +1783 -0
- data/docs/TerminalApi.md +345 -0
- data/docs/TextAnnotations.md +28 -0
- data/docs/TokenResponse.md +28 -0
- data/docs/UpdateAccountRequest.md +20 -0
- data/docs/UpdateAgentRequest.md +30 -0
- data/docs/UpdateAppRequest.md +24 -0
- data/docs/UpdateBlockRequest.md +22 -0
- data/docs/UpdateCellRequest.md +18 -0
- data/docs/UpdateCommentRequest.md +20 -0
- data/docs/UpdateContactCategoryRequest.md +22 -0
- data/docs/UpdateContactRequest.md +32 -0
- data/docs/UpdateConversationRequest.md +26 -0
- data/docs/UpdateDraftRequest.md +32 -0
- data/docs/UpdateEmailFolderRequest.md +18 -0
- data/docs/UpdateEmailRequest.md +26 -0
- data/docs/UpdateEmailResponse.md +20 -0
- data/docs/UpdateEventRequest.md +22 -0
- data/docs/UpdateFileRequest.md +22 -0
- data/docs/UpdateKeyBindingRequest.md +20 -0
- data/docs/UpdateMessageMetadataRequest.md +20 -0
- data/docs/UpdateNoteRequest.md +30 -0
- data/docs/UpdateOrganizationMemberRequest.md +18 -0
- data/docs/UpdateOrganizationRequest.md +22 -0
- data/docs/UpdatePATRequest.md +20 -0
- data/docs/UpdateParticipantStateRequest.md +22 -0
- data/docs/UpdatePresentationRequest.md +22 -0
- data/docs/UpdateRecommendationStatusRequest.md +18 -0
- data/docs/UpdateRecordRequest.md +22 -0
- data/docs/UpdateRecordTypeRequest.md +26 -0
- data/docs/UpdateRoutineRequest.md +26 -0
- data/docs/UpdateRowRequest.md +18 -0
- data/docs/UpdateSheetRequest.md +30 -0
- data/docs/UpdateSlideElementRequest.md +32 -0
- data/docs/UpdateSlideRequest.md +32 -0
- data/docs/UpdateTaskRequest.md +34 -0
- data/docs/UpdateWorkspaceMemberRequest.md +18 -0
- data/docs/UpdateWorkspaceRequest.md +24 -0
- data/docs/UploadChunkedBlockResponse.md +24 -0
- data/docs/UploadFileBase64Request.md +32 -0
- data/docs/UserInfoResponse.md +34 -0
- data/docs/ValidateKeyBindingRequest.md +22 -0
- data/docs/ValidateKeyBindingResponse.md +20 -0
- data/docs/Workspace.md +44 -0
- data/docs/WorkspaceEnvelope.md +18 -0
- data/docs/WorkspaceInvitation.md +34 -0
- data/docs/WorkspaceInvitationListResponse.md +18 -0
- data/docs/WorkspaceListResponse.md +20 -0
- data/docs/WorkspaceMember.md +30 -0
- data/docs/WorkspaceMemberListResponse.md +20 -0
- data/docs/WorkspaceOrganization.md +22 -0
- data/docs/WorkspacesApi.md +900 -0
- data/docs/WriteAppFileRequest.md +20 -0
- data/git_push.sh +57 -0
- data/lib/spatio-sdk/api/account_api.rb +703 -0
- data/lib/spatio-sdk/api/actions_api.rb +381 -0
- data/lib/spatio-sdk/api/agents_api.rb +824 -0
- data/lib/spatio-sdk/api/apps_api.rb +974 -0
- data/lib/spatio-sdk/api/calendar_api.rb +1015 -0
- data/lib/spatio-sdk/api/calls_api.rb +2016 -0
- data/lib/spatio-sdk/api/channels_api.rb +1165 -0
- data/lib/spatio-sdk/api/connections_api.rb +695 -0
- data/lib/spatio-sdk/api/contacts_api.rb +801 -0
- data/lib/spatio-sdk/api/conversations_api.rb +612 -0
- data/lib/spatio-sdk/api/direct_messages_api.rb +2167 -0
- data/lib/spatio-sdk/api/files_api.rb +2518 -0
- data/lib/spatio-sdk/api/folders_api.rb +409 -0
- data/lib/spatio-sdk/api/inbox_api.rb +403 -0
- data/lib/spatio-sdk/api/keybindings_api.rb +386 -0
- data/lib/spatio-sdk/api/logos_api.rb +210 -0
- data/lib/spatio-sdk/api/mail_api.rb +3780 -0
- data/lib/spatio-sdk/api/misc_api.rb +1100 -0
- data/lib/spatio-sdk/api/models_api.rb +456 -0
- data/lib/spatio-sdk/api/native_dm_api.rb +1396 -0
- data/lib/spatio-sdk/api/navigation_api.rb +77 -0
- data/lib/spatio-sdk/api/notes_api.rb +2418 -0
- data/lib/spatio-sdk/api/notifications_api.rb +143 -0
- data/lib/spatio-sdk/api/o_auth_api.rb +714 -0
- data/lib/spatio-sdk/api/organizations_api.rb +1913 -0
- data/lib/spatio-sdk/api/personal_access_tokens_api.rb +625 -0
- data/lib/spatio-sdk/api/platforms_api.rb +981 -0
- data/lib/spatio-sdk/api/realtime_api.rb +86 -0
- data/lib/spatio-sdk/api/recommendations_api.rb +346 -0
- data/lib/spatio-sdk/api/records_api.rb +550 -0
- data/lib/spatio-sdk/api/repo_api.rb +2167 -0
- data/lib/spatio-sdk/api/resources_api.rb +240 -0
- data/lib/spatio-sdk/api/routines_api.rb +670 -0
- data/lib/spatio-sdk/api/search_api.rb +90 -0
- data/lib/spatio-sdk/api/settings_api.rb +706 -0
- data/lib/spatio-sdk/api/sheets_api.rb +817 -0
- data/lib/spatio-sdk/api/slides_api.rb +1692 -0
- data/lib/spatio-sdk/api/tasks_api.rb +1787 -0
- data/lib/spatio-sdk/api/terminal_api.rb +337 -0
- data/lib/spatio-sdk/api/workspaces_api.rb +876 -0
- data/lib/spatio-sdk/api_client.rb +441 -0
- data/lib/spatio-sdk/api_error.rb +58 -0
- data/lib/spatio-sdk/api_model_base.rb +88 -0
- data/lib/spatio-sdk/configuration.rb +393 -0
- data/lib/spatio-sdk/models/accept_organization_invitation_request.rb +164 -0
- data/lib/spatio-sdk/models/account_choice.rb +200 -0
- data/lib/spatio-sdk/models/account_error.rb +191 -0
- data/lib/spatio-sdk/models/account_list_response.rb +171 -0
- data/lib/spatio-sdk/models/account_plan.rb +228 -0
- data/lib/spatio-sdk/models/account_status.rb +273 -0
- data/lib/spatio-sdk/models/account_tier_details.rb +291 -0
- data/lib/spatio-sdk/models/account_usage.rb +229 -0
- data/lib/spatio-sdk/models/action_descriptor.rb +230 -0
- data/lib/spatio-sdk/models/add_organization_member_request.rb +216 -0
- data/lib/spatio-sdk/models/add_workspace_member_request.rb +214 -0
- data/lib/spatio-sdk/models/agent.rb +268 -0
- data/lib/spatio-sdk/models/agent_conversation.rb +212 -0
- data/lib/spatio-sdk/models/agent_conversation_list_response.rb +175 -0
- data/lib/spatio-sdk/models/agent_list_response.rb +179 -0
- data/lib/spatio-sdk/models/agent_message.rb +228 -0
- data/lib/spatio-sdk/models/agent_message_list_response.rb +175 -0
- data/lib/spatio-sdk/models/agent_session_context.rb +185 -0
- data/lib/spatio-sdk/models/agent_task_usage.rb +204 -0
- data/lib/spatio-sdk/models/ambiguous_account_error.rb +194 -0
- data/lib/spatio-sdk/models/api_error.rb +176 -0
- data/lib/spatio-sdk/models/app.rb +228 -0
- data/lib/spatio-sdk/models/app_file_content_response.rb +173 -0
- data/lib/spatio-sdk/models/app_file_list_response.rb +152 -0
- data/lib/spatio-sdk/models/app_list_response.rb +161 -0
- data/lib/spatio-sdk/models/assign_contact_category_request.rb +164 -0
- data/lib/spatio-sdk/models/attachment.rb +217 -0
- data/lib/spatio-sdk/models/attachment_input.rb +227 -0
- data/lib/spatio-sdk/models/attachment_meta.rb +243 -0
- data/lib/spatio-sdk/models/attendee.rb +292 -0
- data/lib/spatio-sdk/models/attendee_role.rb +41 -0
- data/lib/spatio-sdk/models/attendee_status.rb +42 -0
- data/lib/spatio-sdk/models/block.rb +390 -0
- data/lib/spatio-sdk/models/block_content.rb +252 -0
- data/lib/spatio-sdk/models/block_list_response.rb +193 -0
- data/lib/spatio-sdk/models/block_type.rb +61 -0
- data/lib/spatio-sdk/models/bulk_archive_request.rb +175 -0
- data/lib/spatio-sdk/models/bulk_archive_response.rb +222 -0
- data/lib/spatio-sdk/models/bulk_archive_response_failed_inner.rb +190 -0
- data/lib/spatio-sdk/models/bulk_delete_emails_request.rb +185 -0
- data/lib/spatio-sdk/models/bulk_delete_emails_response.rb +221 -0
- data/lib/spatio-sdk/models/bulk_delete_files_request.rb +180 -0
- data/lib/spatio-sdk/models/bulk_delete_tasks_request.rb +181 -0
- data/lib/spatio-sdk/models/bulk_delete_tasks_response.rb +247 -0
- data/lib/spatio-sdk/models/bulk_delete_tasks_response_failed_inner.rb +190 -0
- data/lib/spatio-sdk/models/bulk_files_response.rb +247 -0
- data/lib/spatio-sdk/models/bulk_files_response_failed_inner.rb +190 -0
- data/lib/spatio-sdk/models/bulk_mark_read_request.rb +187 -0
- data/lib/spatio-sdk/models/bulk_mark_read_response.rb +194 -0
- data/lib/spatio-sdk/models/bulk_mark_read_response_failed_inner.rb +190 -0
- data/lib/spatio-sdk/models/bulk_move_files_request.rb +191 -0
- data/lib/spatio-sdk/models/bulk_update_tasks_request.rb +213 -0
- data/lib/spatio-sdk/models/bulk_update_tasks_response.rb +246 -0
- data/lib/spatio-sdk/models/calendar_account_error.rb +242 -0
- data/lib/spatio-sdk/models/calendar_capabilities_response.rb +219 -0
- data/lib/spatio-sdk/models/calendar_operation_result.rb +198 -0
- data/lib/spatio-sdk/models/calendar_provider_info.rb +220 -0
- data/lib/spatio-sdk/models/calendar_providers_info.rb +167 -0
- data/lib/spatio-sdk/models/calendar_sync_response.rb +222 -0
- data/lib/spatio-sdk/models/call_list_response.rb +161 -0
- data/lib/spatio-sdk/models/call_recording.rb +222 -0
- data/lib/spatio-sdk/models/call_recording_list_response.rb +152 -0
- data/lib/spatio-sdk/models/cell.rb +204 -0
- data/lib/spatio-sdk/models/change_password_request.rb +174 -0
- data/lib/spatio-sdk/models/channel.rb +325 -0
- data/lib/spatio-sdk/models/channel_membership_request.rb +148 -0
- data/lib/spatio-sdk/models/chat_action_definition.rb +278 -0
- data/lib/spatio-sdk/models/chat_actions_list.rb +166 -0
- data/lib/spatio-sdk/models/chat_message.rb +317 -0
- data/lib/spatio-sdk/models/chat_user.rb +287 -0
- data/lib/spatio-sdk/models/chunked_file_manifest.rb +324 -0
- data/lib/spatio-sdk/models/client_registration_request.rb +314 -0
- data/lib/spatio-sdk/models/client_registration_response.rb +329 -0
- data/lib/spatio-sdk/models/comment.rb +315 -0
- data/lib/spatio-sdk/models/comment_author.rb +226 -0
- data/lib/spatio-sdk/models/comment_list_response.rb +192 -0
- data/lib/spatio-sdk/models/comment_mutation_response.rb +191 -0
- data/lib/spatio-sdk/models/comment_response.rb +165 -0
- data/lib/spatio-sdk/models/commit_chunked_upload_request.rb +164 -0
- data/lib/spatio-sdk/models/commit_chunked_upload_response.rb +313 -0
- data/lib/spatio-sdk/models/conference_data.rb +229 -0
- data/lib/spatio-sdk/models/connected_app_item.rb +308 -0
- data/lib/spatio-sdk/models/connected_apps_list_response.rb +166 -0
- data/lib/spatio-sdk/models/connection_account_list_response.rb +172 -0
- data/lib/spatio-sdk/models/connection_list_response.rb +177 -0
- data/lib/spatio-sdk/models/consume_agent_task_response.rb +204 -0
- data/lib/spatio-sdk/models/contact.rb +294 -0
- data/lib/spatio-sdk/models/contact_category.rb +217 -0
- data/lib/spatio-sdk/models/contact_category_list_response.rb +152 -0
- data/lib/spatio-sdk/models/contact_list_response.rb +184 -0
- data/lib/spatio-sdk/models/contact_provider.rb +217 -0
- data/lib/spatio-sdk/models/contact_provider_list_response.rb +166 -0
- data/lib/spatio-sdk/models/conversation.rb +314 -0
- data/lib/spatio-sdk/models/conversation_message.rb +246 -0
- data/lib/spatio-sdk/models/core_action.rb +221 -0
- data/lib/spatio-sdk/models/core_action_list_response.rb +161 -0
- data/lib/spatio-sdk/models/create_agent_conversation_request.rb +167 -0
- data/lib/spatio-sdk/models/create_agent_message_request.rb +201 -0
- data/lib/spatio-sdk/models/create_agent_request.rb +222 -0
- data/lib/spatio-sdk/models/create_app_request.rb +200 -0
- data/lib/spatio-sdk/models/create_block_request.rb +260 -0
- data/lib/spatio-sdk/models/create_calendar_event201_response.rb +202 -0
- data/lib/spatio-sdk/models/create_call_request.rb +176 -0
- data/lib/spatio-sdk/models/create_channel_request.rb +191 -0
- data/lib/spatio-sdk/models/create_channel_response.rb +190 -0
- data/lib/spatio-sdk/models/create_comment_request.rb +177 -0
- data/lib/spatio-sdk/models/create_contact_category_request.rb +182 -0
- data/lib/spatio-sdk/models/create_contact_request.rb +212 -0
- data/lib/spatio-sdk/models/create_conversation_request.rb +185 -0
- data/lib/spatio-sdk/models/create_draft_request.rb +248 -0
- data/lib/spatio-sdk/models/create_email_folder_request.rb +173 -0
- data/lib/spatio-sdk/models/create_event_request.rb +254 -0
- data/lib/spatio-sdk/models/create_folder_request.rb +201 -0
- data/lib/spatio-sdk/models/create_label_request.rb +200 -0
- data/lib/spatio-sdk/models/create_label_response.rb +190 -0
- data/lib/spatio-sdk/models/create_meeting_room_request.rb +173 -0
- data/lib/spatio-sdk/models/create_note400_response.rb +104 -0
- data/lib/spatio-sdk/models/create_note_request.rb +232 -0
- data/lib/spatio-sdk/models/create_organization_invitation_request.rb +224 -0
- data/lib/spatio-sdk/models/create_organization_request.rb +211 -0
- data/lib/spatio-sdk/models/create_pat_request.rb +202 -0
- data/lib/spatio-sdk/models/create_pat_response.rb +174 -0
- data/lib/spatio-sdk/models/create_presentation_request.rb +200 -0
- data/lib/spatio-sdk/models/create_record_request.rb +204 -0
- data/lib/spatio-sdk/models/create_record_type_request.rb +211 -0
- data/lib/spatio-sdk/models/create_routine_request.rb +204 -0
- data/lib/spatio-sdk/models/create_row_request.rb +176 -0
- data/lib/spatio-sdk/models/create_sheet_request.rb +222 -0
- data/lib/spatio-sdk/models/create_slide_element_request.rb +229 -0
- data/lib/spatio-sdk/models/create_slide_request.rb +220 -0
- data/lib/spatio-sdk/models/create_task_request.rb +322 -0
- data/lib/spatio-sdk/models/create_workspace_invitation_request.rb +214 -0
- data/lib/spatio-sdk/models/create_workspace_request.rb +191 -0
- data/lib/spatio-sdk/models/disconnect_connection_request.rb +173 -0
- data/lib/spatio-sdk/models/discovery_document.rb +404 -0
- data/lib/spatio-sdk/models/dm_attach_request.rb +254 -0
- data/lib/spatio-sdk/models/dm_forward_request.rb +166 -0
- data/lib/spatio-sdk/models/dm_mark_read_request.rb +173 -0
- data/lib/spatio-sdk/models/dm_message_envelope.rb +165 -0
- data/lib/spatio-sdk/models/dm_mute_request.rb +166 -0
- data/lib/spatio-sdk/models/dm_mute_response.rb +148 -0
- data/lib/spatio-sdk/models/dm_pinned_list.rb +149 -0
- data/lib/spatio-sdk/models/dm_reaction_request.rb +173 -0
- data/lib/spatio-sdk/models/dm_reaction_response.rb +150 -0
- data/lib/spatio-sdk/models/dm_search_results.rb +149 -0
- data/lib/spatio-sdk/models/dm_set_draft_request.rb +173 -0
- data/lib/spatio-sdk/models/dm_thread_reply_request.rb +173 -0
- data/lib/spatio-sdk/models/download_file_response.rb +191 -0
- data/lib/spatio-sdk/models/draft.rb +339 -0
- data/lib/spatio-sdk/models/draft_response.rb +190 -0
- data/lib/spatio-sdk/models/email.rb +488 -0
- data/lib/spatio-sdk/models/email_folder.rb +202 -0
- data/lib/spatio-sdk/models/email_folder_list_response.rb +152 -0
- data/lib/spatio-sdk/models/enable_share_request.rb +157 -0
- data/lib/spatio-sdk/models/execute_action_request.rb +185 -0
- data/lib/spatio-sdk/models/execute_action_response.rb +168 -0
- data/lib/spatio-sdk/models/execute_chat_action_request.rb +175 -0
- data/lib/spatio-sdk/models/execute_chat_action_response.rb +175 -0
- data/lib/spatio-sdk/models/export_pdf_request.rb +162 -0
- data/lib/spatio-sdk/models/export_pdf_request_rasterized_slides_inner.rb +191 -0
- data/lib/spatio-sdk/models/export_pdfr2_response.rb +269 -0
- data/lib/spatio-sdk/models/extract_text_result.rb +212 -0
- data/lib/spatio-sdk/models/federated_search200_response.rb +270 -0
- data/lib/spatio-sdk/models/federated_search200_response_items_inner.rb +237 -0
- data/lib/spatio-sdk/models/federated_search200_response_per_platform_value.rb +156 -0
- data/lib/spatio-sdk/models/federated_search_request.rb +276 -0
- data/lib/spatio-sdk/models/file_list_envelope.rb +181 -0
- data/lib/spatio-sdk/models/files_and_folders_response.rb +235 -0
- data/lib/spatio-sdk/models/folder.rb +297 -0
- data/lib/spatio-sdk/models/folder_list_envelope.rb +181 -0
- data/lib/spatio-sdk/models/get_chat_user_response.rb +190 -0
- data/lib/spatio-sdk/models/get_domain_logo200_response.rb +190 -0
- data/lib/spatio-sdk/models/get_email_response.rb +190 -0
- data/lib/spatio-sdk/models/get_thread_response.rb +190 -0
- data/lib/spatio-sdk/models/inbox_counts.rb +216 -0
- data/lib/spatio-sdk/models/inbox_item.rb +275 -0
- data/lib/spatio-sdk/models/inbox_list_response.rb +218 -0
- data/lib/spatio-sdk/models/init_chunked_upload_request.rb +273 -0
- data/lib/spatio-sdk/models/init_chunked_upload_response.rb +273 -0
- data/lib/spatio-sdk/models/install_connection_request.rb +184 -0
- data/lib/spatio-sdk/models/introspection_response.rb +219 -0
- data/lib/spatio-sdk/models/issue_collaboration_token200_response.rb +254 -0
- data/lib/spatio-sdk/models/issue_collaboration_token_request.rb +148 -0
- data/lib/spatio-sdk/models/jwk.rb +297 -0
- data/lib/spatio-sdk/models/jwks.rb +166 -0
- data/lib/spatio-sdk/models/key_binding.rb +276 -0
- data/lib/spatio-sdk/models/key_binding_list_response.rb +166 -0
- data/lib/spatio-sdk/models/label.rb +244 -0
- data/lib/spatio-sdk/models/label_color.rb +190 -0
- data/lib/spatio-sdk/models/link_repo_task_request.rb +164 -0
- data/lib/spatio-sdk/models/list_calendar_events200_response.rb +202 -0
- data/lib/spatio-sdk/models/list_channels_response.rb +212 -0
- data/lib/spatio-sdk/models/list_chat_users_response.rb +211 -0
- data/lib/spatio-sdk/models/list_drafts_response.rb +227 -0
- data/lib/spatio-sdk/models/list_emails_response.rb +213 -0
- data/lib/spatio-sdk/models/list_events_data.rb +196 -0
- data/lib/spatio-sdk/models/list_labels_response.rb +192 -0
- data/lib/spatio-sdk/models/list_messages_response.rb +211 -0
- data/lib/spatio-sdk/models/meeting_room.rb +191 -0
- data/lib/spatio-sdk/models/move_block_request.rb +175 -0
- data/lib/spatio-sdk/models/move_emails_request.rb +166 -0
- data/lib/spatio-sdk/models/move_file_request.rb +149 -0
- data/lib/spatio-sdk/models/move_file_response.rb +164 -0
- data/lib/spatio-sdk/models/note.rb +380 -0
- data/lib/spatio-sdk/models/note_list_envelope.rb +195 -0
- data/lib/spatio-sdk/models/o_auth_error.rb +197 -0
- data/lib/spatio-sdk/models/organization.rb +346 -0
- data/lib/spatio-sdk/models/organization_detail_legacy.rb +377 -0
- data/lib/spatio-sdk/models/organization_invitation.rb +343 -0
- data/lib/spatio-sdk/models/organization_invitation_list_response.rb +166 -0
- data/lib/spatio-sdk/models/organization_list_response.rb +166 -0
- data/lib/spatio-sdk/models/organization_member.rb +288 -0
- data/lib/spatio-sdk/models/organization_member_invited_by.rb +105 -0
- data/lib/spatio-sdk/models/organization_member_list_response.rb +192 -0
- data/lib/spatio-sdk/models/organization_workspaces_inner.rb +216 -0
- data/lib/spatio-sdk/models/password_required_error.rb +218 -0
- data/lib/spatio-sdk/models/pat_list_response.rb +177 -0
- data/lib/spatio-sdk/models/pat_scopes_response.rb +166 -0
- data/lib/spatio-sdk/models/personal_access_token.rb +241 -0
- data/lib/spatio-sdk/models/preconfigured_agent.rb +236 -0
- data/lib/spatio-sdk/models/presentation.rb +308 -0
- data/lib/spatio-sdk/models/presentation_list_envelope.rb +194 -0
- data/lib/spatio-sdk/models/propose_recommendation_request.rb +211 -0
- data/lib/spatio-sdk/models/public_invitation_payload.rb +365 -0
- data/lib/spatio-sdk/models/quota_exceeded_error.rb +183 -0
- data/lib/spatio-sdk/models/recommendation.rb +300 -0
- data/lib/spatio-sdk/models/recommendation_list_response.rb +166 -0
- data/lib/spatio-sdk/models/record.rb +231 -0
- data/lib/spatio-sdk/models/record_list_response.rb +184 -0
- data/lib/spatio-sdk/models/record_type.rb +256 -0
- data/lib/spatio-sdk/models/record_type_list_response.rb +166 -0
- data/lib/spatio-sdk/models/refresh_connection_request.rb +173 -0
- data/lib/spatio-sdk/models/reminder.rb +213 -0
- data/lib/spatio-sdk/models/reminder_method.rb +42 -0
- data/lib/spatio-sdk/models/reply_email_request.rb +227 -0
- data/lib/spatio-sdk/models/revoke_other_sessions_response.rb +148 -0
- data/lib/spatio-sdk/models/rich_text_object.rb +216 -0
- data/lib/spatio-sdk/models/routine.rb +240 -0
- data/lib/spatio-sdk/models/routine_list_response.rb +166 -0
- data/lib/spatio-sdk/models/routine_run.rb +221 -0
- data/lib/spatio-sdk/models/routine_run_complete_request.rb +158 -0
- data/lib/spatio-sdk/models/routine_run_list_response.rb +166 -0
- data/lib/spatio-sdk/models/routine_run_progress_request.rb +158 -0
- data/lib/spatio-sdk/models/row.rb +194 -0
- data/lib/spatio-sdk/models/row_list.rb +192 -0
- data/lib/spatio-sdk/models/save_message_request.rb +201 -0
- data/lib/spatio-sdk/models/search_emails_response.rb +212 -0
- data/lib/spatio-sdk/models/search_files_response.rb +229 -0
- data/lib/spatio-sdk/models/send_chat_message_request.rb +221 -0
- data/lib/spatio-sdk/models/send_chat_message_response.rb +243 -0
- data/lib/spatio-sdk/models/send_email_request.rb +289 -0
- data/lib/spatio-sdk/models/send_email_response.rb +234 -0
- data/lib/spatio-sdk/models/session.rb +254 -0
- data/lib/spatio-sdk/models/session_list_response.rb +166 -0
- data/lib/spatio-sdk/models/share_settings.rb +221 -0
- data/lib/spatio-sdk/models/sheet.rb +446 -0
- data/lib/spatio-sdk/models/sheet_list_envelope.rb +195 -0
- data/lib/spatio-sdk/models/sign_in_methods.rb +201 -0
- data/lib/spatio-sdk/models/sign_in_methods_providers_inner.rb +193 -0
- data/lib/spatio-sdk/models/slide.rb +370 -0
- data/lib/spatio-sdk/models/slide_element.rb +455 -0
- data/lib/spatio-sdk/models/slide_element_list.rb +192 -0
- data/lib/spatio-sdk/models/slide_list.rb +192 -0
- data/lib/spatio-sdk/models/spatio_call.rb +259 -0
- data/lib/spatio-sdk/models/spatio_connection.rb +260 -0
- data/lib/spatio-sdk/models/spatio_event.rb +686 -0
- data/lib/spatio-sdk/models/spatio_file.rb +372 -0
- data/lib/spatio-sdk/models/spatio_thread.rb +212 -0
- data/lib/spatio-sdk/models/success_flag.rb +165 -0
- data/lib/spatio-sdk/models/task.rb +471 -0
- data/lib/spatio-sdk/models/task_comment.rb +294 -0
- data/lib/spatio-sdk/models/task_comment_author.rb +226 -0
- data/lib/spatio-sdk/models/task_comment_list.rb +192 -0
- data/lib/spatio-sdk/models/task_comment_mutation_response.rb +190 -0
- data/lib/spatio-sdk/models/task_comment_request.rb +164 -0
- data/lib/spatio-sdk/models/task_list_envelope.rb +195 -0
- data/lib/spatio-sdk/models/task_providers_info.rb +194 -0
- data/lib/spatio-sdk/models/task_providers_info_platform.rb +190 -0
- data/lib/spatio-sdk/models/text_annotations.rb +278 -0
- data/lib/spatio-sdk/models/token_response.rb +246 -0
- data/lib/spatio-sdk/models/update_account_request.rb +158 -0
- data/lib/spatio-sdk/models/update_agent_request.rb +205 -0
- data/lib/spatio-sdk/models/update_app_request.rb +174 -0
- data/lib/spatio-sdk/models/update_block_request.rb +168 -0
- data/lib/spatio-sdk/models/update_cell_request.rb +151 -0
- data/lib/spatio-sdk/models/update_comment_request.rb +157 -0
- data/lib/spatio-sdk/models/update_contact_category_request.rb +165 -0
- data/lib/spatio-sdk/models/update_contact_request.rb +212 -0
- data/lib/spatio-sdk/models/update_conversation_request.rb +183 -0
- data/lib/spatio-sdk/models/update_draft_request.rb +219 -0
- data/lib/spatio-sdk/models/update_email_folder_request.rb +147 -0
- data/lib/spatio-sdk/models/update_email_request.rb +188 -0
- data/lib/spatio-sdk/models/update_email_response.rb +190 -0
- data/lib/spatio-sdk/models/update_event_request.rb +236 -0
- data/lib/spatio-sdk/models/update_file_request.rb +169 -0
- data/lib/spatio-sdk/models/update_key_binding_request.rb +175 -0
- data/lib/spatio-sdk/models/update_message_metadata_request.rb +175 -0
- data/lib/spatio-sdk/models/update_note_request.rb +205 -0
- data/lib/spatio-sdk/models/update_organization_member_request.rb +188 -0
- data/lib/spatio-sdk/models/update_organization_request.rb +166 -0
- data/lib/spatio-sdk/models/update_participant_state_request.rb +166 -0
- data/lib/spatio-sdk/models/update_pat_request.rb +156 -0
- data/lib/spatio-sdk/models/update_presentation_request.rb +166 -0
- data/lib/spatio-sdk/models/update_recommendation_status_request.rb +188 -0
- data/lib/spatio-sdk/models/update_record_request.rb +169 -0
- data/lib/spatio-sdk/models/update_record_type_request.rb +185 -0
- data/lib/spatio-sdk/models/update_routine_request.rb +187 -0
- data/lib/spatio-sdk/models/update_row_request.rb +167 -0
- data/lib/spatio-sdk/models/update_sheet_request.rb +205 -0
- data/lib/spatio-sdk/models/update_slide_element_request.rb +213 -0
- data/lib/spatio-sdk/models/update_slide_request.rb +211 -0
- data/lib/spatio-sdk/models/update_task_request.rb +260 -0
- data/lib/spatio-sdk/models/update_workspace_member_request.rb +188 -0
- data/lib/spatio-sdk/models/update_workspace_request.rb +176 -0
- data/lib/spatio-sdk/models/upload_chunked_block_response.rb +243 -0
- data/lib/spatio-sdk/models/upload_file_base64_request.rb +265 -0
- data/lib/spatio-sdk/models/user_info_response.rb +237 -0
- data/lib/spatio-sdk/models/validate_key_binding_request.rb +201 -0
- data/lib/spatio-sdk/models/validate_key_binding_response.rb +175 -0
- data/lib/spatio-sdk/models/workspace.rb +321 -0
- data/lib/spatio-sdk/models/workspace_envelope.rb +164 -0
- data/lib/spatio-sdk/models/workspace_invitation.rb +324 -0
- data/lib/spatio-sdk/models/workspace_invitation_list_response.rb +166 -0
- data/lib/spatio-sdk/models/workspace_list_response.rb +175 -0
- data/lib/spatio-sdk/models/workspace_member.rb +278 -0
- data/lib/spatio-sdk/models/workspace_member_list_response.rb +175 -0
- data/lib/spatio-sdk/models/workspace_organization.rb +166 -0
- data/lib/spatio-sdk/models/write_app_file_request.rb +190 -0
- data/lib/spatio-sdk/version.rb +15 -0
- data/lib/spatio-sdk.rb +408 -0
- data/spatio-sdk.gemspec +41 -0
- data/spec/api/account_api_spec.rb +158 -0
- data/spec/api/actions_api_spec.rb +99 -0
- data/spec/api/agents_api_spec.rb +176 -0
- data/spec/api/apps_api_spec.rb +198 -0
- data/spec/api/calendar_api_spec.rb +217 -0
- data/spec/api/calls_api_spec.rb +378 -0
- data/spec/api/channels_api_spec.rb +236 -0
- data/spec/api/connections_api_spec.rb +154 -0
- data/spec/api/contacts_api_spec.rb +172 -0
- data/spec/api/conversations_api_spec.rb +140 -0
- data/spec/api/direct_messages_api_spec.rb +420 -0
- data/spec/api/files_api_spec.rb +494 -0
- data/spec/api/folders_api_spec.rb +102 -0
- data/spec/api/inbox_api_spec.rb +103 -0
- data/spec/api/keybindings_api_spec.rb +99 -0
- data/spec/api/logos_api_spec.rb +68 -0
- data/spec/api/mail_api_spec.rb +701 -0
- data/spec/api/misc_api_spec.rb +228 -0
- data/spec/api/models_api_spec.rb +112 -0
- data/spec/api/native_dm_api_spec.rb +276 -0
- data/spec/api/navigation_api_spec.rb +45 -0
- data/spec/api/notes_api_spec.rb +474 -0
- data/spec/api/notifications_api_spec.rb +56 -0
- data/spec/api/o_auth_api_spec.rb +161 -0
- data/spec/api/organizations_api_spec.rb +367 -0
- data/spec/api/personal_access_tokens_api_spec.rb +137 -0
- data/spec/api/platforms_api_spec.rb +204 -0
- data/spec/api/realtime_api_spec.rb +47 -0
- data/spec/api/recommendations_api_spec.rb +93 -0
- data/spec/api/records_api_spec.rb +127 -0
- data/spec/api/repo_api_spec.rb +402 -0
- data/spec/api/resources_api_spec.rb +73 -0
- data/spec/api/routines_api_spec.rb +149 -0
- data/spec/api/search_api_spec.rb +47 -0
- data/spec/api/settings_api_spec.rb +154 -0
- data/spec/api/sheets_api_spec.rb +184 -0
- data/spec/api/slides_api_spec.rb +355 -0
- data/spec/api/tasks_api_spec.rb +355 -0
- data/spec/api/terminal_api_spec.rb +90 -0
- data/spec/api/workspaces_api_spec.rb +184 -0
- data/spec/models/accept_organization_invitation_request_spec.rb +36 -0
- data/spec/models/account_choice_spec.rb +48 -0
- data/spec/models/account_error_spec.rb +42 -0
- data/spec/models/account_list_response_spec.rb +48 -0
- data/spec/models/account_plan_spec.rb +54 -0
- data/spec/models/account_status_spec.rb +70 -0
- data/spec/models/account_tier_details_spec.rb +120 -0
- data/spec/models/account_usage_spec.rb +78 -0
- data/spec/models/action_descriptor_spec.rb +78 -0
- data/spec/models/add_organization_member_request_spec.rb +52 -0
- data/spec/models/add_workspace_member_request_spec.rb +46 -0
- data/spec/models/agent_conversation_list_response_spec.rb +42 -0
- data/spec/models/agent_conversation_spec.rb +66 -0
- data/spec/models/agent_list_response_spec.rb +54 -0
- data/spec/models/agent_message_list_response_spec.rb +42 -0
- data/spec/models/agent_message_spec.rb +66 -0
- data/spec/models/agent_session_context_spec.rb +54 -0
- data/spec/models/agent_spec.rb +102 -0
- data/spec/models/agent_task_usage_spec.rb +60 -0
- data/spec/models/ambiguous_account_error_spec.rb +48 -0
- data/spec/models/api_error_spec.rb +42 -0
- data/spec/models/app_file_content_response_spec.rb +42 -0
- data/spec/models/app_file_list_response_spec.rb +36 -0
- data/spec/models/app_list_response_spec.rb +42 -0
- data/spec/models/app_spec.rb +78 -0
- data/spec/models/assign_contact_category_request_spec.rb +36 -0
- data/spec/models/attachment_input_spec.rb +54 -0
- data/spec/models/attachment_meta_spec.rb +54 -0
- data/spec/models/attachment_spec.rb +60 -0
- data/spec/models/attendee_role_spec.rb +30 -0
- data/spec/models/attendee_spec.rb +72 -0
- data/spec/models/attendee_status_spec.rb +30 -0
- data/spec/models/block_content_spec.rb +96 -0
- data/spec/models/block_list_response_spec.rb +42 -0
- data/spec/models/block_spec.rb +90 -0
- data/spec/models/block_type_spec.rb +30 -0
- data/spec/models/bulk_archive_request_spec.rb +42 -0
- data/spec/models/bulk_archive_response_failed_inner_spec.rb +42 -0
- data/spec/models/bulk_archive_response_spec.rb +48 -0
- data/spec/models/bulk_delete_emails_request_spec.rb +48 -0
- data/spec/models/bulk_delete_emails_response_spec.rb +48 -0
- data/spec/models/bulk_delete_files_request_spec.rb +54 -0
- data/spec/models/bulk_delete_tasks_request_spec.rb +54 -0
- data/spec/models/bulk_delete_tasks_response_failed_inner_spec.rb +42 -0
- data/spec/models/bulk_delete_tasks_response_spec.rb +54 -0
- data/spec/models/bulk_files_response_failed_inner_spec.rb +42 -0
- data/spec/models/bulk_files_response_spec.rb +54 -0
- data/spec/models/bulk_mark_read_request_spec.rb +48 -0
- data/spec/models/bulk_mark_read_response_failed_inner_spec.rb +42 -0
- data/spec/models/bulk_mark_read_response_spec.rb +42 -0
- data/spec/models/bulk_move_files_request_spec.rb +60 -0
- data/spec/models/bulk_update_tasks_request_spec.rb +54 -0
- data/spec/models/bulk_update_tasks_response_spec.rb +54 -0
- data/spec/models/calendar_account_error_spec.rb +54 -0
- data/spec/models/calendar_capabilities_response_spec.rb +48 -0
- data/spec/models/calendar_operation_result_spec.rb +54 -0
- data/spec/models/calendar_provider_info_spec.rb +60 -0
- data/spec/models/calendar_providers_info_spec.rb +36 -0
- data/spec/models/calendar_sync_response_spec.rb +60 -0
- data/spec/models/call_list_response_spec.rb +42 -0
- data/spec/models/call_recording_list_response_spec.rb +36 -0
- data/spec/models/call_recording_spec.rb +72 -0
- data/spec/models/cell_spec.rb +48 -0
- data/spec/models/change_password_request_spec.rb +42 -0
- data/spec/models/channel_membership_request_spec.rb +36 -0
- data/spec/models/channel_spec.rb +96 -0
- data/spec/models/chat_action_definition_spec.rb +84 -0
- data/spec/models/chat_actions_list_spec.rb +36 -0
- data/spec/models/chat_message_spec.rb +90 -0
- data/spec/models/chat_user_spec.rb +84 -0
- data/spec/models/chunked_file_manifest_spec.rb +84 -0
- data/spec/models/client_registration_request_spec.rb +94 -0
- data/spec/models/client_registration_response_spec.rb +96 -0
- data/spec/models/comment_author_spec.rb +54 -0
- data/spec/models/comment_list_response_spec.rb +42 -0
- data/spec/models/comment_mutation_response_spec.rb +42 -0
- data/spec/models/comment_response_spec.rb +36 -0
- data/spec/models/comment_spec.rb +78 -0
- data/spec/models/commit_chunked_upload_request_spec.rb +36 -0
- data/spec/models/commit_chunked_upload_response_spec.rb +90 -0
- data/spec/models/conference_data_spec.rb +66 -0
- data/spec/models/connected_app_item_spec.rb +84 -0
- data/spec/models/connected_apps_list_response_spec.rb +36 -0
- data/spec/models/connection_account_list_response_spec.rb +48 -0
- data/spec/models/connection_list_response_spec.rb +42 -0
- data/spec/models/consume_agent_task_response_spec.rb +60 -0
- data/spec/models/contact_category_list_response_spec.rb +36 -0
- data/spec/models/contact_category_spec.rb +60 -0
- data/spec/models/contact_list_response_spec.rb +48 -0
- data/spec/models/contact_provider_list_response_spec.rb +36 -0
- data/spec/models/contact_provider_spec.rb +60 -0
- data/spec/models/contact_spec.rb +120 -0
- data/spec/models/conversation_message_spec.rb +66 -0
- data/spec/models/conversation_spec.rb +108 -0
- data/spec/models/core_action_list_response_spec.rb +42 -0
- data/spec/models/core_action_spec.rb +72 -0
- data/spec/models/create_agent_conversation_request_spec.rb +48 -0
- data/spec/models/create_agent_message_request_spec.rb +48 -0
- data/spec/models/create_agent_request_spec.rb +72 -0
- data/spec/models/create_app_request_spec.rb +60 -0
- data/spec/models/create_block_request_spec.rb +60 -0
- data/spec/models/create_calendar_event201_response_spec.rb +54 -0
- data/spec/models/create_call_request_spec.rb +54 -0
- data/spec/models/create_channel_request_spec.rb +54 -0
- data/spec/models/create_channel_response_spec.rb +42 -0
- data/spec/models/create_comment_request_spec.rb +54 -0
- data/spec/models/create_contact_category_request_spec.rb +48 -0
- data/spec/models/create_contact_request_spec.rb +78 -0
- data/spec/models/create_conversation_request_spec.rb +60 -0
- data/spec/models/create_draft_request_spec.rb +96 -0
- data/spec/models/create_email_folder_request_spec.rb +42 -0
- data/spec/models/create_event_request_spec.rb +64 -0
- data/spec/models/create_folder_request_spec.rb +60 -0
- data/spec/models/create_label_request_spec.rb +60 -0
- data/spec/models/create_label_response_spec.rb +42 -0
- data/spec/models/create_meeting_room_request_spec.rb +42 -0
- data/spec/models/create_note400_response_spec.rb +32 -0
- data/spec/models/create_note_request_spec.rb +78 -0
- data/spec/models/create_organization_invitation_request_spec.rb +52 -0
- data/spec/models/create_organization_request_spec.rb +66 -0
- data/spec/models/create_pat_request_spec.rb +60 -0
- data/spec/models/create_pat_response_spec.rb +42 -0
- data/spec/models/create_presentation_request_spec.rb +60 -0
- data/spec/models/create_record_request_spec.rb +60 -0
- data/spec/models/create_record_type_request_spec.rb +66 -0
- data/spec/models/create_routine_request_spec.rb +60 -0
- data/spec/models/create_row_request_spec.rb +42 -0
- data/spec/models/create_sheet_request_spec.rb +72 -0
- data/spec/models/create_slide_element_request_spec.rb +78 -0
- data/spec/models/create_slide_request_spec.rb +84 -0
- data/spec/models/create_task_request_spec.rb +118 -0
- data/spec/models/create_workspace_invitation_request_spec.rb +46 -0
- data/spec/models/create_workspace_request_spec.rb +54 -0
- data/spec/models/disconnect_connection_request_spec.rb +42 -0
- data/spec/models/discovery_document_spec.rb +138 -0
- data/spec/models/dm_attach_request_spec.rb +84 -0
- data/spec/models/dm_forward_request_spec.rb +48 -0
- data/spec/models/dm_mark_read_request_spec.rb +42 -0
- data/spec/models/dm_message_envelope_spec.rb +36 -0
- data/spec/models/dm_mute_request_spec.rb +48 -0
- data/spec/models/dm_mute_response_spec.rb +36 -0
- data/spec/models/dm_pinned_list_spec.rb +36 -0
- data/spec/models/dm_reaction_request_spec.rb +42 -0
- data/spec/models/dm_reaction_response_spec.rb +36 -0
- data/spec/models/dm_search_results_spec.rb +36 -0
- data/spec/models/dm_set_draft_request_spec.rb +42 -0
- data/spec/models/dm_thread_reply_request_spec.rb +42 -0
- data/spec/models/download_file_response_spec.rb +42 -0
- data/spec/models/draft_response_spec.rb +42 -0
- data/spec/models/draft_spec.rb +102 -0
- data/spec/models/email_folder_list_response_spec.rb +36 -0
- data/spec/models/email_folder_spec.rb +60 -0
- data/spec/models/email_spec.rb +150 -0
- data/spec/models/enable_share_request_spec.rb +42 -0
- data/spec/models/execute_action_request_spec.rb +48 -0
- data/spec/models/execute_action_response_spec.rb +48 -0
- data/spec/models/execute_chat_action_request_spec.rb +42 -0
- data/spec/models/execute_chat_action_response_spec.rb +42 -0
- data/spec/models/export_pdf_request_rasterized_slides_inner_spec.rb +42 -0
- data/spec/models/export_pdf_request_spec.rb +42 -0
- data/spec/models/export_pdfr2_response_spec.rb +58 -0
- data/spec/models/extract_text_result_spec.rb +54 -0
- data/spec/models/federated_search200_response_items_inner_spec.rb +96 -0
- data/spec/models/federated_search200_response_per_platform_value_spec.rb +42 -0
- data/spec/models/federated_search200_response_spec.rb +66 -0
- data/spec/models/federated_search_request_spec.rb +82 -0
- data/spec/models/file_list_envelope_spec.rb +42 -0
- data/spec/models/files_and_folders_response_spec.rb +66 -0
- data/spec/models/folder_list_envelope_spec.rb +42 -0
- data/spec/models/folder_spec.rb +78 -0
- data/spec/models/get_chat_user_response_spec.rb +42 -0
- data/spec/models/get_domain_logo200_response_spec.rb +42 -0
- data/spec/models/get_email_response_spec.rb +42 -0
- data/spec/models/get_thread_response_spec.rb +42 -0
- data/spec/models/inbox_counts_spec.rb +48 -0
- data/spec/models/inbox_item_spec.rb +96 -0
- data/spec/models/inbox_list_response_spec.rb +48 -0
- data/spec/models/init_chunked_upload_request_spec.rb +72 -0
- data/spec/models/init_chunked_upload_response_spec.rb +60 -0
- data/spec/models/install_connection_request_spec.rb +48 -0
- data/spec/models/introspection_response_spec.rb +72 -0
- data/spec/models/issue_collaboration_token200_response_spec.rb +60 -0
- data/spec/models/issue_collaboration_token_request_spec.rb +36 -0
- data/spec/models/jwk_spec.rb +66 -0
- data/spec/models/jwks_spec.rb +36 -0
- data/spec/models/key_binding_list_response_spec.rb +36 -0
- data/spec/models/key_binding_spec.rb +96 -0
- data/spec/models/label_color_spec.rb +42 -0
- data/spec/models/label_spec.rb +66 -0
- data/spec/models/link_repo_task_request_spec.rb +36 -0
- data/spec/models/list_calendar_events200_response_spec.rb +54 -0
- data/spec/models/list_channels_response_spec.rb +54 -0
- data/spec/models/list_chat_users_response_spec.rb +54 -0
- data/spec/models/list_drafts_response_spec.rb +54 -0
- data/spec/models/list_emails_response_spec.rb +54 -0
- data/spec/models/list_events_data_spec.rb +54 -0
- data/spec/models/list_labels_response_spec.rb +42 -0
- data/spec/models/list_messages_response_spec.rb +54 -0
- data/spec/models/meeting_room_spec.rb +54 -0
- data/spec/models/move_block_request_spec.rb +42 -0
- data/spec/models/move_emails_request_spec.rb +36 -0
- data/spec/models/move_file_request_spec.rb +36 -0
- data/spec/models/move_file_response_spec.rb +36 -0
- data/spec/models/note_list_envelope_spec.rb +42 -0
- data/spec/models/note_spec.rb +114 -0
- data/spec/models/o_auth_error_spec.rb +46 -0
- data/spec/models/organization_detail_legacy_spec.rb +96 -0
- data/spec/models/organization_invitation_list_response_spec.rb +36 -0
- data/spec/models/organization_invitation_spec.rb +100 -0
- data/spec/models/organization_list_response_spec.rb +36 -0
- data/spec/models/organization_member_invited_by_spec.rb +32 -0
- data/spec/models/organization_member_list_response_spec.rb +42 -0
- data/spec/models/organization_member_spec.rb +70 -0
- data/spec/models/organization_spec.rb +96 -0
- data/spec/models/organization_workspaces_inner_spec.rb +48 -0
- data/spec/models/password_required_error_spec.rb +54 -0
- data/spec/models/pat_list_response_spec.rb +42 -0
- data/spec/models/pat_scopes_response_spec.rb +36 -0
- data/spec/models/personal_access_token_spec.rb +84 -0
- data/spec/models/preconfigured_agent_spec.rb +72 -0
- data/spec/models/presentation_list_envelope_spec.rb +42 -0
- data/spec/models/presentation_spec.rb +96 -0
- data/spec/models/propose_recommendation_request_spec.rb +66 -0
- data/spec/models/public_invitation_payload_spec.rb +110 -0
- data/spec/models/quota_exceeded_error_spec.rb +42 -0
- data/spec/models/recommendation_list_response_spec.rb +36 -0
- data/spec/models/recommendation_spec.rb +100 -0
- data/spec/models/record_list_response_spec.rb +48 -0
- data/spec/models/record_spec.rb +78 -0
- data/spec/models/record_type_list_response_spec.rb +36 -0
- data/spec/models/record_type_spec.rb +84 -0
- data/spec/models/refresh_connection_request_spec.rb +42 -0
- data/spec/models/reminder_method_spec.rb +30 -0
- data/spec/models/reminder_spec.rb +42 -0
- data/spec/models/reply_email_request_spec.rb +72 -0
- data/spec/models/revoke_other_sessions_response_spec.rb +36 -0
- data/spec/models/rich_text_object_spec.rb +58 -0
- data/spec/models/routine_list_response_spec.rb +36 -0
- data/spec/models/routine_run_complete_request_spec.rb +42 -0
- data/spec/models/routine_run_list_response_spec.rb +36 -0
- data/spec/models/routine_run_progress_request_spec.rb +42 -0
- data/spec/models/routine_run_spec.rb +72 -0
- data/spec/models/routine_spec.rb +84 -0
- data/spec/models/row_list_spec.rb +42 -0
- data/spec/models/row_spec.rb +42 -0
- data/spec/models/save_message_request_spec.rb +48 -0
- data/spec/models/search_emails_response_spec.rb +54 -0
- data/spec/models/search_files_response_spec.rb +54 -0
- data/spec/models/send_chat_message_request_spec.rb +60 -0
- data/spec/models/send_chat_message_response_spec.rb +66 -0
- data/spec/models/send_email_request_spec.rb +90 -0
- data/spec/models/send_email_response_spec.rb +60 -0
- data/spec/models/session_list_response_spec.rb +36 -0
- data/spec/models/session_spec.rb +96 -0
- data/spec/models/share_settings_spec.rb +60 -0
- data/spec/models/sheet_list_envelope_spec.rb +42 -0
- data/spec/models/sheet_spec.rb +126 -0
- data/spec/models/sign_in_methods_providers_inner_spec.rb +54 -0
- data/spec/models/sign_in_methods_spec.rb +48 -0
- data/spec/models/slide_element_list_spec.rb +42 -0
- data/spec/models/slide_element_spec.rb +102 -0
- data/spec/models/slide_list_spec.rb +42 -0
- data/spec/models/slide_spec.rb +114 -0
- data/spec/models/spatio_call_spec.rb +96 -0
- data/spec/models/spatio_connection_spec.rb +96 -0
- data/spec/models/spatio_event_spec.rb +240 -0
- data/spec/models/spatio_file_spec.rb +102 -0
- data/spec/models/spatio_thread_spec.rb +54 -0
- data/spec/models/success_flag_spec.rb +36 -0
- data/spec/models/task_comment_author_spec.rb +54 -0
- data/spec/models/task_comment_list_spec.rb +42 -0
- data/spec/models/task_comment_mutation_response_spec.rb +42 -0
- data/spec/models/task_comment_request_spec.rb +36 -0
- data/spec/models/task_comment_spec.rb +66 -0
- data/spec/models/task_list_envelope_spec.rb +42 -0
- data/spec/models/task_providers_info_platform_spec.rb +42 -0
- data/spec/models/task_providers_info_spec.rb +42 -0
- data/spec/models/task_spec.rb +160 -0
- data/spec/models/text_annotations_spec.rb +66 -0
- data/spec/models/token_response_spec.rb +66 -0
- data/spec/models/update_account_request_spec.rb +42 -0
- data/spec/models/update_agent_request_spec.rb +72 -0
- data/spec/models/update_app_request_spec.rb +54 -0
- data/spec/models/update_block_request_spec.rb +48 -0
- data/spec/models/update_cell_request_spec.rb +36 -0
- data/spec/models/update_comment_request_spec.rb +42 -0
- data/spec/models/update_contact_category_request_spec.rb +48 -0
- data/spec/models/update_contact_request_spec.rb +78 -0
- data/spec/models/update_conversation_request_spec.rb +60 -0
- data/spec/models/update_draft_request_spec.rb +78 -0
- data/spec/models/update_email_folder_request_spec.rb +36 -0
- data/spec/models/update_email_request_spec.rb +60 -0
- data/spec/models/update_email_response_spec.rb +42 -0
- data/spec/models/update_event_request_spec.rb +52 -0
- data/spec/models/update_file_request_spec.rb +48 -0
- data/spec/models/update_key_binding_request_spec.rb +42 -0
- data/spec/models/update_message_metadata_request_spec.rb +42 -0
- data/spec/models/update_note_request_spec.rb +72 -0
- data/spec/models/update_organization_member_request_spec.rb +40 -0
- data/spec/models/update_organization_request_spec.rb +48 -0
- data/spec/models/update_participant_state_request_spec.rb +48 -0
- data/spec/models/update_pat_request_spec.rb +42 -0
- data/spec/models/update_presentation_request_spec.rb +48 -0
- data/spec/models/update_recommendation_status_request_spec.rb +40 -0
- data/spec/models/update_record_request_spec.rb +48 -0
- data/spec/models/update_record_type_request_spec.rb +60 -0
- data/spec/models/update_routine_request_spec.rb +60 -0
- data/spec/models/update_row_request_spec.rb +36 -0
- data/spec/models/update_sheet_request_spec.rb +72 -0
- data/spec/models/update_slide_element_request_spec.rb +78 -0
- data/spec/models/update_slide_request_spec.rb +78 -0
- data/spec/models/update_task_request_spec.rb +88 -0
- data/spec/models/update_workspace_member_request_spec.rb +40 -0
- data/spec/models/update_workspace_request_spec.rb +54 -0
- data/spec/models/upload_chunked_block_response_spec.rb +54 -0
- data/spec/models/upload_file_base64_request_spec.rb +78 -0
- data/spec/models/user_info_response_spec.rb +84 -0
- data/spec/models/validate_key_binding_request_spec.rb +48 -0
- data/spec/models/validate_key_binding_response_spec.rb +42 -0
- data/spec/models/workspace_envelope_spec.rb +36 -0
- data/spec/models/workspace_invitation_list_response_spec.rb +36 -0
- data/spec/models/workspace_invitation_spec.rb +88 -0
- data/spec/models/workspace_list_response_spec.rb +42 -0
- data/spec/models/workspace_member_list_response_spec.rb +42 -0
- data/spec/models/workspace_member_spec.rb +76 -0
- data/spec/models/workspace_organization_spec.rb +48 -0
- data/spec/models/workspace_spec.rb +114 -0
- data/spec/models/write_app_file_request_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1597 -0
data/docs/MailApi.md
ADDED
|
@@ -0,0 +1,3803 @@
|
|
|
1
|
+
# Spatio::MailApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spatio.app*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**bulk_archive_emails**](MailApi.md#bulk_archive_emails) | **POST** /v1/mail/archive | Archive multiple messages (remove the INBOX label). |
|
|
8
|
+
| [**bulk_delete_emails**](MailApi.md#bulk_delete_emails) | **POST** /v1/mail/delete | Delete multiple messages in one call. |
|
|
9
|
+
| [**bulk_mark_emails_read**](MailApi.md#bulk_mark_emails_read) | **POST** /v1/mail/mark-read | Mark multiple messages read or unread in one call. |
|
|
10
|
+
| [**create_draft**](MailApi.md#create_draft) | **POST** /v1/mail/drafts | Create a draft. |
|
|
11
|
+
| [**create_email_label**](MailApi.md#create_email_label) | **POST** /v1/mail/labels | Create a label. |
|
|
12
|
+
| [**create_mail_template**](MailApi.md#create_mail_template) | **POST** /v1/mail/templates | Create a mail template. |
|
|
13
|
+
| [**delete_draft**](MailApi.md#delete_draft) | **DELETE** /v1/mail/drafts/{id} | Delete a draft. |
|
|
14
|
+
| [**delete_email**](MailApi.md#delete_email) | **DELETE** /v1/mail/email/{id} | Delete an email. |
|
|
15
|
+
| [**delete_email_label**](MailApi.md#delete_email_label) | **DELETE** /v1/mail/labels/{id} | Delete a label. |
|
|
16
|
+
| [**delete_mail_template**](MailApi.md#delete_mail_template) | **DELETE** /v1/mail/templates/{id} | Delete a mail template. |
|
|
17
|
+
| [**get_email**](MailApi.md#get_email) | **GET** /v1/mail/email/{id} | Fetch one email. |
|
|
18
|
+
| [**get_email_attachment**](MailApi.md#get_email_attachment) | **GET** /v1/mail/attachment/{messageId}/{attachmentId} | Download an attachment. |
|
|
19
|
+
| [**get_email_thread**](MailApi.md#get_email_thread) | **GET** /v1/mail/thread/{id} | Fetch a thread (the conversation a message belongs to). |
|
|
20
|
+
| [**get_mail_template**](MailApi.md#get_mail_template) | **GET** /v1/mail/templates/{id} | Fetch a mail template. |
|
|
21
|
+
| [**get_mail_thread_tracking**](MailApi.md#get_mail_thread_tracking) | **GET** /v1/mail/threads/{threadId}/tracking | Read mail-tracking events for a thread (open log, reply log, etc.). |
|
|
22
|
+
| [**instantiate_mail_template**](MailApi.md#instantiate_mail_template) | **POST** /v1/mail/templates/{id}/instantiate | Render a template with variables and return the resulting draft. |
|
|
23
|
+
| [**list_drafts**](MailApi.md#list_drafts) | **GET** /v1/mail/drafts | List drafts across connected mail accounts. |
|
|
24
|
+
| [**list_email_labels**](MailApi.md#list_email_labels) | **GET** /v1/mail/labels | List labels on the resolved mail account. |
|
|
25
|
+
| [**list_emails**](MailApi.md#list_emails) | **GET** /v1/mail/list | List emails across connected mail accounts. |
|
|
26
|
+
| [**list_mail_templates**](MailApi.md#list_mail_templates) | **GET** /v1/mail/templates | List the caller's saved mail templates. |
|
|
27
|
+
| [**reply_email**](MailApi.md#reply_email) | **POST** /v1/mail/reply | Reply to a specific email. |
|
|
28
|
+
| [**save_mail_template**](MailApi.md#save_mail_template) | **POST** /v1/mail/templates/save | Save-or-create endpoint used by the renderer's \"save as template\" flow. Distinct from POST /v1/mail/templates which is the strict create. |
|
|
29
|
+
| [**search_emails**](MailApi.md#search_emails) | **GET** /v1/mail/search | Structured search across connected mail accounts. |
|
|
30
|
+
| [**send_draft**](MailApi.md#send_draft) | **POST** /v1/mail/drafts/{id}/send | Send a draft. |
|
|
31
|
+
| [**send_email**](MailApi.md#send_email) | **POST** /v1/mail/send | Send an email. |
|
|
32
|
+
| [**update_draft**](MailApi.md#update_draft) | **PUT** /v1/mail/drafts/{id} | Update a draft (full replacement of provided fields). |
|
|
33
|
+
| [**update_email**](MailApi.md#update_email) | **PATCH** /v1/mail/email/{id} | Update an email (mark read/star, add/remove labels). |
|
|
34
|
+
| [**update_mail_template**](MailApi.md#update_mail_template) | **PATCH** /v1/mail/templates/{id} | Update a mail template. |
|
|
35
|
+
| [**workspace_add_mail_message_labels**](MailApi.md#workspace_add_mail_message_labels) | **POST** /v1/organizations/{org}/workspaces/{workspace}/mail/{messageId}/labels | |
|
|
36
|
+
| [**workspace_create_mail_draft**](MailApi.md#workspace_create_mail_draft) | **POST** /v1/organizations/{org}/workspaces/{workspace}/mail/drafts | |
|
|
37
|
+
| [**workspace_create_mail_label**](MailApi.md#workspace_create_mail_label) | **POST** /v1/organizations/{org}/workspaces/{workspace}/mail/labels | |
|
|
38
|
+
| [**workspace_delete_mail**](MailApi.md#workspace_delete_mail) | **DELETE** /v1/organizations/{org}/workspaces/{workspace}/mail/email/{id} | |
|
|
39
|
+
| [**workspace_delete_mail_draft**](MailApi.md#workspace_delete_mail_draft) | **DELETE** /v1/organizations/{org}/workspaces/{workspace}/mail/drafts/{id} | |
|
|
40
|
+
| [**workspace_delete_mail_label**](MailApi.md#workspace_delete_mail_label) | **DELETE** /v1/organizations/{org}/workspaces/{workspace}/mail/labels/{id} | |
|
|
41
|
+
| [**workspace_get_mail**](MailApi.md#workspace_get_mail) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/email/{id} | |
|
|
42
|
+
| [**workspace_get_mail_attachment**](MailApi.md#workspace_get_mail_attachment) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/attachment/{messageId}/{attachmentId} | |
|
|
43
|
+
| [**workspace_get_mail_by_id**](MailApi.md#workspace_get_mail_by_id) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/{id} | Workspace-scoped renderer-compat alias for mail/email/{id}. |
|
|
44
|
+
| [**workspace_get_mail_draft**](MailApi.md#workspace_get_mail_draft) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/drafts/{id} | |
|
|
45
|
+
| [**workspace_get_mail_thread**](MailApi.md#workspace_get_mail_thread) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/thread/{id} | |
|
|
46
|
+
| [**workspace_list_mail**](MailApi.md#workspace_list_mail) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/list | |
|
|
47
|
+
| [**workspace_list_mail_drafts**](MailApi.md#workspace_list_mail_drafts) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/drafts | |
|
|
48
|
+
| [**workspace_list_mail_labels**](MailApi.md#workspace_list_mail_labels) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/labels | |
|
|
49
|
+
| [**workspace_patch_mail**](MailApi.md#workspace_patch_mail) | **PATCH** /v1/organizations/{org}/workspaces/{workspace}/mail/email/{id} | |
|
|
50
|
+
| [**workspace_remove_mail_message_label**](MailApi.md#workspace_remove_mail_message_label) | **DELETE** /v1/organizations/{org}/workspaces/{workspace}/mail/{messageId}/labels/{labelId} | |
|
|
51
|
+
| [**workspace_reply_mail**](MailApi.md#workspace_reply_mail) | **POST** /v1/organizations/{org}/workspaces/{workspace}/mail/reply | |
|
|
52
|
+
| [**workspace_search_mail**](MailApi.md#workspace_search_mail) | **GET** /v1/organizations/{org}/workspaces/{workspace}/mail/search | |
|
|
53
|
+
| [**workspace_send_mail**](MailApi.md#workspace_send_mail) | **POST** /v1/organizations/{org}/workspaces/{workspace}/mail/send | |
|
|
54
|
+
| [**workspace_send_mail_draft**](MailApi.md#workspace_send_mail_draft) | **POST** /v1/organizations/{org}/workspaces/{workspace}/mail/drafts/{id}/send | |
|
|
55
|
+
| [**workspace_send_mail_email_alias**](MailApi.md#workspace_send_mail_email_alias) | **POST** /v1/organizations/{org}/workspaces/{workspace}/mail/email | Renderer-compat alias for /mail/send. |
|
|
56
|
+
| [**workspace_update_mail**](MailApi.md#workspace_update_mail) | **PUT** /v1/organizations/{org}/workspaces/{workspace}/mail/email/{id} | |
|
|
57
|
+
| [**workspace_update_mail_draft**](MailApi.md#workspace_update_mail_draft) | **PUT** /v1/organizations/{org}/workspaces/{workspace}/mail/drafts/{id} | |
|
|
58
|
+
| [**workspace_update_mail_label**](MailApi.md#workspace_update_mail_label) | **PUT** /v1/organizations/{org}/workspaces/{workspace}/mail/labels/{id} | |
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
## bulk_archive_emails
|
|
62
|
+
|
|
63
|
+
> <BulkArchiveResponse> bulk_archive_emails(bulk_archive_request)
|
|
64
|
+
|
|
65
|
+
Archive multiple messages (remove the INBOX label).
|
|
66
|
+
|
|
67
|
+
### Examples
|
|
68
|
+
|
|
69
|
+
```ruby
|
|
70
|
+
require 'time'
|
|
71
|
+
require 'spatio-sdk'
|
|
72
|
+
# setup authorization
|
|
73
|
+
Spatio.configure do |config|
|
|
74
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
75
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
api_instance = Spatio::MailApi.new
|
|
79
|
+
bulk_archive_request = Spatio::BulkArchiveRequest.new({message_ids: ['message_ids_example']}) # BulkArchiveRequest |
|
|
80
|
+
|
|
81
|
+
begin
|
|
82
|
+
# Archive multiple messages (remove the INBOX label).
|
|
83
|
+
result = api_instance.bulk_archive_emails(bulk_archive_request)
|
|
84
|
+
p result
|
|
85
|
+
rescue Spatio::ApiError => e
|
|
86
|
+
puts "Error when calling MailApi->bulk_archive_emails: #{e}"
|
|
87
|
+
end
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
#### Using the bulk_archive_emails_with_http_info variant
|
|
91
|
+
|
|
92
|
+
This returns an Array which contains the response data, status code and headers.
|
|
93
|
+
|
|
94
|
+
> <Array(<BulkArchiveResponse>, Integer, Hash)> bulk_archive_emails_with_http_info(bulk_archive_request)
|
|
95
|
+
|
|
96
|
+
```ruby
|
|
97
|
+
begin
|
|
98
|
+
# Archive multiple messages (remove the INBOX label).
|
|
99
|
+
data, status_code, headers = api_instance.bulk_archive_emails_with_http_info(bulk_archive_request)
|
|
100
|
+
p status_code # => 2xx
|
|
101
|
+
p headers # => { ... }
|
|
102
|
+
p data # => <BulkArchiveResponse>
|
|
103
|
+
rescue Spatio::ApiError => e
|
|
104
|
+
puts "Error when calling MailApi->bulk_archive_emails_with_http_info: #{e}"
|
|
105
|
+
end
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Parameters
|
|
109
|
+
|
|
110
|
+
| Name | Type | Description | Notes |
|
|
111
|
+
| ---- | ---- | ----------- | ----- |
|
|
112
|
+
| **bulk_archive_request** | [**BulkArchiveRequest**](BulkArchiveRequest.md) | | |
|
|
113
|
+
|
|
114
|
+
### Return type
|
|
115
|
+
|
|
116
|
+
[**BulkArchiveResponse**](BulkArchiveResponse.md)
|
|
117
|
+
|
|
118
|
+
### Authorization
|
|
119
|
+
|
|
120
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
121
|
+
|
|
122
|
+
### HTTP request headers
|
|
123
|
+
|
|
124
|
+
- **Content-Type**: application/json
|
|
125
|
+
- **Accept**: application/json
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
## bulk_delete_emails
|
|
129
|
+
|
|
130
|
+
> <BulkDeleteEmailsResponse> bulk_delete_emails(bulk_delete_emails_request)
|
|
131
|
+
|
|
132
|
+
Delete multiple messages in one call.
|
|
133
|
+
|
|
134
|
+
Soft-delete by default (moves to provider trash). Set `permanent: true` for a hard delete.
|
|
135
|
+
|
|
136
|
+
### Examples
|
|
137
|
+
|
|
138
|
+
```ruby
|
|
139
|
+
require 'time'
|
|
140
|
+
require 'spatio-sdk'
|
|
141
|
+
# setup authorization
|
|
142
|
+
Spatio.configure do |config|
|
|
143
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
144
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
api_instance = Spatio::MailApi.new
|
|
148
|
+
bulk_delete_emails_request = Spatio::BulkDeleteEmailsRequest.new({message_ids: ['message_ids_example']}) # BulkDeleteEmailsRequest |
|
|
149
|
+
|
|
150
|
+
begin
|
|
151
|
+
# Delete multiple messages in one call.
|
|
152
|
+
result = api_instance.bulk_delete_emails(bulk_delete_emails_request)
|
|
153
|
+
p result
|
|
154
|
+
rescue Spatio::ApiError => e
|
|
155
|
+
puts "Error when calling MailApi->bulk_delete_emails: #{e}"
|
|
156
|
+
end
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
#### Using the bulk_delete_emails_with_http_info variant
|
|
160
|
+
|
|
161
|
+
This returns an Array which contains the response data, status code and headers.
|
|
162
|
+
|
|
163
|
+
> <Array(<BulkDeleteEmailsResponse>, Integer, Hash)> bulk_delete_emails_with_http_info(bulk_delete_emails_request)
|
|
164
|
+
|
|
165
|
+
```ruby
|
|
166
|
+
begin
|
|
167
|
+
# Delete multiple messages in one call.
|
|
168
|
+
data, status_code, headers = api_instance.bulk_delete_emails_with_http_info(bulk_delete_emails_request)
|
|
169
|
+
p status_code # => 2xx
|
|
170
|
+
p headers # => { ... }
|
|
171
|
+
p data # => <BulkDeleteEmailsResponse>
|
|
172
|
+
rescue Spatio::ApiError => e
|
|
173
|
+
puts "Error when calling MailApi->bulk_delete_emails_with_http_info: #{e}"
|
|
174
|
+
end
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
| Name | Type | Description | Notes |
|
|
180
|
+
| ---- | ---- | ----------- | ----- |
|
|
181
|
+
| **bulk_delete_emails_request** | [**BulkDeleteEmailsRequest**](BulkDeleteEmailsRequest.md) | | |
|
|
182
|
+
|
|
183
|
+
### Return type
|
|
184
|
+
|
|
185
|
+
[**BulkDeleteEmailsResponse**](BulkDeleteEmailsResponse.md)
|
|
186
|
+
|
|
187
|
+
### Authorization
|
|
188
|
+
|
|
189
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
190
|
+
|
|
191
|
+
### HTTP request headers
|
|
192
|
+
|
|
193
|
+
- **Content-Type**: application/json
|
|
194
|
+
- **Accept**: application/json
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
## bulk_mark_emails_read
|
|
198
|
+
|
|
199
|
+
> <BulkMarkReadResponse> bulk_mark_emails_read(bulk_mark_read_request)
|
|
200
|
+
|
|
201
|
+
Mark multiple messages read or unread in one call.
|
|
202
|
+
|
|
203
|
+
### Examples
|
|
204
|
+
|
|
205
|
+
```ruby
|
|
206
|
+
require 'time'
|
|
207
|
+
require 'spatio-sdk'
|
|
208
|
+
# setup authorization
|
|
209
|
+
Spatio.configure do |config|
|
|
210
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
211
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
212
|
+
end
|
|
213
|
+
|
|
214
|
+
api_instance = Spatio::MailApi.new
|
|
215
|
+
bulk_mark_read_request = Spatio::BulkMarkReadRequest.new({message_ids: ['message_ids_example']}) # BulkMarkReadRequest |
|
|
216
|
+
|
|
217
|
+
begin
|
|
218
|
+
# Mark multiple messages read or unread in one call.
|
|
219
|
+
result = api_instance.bulk_mark_emails_read(bulk_mark_read_request)
|
|
220
|
+
p result
|
|
221
|
+
rescue Spatio::ApiError => e
|
|
222
|
+
puts "Error when calling MailApi->bulk_mark_emails_read: #{e}"
|
|
223
|
+
end
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
#### Using the bulk_mark_emails_read_with_http_info variant
|
|
227
|
+
|
|
228
|
+
This returns an Array which contains the response data, status code and headers.
|
|
229
|
+
|
|
230
|
+
> <Array(<BulkMarkReadResponse>, Integer, Hash)> bulk_mark_emails_read_with_http_info(bulk_mark_read_request)
|
|
231
|
+
|
|
232
|
+
```ruby
|
|
233
|
+
begin
|
|
234
|
+
# Mark multiple messages read or unread in one call.
|
|
235
|
+
data, status_code, headers = api_instance.bulk_mark_emails_read_with_http_info(bulk_mark_read_request)
|
|
236
|
+
p status_code # => 2xx
|
|
237
|
+
p headers # => { ... }
|
|
238
|
+
p data # => <BulkMarkReadResponse>
|
|
239
|
+
rescue Spatio::ApiError => e
|
|
240
|
+
puts "Error when calling MailApi->bulk_mark_emails_read_with_http_info: #{e}"
|
|
241
|
+
end
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### Parameters
|
|
245
|
+
|
|
246
|
+
| Name | Type | Description | Notes |
|
|
247
|
+
| ---- | ---- | ----------- | ----- |
|
|
248
|
+
| **bulk_mark_read_request** | [**BulkMarkReadRequest**](BulkMarkReadRequest.md) | | |
|
|
249
|
+
|
|
250
|
+
### Return type
|
|
251
|
+
|
|
252
|
+
[**BulkMarkReadResponse**](BulkMarkReadResponse.md)
|
|
253
|
+
|
|
254
|
+
### Authorization
|
|
255
|
+
|
|
256
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
257
|
+
|
|
258
|
+
### HTTP request headers
|
|
259
|
+
|
|
260
|
+
- **Content-Type**: application/json
|
|
261
|
+
- **Accept**: application/json
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
## create_draft
|
|
265
|
+
|
|
266
|
+
> <DraftResponse> create_draft(create_draft_request, opts)
|
|
267
|
+
|
|
268
|
+
Create a draft.
|
|
269
|
+
|
|
270
|
+
### Examples
|
|
271
|
+
|
|
272
|
+
```ruby
|
|
273
|
+
require 'time'
|
|
274
|
+
require 'spatio-sdk'
|
|
275
|
+
# setup authorization
|
|
276
|
+
Spatio.configure do |config|
|
|
277
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
278
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
279
|
+
end
|
|
280
|
+
|
|
281
|
+
api_instance = Spatio::MailApi.new
|
|
282
|
+
create_draft_request = Spatio::CreateDraftRequest.new # CreateDraftRequest |
|
|
283
|
+
opts = {
|
|
284
|
+
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.
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
begin
|
|
288
|
+
# Create a draft.
|
|
289
|
+
result = api_instance.create_draft(create_draft_request, opts)
|
|
290
|
+
p result
|
|
291
|
+
rescue Spatio::ApiError => e
|
|
292
|
+
puts "Error when calling MailApi->create_draft: #{e}"
|
|
293
|
+
end
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
#### Using the create_draft_with_http_info variant
|
|
297
|
+
|
|
298
|
+
This returns an Array which contains the response data, status code and headers.
|
|
299
|
+
|
|
300
|
+
> <Array(<DraftResponse>, Integer, Hash)> create_draft_with_http_info(create_draft_request, opts)
|
|
301
|
+
|
|
302
|
+
```ruby
|
|
303
|
+
begin
|
|
304
|
+
# Create a draft.
|
|
305
|
+
data, status_code, headers = api_instance.create_draft_with_http_info(create_draft_request, opts)
|
|
306
|
+
p status_code # => 2xx
|
|
307
|
+
p headers # => { ... }
|
|
308
|
+
p data # => <DraftResponse>
|
|
309
|
+
rescue Spatio::ApiError => e
|
|
310
|
+
puts "Error when calling MailApi->create_draft_with_http_info: #{e}"
|
|
311
|
+
end
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
### Parameters
|
|
315
|
+
|
|
316
|
+
| Name | Type | Description | Notes |
|
|
317
|
+
| ---- | ---- | ----------- | ----- |
|
|
318
|
+
| **create_draft_request** | [**CreateDraftRequest**](CreateDraftRequest.md) | | |
|
|
319
|
+
| **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] |
|
|
320
|
+
|
|
321
|
+
### Return type
|
|
322
|
+
|
|
323
|
+
[**DraftResponse**](DraftResponse.md)
|
|
324
|
+
|
|
325
|
+
### Authorization
|
|
326
|
+
|
|
327
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
328
|
+
|
|
329
|
+
### HTTP request headers
|
|
330
|
+
|
|
331
|
+
- **Content-Type**: application/json
|
|
332
|
+
- **Accept**: application/json
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
## create_email_label
|
|
336
|
+
|
|
337
|
+
> <CreateLabelResponse> create_email_label(create_label_request, opts)
|
|
338
|
+
|
|
339
|
+
Create a label.
|
|
340
|
+
|
|
341
|
+
### Examples
|
|
342
|
+
|
|
343
|
+
```ruby
|
|
344
|
+
require 'time'
|
|
345
|
+
require 'spatio-sdk'
|
|
346
|
+
# setup authorization
|
|
347
|
+
Spatio.configure do |config|
|
|
348
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
349
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
350
|
+
end
|
|
351
|
+
|
|
352
|
+
api_instance = Spatio::MailApi.new
|
|
353
|
+
create_label_request = Spatio::CreateLabelRequest.new({name: 'name_example'}) # CreateLabelRequest |
|
|
354
|
+
opts = {
|
|
355
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
356
|
+
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.
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
begin
|
|
360
|
+
# Create a label.
|
|
361
|
+
result = api_instance.create_email_label(create_label_request, opts)
|
|
362
|
+
p result
|
|
363
|
+
rescue Spatio::ApiError => e
|
|
364
|
+
puts "Error when calling MailApi->create_email_label: #{e}"
|
|
365
|
+
end
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
#### Using the create_email_label_with_http_info variant
|
|
369
|
+
|
|
370
|
+
This returns an Array which contains the response data, status code and headers.
|
|
371
|
+
|
|
372
|
+
> <Array(<CreateLabelResponse>, Integer, Hash)> create_email_label_with_http_info(create_label_request, opts)
|
|
373
|
+
|
|
374
|
+
```ruby
|
|
375
|
+
begin
|
|
376
|
+
# Create a label.
|
|
377
|
+
data, status_code, headers = api_instance.create_email_label_with_http_info(create_label_request, opts)
|
|
378
|
+
p status_code # => 2xx
|
|
379
|
+
p headers # => { ... }
|
|
380
|
+
p data # => <CreateLabelResponse>
|
|
381
|
+
rescue Spatio::ApiError => e
|
|
382
|
+
puts "Error when calling MailApi->create_email_label_with_http_info: #{e}"
|
|
383
|
+
end
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
### Parameters
|
|
387
|
+
|
|
388
|
+
| Name | Type | Description | Notes |
|
|
389
|
+
| ---- | ---- | ----------- | ----- |
|
|
390
|
+
| **create_label_request** | [**CreateLabelRequest**](CreateLabelRequest.md) | | |
|
|
391
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
392
|
+
| **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] |
|
|
393
|
+
|
|
394
|
+
### Return type
|
|
395
|
+
|
|
396
|
+
[**CreateLabelResponse**](CreateLabelResponse.md)
|
|
397
|
+
|
|
398
|
+
### Authorization
|
|
399
|
+
|
|
400
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
401
|
+
|
|
402
|
+
### HTTP request headers
|
|
403
|
+
|
|
404
|
+
- **Content-Type**: application/json
|
|
405
|
+
- **Accept**: application/json
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
## create_mail_template
|
|
409
|
+
|
|
410
|
+
> Hash<String, Object> create_mail_template(request_body)
|
|
411
|
+
|
|
412
|
+
Create a mail template.
|
|
413
|
+
|
|
414
|
+
### Examples
|
|
415
|
+
|
|
416
|
+
```ruby
|
|
417
|
+
require 'time'
|
|
418
|
+
require 'spatio-sdk'
|
|
419
|
+
# setup authorization
|
|
420
|
+
Spatio.configure do |config|
|
|
421
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
422
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
423
|
+
end
|
|
424
|
+
|
|
425
|
+
api_instance = Spatio::MailApi.new
|
|
426
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
427
|
+
|
|
428
|
+
begin
|
|
429
|
+
# Create a mail template.
|
|
430
|
+
result = api_instance.create_mail_template(request_body)
|
|
431
|
+
p result
|
|
432
|
+
rescue Spatio::ApiError => e
|
|
433
|
+
puts "Error when calling MailApi->create_mail_template: #{e}"
|
|
434
|
+
end
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
#### Using the create_mail_template_with_http_info variant
|
|
438
|
+
|
|
439
|
+
This returns an Array which contains the response data, status code and headers.
|
|
440
|
+
|
|
441
|
+
> <Array(Hash<String, Object>, Integer, Hash)> create_mail_template_with_http_info(request_body)
|
|
442
|
+
|
|
443
|
+
```ruby
|
|
444
|
+
begin
|
|
445
|
+
# Create a mail template.
|
|
446
|
+
data, status_code, headers = api_instance.create_mail_template_with_http_info(request_body)
|
|
447
|
+
p status_code # => 2xx
|
|
448
|
+
p headers # => { ... }
|
|
449
|
+
p data # => Hash<String, Object>
|
|
450
|
+
rescue Spatio::ApiError => e
|
|
451
|
+
puts "Error when calling MailApi->create_mail_template_with_http_info: #{e}"
|
|
452
|
+
end
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
### Parameters
|
|
456
|
+
|
|
457
|
+
| Name | Type | Description | Notes |
|
|
458
|
+
| ---- | ---- | ----------- | ----- |
|
|
459
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
460
|
+
|
|
461
|
+
### Return type
|
|
462
|
+
|
|
463
|
+
**Hash<String, Object>**
|
|
464
|
+
|
|
465
|
+
### Authorization
|
|
466
|
+
|
|
467
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
468
|
+
|
|
469
|
+
### HTTP request headers
|
|
470
|
+
|
|
471
|
+
- **Content-Type**: application/json
|
|
472
|
+
- **Accept**: application/json
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
## delete_draft
|
|
476
|
+
|
|
477
|
+
> delete_draft(id, opts)
|
|
478
|
+
|
|
479
|
+
Delete a draft.
|
|
480
|
+
|
|
481
|
+
### Examples
|
|
482
|
+
|
|
483
|
+
```ruby
|
|
484
|
+
require 'time'
|
|
485
|
+
require 'spatio-sdk'
|
|
486
|
+
# setup authorization
|
|
487
|
+
Spatio.configure do |config|
|
|
488
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
489
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
490
|
+
end
|
|
491
|
+
|
|
492
|
+
api_instance = Spatio::MailApi.new
|
|
493
|
+
id = 'id_example' # String | Draft id.
|
|
494
|
+
opts = {
|
|
495
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
496
|
+
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.
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
begin
|
|
500
|
+
# Delete a draft.
|
|
501
|
+
api_instance.delete_draft(id, opts)
|
|
502
|
+
rescue Spatio::ApiError => e
|
|
503
|
+
puts "Error when calling MailApi->delete_draft: #{e}"
|
|
504
|
+
end
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
#### Using the delete_draft_with_http_info variant
|
|
508
|
+
|
|
509
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
510
|
+
|
|
511
|
+
> <Array(nil, Integer, Hash)> delete_draft_with_http_info(id, opts)
|
|
512
|
+
|
|
513
|
+
```ruby
|
|
514
|
+
begin
|
|
515
|
+
# Delete a draft.
|
|
516
|
+
data, status_code, headers = api_instance.delete_draft_with_http_info(id, opts)
|
|
517
|
+
p status_code # => 2xx
|
|
518
|
+
p headers # => { ... }
|
|
519
|
+
p data # => nil
|
|
520
|
+
rescue Spatio::ApiError => e
|
|
521
|
+
puts "Error when calling MailApi->delete_draft_with_http_info: #{e}"
|
|
522
|
+
end
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
### Parameters
|
|
526
|
+
|
|
527
|
+
| Name | Type | Description | Notes |
|
|
528
|
+
| ---- | ---- | ----------- | ----- |
|
|
529
|
+
| **id** | **String** | Draft id. | |
|
|
530
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
531
|
+
| **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] |
|
|
532
|
+
|
|
533
|
+
### Return type
|
|
534
|
+
|
|
535
|
+
nil (empty response body)
|
|
536
|
+
|
|
537
|
+
### Authorization
|
|
538
|
+
|
|
539
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
540
|
+
|
|
541
|
+
### HTTP request headers
|
|
542
|
+
|
|
543
|
+
- **Content-Type**: Not defined
|
|
544
|
+
- **Accept**: application/json
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
## delete_email
|
|
548
|
+
|
|
549
|
+
> <SuccessFlag> delete_email(id, opts)
|
|
550
|
+
|
|
551
|
+
Delete an email.
|
|
552
|
+
|
|
553
|
+
Soft-deletes (moves to provider trash).
|
|
554
|
+
|
|
555
|
+
### Examples
|
|
556
|
+
|
|
557
|
+
```ruby
|
|
558
|
+
require 'time'
|
|
559
|
+
require 'spatio-sdk'
|
|
560
|
+
# setup authorization
|
|
561
|
+
Spatio.configure do |config|
|
|
562
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
563
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
564
|
+
end
|
|
565
|
+
|
|
566
|
+
api_instance = Spatio::MailApi.new
|
|
567
|
+
id = 'id_example' # String | Email message id.
|
|
568
|
+
opts = {
|
|
569
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
570
|
+
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.
|
|
571
|
+
}
|
|
572
|
+
|
|
573
|
+
begin
|
|
574
|
+
# Delete an email.
|
|
575
|
+
result = api_instance.delete_email(id, opts)
|
|
576
|
+
p result
|
|
577
|
+
rescue Spatio::ApiError => e
|
|
578
|
+
puts "Error when calling MailApi->delete_email: #{e}"
|
|
579
|
+
end
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
#### Using the delete_email_with_http_info variant
|
|
583
|
+
|
|
584
|
+
This returns an Array which contains the response data, status code and headers.
|
|
585
|
+
|
|
586
|
+
> <Array(<SuccessFlag>, Integer, Hash)> delete_email_with_http_info(id, opts)
|
|
587
|
+
|
|
588
|
+
```ruby
|
|
589
|
+
begin
|
|
590
|
+
# Delete an email.
|
|
591
|
+
data, status_code, headers = api_instance.delete_email_with_http_info(id, opts)
|
|
592
|
+
p status_code # => 2xx
|
|
593
|
+
p headers # => { ... }
|
|
594
|
+
p data # => <SuccessFlag>
|
|
595
|
+
rescue Spatio::ApiError => e
|
|
596
|
+
puts "Error when calling MailApi->delete_email_with_http_info: #{e}"
|
|
597
|
+
end
|
|
598
|
+
```
|
|
599
|
+
|
|
600
|
+
### Parameters
|
|
601
|
+
|
|
602
|
+
| Name | Type | Description | Notes |
|
|
603
|
+
| ---- | ---- | ----------- | ----- |
|
|
604
|
+
| **id** | **String** | Email message id. | |
|
|
605
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
606
|
+
| **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] |
|
|
607
|
+
|
|
608
|
+
### Return type
|
|
609
|
+
|
|
610
|
+
[**SuccessFlag**](SuccessFlag.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
|
+
## delete_email_label
|
|
623
|
+
|
|
624
|
+
> delete_email_label(id, opts)
|
|
625
|
+
|
|
626
|
+
Delete a label.
|
|
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::MailApi.new
|
|
640
|
+
id = 'id_example' # String | Label id.
|
|
641
|
+
opts = {
|
|
642
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
643
|
+
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.
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
begin
|
|
647
|
+
# Delete a label.
|
|
648
|
+
api_instance.delete_email_label(id, opts)
|
|
649
|
+
rescue Spatio::ApiError => e
|
|
650
|
+
puts "Error when calling MailApi->delete_email_label: #{e}"
|
|
651
|
+
end
|
|
652
|
+
```
|
|
653
|
+
|
|
654
|
+
#### Using the delete_email_label_with_http_info variant
|
|
655
|
+
|
|
656
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
657
|
+
|
|
658
|
+
> <Array(nil, Integer, Hash)> delete_email_label_with_http_info(id, opts)
|
|
659
|
+
|
|
660
|
+
```ruby
|
|
661
|
+
begin
|
|
662
|
+
# Delete a label.
|
|
663
|
+
data, status_code, headers = api_instance.delete_email_label_with_http_info(id, opts)
|
|
664
|
+
p status_code # => 2xx
|
|
665
|
+
p headers # => { ... }
|
|
666
|
+
p data # => nil
|
|
667
|
+
rescue Spatio::ApiError => e
|
|
668
|
+
puts "Error when calling MailApi->delete_email_label_with_http_info: #{e}"
|
|
669
|
+
end
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
### Parameters
|
|
673
|
+
|
|
674
|
+
| Name | Type | Description | Notes |
|
|
675
|
+
| ---- | ---- | ----------- | ----- |
|
|
676
|
+
| **id** | **String** | Label id. | |
|
|
677
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
678
|
+
| **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] |
|
|
679
|
+
|
|
680
|
+
### Return type
|
|
681
|
+
|
|
682
|
+
nil (empty response body)
|
|
683
|
+
|
|
684
|
+
### Authorization
|
|
685
|
+
|
|
686
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
687
|
+
|
|
688
|
+
### HTTP request headers
|
|
689
|
+
|
|
690
|
+
- **Content-Type**: Not defined
|
|
691
|
+
- **Accept**: application/json
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
## delete_mail_template
|
|
695
|
+
|
|
696
|
+
> delete_mail_template(id)
|
|
697
|
+
|
|
698
|
+
Delete a mail template.
|
|
699
|
+
|
|
700
|
+
### Examples
|
|
701
|
+
|
|
702
|
+
```ruby
|
|
703
|
+
require 'time'
|
|
704
|
+
require 'spatio-sdk'
|
|
705
|
+
# setup authorization
|
|
706
|
+
Spatio.configure do |config|
|
|
707
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
708
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
709
|
+
end
|
|
710
|
+
|
|
711
|
+
api_instance = Spatio::MailApi.new
|
|
712
|
+
id = 'id_example' # String |
|
|
713
|
+
|
|
714
|
+
begin
|
|
715
|
+
# Delete a mail template.
|
|
716
|
+
api_instance.delete_mail_template(id)
|
|
717
|
+
rescue Spatio::ApiError => e
|
|
718
|
+
puts "Error when calling MailApi->delete_mail_template: #{e}"
|
|
719
|
+
end
|
|
720
|
+
```
|
|
721
|
+
|
|
722
|
+
#### Using the delete_mail_template_with_http_info variant
|
|
723
|
+
|
|
724
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
725
|
+
|
|
726
|
+
> <Array(nil, Integer, Hash)> delete_mail_template_with_http_info(id)
|
|
727
|
+
|
|
728
|
+
```ruby
|
|
729
|
+
begin
|
|
730
|
+
# Delete a mail template.
|
|
731
|
+
data, status_code, headers = api_instance.delete_mail_template_with_http_info(id)
|
|
732
|
+
p status_code # => 2xx
|
|
733
|
+
p headers # => { ... }
|
|
734
|
+
p data # => nil
|
|
735
|
+
rescue Spatio::ApiError => e
|
|
736
|
+
puts "Error when calling MailApi->delete_mail_template_with_http_info: #{e}"
|
|
737
|
+
end
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
### Parameters
|
|
741
|
+
|
|
742
|
+
| Name | Type | Description | Notes |
|
|
743
|
+
| ---- | ---- | ----------- | ----- |
|
|
744
|
+
| **id** | **String** | | |
|
|
745
|
+
|
|
746
|
+
### Return type
|
|
747
|
+
|
|
748
|
+
nil (empty response body)
|
|
749
|
+
|
|
750
|
+
### Authorization
|
|
751
|
+
|
|
752
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
753
|
+
|
|
754
|
+
### HTTP request headers
|
|
755
|
+
|
|
756
|
+
- **Content-Type**: Not defined
|
|
757
|
+
- **Accept**: application/json
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
## get_email
|
|
761
|
+
|
|
762
|
+
> <GetEmailResponse> get_email(id, opts)
|
|
763
|
+
|
|
764
|
+
Fetch one email.
|
|
765
|
+
|
|
766
|
+
### Examples
|
|
767
|
+
|
|
768
|
+
```ruby
|
|
769
|
+
require 'time'
|
|
770
|
+
require 'spatio-sdk'
|
|
771
|
+
# setup authorization
|
|
772
|
+
Spatio.configure do |config|
|
|
773
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
774
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
775
|
+
end
|
|
776
|
+
|
|
777
|
+
api_instance = Spatio::MailApi.new
|
|
778
|
+
id = 'id_example' # String | Email message id.
|
|
779
|
+
opts = {
|
|
780
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
781
|
+
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.
|
|
782
|
+
}
|
|
783
|
+
|
|
784
|
+
begin
|
|
785
|
+
# Fetch one email.
|
|
786
|
+
result = api_instance.get_email(id, opts)
|
|
787
|
+
p result
|
|
788
|
+
rescue Spatio::ApiError => e
|
|
789
|
+
puts "Error when calling MailApi->get_email: #{e}"
|
|
790
|
+
end
|
|
791
|
+
```
|
|
792
|
+
|
|
793
|
+
#### Using the get_email_with_http_info variant
|
|
794
|
+
|
|
795
|
+
This returns an Array which contains the response data, status code and headers.
|
|
796
|
+
|
|
797
|
+
> <Array(<GetEmailResponse>, Integer, Hash)> get_email_with_http_info(id, opts)
|
|
798
|
+
|
|
799
|
+
```ruby
|
|
800
|
+
begin
|
|
801
|
+
# Fetch one email.
|
|
802
|
+
data, status_code, headers = api_instance.get_email_with_http_info(id, opts)
|
|
803
|
+
p status_code # => 2xx
|
|
804
|
+
p headers # => { ... }
|
|
805
|
+
p data # => <GetEmailResponse>
|
|
806
|
+
rescue Spatio::ApiError => e
|
|
807
|
+
puts "Error when calling MailApi->get_email_with_http_info: #{e}"
|
|
808
|
+
end
|
|
809
|
+
```
|
|
810
|
+
|
|
811
|
+
### Parameters
|
|
812
|
+
|
|
813
|
+
| Name | Type | Description | Notes |
|
|
814
|
+
| ---- | ---- | ----------- | ----- |
|
|
815
|
+
| **id** | **String** | Email message id. | |
|
|
816
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
817
|
+
| **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] |
|
|
818
|
+
|
|
819
|
+
### Return type
|
|
820
|
+
|
|
821
|
+
[**GetEmailResponse**](GetEmailResponse.md)
|
|
822
|
+
|
|
823
|
+
### Authorization
|
|
824
|
+
|
|
825
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
826
|
+
|
|
827
|
+
### HTTP request headers
|
|
828
|
+
|
|
829
|
+
- **Content-Type**: Not defined
|
|
830
|
+
- **Accept**: application/json
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
## get_email_attachment
|
|
834
|
+
|
|
835
|
+
> File get_email_attachment(message_id, attachment_id, opts)
|
|
836
|
+
|
|
837
|
+
Download an attachment.
|
|
838
|
+
|
|
839
|
+
Streams the attachment binary. Response `Content-Type` matches the attachment's declared MIME type; `Content-Disposition` sets the filename.
|
|
840
|
+
|
|
841
|
+
### Examples
|
|
842
|
+
|
|
843
|
+
```ruby
|
|
844
|
+
require 'time'
|
|
845
|
+
require 'spatio-sdk'
|
|
846
|
+
# setup authorization
|
|
847
|
+
Spatio.configure do |config|
|
|
848
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
849
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
850
|
+
end
|
|
851
|
+
|
|
852
|
+
api_instance = Spatio::MailApi.new
|
|
853
|
+
message_id = 'message_id_example' # String | Message id the attachment belongs to.
|
|
854
|
+
attachment_id = 'attachment_id_example' # String | Attachment id within the message.
|
|
855
|
+
opts = {
|
|
856
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
857
|
+
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.
|
|
858
|
+
}
|
|
859
|
+
|
|
860
|
+
begin
|
|
861
|
+
# Download an attachment.
|
|
862
|
+
result = api_instance.get_email_attachment(message_id, attachment_id, opts)
|
|
863
|
+
p result
|
|
864
|
+
rescue Spatio::ApiError => e
|
|
865
|
+
puts "Error when calling MailApi->get_email_attachment: #{e}"
|
|
866
|
+
end
|
|
867
|
+
```
|
|
868
|
+
|
|
869
|
+
#### Using the get_email_attachment_with_http_info variant
|
|
870
|
+
|
|
871
|
+
This returns an Array which contains the response data, status code and headers.
|
|
872
|
+
|
|
873
|
+
> <Array(File, Integer, Hash)> get_email_attachment_with_http_info(message_id, attachment_id, opts)
|
|
874
|
+
|
|
875
|
+
```ruby
|
|
876
|
+
begin
|
|
877
|
+
# Download an attachment.
|
|
878
|
+
data, status_code, headers = api_instance.get_email_attachment_with_http_info(message_id, attachment_id, opts)
|
|
879
|
+
p status_code # => 2xx
|
|
880
|
+
p headers # => { ... }
|
|
881
|
+
p data # => File
|
|
882
|
+
rescue Spatio::ApiError => e
|
|
883
|
+
puts "Error when calling MailApi->get_email_attachment_with_http_info: #{e}"
|
|
884
|
+
end
|
|
885
|
+
```
|
|
886
|
+
|
|
887
|
+
### Parameters
|
|
888
|
+
|
|
889
|
+
| Name | Type | Description | Notes |
|
|
890
|
+
| ---- | ---- | ----------- | ----- |
|
|
891
|
+
| **message_id** | **String** | Message id the attachment belongs to. | |
|
|
892
|
+
| **attachment_id** | **String** | Attachment id within the message. | |
|
|
893
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
894
|
+
| **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] |
|
|
895
|
+
|
|
896
|
+
### Return type
|
|
897
|
+
|
|
898
|
+
**File**
|
|
899
|
+
|
|
900
|
+
### Authorization
|
|
901
|
+
|
|
902
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
903
|
+
|
|
904
|
+
### HTTP request headers
|
|
905
|
+
|
|
906
|
+
- **Content-Type**: Not defined
|
|
907
|
+
- **Accept**: application/octet-stream, application/json
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
## get_email_thread
|
|
911
|
+
|
|
912
|
+
> <GetThreadResponse> get_email_thread(id, opts)
|
|
913
|
+
|
|
914
|
+
Fetch a thread (the conversation a message belongs to).
|
|
915
|
+
|
|
916
|
+
### Examples
|
|
917
|
+
|
|
918
|
+
```ruby
|
|
919
|
+
require 'time'
|
|
920
|
+
require 'spatio-sdk'
|
|
921
|
+
# setup authorization
|
|
922
|
+
Spatio.configure do |config|
|
|
923
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
924
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
925
|
+
end
|
|
926
|
+
|
|
927
|
+
api_instance = Spatio::MailApi.new
|
|
928
|
+
id = 'id_example' # String | Thread id.
|
|
929
|
+
opts = {
|
|
930
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
931
|
+
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.
|
|
932
|
+
}
|
|
933
|
+
|
|
934
|
+
begin
|
|
935
|
+
# Fetch a thread (the conversation a message belongs to).
|
|
936
|
+
result = api_instance.get_email_thread(id, opts)
|
|
937
|
+
p result
|
|
938
|
+
rescue Spatio::ApiError => e
|
|
939
|
+
puts "Error when calling MailApi->get_email_thread: #{e}"
|
|
940
|
+
end
|
|
941
|
+
```
|
|
942
|
+
|
|
943
|
+
#### Using the get_email_thread_with_http_info variant
|
|
944
|
+
|
|
945
|
+
This returns an Array which contains the response data, status code and headers.
|
|
946
|
+
|
|
947
|
+
> <Array(<GetThreadResponse>, Integer, Hash)> get_email_thread_with_http_info(id, opts)
|
|
948
|
+
|
|
949
|
+
```ruby
|
|
950
|
+
begin
|
|
951
|
+
# Fetch a thread (the conversation a message belongs to).
|
|
952
|
+
data, status_code, headers = api_instance.get_email_thread_with_http_info(id, opts)
|
|
953
|
+
p status_code # => 2xx
|
|
954
|
+
p headers # => { ... }
|
|
955
|
+
p data # => <GetThreadResponse>
|
|
956
|
+
rescue Spatio::ApiError => e
|
|
957
|
+
puts "Error when calling MailApi->get_email_thread_with_http_info: #{e}"
|
|
958
|
+
end
|
|
959
|
+
```
|
|
960
|
+
|
|
961
|
+
### Parameters
|
|
962
|
+
|
|
963
|
+
| Name | Type | Description | Notes |
|
|
964
|
+
| ---- | ---- | ----------- | ----- |
|
|
965
|
+
| **id** | **String** | Thread id. | |
|
|
966
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
967
|
+
| **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] |
|
|
968
|
+
|
|
969
|
+
### Return type
|
|
970
|
+
|
|
971
|
+
[**GetThreadResponse**](GetThreadResponse.md)
|
|
972
|
+
|
|
973
|
+
### Authorization
|
|
974
|
+
|
|
975
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
976
|
+
|
|
977
|
+
### HTTP request headers
|
|
978
|
+
|
|
979
|
+
- **Content-Type**: Not defined
|
|
980
|
+
- **Accept**: application/json
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
## get_mail_template
|
|
984
|
+
|
|
985
|
+
> Hash<String, Object> get_mail_template(id)
|
|
986
|
+
|
|
987
|
+
Fetch a mail template.
|
|
988
|
+
|
|
989
|
+
### Examples
|
|
990
|
+
|
|
991
|
+
```ruby
|
|
992
|
+
require 'time'
|
|
993
|
+
require 'spatio-sdk'
|
|
994
|
+
# setup authorization
|
|
995
|
+
Spatio.configure do |config|
|
|
996
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
997
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
998
|
+
end
|
|
999
|
+
|
|
1000
|
+
api_instance = Spatio::MailApi.new
|
|
1001
|
+
id = 'id_example' # String |
|
|
1002
|
+
|
|
1003
|
+
begin
|
|
1004
|
+
# Fetch a mail template.
|
|
1005
|
+
result = api_instance.get_mail_template(id)
|
|
1006
|
+
p result
|
|
1007
|
+
rescue Spatio::ApiError => e
|
|
1008
|
+
puts "Error when calling MailApi->get_mail_template: #{e}"
|
|
1009
|
+
end
|
|
1010
|
+
```
|
|
1011
|
+
|
|
1012
|
+
#### Using the get_mail_template_with_http_info variant
|
|
1013
|
+
|
|
1014
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1015
|
+
|
|
1016
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_mail_template_with_http_info(id)
|
|
1017
|
+
|
|
1018
|
+
```ruby
|
|
1019
|
+
begin
|
|
1020
|
+
# Fetch a mail template.
|
|
1021
|
+
data, status_code, headers = api_instance.get_mail_template_with_http_info(id)
|
|
1022
|
+
p status_code # => 2xx
|
|
1023
|
+
p headers # => { ... }
|
|
1024
|
+
p data # => Hash<String, Object>
|
|
1025
|
+
rescue Spatio::ApiError => e
|
|
1026
|
+
puts "Error when calling MailApi->get_mail_template_with_http_info: #{e}"
|
|
1027
|
+
end
|
|
1028
|
+
```
|
|
1029
|
+
|
|
1030
|
+
### Parameters
|
|
1031
|
+
|
|
1032
|
+
| Name | Type | Description | Notes |
|
|
1033
|
+
| ---- | ---- | ----------- | ----- |
|
|
1034
|
+
| **id** | **String** | | |
|
|
1035
|
+
|
|
1036
|
+
### Return type
|
|
1037
|
+
|
|
1038
|
+
**Hash<String, Object>**
|
|
1039
|
+
|
|
1040
|
+
### Authorization
|
|
1041
|
+
|
|
1042
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1043
|
+
|
|
1044
|
+
### HTTP request headers
|
|
1045
|
+
|
|
1046
|
+
- **Content-Type**: Not defined
|
|
1047
|
+
- **Accept**: application/json
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
## get_mail_thread_tracking
|
|
1051
|
+
|
|
1052
|
+
> Hash<String, Object> get_mail_thread_tracking(thread_id)
|
|
1053
|
+
|
|
1054
|
+
Read mail-tracking events for a thread (open log, reply log, etc.).
|
|
1055
|
+
|
|
1056
|
+
### Examples
|
|
1057
|
+
|
|
1058
|
+
```ruby
|
|
1059
|
+
require 'time'
|
|
1060
|
+
require 'spatio-sdk'
|
|
1061
|
+
# setup authorization
|
|
1062
|
+
Spatio.configure do |config|
|
|
1063
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1064
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1065
|
+
end
|
|
1066
|
+
|
|
1067
|
+
api_instance = Spatio::MailApi.new
|
|
1068
|
+
thread_id = 'thread_id_example' # String |
|
|
1069
|
+
|
|
1070
|
+
begin
|
|
1071
|
+
# Read mail-tracking events for a thread (open log, reply log, etc.).
|
|
1072
|
+
result = api_instance.get_mail_thread_tracking(thread_id)
|
|
1073
|
+
p result
|
|
1074
|
+
rescue Spatio::ApiError => e
|
|
1075
|
+
puts "Error when calling MailApi->get_mail_thread_tracking: #{e}"
|
|
1076
|
+
end
|
|
1077
|
+
```
|
|
1078
|
+
|
|
1079
|
+
#### Using the get_mail_thread_tracking_with_http_info variant
|
|
1080
|
+
|
|
1081
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1082
|
+
|
|
1083
|
+
> <Array(Hash<String, Object>, Integer, Hash)> get_mail_thread_tracking_with_http_info(thread_id)
|
|
1084
|
+
|
|
1085
|
+
```ruby
|
|
1086
|
+
begin
|
|
1087
|
+
# Read mail-tracking events for a thread (open log, reply log, etc.).
|
|
1088
|
+
data, status_code, headers = api_instance.get_mail_thread_tracking_with_http_info(thread_id)
|
|
1089
|
+
p status_code # => 2xx
|
|
1090
|
+
p headers # => { ... }
|
|
1091
|
+
p data # => Hash<String, Object>
|
|
1092
|
+
rescue Spatio::ApiError => e
|
|
1093
|
+
puts "Error when calling MailApi->get_mail_thread_tracking_with_http_info: #{e}"
|
|
1094
|
+
end
|
|
1095
|
+
```
|
|
1096
|
+
|
|
1097
|
+
### Parameters
|
|
1098
|
+
|
|
1099
|
+
| Name | Type | Description | Notes |
|
|
1100
|
+
| ---- | ---- | ----------- | ----- |
|
|
1101
|
+
| **thread_id** | **String** | | |
|
|
1102
|
+
|
|
1103
|
+
### Return type
|
|
1104
|
+
|
|
1105
|
+
**Hash<String, Object>**
|
|
1106
|
+
|
|
1107
|
+
### Authorization
|
|
1108
|
+
|
|
1109
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1110
|
+
|
|
1111
|
+
### HTTP request headers
|
|
1112
|
+
|
|
1113
|
+
- **Content-Type**: Not defined
|
|
1114
|
+
- **Accept**: application/json
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
## instantiate_mail_template
|
|
1118
|
+
|
|
1119
|
+
> Hash<String, Object> instantiate_mail_template(id, request_body)
|
|
1120
|
+
|
|
1121
|
+
Render a template with variables and return the resulting draft.
|
|
1122
|
+
|
|
1123
|
+
### Examples
|
|
1124
|
+
|
|
1125
|
+
```ruby
|
|
1126
|
+
require 'time'
|
|
1127
|
+
require 'spatio-sdk'
|
|
1128
|
+
# setup authorization
|
|
1129
|
+
Spatio.configure do |config|
|
|
1130
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1131
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1132
|
+
end
|
|
1133
|
+
|
|
1134
|
+
api_instance = Spatio::MailApi.new
|
|
1135
|
+
id = 'id_example' # String |
|
|
1136
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1137
|
+
|
|
1138
|
+
begin
|
|
1139
|
+
# Render a template with variables and return the resulting draft.
|
|
1140
|
+
result = api_instance.instantiate_mail_template(id, request_body)
|
|
1141
|
+
p result
|
|
1142
|
+
rescue Spatio::ApiError => e
|
|
1143
|
+
puts "Error when calling MailApi->instantiate_mail_template: #{e}"
|
|
1144
|
+
end
|
|
1145
|
+
```
|
|
1146
|
+
|
|
1147
|
+
#### Using the instantiate_mail_template_with_http_info variant
|
|
1148
|
+
|
|
1149
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1150
|
+
|
|
1151
|
+
> <Array(Hash<String, Object>, Integer, Hash)> instantiate_mail_template_with_http_info(id, request_body)
|
|
1152
|
+
|
|
1153
|
+
```ruby
|
|
1154
|
+
begin
|
|
1155
|
+
# Render a template with variables and return the resulting draft.
|
|
1156
|
+
data, status_code, headers = api_instance.instantiate_mail_template_with_http_info(id, request_body)
|
|
1157
|
+
p status_code # => 2xx
|
|
1158
|
+
p headers # => { ... }
|
|
1159
|
+
p data # => Hash<String, Object>
|
|
1160
|
+
rescue Spatio::ApiError => e
|
|
1161
|
+
puts "Error when calling MailApi->instantiate_mail_template_with_http_info: #{e}"
|
|
1162
|
+
end
|
|
1163
|
+
```
|
|
1164
|
+
|
|
1165
|
+
### Parameters
|
|
1166
|
+
|
|
1167
|
+
| Name | Type | Description | Notes |
|
|
1168
|
+
| ---- | ---- | ----------- | ----- |
|
|
1169
|
+
| **id** | **String** | | |
|
|
1170
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1171
|
+
|
|
1172
|
+
### Return type
|
|
1173
|
+
|
|
1174
|
+
**Hash<String, Object>**
|
|
1175
|
+
|
|
1176
|
+
### Authorization
|
|
1177
|
+
|
|
1178
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1179
|
+
|
|
1180
|
+
### HTTP request headers
|
|
1181
|
+
|
|
1182
|
+
- **Content-Type**: application/json
|
|
1183
|
+
- **Accept**: application/json
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
## list_drafts
|
|
1187
|
+
|
|
1188
|
+
> <ListDraftsResponse> list_drafts(opts)
|
|
1189
|
+
|
|
1190
|
+
List drafts across connected mail accounts.
|
|
1191
|
+
|
|
1192
|
+
### Examples
|
|
1193
|
+
|
|
1194
|
+
```ruby
|
|
1195
|
+
require 'time'
|
|
1196
|
+
require 'spatio-sdk'
|
|
1197
|
+
# setup authorization
|
|
1198
|
+
Spatio.configure do |config|
|
|
1199
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1200
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1201
|
+
end
|
|
1202
|
+
|
|
1203
|
+
api_instance = Spatio::MailApi.new
|
|
1204
|
+
opts = {
|
|
1205
|
+
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.
|
|
1206
|
+
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.
|
|
1207
|
+
providers: ['inner_example'], # Array<String> | Repeatable. Restrict to these provider ids (`gmail`, `outlook`).
|
|
1208
|
+
limit: 56, # Integer |
|
|
1209
|
+
next_page_token: 'next_page_token_example' # String |
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1212
|
+
begin
|
|
1213
|
+
# List drafts across connected mail accounts.
|
|
1214
|
+
result = api_instance.list_drafts(opts)
|
|
1215
|
+
p result
|
|
1216
|
+
rescue Spatio::ApiError => e
|
|
1217
|
+
puts "Error when calling MailApi->list_drafts: #{e}"
|
|
1218
|
+
end
|
|
1219
|
+
```
|
|
1220
|
+
|
|
1221
|
+
#### Using the list_drafts_with_http_info variant
|
|
1222
|
+
|
|
1223
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1224
|
+
|
|
1225
|
+
> <Array(<ListDraftsResponse>, Integer, Hash)> list_drafts_with_http_info(opts)
|
|
1226
|
+
|
|
1227
|
+
```ruby
|
|
1228
|
+
begin
|
|
1229
|
+
# List drafts across connected mail accounts.
|
|
1230
|
+
data, status_code, headers = api_instance.list_drafts_with_http_info(opts)
|
|
1231
|
+
p status_code # => 2xx
|
|
1232
|
+
p headers # => { ... }
|
|
1233
|
+
p data # => <ListDraftsResponse>
|
|
1234
|
+
rescue Spatio::ApiError => e
|
|
1235
|
+
puts "Error when calling MailApi->list_drafts_with_http_info: #{e}"
|
|
1236
|
+
end
|
|
1237
|
+
```
|
|
1238
|
+
|
|
1239
|
+
### Parameters
|
|
1240
|
+
|
|
1241
|
+
| Name | Type | Description | Notes |
|
|
1242
|
+
| ---- | ---- | ----------- | ----- |
|
|
1243
|
+
| **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] |
|
|
1244
|
+
| **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] |
|
|
1245
|
+
| **providers** | [**Array<String>**](String.md) | Repeatable. Restrict to these provider ids (`gmail`, `outlook`). | [optional] |
|
|
1246
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
1247
|
+
| **next_page_token** | **String** | | [optional] |
|
|
1248
|
+
|
|
1249
|
+
### Return type
|
|
1250
|
+
|
|
1251
|
+
[**ListDraftsResponse**](ListDraftsResponse.md)
|
|
1252
|
+
|
|
1253
|
+
### Authorization
|
|
1254
|
+
|
|
1255
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1256
|
+
|
|
1257
|
+
### HTTP request headers
|
|
1258
|
+
|
|
1259
|
+
- **Content-Type**: Not defined
|
|
1260
|
+
- **Accept**: application/json
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
## list_email_labels
|
|
1264
|
+
|
|
1265
|
+
> <ListLabelsResponse> list_email_labels(opts)
|
|
1266
|
+
|
|
1267
|
+
List labels on the resolved mail account.
|
|
1268
|
+
|
|
1269
|
+
Single-account list. The platform auto-resolves to the caller's sole connected account; pass `?accountId=` to disambiguate when multiple are connected.
|
|
1270
|
+
|
|
1271
|
+
### Examples
|
|
1272
|
+
|
|
1273
|
+
```ruby
|
|
1274
|
+
require 'time'
|
|
1275
|
+
require 'spatio-sdk'
|
|
1276
|
+
# setup authorization
|
|
1277
|
+
Spatio.configure do |config|
|
|
1278
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1279
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1280
|
+
end
|
|
1281
|
+
|
|
1282
|
+
api_instance = Spatio::MailApi.new
|
|
1283
|
+
opts = {
|
|
1284
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1285
|
+
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.
|
|
1286
|
+
}
|
|
1287
|
+
|
|
1288
|
+
begin
|
|
1289
|
+
# List labels on the resolved mail account.
|
|
1290
|
+
result = api_instance.list_email_labels(opts)
|
|
1291
|
+
p result
|
|
1292
|
+
rescue Spatio::ApiError => e
|
|
1293
|
+
puts "Error when calling MailApi->list_email_labels: #{e}"
|
|
1294
|
+
end
|
|
1295
|
+
```
|
|
1296
|
+
|
|
1297
|
+
#### Using the list_email_labels_with_http_info variant
|
|
1298
|
+
|
|
1299
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1300
|
+
|
|
1301
|
+
> <Array(<ListLabelsResponse>, Integer, Hash)> list_email_labels_with_http_info(opts)
|
|
1302
|
+
|
|
1303
|
+
```ruby
|
|
1304
|
+
begin
|
|
1305
|
+
# List labels on the resolved mail account.
|
|
1306
|
+
data, status_code, headers = api_instance.list_email_labels_with_http_info(opts)
|
|
1307
|
+
p status_code # => 2xx
|
|
1308
|
+
p headers # => { ... }
|
|
1309
|
+
p data # => <ListLabelsResponse>
|
|
1310
|
+
rescue Spatio::ApiError => e
|
|
1311
|
+
puts "Error when calling MailApi->list_email_labels_with_http_info: #{e}"
|
|
1312
|
+
end
|
|
1313
|
+
```
|
|
1314
|
+
|
|
1315
|
+
### Parameters
|
|
1316
|
+
|
|
1317
|
+
| Name | Type | Description | Notes |
|
|
1318
|
+
| ---- | ---- | ----------- | ----- |
|
|
1319
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1320
|
+
| **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] |
|
|
1321
|
+
|
|
1322
|
+
### Return type
|
|
1323
|
+
|
|
1324
|
+
[**ListLabelsResponse**](ListLabelsResponse.md)
|
|
1325
|
+
|
|
1326
|
+
### Authorization
|
|
1327
|
+
|
|
1328
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1329
|
+
|
|
1330
|
+
### HTTP request headers
|
|
1331
|
+
|
|
1332
|
+
- **Content-Type**: Not defined
|
|
1333
|
+
- **Accept**: application/json
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
## list_emails
|
|
1337
|
+
|
|
1338
|
+
> <ListEmailsResponse> list_emails(opts)
|
|
1339
|
+
|
|
1340
|
+
List emails across connected mail accounts.
|
|
1341
|
+
|
|
1342
|
+
Fan-out list. Returns messages across every connected mail provider unless filtered. Pass `?accountIds=` (repeatable) to restrict to specific accounts, `?providers=` to restrict to specific provider ids, or both for the intersection.
|
|
1343
|
+
|
|
1344
|
+
### Examples
|
|
1345
|
+
|
|
1346
|
+
```ruby
|
|
1347
|
+
require 'time'
|
|
1348
|
+
require 'spatio-sdk'
|
|
1349
|
+
# setup authorization
|
|
1350
|
+
Spatio.configure do |config|
|
|
1351
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1352
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1353
|
+
end
|
|
1354
|
+
|
|
1355
|
+
api_instance = Spatio::MailApi.new
|
|
1356
|
+
opts = {
|
|
1357
|
+
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.
|
|
1358
|
+
providers: ['inner_example'], # Array<String> | Repeatable. Restrict to these provider ids (`gmail`, `outlook`).
|
|
1359
|
+
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.
|
|
1360
|
+
query: 'query_example', # String | Provider-specific full-text query (e.g. Gmail search syntax).
|
|
1361
|
+
labels: ['inner_example'], # Array<String> | Repeatable. Filter to messages carrying every label.
|
|
1362
|
+
folder: 'folder_example', # String | Logical folder filter. Canonical values: `inbox`, `sent`, `starred`, `trash`, `archive`. Provider-specific folders accepted as opaque strings.
|
|
1363
|
+
limit: 56, # Integer |
|
|
1364
|
+
offset: 56 # Integer |
|
|
1365
|
+
}
|
|
1366
|
+
|
|
1367
|
+
begin
|
|
1368
|
+
# List emails across connected mail accounts.
|
|
1369
|
+
result = api_instance.list_emails(opts)
|
|
1370
|
+
p result
|
|
1371
|
+
rescue Spatio::ApiError => e
|
|
1372
|
+
puts "Error when calling MailApi->list_emails: #{e}"
|
|
1373
|
+
end
|
|
1374
|
+
```
|
|
1375
|
+
|
|
1376
|
+
#### Using the list_emails_with_http_info variant
|
|
1377
|
+
|
|
1378
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1379
|
+
|
|
1380
|
+
> <Array(<ListEmailsResponse>, Integer, Hash)> list_emails_with_http_info(opts)
|
|
1381
|
+
|
|
1382
|
+
```ruby
|
|
1383
|
+
begin
|
|
1384
|
+
# List emails across connected mail accounts.
|
|
1385
|
+
data, status_code, headers = api_instance.list_emails_with_http_info(opts)
|
|
1386
|
+
p status_code # => 2xx
|
|
1387
|
+
p headers # => { ... }
|
|
1388
|
+
p data # => <ListEmailsResponse>
|
|
1389
|
+
rescue Spatio::ApiError => e
|
|
1390
|
+
puts "Error when calling MailApi->list_emails_with_http_info: #{e}"
|
|
1391
|
+
end
|
|
1392
|
+
```
|
|
1393
|
+
|
|
1394
|
+
### Parameters
|
|
1395
|
+
|
|
1396
|
+
| Name | Type | Description | Notes |
|
|
1397
|
+
| ---- | ---- | ----------- | ----- |
|
|
1398
|
+
| **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] |
|
|
1399
|
+
| **providers** | [**Array<String>**](String.md) | Repeatable. Restrict to these provider ids (`gmail`, `outlook`). | [optional] |
|
|
1400
|
+
| **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] |
|
|
1401
|
+
| **query** | **String** | Provider-specific full-text query (e.g. Gmail search syntax). | [optional] |
|
|
1402
|
+
| **labels** | [**Array<String>**](String.md) | Repeatable. Filter to messages carrying every label. | [optional] |
|
|
1403
|
+
| **folder** | **String** | Logical folder filter. Canonical values: `inbox`, `sent`, `starred`, `trash`, `archive`. Provider-specific folders accepted as opaque strings. | [optional] |
|
|
1404
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
1405
|
+
| **offset** | **Integer** | | [optional][default to 0] |
|
|
1406
|
+
|
|
1407
|
+
### Return type
|
|
1408
|
+
|
|
1409
|
+
[**ListEmailsResponse**](ListEmailsResponse.md)
|
|
1410
|
+
|
|
1411
|
+
### Authorization
|
|
1412
|
+
|
|
1413
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1414
|
+
|
|
1415
|
+
### HTTP request headers
|
|
1416
|
+
|
|
1417
|
+
- **Content-Type**: Not defined
|
|
1418
|
+
- **Accept**: application/json
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
## list_mail_templates
|
|
1422
|
+
|
|
1423
|
+
> Hash<String, Object> list_mail_templates
|
|
1424
|
+
|
|
1425
|
+
List the caller's saved mail templates.
|
|
1426
|
+
|
|
1427
|
+
### Examples
|
|
1428
|
+
|
|
1429
|
+
```ruby
|
|
1430
|
+
require 'time'
|
|
1431
|
+
require 'spatio-sdk'
|
|
1432
|
+
# setup authorization
|
|
1433
|
+
Spatio.configure do |config|
|
|
1434
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1435
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1436
|
+
end
|
|
1437
|
+
|
|
1438
|
+
api_instance = Spatio::MailApi.new
|
|
1439
|
+
|
|
1440
|
+
begin
|
|
1441
|
+
# List the caller's saved mail templates.
|
|
1442
|
+
result = api_instance.list_mail_templates
|
|
1443
|
+
p result
|
|
1444
|
+
rescue Spatio::ApiError => e
|
|
1445
|
+
puts "Error when calling MailApi->list_mail_templates: #{e}"
|
|
1446
|
+
end
|
|
1447
|
+
```
|
|
1448
|
+
|
|
1449
|
+
#### Using the list_mail_templates_with_http_info variant
|
|
1450
|
+
|
|
1451
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1452
|
+
|
|
1453
|
+
> <Array(Hash<String, Object>, Integer, Hash)> list_mail_templates_with_http_info
|
|
1454
|
+
|
|
1455
|
+
```ruby
|
|
1456
|
+
begin
|
|
1457
|
+
# List the caller's saved mail templates.
|
|
1458
|
+
data, status_code, headers = api_instance.list_mail_templates_with_http_info
|
|
1459
|
+
p status_code # => 2xx
|
|
1460
|
+
p headers # => { ... }
|
|
1461
|
+
p data # => Hash<String, Object>
|
|
1462
|
+
rescue Spatio::ApiError => e
|
|
1463
|
+
puts "Error when calling MailApi->list_mail_templates_with_http_info: #{e}"
|
|
1464
|
+
end
|
|
1465
|
+
```
|
|
1466
|
+
|
|
1467
|
+
### Parameters
|
|
1468
|
+
|
|
1469
|
+
This endpoint does not need any parameter.
|
|
1470
|
+
|
|
1471
|
+
### Return type
|
|
1472
|
+
|
|
1473
|
+
**Hash<String, Object>**
|
|
1474
|
+
|
|
1475
|
+
### Authorization
|
|
1476
|
+
|
|
1477
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1478
|
+
|
|
1479
|
+
### HTTP request headers
|
|
1480
|
+
|
|
1481
|
+
- **Content-Type**: Not defined
|
|
1482
|
+
- **Accept**: application/json
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
## reply_email
|
|
1486
|
+
|
|
1487
|
+
> <SendEmailResponse> reply_email(message_id, reply_email_request, opts)
|
|
1488
|
+
|
|
1489
|
+
Reply to a specific email.
|
|
1490
|
+
|
|
1491
|
+
The original message is identified by `?messageId=`. Body defaults to the original sender as recipient — pass `to`, `cc`, `bcc` to override.
|
|
1492
|
+
|
|
1493
|
+
### Examples
|
|
1494
|
+
|
|
1495
|
+
```ruby
|
|
1496
|
+
require 'time'
|
|
1497
|
+
require 'spatio-sdk'
|
|
1498
|
+
# setup authorization
|
|
1499
|
+
Spatio.configure do |config|
|
|
1500
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1501
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1502
|
+
end
|
|
1503
|
+
|
|
1504
|
+
api_instance = Spatio::MailApi.new
|
|
1505
|
+
message_id = 'message_id_example' # String | Id of the message being replied to.
|
|
1506
|
+
reply_email_request = Spatio::ReplyEmailRequest.new({body: 'body_example'}) # ReplyEmailRequest |
|
|
1507
|
+
opts = {
|
|
1508
|
+
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.
|
|
1509
|
+
}
|
|
1510
|
+
|
|
1511
|
+
begin
|
|
1512
|
+
# Reply to a specific email.
|
|
1513
|
+
result = api_instance.reply_email(message_id, reply_email_request, opts)
|
|
1514
|
+
p result
|
|
1515
|
+
rescue Spatio::ApiError => e
|
|
1516
|
+
puts "Error when calling MailApi->reply_email: #{e}"
|
|
1517
|
+
end
|
|
1518
|
+
```
|
|
1519
|
+
|
|
1520
|
+
#### Using the reply_email_with_http_info variant
|
|
1521
|
+
|
|
1522
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1523
|
+
|
|
1524
|
+
> <Array(<SendEmailResponse>, Integer, Hash)> reply_email_with_http_info(message_id, reply_email_request, opts)
|
|
1525
|
+
|
|
1526
|
+
```ruby
|
|
1527
|
+
begin
|
|
1528
|
+
# Reply to a specific email.
|
|
1529
|
+
data, status_code, headers = api_instance.reply_email_with_http_info(message_id, reply_email_request, opts)
|
|
1530
|
+
p status_code # => 2xx
|
|
1531
|
+
p headers # => { ... }
|
|
1532
|
+
p data # => <SendEmailResponse>
|
|
1533
|
+
rescue Spatio::ApiError => e
|
|
1534
|
+
puts "Error when calling MailApi->reply_email_with_http_info: #{e}"
|
|
1535
|
+
end
|
|
1536
|
+
```
|
|
1537
|
+
|
|
1538
|
+
### Parameters
|
|
1539
|
+
|
|
1540
|
+
| Name | Type | Description | Notes |
|
|
1541
|
+
| ---- | ---- | ----------- | ----- |
|
|
1542
|
+
| **message_id** | **String** | Id of the message being replied to. | |
|
|
1543
|
+
| **reply_email_request** | [**ReplyEmailRequest**](ReplyEmailRequest.md) | | |
|
|
1544
|
+
| **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] |
|
|
1545
|
+
|
|
1546
|
+
### Return type
|
|
1547
|
+
|
|
1548
|
+
[**SendEmailResponse**](SendEmailResponse.md)
|
|
1549
|
+
|
|
1550
|
+
### Authorization
|
|
1551
|
+
|
|
1552
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1553
|
+
|
|
1554
|
+
### HTTP request headers
|
|
1555
|
+
|
|
1556
|
+
- **Content-Type**: application/json
|
|
1557
|
+
- **Accept**: application/json
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
## save_mail_template
|
|
1561
|
+
|
|
1562
|
+
> Hash<String, Object> save_mail_template(request_body)
|
|
1563
|
+
|
|
1564
|
+
Save-or-create endpoint used by the renderer's \"save as template\" flow. Distinct from POST /v1/mail/templates which is the strict create.
|
|
1565
|
+
|
|
1566
|
+
### Examples
|
|
1567
|
+
|
|
1568
|
+
```ruby
|
|
1569
|
+
require 'time'
|
|
1570
|
+
require 'spatio-sdk'
|
|
1571
|
+
# setup authorization
|
|
1572
|
+
Spatio.configure do |config|
|
|
1573
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1574
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1575
|
+
end
|
|
1576
|
+
|
|
1577
|
+
api_instance = Spatio::MailApi.new
|
|
1578
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1579
|
+
|
|
1580
|
+
begin
|
|
1581
|
+
# Save-or-create endpoint used by the renderer's \"save as template\" flow. Distinct from POST /v1/mail/templates which is the strict create.
|
|
1582
|
+
result = api_instance.save_mail_template(request_body)
|
|
1583
|
+
p result
|
|
1584
|
+
rescue Spatio::ApiError => e
|
|
1585
|
+
puts "Error when calling MailApi->save_mail_template: #{e}"
|
|
1586
|
+
end
|
|
1587
|
+
```
|
|
1588
|
+
|
|
1589
|
+
#### Using the save_mail_template_with_http_info variant
|
|
1590
|
+
|
|
1591
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1592
|
+
|
|
1593
|
+
> <Array(Hash<String, Object>, Integer, Hash)> save_mail_template_with_http_info(request_body)
|
|
1594
|
+
|
|
1595
|
+
```ruby
|
|
1596
|
+
begin
|
|
1597
|
+
# Save-or-create endpoint used by the renderer's \"save as template\" flow. Distinct from POST /v1/mail/templates which is the strict create.
|
|
1598
|
+
data, status_code, headers = api_instance.save_mail_template_with_http_info(request_body)
|
|
1599
|
+
p status_code # => 2xx
|
|
1600
|
+
p headers # => { ... }
|
|
1601
|
+
p data # => Hash<String, Object>
|
|
1602
|
+
rescue Spatio::ApiError => e
|
|
1603
|
+
puts "Error when calling MailApi->save_mail_template_with_http_info: #{e}"
|
|
1604
|
+
end
|
|
1605
|
+
```
|
|
1606
|
+
|
|
1607
|
+
### Parameters
|
|
1608
|
+
|
|
1609
|
+
| Name | Type | Description | Notes |
|
|
1610
|
+
| ---- | ---- | ----------- | ----- |
|
|
1611
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1612
|
+
|
|
1613
|
+
### Return type
|
|
1614
|
+
|
|
1615
|
+
**Hash<String, Object>**
|
|
1616
|
+
|
|
1617
|
+
### Authorization
|
|
1618
|
+
|
|
1619
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1620
|
+
|
|
1621
|
+
### HTTP request headers
|
|
1622
|
+
|
|
1623
|
+
- **Content-Type**: application/json
|
|
1624
|
+
- **Accept**: application/json
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
## search_emails
|
|
1628
|
+
|
|
1629
|
+
> <SearchEmailsResponse> search_emails(q, opts)
|
|
1630
|
+
|
|
1631
|
+
Structured search across connected mail accounts.
|
|
1632
|
+
|
|
1633
|
+
Fan-out search. Mirrors `listEmails`'s account/provider filter semantics. Date range filters are inclusive. The query string itself is passed via `?q=` (not `?query=`); structured filters go in their own params.
|
|
1634
|
+
|
|
1635
|
+
### Examples
|
|
1636
|
+
|
|
1637
|
+
```ruby
|
|
1638
|
+
require 'time'
|
|
1639
|
+
require 'spatio-sdk'
|
|
1640
|
+
# setup authorization
|
|
1641
|
+
Spatio.configure do |config|
|
|
1642
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1643
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1644
|
+
end
|
|
1645
|
+
|
|
1646
|
+
api_instance = Spatio::MailApi.new
|
|
1647
|
+
q = 'q_example' # String | Provider-specific full-text query string.
|
|
1648
|
+
opts = {
|
|
1649
|
+
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.
|
|
1650
|
+
providers: ['inner_example'], # Array<String> | Repeatable. Restrict to these provider ids (`gmail`, `outlook`).
|
|
1651
|
+
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.
|
|
1652
|
+
from: 'from_example', # String |
|
|
1653
|
+
to: 'to_example', # String |
|
|
1654
|
+
subject: 'subject_example', # String |
|
|
1655
|
+
has_attachment: true, # Boolean |
|
|
1656
|
+
is_unread: true, # Boolean |
|
|
1657
|
+
is_starred: true, # Boolean |
|
|
1658
|
+
labels: ['inner_example'], # Array<String> |
|
|
1659
|
+
after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Inclusive lower-bound date.
|
|
1660
|
+
before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Inclusive upper-bound date.
|
|
1661
|
+
limit: 56, # Integer |
|
|
1662
|
+
next_page_token: 'next_page_token_example' # String | Cursor returned by the previous call.
|
|
1663
|
+
}
|
|
1664
|
+
|
|
1665
|
+
begin
|
|
1666
|
+
# Structured search across connected mail accounts.
|
|
1667
|
+
result = api_instance.search_emails(q, opts)
|
|
1668
|
+
p result
|
|
1669
|
+
rescue Spatio::ApiError => e
|
|
1670
|
+
puts "Error when calling MailApi->search_emails: #{e}"
|
|
1671
|
+
end
|
|
1672
|
+
```
|
|
1673
|
+
|
|
1674
|
+
#### Using the search_emails_with_http_info variant
|
|
1675
|
+
|
|
1676
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1677
|
+
|
|
1678
|
+
> <Array(<SearchEmailsResponse>, Integer, Hash)> search_emails_with_http_info(q, opts)
|
|
1679
|
+
|
|
1680
|
+
```ruby
|
|
1681
|
+
begin
|
|
1682
|
+
# Structured search across connected mail accounts.
|
|
1683
|
+
data, status_code, headers = api_instance.search_emails_with_http_info(q, opts)
|
|
1684
|
+
p status_code # => 2xx
|
|
1685
|
+
p headers # => { ... }
|
|
1686
|
+
p data # => <SearchEmailsResponse>
|
|
1687
|
+
rescue Spatio::ApiError => e
|
|
1688
|
+
puts "Error when calling MailApi->search_emails_with_http_info: #{e}"
|
|
1689
|
+
end
|
|
1690
|
+
```
|
|
1691
|
+
|
|
1692
|
+
### Parameters
|
|
1693
|
+
|
|
1694
|
+
| Name | Type | Description | Notes |
|
|
1695
|
+
| ---- | ---- | ----------- | ----- |
|
|
1696
|
+
| **q** | **String** | Provider-specific full-text query string. | |
|
|
1697
|
+
| **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] |
|
|
1698
|
+
| **providers** | [**Array<String>**](String.md) | Repeatable. Restrict to these provider ids (`gmail`, `outlook`). | [optional] |
|
|
1699
|
+
| **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] |
|
|
1700
|
+
| **from** | **String** | | [optional] |
|
|
1701
|
+
| **to** | **String** | | [optional] |
|
|
1702
|
+
| **subject** | **String** | | [optional] |
|
|
1703
|
+
| **has_attachment** | **Boolean** | | [optional] |
|
|
1704
|
+
| **is_unread** | **Boolean** | | [optional] |
|
|
1705
|
+
| **is_starred** | **Boolean** | | [optional] |
|
|
1706
|
+
| **labels** | [**Array<String>**](String.md) | | [optional] |
|
|
1707
|
+
| **after** | **Time** | Inclusive lower-bound date. | [optional] |
|
|
1708
|
+
| **before** | **Time** | Inclusive upper-bound date. | [optional] |
|
|
1709
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
1710
|
+
| **next_page_token** | **String** | Cursor returned by the previous call. | [optional] |
|
|
1711
|
+
|
|
1712
|
+
### Return type
|
|
1713
|
+
|
|
1714
|
+
[**SearchEmailsResponse**](SearchEmailsResponse.md)
|
|
1715
|
+
|
|
1716
|
+
### Authorization
|
|
1717
|
+
|
|
1718
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1719
|
+
|
|
1720
|
+
### HTTP request headers
|
|
1721
|
+
|
|
1722
|
+
- **Content-Type**: Not defined
|
|
1723
|
+
- **Accept**: application/json
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
## send_draft
|
|
1727
|
+
|
|
1728
|
+
> <SendEmailResponse> send_draft(id, opts)
|
|
1729
|
+
|
|
1730
|
+
Send a draft.
|
|
1731
|
+
|
|
1732
|
+
Submits the draft as an outbound message. The draft is consumed by the provider — subsequent `getDraft`/`updateDraft` calls return `404`.
|
|
1733
|
+
|
|
1734
|
+
### Examples
|
|
1735
|
+
|
|
1736
|
+
```ruby
|
|
1737
|
+
require 'time'
|
|
1738
|
+
require 'spatio-sdk'
|
|
1739
|
+
# setup authorization
|
|
1740
|
+
Spatio.configure do |config|
|
|
1741
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1742
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1743
|
+
end
|
|
1744
|
+
|
|
1745
|
+
api_instance = Spatio::MailApi.new
|
|
1746
|
+
id = 'id_example' # String | Draft id.
|
|
1747
|
+
opts = {
|
|
1748
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1749
|
+
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.
|
|
1750
|
+
}
|
|
1751
|
+
|
|
1752
|
+
begin
|
|
1753
|
+
# Send a draft.
|
|
1754
|
+
result = api_instance.send_draft(id, opts)
|
|
1755
|
+
p result
|
|
1756
|
+
rescue Spatio::ApiError => e
|
|
1757
|
+
puts "Error when calling MailApi->send_draft: #{e}"
|
|
1758
|
+
end
|
|
1759
|
+
```
|
|
1760
|
+
|
|
1761
|
+
#### Using the send_draft_with_http_info variant
|
|
1762
|
+
|
|
1763
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1764
|
+
|
|
1765
|
+
> <Array(<SendEmailResponse>, Integer, Hash)> send_draft_with_http_info(id, opts)
|
|
1766
|
+
|
|
1767
|
+
```ruby
|
|
1768
|
+
begin
|
|
1769
|
+
# Send a draft.
|
|
1770
|
+
data, status_code, headers = api_instance.send_draft_with_http_info(id, opts)
|
|
1771
|
+
p status_code # => 2xx
|
|
1772
|
+
p headers # => { ... }
|
|
1773
|
+
p data # => <SendEmailResponse>
|
|
1774
|
+
rescue Spatio::ApiError => e
|
|
1775
|
+
puts "Error when calling MailApi->send_draft_with_http_info: #{e}"
|
|
1776
|
+
end
|
|
1777
|
+
```
|
|
1778
|
+
|
|
1779
|
+
### Parameters
|
|
1780
|
+
|
|
1781
|
+
| Name | Type | Description | Notes |
|
|
1782
|
+
| ---- | ---- | ----------- | ----- |
|
|
1783
|
+
| **id** | **String** | Draft id. | |
|
|
1784
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1785
|
+
| **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] |
|
|
1786
|
+
|
|
1787
|
+
### Return type
|
|
1788
|
+
|
|
1789
|
+
[**SendEmailResponse**](SendEmailResponse.md)
|
|
1790
|
+
|
|
1791
|
+
### Authorization
|
|
1792
|
+
|
|
1793
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1794
|
+
|
|
1795
|
+
### HTTP request headers
|
|
1796
|
+
|
|
1797
|
+
- **Content-Type**: Not defined
|
|
1798
|
+
- **Accept**: application/json
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
## send_email
|
|
1802
|
+
|
|
1803
|
+
> <SendEmailResponse> send_email(send_email_request, opts)
|
|
1804
|
+
|
|
1805
|
+
Send an email.
|
|
1806
|
+
|
|
1807
|
+
Sends through the resolved connected account (auto-picks if the caller has exactly one connected mail account; errors `ambiguous_account` otherwise unless `accountId` is supplied).
|
|
1808
|
+
|
|
1809
|
+
### Examples
|
|
1810
|
+
|
|
1811
|
+
```ruby
|
|
1812
|
+
require 'time'
|
|
1813
|
+
require 'spatio-sdk'
|
|
1814
|
+
# setup authorization
|
|
1815
|
+
Spatio.configure do |config|
|
|
1816
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1817
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1818
|
+
end
|
|
1819
|
+
|
|
1820
|
+
api_instance = Spatio::MailApi.new
|
|
1821
|
+
send_email_request = Spatio::SendEmailRequest.new({to: ['to_example'], subject: 'subject_example', body: 'body_example'}) # SendEmailRequest |
|
|
1822
|
+
opts = {
|
|
1823
|
+
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.
|
|
1824
|
+
}
|
|
1825
|
+
|
|
1826
|
+
begin
|
|
1827
|
+
# Send an email.
|
|
1828
|
+
result = api_instance.send_email(send_email_request, opts)
|
|
1829
|
+
p result
|
|
1830
|
+
rescue Spatio::ApiError => e
|
|
1831
|
+
puts "Error when calling MailApi->send_email: #{e}"
|
|
1832
|
+
end
|
|
1833
|
+
```
|
|
1834
|
+
|
|
1835
|
+
#### Using the send_email_with_http_info variant
|
|
1836
|
+
|
|
1837
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1838
|
+
|
|
1839
|
+
> <Array(<SendEmailResponse>, Integer, Hash)> send_email_with_http_info(send_email_request, opts)
|
|
1840
|
+
|
|
1841
|
+
```ruby
|
|
1842
|
+
begin
|
|
1843
|
+
# Send an email.
|
|
1844
|
+
data, status_code, headers = api_instance.send_email_with_http_info(send_email_request, opts)
|
|
1845
|
+
p status_code # => 2xx
|
|
1846
|
+
p headers # => { ... }
|
|
1847
|
+
p data # => <SendEmailResponse>
|
|
1848
|
+
rescue Spatio::ApiError => e
|
|
1849
|
+
puts "Error when calling MailApi->send_email_with_http_info: #{e}"
|
|
1850
|
+
end
|
|
1851
|
+
```
|
|
1852
|
+
|
|
1853
|
+
### Parameters
|
|
1854
|
+
|
|
1855
|
+
| Name | Type | Description | Notes |
|
|
1856
|
+
| ---- | ---- | ----------- | ----- |
|
|
1857
|
+
| **send_email_request** | [**SendEmailRequest**](SendEmailRequest.md) | | |
|
|
1858
|
+
| **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] |
|
|
1859
|
+
|
|
1860
|
+
### Return type
|
|
1861
|
+
|
|
1862
|
+
[**SendEmailResponse**](SendEmailResponse.md)
|
|
1863
|
+
|
|
1864
|
+
### Authorization
|
|
1865
|
+
|
|
1866
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1867
|
+
|
|
1868
|
+
### HTTP request headers
|
|
1869
|
+
|
|
1870
|
+
- **Content-Type**: application/json
|
|
1871
|
+
- **Accept**: application/json
|
|
1872
|
+
|
|
1873
|
+
|
|
1874
|
+
## update_draft
|
|
1875
|
+
|
|
1876
|
+
> <DraftResponse> update_draft(id, update_draft_request, opts)
|
|
1877
|
+
|
|
1878
|
+
Update a draft (full replacement of provided fields).
|
|
1879
|
+
|
|
1880
|
+
PUT replaces the full set of provided fields on the draft. Fields omitted from the body are not modified.
|
|
1881
|
+
|
|
1882
|
+
### Examples
|
|
1883
|
+
|
|
1884
|
+
```ruby
|
|
1885
|
+
require 'time'
|
|
1886
|
+
require 'spatio-sdk'
|
|
1887
|
+
# setup authorization
|
|
1888
|
+
Spatio.configure do |config|
|
|
1889
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1890
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1891
|
+
end
|
|
1892
|
+
|
|
1893
|
+
api_instance = Spatio::MailApi.new
|
|
1894
|
+
id = 'id_example' # String | Draft id.
|
|
1895
|
+
update_draft_request = Spatio::UpdateDraftRequest.new # UpdateDraftRequest |
|
|
1896
|
+
opts = {
|
|
1897
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1898
|
+
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.
|
|
1899
|
+
}
|
|
1900
|
+
|
|
1901
|
+
begin
|
|
1902
|
+
# Update a draft (full replacement of provided fields).
|
|
1903
|
+
result = api_instance.update_draft(id, update_draft_request, opts)
|
|
1904
|
+
p result
|
|
1905
|
+
rescue Spatio::ApiError => e
|
|
1906
|
+
puts "Error when calling MailApi->update_draft: #{e}"
|
|
1907
|
+
end
|
|
1908
|
+
```
|
|
1909
|
+
|
|
1910
|
+
#### Using the update_draft_with_http_info variant
|
|
1911
|
+
|
|
1912
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1913
|
+
|
|
1914
|
+
> <Array(<DraftResponse>, Integer, Hash)> update_draft_with_http_info(id, update_draft_request, opts)
|
|
1915
|
+
|
|
1916
|
+
```ruby
|
|
1917
|
+
begin
|
|
1918
|
+
# Update a draft (full replacement of provided fields).
|
|
1919
|
+
data, status_code, headers = api_instance.update_draft_with_http_info(id, update_draft_request, opts)
|
|
1920
|
+
p status_code # => 2xx
|
|
1921
|
+
p headers # => { ... }
|
|
1922
|
+
p data # => <DraftResponse>
|
|
1923
|
+
rescue Spatio::ApiError => e
|
|
1924
|
+
puts "Error when calling MailApi->update_draft_with_http_info: #{e}"
|
|
1925
|
+
end
|
|
1926
|
+
```
|
|
1927
|
+
|
|
1928
|
+
### Parameters
|
|
1929
|
+
|
|
1930
|
+
| Name | Type | Description | Notes |
|
|
1931
|
+
| ---- | ---- | ----------- | ----- |
|
|
1932
|
+
| **id** | **String** | Draft id. | |
|
|
1933
|
+
| **update_draft_request** | [**UpdateDraftRequest**](UpdateDraftRequest.md) | | |
|
|
1934
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
1935
|
+
| **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] |
|
|
1936
|
+
|
|
1937
|
+
### Return type
|
|
1938
|
+
|
|
1939
|
+
[**DraftResponse**](DraftResponse.md)
|
|
1940
|
+
|
|
1941
|
+
### Authorization
|
|
1942
|
+
|
|
1943
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1944
|
+
|
|
1945
|
+
### HTTP request headers
|
|
1946
|
+
|
|
1947
|
+
- **Content-Type**: application/json
|
|
1948
|
+
- **Accept**: application/json
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
## update_email
|
|
1952
|
+
|
|
1953
|
+
> <UpdateEmailResponse> update_email(id, update_email_request, opts)
|
|
1954
|
+
|
|
1955
|
+
Update an email (mark read/star, add/remove labels).
|
|
1956
|
+
|
|
1957
|
+
### Examples
|
|
1958
|
+
|
|
1959
|
+
```ruby
|
|
1960
|
+
require 'time'
|
|
1961
|
+
require 'spatio-sdk'
|
|
1962
|
+
# setup authorization
|
|
1963
|
+
Spatio.configure do |config|
|
|
1964
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1965
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1966
|
+
end
|
|
1967
|
+
|
|
1968
|
+
api_instance = Spatio::MailApi.new
|
|
1969
|
+
id = 'id_example' # String | Email message id.
|
|
1970
|
+
update_email_request = Spatio::UpdateEmailRequest.new # UpdateEmailRequest |
|
|
1971
|
+
opts = {
|
|
1972
|
+
account_id: 'account_id_example', # String | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.
|
|
1973
|
+
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.
|
|
1974
|
+
}
|
|
1975
|
+
|
|
1976
|
+
begin
|
|
1977
|
+
# Update an email (mark read/star, add/remove labels).
|
|
1978
|
+
result = api_instance.update_email(id, update_email_request, opts)
|
|
1979
|
+
p result
|
|
1980
|
+
rescue Spatio::ApiError => e
|
|
1981
|
+
puts "Error when calling MailApi->update_email: #{e}"
|
|
1982
|
+
end
|
|
1983
|
+
```
|
|
1984
|
+
|
|
1985
|
+
#### Using the update_email_with_http_info variant
|
|
1986
|
+
|
|
1987
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1988
|
+
|
|
1989
|
+
> <Array(<UpdateEmailResponse>, Integer, Hash)> update_email_with_http_info(id, update_email_request, opts)
|
|
1990
|
+
|
|
1991
|
+
```ruby
|
|
1992
|
+
begin
|
|
1993
|
+
# Update an email (mark read/star, add/remove labels).
|
|
1994
|
+
data, status_code, headers = api_instance.update_email_with_http_info(id, update_email_request, opts)
|
|
1995
|
+
p status_code # => 2xx
|
|
1996
|
+
p headers # => { ... }
|
|
1997
|
+
p data # => <UpdateEmailResponse>
|
|
1998
|
+
rescue Spatio::ApiError => e
|
|
1999
|
+
puts "Error when calling MailApi->update_email_with_http_info: #{e}"
|
|
2000
|
+
end
|
|
2001
|
+
```
|
|
2002
|
+
|
|
2003
|
+
### Parameters
|
|
2004
|
+
|
|
2005
|
+
| Name | Type | Description | Notes |
|
|
2006
|
+
| ---- | ---- | ----------- | ----- |
|
|
2007
|
+
| **id** | **String** | Email message id. | |
|
|
2008
|
+
| **update_email_request** | [**UpdateEmailRequest**](UpdateEmailRequest.md) | | |
|
|
2009
|
+
| **account_id** | **String** | Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account. | [optional] |
|
|
2010
|
+
| **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] |
|
|
2011
|
+
|
|
2012
|
+
### Return type
|
|
2013
|
+
|
|
2014
|
+
[**UpdateEmailResponse**](UpdateEmailResponse.md)
|
|
2015
|
+
|
|
2016
|
+
### Authorization
|
|
2017
|
+
|
|
2018
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2019
|
+
|
|
2020
|
+
### HTTP request headers
|
|
2021
|
+
|
|
2022
|
+
- **Content-Type**: application/json
|
|
2023
|
+
- **Accept**: application/json
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
## update_mail_template
|
|
2027
|
+
|
|
2028
|
+
> Hash<String, Object> update_mail_template(id, request_body)
|
|
2029
|
+
|
|
2030
|
+
Update a mail template.
|
|
2031
|
+
|
|
2032
|
+
### Examples
|
|
2033
|
+
|
|
2034
|
+
```ruby
|
|
2035
|
+
require 'time'
|
|
2036
|
+
require 'spatio-sdk'
|
|
2037
|
+
# setup authorization
|
|
2038
|
+
Spatio.configure do |config|
|
|
2039
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2040
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2041
|
+
end
|
|
2042
|
+
|
|
2043
|
+
api_instance = Spatio::MailApi.new
|
|
2044
|
+
id = 'id_example' # String |
|
|
2045
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2046
|
+
|
|
2047
|
+
begin
|
|
2048
|
+
# Update a mail template.
|
|
2049
|
+
result = api_instance.update_mail_template(id, request_body)
|
|
2050
|
+
p result
|
|
2051
|
+
rescue Spatio::ApiError => e
|
|
2052
|
+
puts "Error when calling MailApi->update_mail_template: #{e}"
|
|
2053
|
+
end
|
|
2054
|
+
```
|
|
2055
|
+
|
|
2056
|
+
#### Using the update_mail_template_with_http_info variant
|
|
2057
|
+
|
|
2058
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2059
|
+
|
|
2060
|
+
> <Array(Hash<String, Object>, Integer, Hash)> update_mail_template_with_http_info(id, request_body)
|
|
2061
|
+
|
|
2062
|
+
```ruby
|
|
2063
|
+
begin
|
|
2064
|
+
# Update a mail template.
|
|
2065
|
+
data, status_code, headers = api_instance.update_mail_template_with_http_info(id, request_body)
|
|
2066
|
+
p status_code # => 2xx
|
|
2067
|
+
p headers # => { ... }
|
|
2068
|
+
p data # => Hash<String, Object>
|
|
2069
|
+
rescue Spatio::ApiError => e
|
|
2070
|
+
puts "Error when calling MailApi->update_mail_template_with_http_info: #{e}"
|
|
2071
|
+
end
|
|
2072
|
+
```
|
|
2073
|
+
|
|
2074
|
+
### Parameters
|
|
2075
|
+
|
|
2076
|
+
| Name | Type | Description | Notes |
|
|
2077
|
+
| ---- | ---- | ----------- | ----- |
|
|
2078
|
+
| **id** | **String** | | |
|
|
2079
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2080
|
+
|
|
2081
|
+
### Return type
|
|
2082
|
+
|
|
2083
|
+
**Hash<String, Object>**
|
|
2084
|
+
|
|
2085
|
+
### Authorization
|
|
2086
|
+
|
|
2087
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2088
|
+
|
|
2089
|
+
### HTTP request headers
|
|
2090
|
+
|
|
2091
|
+
- **Content-Type**: application/json
|
|
2092
|
+
- **Accept**: application/json
|
|
2093
|
+
|
|
2094
|
+
|
|
2095
|
+
## workspace_add_mail_message_labels
|
|
2096
|
+
|
|
2097
|
+
> Hash<String, Object> workspace_add_mail_message_labels(org, workspace, message_id, request_body)
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
|
|
2101
|
+
### Examples
|
|
2102
|
+
|
|
2103
|
+
```ruby
|
|
2104
|
+
require 'time'
|
|
2105
|
+
require 'spatio-sdk'
|
|
2106
|
+
# setup authorization
|
|
2107
|
+
Spatio.configure do |config|
|
|
2108
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2109
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2110
|
+
end
|
|
2111
|
+
|
|
2112
|
+
api_instance = Spatio::MailApi.new
|
|
2113
|
+
org = 'org_example' # String |
|
|
2114
|
+
workspace = 'workspace_example' # String |
|
|
2115
|
+
message_id = 'message_id_example' # String |
|
|
2116
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2117
|
+
|
|
2118
|
+
begin
|
|
2119
|
+
|
|
2120
|
+
result = api_instance.workspace_add_mail_message_labels(org, workspace, message_id, request_body)
|
|
2121
|
+
p result
|
|
2122
|
+
rescue Spatio::ApiError => e
|
|
2123
|
+
puts "Error when calling MailApi->workspace_add_mail_message_labels: #{e}"
|
|
2124
|
+
end
|
|
2125
|
+
```
|
|
2126
|
+
|
|
2127
|
+
#### Using the workspace_add_mail_message_labels_with_http_info variant
|
|
2128
|
+
|
|
2129
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2130
|
+
|
|
2131
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_add_mail_message_labels_with_http_info(org, workspace, message_id, request_body)
|
|
2132
|
+
|
|
2133
|
+
```ruby
|
|
2134
|
+
begin
|
|
2135
|
+
|
|
2136
|
+
data, status_code, headers = api_instance.workspace_add_mail_message_labels_with_http_info(org, workspace, message_id, request_body)
|
|
2137
|
+
p status_code # => 2xx
|
|
2138
|
+
p headers # => { ... }
|
|
2139
|
+
p data # => Hash<String, Object>
|
|
2140
|
+
rescue Spatio::ApiError => e
|
|
2141
|
+
puts "Error when calling MailApi->workspace_add_mail_message_labels_with_http_info: #{e}"
|
|
2142
|
+
end
|
|
2143
|
+
```
|
|
2144
|
+
|
|
2145
|
+
### Parameters
|
|
2146
|
+
|
|
2147
|
+
| Name | Type | Description | Notes |
|
|
2148
|
+
| ---- | ---- | ----------- | ----- |
|
|
2149
|
+
| **org** | **String** | | |
|
|
2150
|
+
| **workspace** | **String** | | |
|
|
2151
|
+
| **message_id** | **String** | | |
|
|
2152
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2153
|
+
|
|
2154
|
+
### Return type
|
|
2155
|
+
|
|
2156
|
+
**Hash<String, Object>**
|
|
2157
|
+
|
|
2158
|
+
### Authorization
|
|
2159
|
+
|
|
2160
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2161
|
+
|
|
2162
|
+
### HTTP request headers
|
|
2163
|
+
|
|
2164
|
+
- **Content-Type**: application/json
|
|
2165
|
+
- **Accept**: application/json
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
## workspace_create_mail_draft
|
|
2169
|
+
|
|
2170
|
+
> Hash<String, Object> workspace_create_mail_draft(org, workspace, request_body)
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
### Examples
|
|
2175
|
+
|
|
2176
|
+
```ruby
|
|
2177
|
+
require 'time'
|
|
2178
|
+
require 'spatio-sdk'
|
|
2179
|
+
# setup authorization
|
|
2180
|
+
Spatio.configure do |config|
|
|
2181
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2182
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2183
|
+
end
|
|
2184
|
+
|
|
2185
|
+
api_instance = Spatio::MailApi.new
|
|
2186
|
+
org = 'org_example' # String |
|
|
2187
|
+
workspace = 'workspace_example' # String |
|
|
2188
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2189
|
+
|
|
2190
|
+
begin
|
|
2191
|
+
|
|
2192
|
+
result = api_instance.workspace_create_mail_draft(org, workspace, request_body)
|
|
2193
|
+
p result
|
|
2194
|
+
rescue Spatio::ApiError => e
|
|
2195
|
+
puts "Error when calling MailApi->workspace_create_mail_draft: #{e}"
|
|
2196
|
+
end
|
|
2197
|
+
```
|
|
2198
|
+
|
|
2199
|
+
#### Using the workspace_create_mail_draft_with_http_info variant
|
|
2200
|
+
|
|
2201
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2202
|
+
|
|
2203
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_create_mail_draft_with_http_info(org, workspace, request_body)
|
|
2204
|
+
|
|
2205
|
+
```ruby
|
|
2206
|
+
begin
|
|
2207
|
+
|
|
2208
|
+
data, status_code, headers = api_instance.workspace_create_mail_draft_with_http_info(org, workspace, request_body)
|
|
2209
|
+
p status_code # => 2xx
|
|
2210
|
+
p headers # => { ... }
|
|
2211
|
+
p data # => Hash<String, Object>
|
|
2212
|
+
rescue Spatio::ApiError => e
|
|
2213
|
+
puts "Error when calling MailApi->workspace_create_mail_draft_with_http_info: #{e}"
|
|
2214
|
+
end
|
|
2215
|
+
```
|
|
2216
|
+
|
|
2217
|
+
### Parameters
|
|
2218
|
+
|
|
2219
|
+
| Name | Type | Description | Notes |
|
|
2220
|
+
| ---- | ---- | ----------- | ----- |
|
|
2221
|
+
| **org** | **String** | | |
|
|
2222
|
+
| **workspace** | **String** | | |
|
|
2223
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2224
|
+
|
|
2225
|
+
### Return type
|
|
2226
|
+
|
|
2227
|
+
**Hash<String, Object>**
|
|
2228
|
+
|
|
2229
|
+
### Authorization
|
|
2230
|
+
|
|
2231
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2232
|
+
|
|
2233
|
+
### HTTP request headers
|
|
2234
|
+
|
|
2235
|
+
- **Content-Type**: application/json
|
|
2236
|
+
- **Accept**: application/json
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
## workspace_create_mail_label
|
|
2240
|
+
|
|
2241
|
+
> Hash<String, Object> workspace_create_mail_label(org, workspace, request_body)
|
|
2242
|
+
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
### Examples
|
|
2246
|
+
|
|
2247
|
+
```ruby
|
|
2248
|
+
require 'time'
|
|
2249
|
+
require 'spatio-sdk'
|
|
2250
|
+
# setup authorization
|
|
2251
|
+
Spatio.configure do |config|
|
|
2252
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2253
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2254
|
+
end
|
|
2255
|
+
|
|
2256
|
+
api_instance = Spatio::MailApi.new
|
|
2257
|
+
org = 'org_example' # String |
|
|
2258
|
+
workspace = 'workspace_example' # String |
|
|
2259
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2260
|
+
|
|
2261
|
+
begin
|
|
2262
|
+
|
|
2263
|
+
result = api_instance.workspace_create_mail_label(org, workspace, request_body)
|
|
2264
|
+
p result
|
|
2265
|
+
rescue Spatio::ApiError => e
|
|
2266
|
+
puts "Error when calling MailApi->workspace_create_mail_label: #{e}"
|
|
2267
|
+
end
|
|
2268
|
+
```
|
|
2269
|
+
|
|
2270
|
+
#### Using the workspace_create_mail_label_with_http_info variant
|
|
2271
|
+
|
|
2272
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2273
|
+
|
|
2274
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_create_mail_label_with_http_info(org, workspace, request_body)
|
|
2275
|
+
|
|
2276
|
+
```ruby
|
|
2277
|
+
begin
|
|
2278
|
+
|
|
2279
|
+
data, status_code, headers = api_instance.workspace_create_mail_label_with_http_info(org, workspace, request_body)
|
|
2280
|
+
p status_code # => 2xx
|
|
2281
|
+
p headers # => { ... }
|
|
2282
|
+
p data # => Hash<String, Object>
|
|
2283
|
+
rescue Spatio::ApiError => e
|
|
2284
|
+
puts "Error when calling MailApi->workspace_create_mail_label_with_http_info: #{e}"
|
|
2285
|
+
end
|
|
2286
|
+
```
|
|
2287
|
+
|
|
2288
|
+
### Parameters
|
|
2289
|
+
|
|
2290
|
+
| Name | Type | Description | Notes |
|
|
2291
|
+
| ---- | ---- | ----------- | ----- |
|
|
2292
|
+
| **org** | **String** | | |
|
|
2293
|
+
| **workspace** | **String** | | |
|
|
2294
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2295
|
+
|
|
2296
|
+
### Return type
|
|
2297
|
+
|
|
2298
|
+
**Hash<String, Object>**
|
|
2299
|
+
|
|
2300
|
+
### Authorization
|
|
2301
|
+
|
|
2302
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2303
|
+
|
|
2304
|
+
### HTTP request headers
|
|
2305
|
+
|
|
2306
|
+
- **Content-Type**: application/json
|
|
2307
|
+
- **Accept**: application/json
|
|
2308
|
+
|
|
2309
|
+
|
|
2310
|
+
## workspace_delete_mail
|
|
2311
|
+
|
|
2312
|
+
> workspace_delete_mail(org, workspace, id)
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
### Examples
|
|
2317
|
+
|
|
2318
|
+
```ruby
|
|
2319
|
+
require 'time'
|
|
2320
|
+
require 'spatio-sdk'
|
|
2321
|
+
# setup authorization
|
|
2322
|
+
Spatio.configure do |config|
|
|
2323
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2324
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2325
|
+
end
|
|
2326
|
+
|
|
2327
|
+
api_instance = Spatio::MailApi.new
|
|
2328
|
+
org = 'org_example' # String |
|
|
2329
|
+
workspace = 'workspace_example' # String |
|
|
2330
|
+
id = 'id_example' # String |
|
|
2331
|
+
|
|
2332
|
+
begin
|
|
2333
|
+
|
|
2334
|
+
api_instance.workspace_delete_mail(org, workspace, id)
|
|
2335
|
+
rescue Spatio::ApiError => e
|
|
2336
|
+
puts "Error when calling MailApi->workspace_delete_mail: #{e}"
|
|
2337
|
+
end
|
|
2338
|
+
```
|
|
2339
|
+
|
|
2340
|
+
#### Using the workspace_delete_mail_with_http_info variant
|
|
2341
|
+
|
|
2342
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
2343
|
+
|
|
2344
|
+
> <Array(nil, Integer, Hash)> workspace_delete_mail_with_http_info(org, workspace, id)
|
|
2345
|
+
|
|
2346
|
+
```ruby
|
|
2347
|
+
begin
|
|
2348
|
+
|
|
2349
|
+
data, status_code, headers = api_instance.workspace_delete_mail_with_http_info(org, workspace, id)
|
|
2350
|
+
p status_code # => 2xx
|
|
2351
|
+
p headers # => { ... }
|
|
2352
|
+
p data # => nil
|
|
2353
|
+
rescue Spatio::ApiError => e
|
|
2354
|
+
puts "Error when calling MailApi->workspace_delete_mail_with_http_info: #{e}"
|
|
2355
|
+
end
|
|
2356
|
+
```
|
|
2357
|
+
|
|
2358
|
+
### Parameters
|
|
2359
|
+
|
|
2360
|
+
| Name | Type | Description | Notes |
|
|
2361
|
+
| ---- | ---- | ----------- | ----- |
|
|
2362
|
+
| **org** | **String** | | |
|
|
2363
|
+
| **workspace** | **String** | | |
|
|
2364
|
+
| **id** | **String** | | |
|
|
2365
|
+
|
|
2366
|
+
### Return type
|
|
2367
|
+
|
|
2368
|
+
nil (empty response body)
|
|
2369
|
+
|
|
2370
|
+
### Authorization
|
|
2371
|
+
|
|
2372
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2373
|
+
|
|
2374
|
+
### HTTP request headers
|
|
2375
|
+
|
|
2376
|
+
- **Content-Type**: Not defined
|
|
2377
|
+
- **Accept**: application/json
|
|
2378
|
+
|
|
2379
|
+
|
|
2380
|
+
## workspace_delete_mail_draft
|
|
2381
|
+
|
|
2382
|
+
> workspace_delete_mail_draft(org, workspace, id)
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
### Examples
|
|
2387
|
+
|
|
2388
|
+
```ruby
|
|
2389
|
+
require 'time'
|
|
2390
|
+
require 'spatio-sdk'
|
|
2391
|
+
# setup authorization
|
|
2392
|
+
Spatio.configure do |config|
|
|
2393
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2394
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2395
|
+
end
|
|
2396
|
+
|
|
2397
|
+
api_instance = Spatio::MailApi.new
|
|
2398
|
+
org = 'org_example' # String |
|
|
2399
|
+
workspace = 'workspace_example' # String |
|
|
2400
|
+
id = 'id_example' # String |
|
|
2401
|
+
|
|
2402
|
+
begin
|
|
2403
|
+
|
|
2404
|
+
api_instance.workspace_delete_mail_draft(org, workspace, id)
|
|
2405
|
+
rescue Spatio::ApiError => e
|
|
2406
|
+
puts "Error when calling MailApi->workspace_delete_mail_draft: #{e}"
|
|
2407
|
+
end
|
|
2408
|
+
```
|
|
2409
|
+
|
|
2410
|
+
#### Using the workspace_delete_mail_draft_with_http_info variant
|
|
2411
|
+
|
|
2412
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
2413
|
+
|
|
2414
|
+
> <Array(nil, Integer, Hash)> workspace_delete_mail_draft_with_http_info(org, workspace, id)
|
|
2415
|
+
|
|
2416
|
+
```ruby
|
|
2417
|
+
begin
|
|
2418
|
+
|
|
2419
|
+
data, status_code, headers = api_instance.workspace_delete_mail_draft_with_http_info(org, workspace, id)
|
|
2420
|
+
p status_code # => 2xx
|
|
2421
|
+
p headers # => { ... }
|
|
2422
|
+
p data # => nil
|
|
2423
|
+
rescue Spatio::ApiError => e
|
|
2424
|
+
puts "Error when calling MailApi->workspace_delete_mail_draft_with_http_info: #{e}"
|
|
2425
|
+
end
|
|
2426
|
+
```
|
|
2427
|
+
|
|
2428
|
+
### Parameters
|
|
2429
|
+
|
|
2430
|
+
| Name | Type | Description | Notes |
|
|
2431
|
+
| ---- | ---- | ----------- | ----- |
|
|
2432
|
+
| **org** | **String** | | |
|
|
2433
|
+
| **workspace** | **String** | | |
|
|
2434
|
+
| **id** | **String** | | |
|
|
2435
|
+
|
|
2436
|
+
### Return type
|
|
2437
|
+
|
|
2438
|
+
nil (empty response body)
|
|
2439
|
+
|
|
2440
|
+
### Authorization
|
|
2441
|
+
|
|
2442
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2443
|
+
|
|
2444
|
+
### HTTP request headers
|
|
2445
|
+
|
|
2446
|
+
- **Content-Type**: Not defined
|
|
2447
|
+
- **Accept**: application/json
|
|
2448
|
+
|
|
2449
|
+
|
|
2450
|
+
## workspace_delete_mail_label
|
|
2451
|
+
|
|
2452
|
+
> workspace_delete_mail_label(org, workspace, id)
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
### Examples
|
|
2457
|
+
|
|
2458
|
+
```ruby
|
|
2459
|
+
require 'time'
|
|
2460
|
+
require 'spatio-sdk'
|
|
2461
|
+
# setup authorization
|
|
2462
|
+
Spatio.configure do |config|
|
|
2463
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2464
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2465
|
+
end
|
|
2466
|
+
|
|
2467
|
+
api_instance = Spatio::MailApi.new
|
|
2468
|
+
org = 'org_example' # String |
|
|
2469
|
+
workspace = 'workspace_example' # String |
|
|
2470
|
+
id = 'id_example' # String |
|
|
2471
|
+
|
|
2472
|
+
begin
|
|
2473
|
+
|
|
2474
|
+
api_instance.workspace_delete_mail_label(org, workspace, id)
|
|
2475
|
+
rescue Spatio::ApiError => e
|
|
2476
|
+
puts "Error when calling MailApi->workspace_delete_mail_label: #{e}"
|
|
2477
|
+
end
|
|
2478
|
+
```
|
|
2479
|
+
|
|
2480
|
+
#### Using the workspace_delete_mail_label_with_http_info variant
|
|
2481
|
+
|
|
2482
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
2483
|
+
|
|
2484
|
+
> <Array(nil, Integer, Hash)> workspace_delete_mail_label_with_http_info(org, workspace, id)
|
|
2485
|
+
|
|
2486
|
+
```ruby
|
|
2487
|
+
begin
|
|
2488
|
+
|
|
2489
|
+
data, status_code, headers = api_instance.workspace_delete_mail_label_with_http_info(org, workspace, id)
|
|
2490
|
+
p status_code # => 2xx
|
|
2491
|
+
p headers # => { ... }
|
|
2492
|
+
p data # => nil
|
|
2493
|
+
rescue Spatio::ApiError => e
|
|
2494
|
+
puts "Error when calling MailApi->workspace_delete_mail_label_with_http_info: #{e}"
|
|
2495
|
+
end
|
|
2496
|
+
```
|
|
2497
|
+
|
|
2498
|
+
### Parameters
|
|
2499
|
+
|
|
2500
|
+
| Name | Type | Description | Notes |
|
|
2501
|
+
| ---- | ---- | ----------- | ----- |
|
|
2502
|
+
| **org** | **String** | | |
|
|
2503
|
+
| **workspace** | **String** | | |
|
|
2504
|
+
| **id** | **String** | | |
|
|
2505
|
+
|
|
2506
|
+
### Return type
|
|
2507
|
+
|
|
2508
|
+
nil (empty response body)
|
|
2509
|
+
|
|
2510
|
+
### Authorization
|
|
2511
|
+
|
|
2512
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2513
|
+
|
|
2514
|
+
### HTTP request headers
|
|
2515
|
+
|
|
2516
|
+
- **Content-Type**: Not defined
|
|
2517
|
+
- **Accept**: application/json
|
|
2518
|
+
|
|
2519
|
+
|
|
2520
|
+
## workspace_get_mail
|
|
2521
|
+
|
|
2522
|
+
> Hash<String, Object> workspace_get_mail(org, workspace, id)
|
|
2523
|
+
|
|
2524
|
+
|
|
2525
|
+
|
|
2526
|
+
### Examples
|
|
2527
|
+
|
|
2528
|
+
```ruby
|
|
2529
|
+
require 'time'
|
|
2530
|
+
require 'spatio-sdk'
|
|
2531
|
+
# setup authorization
|
|
2532
|
+
Spatio.configure do |config|
|
|
2533
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2534
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2535
|
+
end
|
|
2536
|
+
|
|
2537
|
+
api_instance = Spatio::MailApi.new
|
|
2538
|
+
org = 'org_example' # String |
|
|
2539
|
+
workspace = 'workspace_example' # String |
|
|
2540
|
+
id = 'id_example' # String |
|
|
2541
|
+
|
|
2542
|
+
begin
|
|
2543
|
+
|
|
2544
|
+
result = api_instance.workspace_get_mail(org, workspace, id)
|
|
2545
|
+
p result
|
|
2546
|
+
rescue Spatio::ApiError => e
|
|
2547
|
+
puts "Error when calling MailApi->workspace_get_mail: #{e}"
|
|
2548
|
+
end
|
|
2549
|
+
```
|
|
2550
|
+
|
|
2551
|
+
#### Using the workspace_get_mail_with_http_info variant
|
|
2552
|
+
|
|
2553
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2554
|
+
|
|
2555
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_mail_with_http_info(org, workspace, id)
|
|
2556
|
+
|
|
2557
|
+
```ruby
|
|
2558
|
+
begin
|
|
2559
|
+
|
|
2560
|
+
data, status_code, headers = api_instance.workspace_get_mail_with_http_info(org, workspace, id)
|
|
2561
|
+
p status_code # => 2xx
|
|
2562
|
+
p headers # => { ... }
|
|
2563
|
+
p data # => Hash<String, Object>
|
|
2564
|
+
rescue Spatio::ApiError => e
|
|
2565
|
+
puts "Error when calling MailApi->workspace_get_mail_with_http_info: #{e}"
|
|
2566
|
+
end
|
|
2567
|
+
```
|
|
2568
|
+
|
|
2569
|
+
### Parameters
|
|
2570
|
+
|
|
2571
|
+
| Name | Type | Description | Notes |
|
|
2572
|
+
| ---- | ---- | ----------- | ----- |
|
|
2573
|
+
| **org** | **String** | | |
|
|
2574
|
+
| **workspace** | **String** | | |
|
|
2575
|
+
| **id** | **String** | | |
|
|
2576
|
+
|
|
2577
|
+
### Return type
|
|
2578
|
+
|
|
2579
|
+
**Hash<String, Object>**
|
|
2580
|
+
|
|
2581
|
+
### Authorization
|
|
2582
|
+
|
|
2583
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2584
|
+
|
|
2585
|
+
### HTTP request headers
|
|
2586
|
+
|
|
2587
|
+
- **Content-Type**: Not defined
|
|
2588
|
+
- **Accept**: application/json
|
|
2589
|
+
|
|
2590
|
+
|
|
2591
|
+
## workspace_get_mail_attachment
|
|
2592
|
+
|
|
2593
|
+
> Hash<String, Object> workspace_get_mail_attachment(org, workspace, message_id, attachment_id)
|
|
2594
|
+
|
|
2595
|
+
|
|
2596
|
+
|
|
2597
|
+
### Examples
|
|
2598
|
+
|
|
2599
|
+
```ruby
|
|
2600
|
+
require 'time'
|
|
2601
|
+
require 'spatio-sdk'
|
|
2602
|
+
# setup authorization
|
|
2603
|
+
Spatio.configure do |config|
|
|
2604
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2605
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2606
|
+
end
|
|
2607
|
+
|
|
2608
|
+
api_instance = Spatio::MailApi.new
|
|
2609
|
+
org = 'org_example' # String |
|
|
2610
|
+
workspace = 'workspace_example' # String |
|
|
2611
|
+
message_id = 'message_id_example' # String |
|
|
2612
|
+
attachment_id = 'attachment_id_example' # String |
|
|
2613
|
+
|
|
2614
|
+
begin
|
|
2615
|
+
|
|
2616
|
+
result = api_instance.workspace_get_mail_attachment(org, workspace, message_id, attachment_id)
|
|
2617
|
+
p result
|
|
2618
|
+
rescue Spatio::ApiError => e
|
|
2619
|
+
puts "Error when calling MailApi->workspace_get_mail_attachment: #{e}"
|
|
2620
|
+
end
|
|
2621
|
+
```
|
|
2622
|
+
|
|
2623
|
+
#### Using the workspace_get_mail_attachment_with_http_info variant
|
|
2624
|
+
|
|
2625
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2626
|
+
|
|
2627
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_mail_attachment_with_http_info(org, workspace, message_id, attachment_id)
|
|
2628
|
+
|
|
2629
|
+
```ruby
|
|
2630
|
+
begin
|
|
2631
|
+
|
|
2632
|
+
data, status_code, headers = api_instance.workspace_get_mail_attachment_with_http_info(org, workspace, message_id, attachment_id)
|
|
2633
|
+
p status_code # => 2xx
|
|
2634
|
+
p headers # => { ... }
|
|
2635
|
+
p data # => Hash<String, Object>
|
|
2636
|
+
rescue Spatio::ApiError => e
|
|
2637
|
+
puts "Error when calling MailApi->workspace_get_mail_attachment_with_http_info: #{e}"
|
|
2638
|
+
end
|
|
2639
|
+
```
|
|
2640
|
+
|
|
2641
|
+
### Parameters
|
|
2642
|
+
|
|
2643
|
+
| Name | Type | Description | Notes |
|
|
2644
|
+
| ---- | ---- | ----------- | ----- |
|
|
2645
|
+
| **org** | **String** | | |
|
|
2646
|
+
| **workspace** | **String** | | |
|
|
2647
|
+
| **message_id** | **String** | | |
|
|
2648
|
+
| **attachment_id** | **String** | | |
|
|
2649
|
+
|
|
2650
|
+
### Return type
|
|
2651
|
+
|
|
2652
|
+
**Hash<String, Object>**
|
|
2653
|
+
|
|
2654
|
+
### Authorization
|
|
2655
|
+
|
|
2656
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2657
|
+
|
|
2658
|
+
### HTTP request headers
|
|
2659
|
+
|
|
2660
|
+
- **Content-Type**: Not defined
|
|
2661
|
+
- **Accept**: application/json
|
|
2662
|
+
|
|
2663
|
+
|
|
2664
|
+
## workspace_get_mail_by_id
|
|
2665
|
+
|
|
2666
|
+
> Hash<String, Object> workspace_get_mail_by_id(org, workspace, id)
|
|
2667
|
+
|
|
2668
|
+
Workspace-scoped renderer-compat alias for mail/email/{id}.
|
|
2669
|
+
|
|
2670
|
+
### Examples
|
|
2671
|
+
|
|
2672
|
+
```ruby
|
|
2673
|
+
require 'time'
|
|
2674
|
+
require 'spatio-sdk'
|
|
2675
|
+
# setup authorization
|
|
2676
|
+
Spatio.configure do |config|
|
|
2677
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2678
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2679
|
+
end
|
|
2680
|
+
|
|
2681
|
+
api_instance = Spatio::MailApi.new
|
|
2682
|
+
org = 'org_example' # String |
|
|
2683
|
+
workspace = 'workspace_example' # String |
|
|
2684
|
+
id = 'id_example' # String |
|
|
2685
|
+
|
|
2686
|
+
begin
|
|
2687
|
+
# Workspace-scoped renderer-compat alias for mail/email/{id}.
|
|
2688
|
+
result = api_instance.workspace_get_mail_by_id(org, workspace, id)
|
|
2689
|
+
p result
|
|
2690
|
+
rescue Spatio::ApiError => e
|
|
2691
|
+
puts "Error when calling MailApi->workspace_get_mail_by_id: #{e}"
|
|
2692
|
+
end
|
|
2693
|
+
```
|
|
2694
|
+
|
|
2695
|
+
#### Using the workspace_get_mail_by_id_with_http_info variant
|
|
2696
|
+
|
|
2697
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2698
|
+
|
|
2699
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_mail_by_id_with_http_info(org, workspace, id)
|
|
2700
|
+
|
|
2701
|
+
```ruby
|
|
2702
|
+
begin
|
|
2703
|
+
# Workspace-scoped renderer-compat alias for mail/email/{id}.
|
|
2704
|
+
data, status_code, headers = api_instance.workspace_get_mail_by_id_with_http_info(org, workspace, id)
|
|
2705
|
+
p status_code # => 2xx
|
|
2706
|
+
p headers # => { ... }
|
|
2707
|
+
p data # => Hash<String, Object>
|
|
2708
|
+
rescue Spatio::ApiError => e
|
|
2709
|
+
puts "Error when calling MailApi->workspace_get_mail_by_id_with_http_info: #{e}"
|
|
2710
|
+
end
|
|
2711
|
+
```
|
|
2712
|
+
|
|
2713
|
+
### Parameters
|
|
2714
|
+
|
|
2715
|
+
| Name | Type | Description | Notes |
|
|
2716
|
+
| ---- | ---- | ----------- | ----- |
|
|
2717
|
+
| **org** | **String** | | |
|
|
2718
|
+
| **workspace** | **String** | | |
|
|
2719
|
+
| **id** | **String** | | |
|
|
2720
|
+
|
|
2721
|
+
### Return type
|
|
2722
|
+
|
|
2723
|
+
**Hash<String, Object>**
|
|
2724
|
+
|
|
2725
|
+
### Authorization
|
|
2726
|
+
|
|
2727
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2728
|
+
|
|
2729
|
+
### HTTP request headers
|
|
2730
|
+
|
|
2731
|
+
- **Content-Type**: Not defined
|
|
2732
|
+
- **Accept**: application/json
|
|
2733
|
+
|
|
2734
|
+
|
|
2735
|
+
## workspace_get_mail_draft
|
|
2736
|
+
|
|
2737
|
+
> Hash<String, Object> workspace_get_mail_draft(org, workspace, id)
|
|
2738
|
+
|
|
2739
|
+
|
|
2740
|
+
|
|
2741
|
+
### Examples
|
|
2742
|
+
|
|
2743
|
+
```ruby
|
|
2744
|
+
require 'time'
|
|
2745
|
+
require 'spatio-sdk'
|
|
2746
|
+
# setup authorization
|
|
2747
|
+
Spatio.configure do |config|
|
|
2748
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2749
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2750
|
+
end
|
|
2751
|
+
|
|
2752
|
+
api_instance = Spatio::MailApi.new
|
|
2753
|
+
org = 'org_example' # String |
|
|
2754
|
+
workspace = 'workspace_example' # String |
|
|
2755
|
+
id = 'id_example' # String |
|
|
2756
|
+
|
|
2757
|
+
begin
|
|
2758
|
+
|
|
2759
|
+
result = api_instance.workspace_get_mail_draft(org, workspace, id)
|
|
2760
|
+
p result
|
|
2761
|
+
rescue Spatio::ApiError => e
|
|
2762
|
+
puts "Error when calling MailApi->workspace_get_mail_draft: #{e}"
|
|
2763
|
+
end
|
|
2764
|
+
```
|
|
2765
|
+
|
|
2766
|
+
#### Using the workspace_get_mail_draft_with_http_info variant
|
|
2767
|
+
|
|
2768
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2769
|
+
|
|
2770
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_mail_draft_with_http_info(org, workspace, id)
|
|
2771
|
+
|
|
2772
|
+
```ruby
|
|
2773
|
+
begin
|
|
2774
|
+
|
|
2775
|
+
data, status_code, headers = api_instance.workspace_get_mail_draft_with_http_info(org, workspace, id)
|
|
2776
|
+
p status_code # => 2xx
|
|
2777
|
+
p headers # => { ... }
|
|
2778
|
+
p data # => Hash<String, Object>
|
|
2779
|
+
rescue Spatio::ApiError => e
|
|
2780
|
+
puts "Error when calling MailApi->workspace_get_mail_draft_with_http_info: #{e}"
|
|
2781
|
+
end
|
|
2782
|
+
```
|
|
2783
|
+
|
|
2784
|
+
### Parameters
|
|
2785
|
+
|
|
2786
|
+
| Name | Type | Description | Notes |
|
|
2787
|
+
| ---- | ---- | ----------- | ----- |
|
|
2788
|
+
| **org** | **String** | | |
|
|
2789
|
+
| **workspace** | **String** | | |
|
|
2790
|
+
| **id** | **String** | | |
|
|
2791
|
+
|
|
2792
|
+
### Return type
|
|
2793
|
+
|
|
2794
|
+
**Hash<String, Object>**
|
|
2795
|
+
|
|
2796
|
+
### Authorization
|
|
2797
|
+
|
|
2798
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2799
|
+
|
|
2800
|
+
### HTTP request headers
|
|
2801
|
+
|
|
2802
|
+
- **Content-Type**: Not defined
|
|
2803
|
+
- **Accept**: application/json
|
|
2804
|
+
|
|
2805
|
+
|
|
2806
|
+
## workspace_get_mail_thread
|
|
2807
|
+
|
|
2808
|
+
> Hash<String, Object> workspace_get_mail_thread(org, workspace, id)
|
|
2809
|
+
|
|
2810
|
+
|
|
2811
|
+
|
|
2812
|
+
### Examples
|
|
2813
|
+
|
|
2814
|
+
```ruby
|
|
2815
|
+
require 'time'
|
|
2816
|
+
require 'spatio-sdk'
|
|
2817
|
+
# setup authorization
|
|
2818
|
+
Spatio.configure do |config|
|
|
2819
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2820
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2821
|
+
end
|
|
2822
|
+
|
|
2823
|
+
api_instance = Spatio::MailApi.new
|
|
2824
|
+
org = 'org_example' # String |
|
|
2825
|
+
workspace = 'workspace_example' # String |
|
|
2826
|
+
id = 'id_example' # String |
|
|
2827
|
+
|
|
2828
|
+
begin
|
|
2829
|
+
|
|
2830
|
+
result = api_instance.workspace_get_mail_thread(org, workspace, id)
|
|
2831
|
+
p result
|
|
2832
|
+
rescue Spatio::ApiError => e
|
|
2833
|
+
puts "Error when calling MailApi->workspace_get_mail_thread: #{e}"
|
|
2834
|
+
end
|
|
2835
|
+
```
|
|
2836
|
+
|
|
2837
|
+
#### Using the workspace_get_mail_thread_with_http_info variant
|
|
2838
|
+
|
|
2839
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2840
|
+
|
|
2841
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_mail_thread_with_http_info(org, workspace, id)
|
|
2842
|
+
|
|
2843
|
+
```ruby
|
|
2844
|
+
begin
|
|
2845
|
+
|
|
2846
|
+
data, status_code, headers = api_instance.workspace_get_mail_thread_with_http_info(org, workspace, id)
|
|
2847
|
+
p status_code # => 2xx
|
|
2848
|
+
p headers # => { ... }
|
|
2849
|
+
p data # => Hash<String, Object>
|
|
2850
|
+
rescue Spatio::ApiError => e
|
|
2851
|
+
puts "Error when calling MailApi->workspace_get_mail_thread_with_http_info: #{e}"
|
|
2852
|
+
end
|
|
2853
|
+
```
|
|
2854
|
+
|
|
2855
|
+
### Parameters
|
|
2856
|
+
|
|
2857
|
+
| Name | Type | Description | Notes |
|
|
2858
|
+
| ---- | ---- | ----------- | ----- |
|
|
2859
|
+
| **org** | **String** | | |
|
|
2860
|
+
| **workspace** | **String** | | |
|
|
2861
|
+
| **id** | **String** | | |
|
|
2862
|
+
|
|
2863
|
+
### Return type
|
|
2864
|
+
|
|
2865
|
+
**Hash<String, Object>**
|
|
2866
|
+
|
|
2867
|
+
### Authorization
|
|
2868
|
+
|
|
2869
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2870
|
+
|
|
2871
|
+
### HTTP request headers
|
|
2872
|
+
|
|
2873
|
+
- **Content-Type**: Not defined
|
|
2874
|
+
- **Accept**: application/json
|
|
2875
|
+
|
|
2876
|
+
|
|
2877
|
+
## workspace_list_mail
|
|
2878
|
+
|
|
2879
|
+
> Hash<String, Object> workspace_list_mail(org, workspace)
|
|
2880
|
+
|
|
2881
|
+
|
|
2882
|
+
|
|
2883
|
+
### Examples
|
|
2884
|
+
|
|
2885
|
+
```ruby
|
|
2886
|
+
require 'time'
|
|
2887
|
+
require 'spatio-sdk'
|
|
2888
|
+
# setup authorization
|
|
2889
|
+
Spatio.configure do |config|
|
|
2890
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2891
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2892
|
+
end
|
|
2893
|
+
|
|
2894
|
+
api_instance = Spatio::MailApi.new
|
|
2895
|
+
org = 'org_example' # String |
|
|
2896
|
+
workspace = 'workspace_example' # String |
|
|
2897
|
+
|
|
2898
|
+
begin
|
|
2899
|
+
|
|
2900
|
+
result = api_instance.workspace_list_mail(org, workspace)
|
|
2901
|
+
p result
|
|
2902
|
+
rescue Spatio::ApiError => e
|
|
2903
|
+
puts "Error when calling MailApi->workspace_list_mail: #{e}"
|
|
2904
|
+
end
|
|
2905
|
+
```
|
|
2906
|
+
|
|
2907
|
+
#### Using the workspace_list_mail_with_http_info variant
|
|
2908
|
+
|
|
2909
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2910
|
+
|
|
2911
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_mail_with_http_info(org, workspace)
|
|
2912
|
+
|
|
2913
|
+
```ruby
|
|
2914
|
+
begin
|
|
2915
|
+
|
|
2916
|
+
data, status_code, headers = api_instance.workspace_list_mail_with_http_info(org, workspace)
|
|
2917
|
+
p status_code # => 2xx
|
|
2918
|
+
p headers # => { ... }
|
|
2919
|
+
p data # => Hash<String, Object>
|
|
2920
|
+
rescue Spatio::ApiError => e
|
|
2921
|
+
puts "Error when calling MailApi->workspace_list_mail_with_http_info: #{e}"
|
|
2922
|
+
end
|
|
2923
|
+
```
|
|
2924
|
+
|
|
2925
|
+
### Parameters
|
|
2926
|
+
|
|
2927
|
+
| Name | Type | Description | Notes |
|
|
2928
|
+
| ---- | ---- | ----------- | ----- |
|
|
2929
|
+
| **org** | **String** | | |
|
|
2930
|
+
| **workspace** | **String** | | |
|
|
2931
|
+
|
|
2932
|
+
### Return type
|
|
2933
|
+
|
|
2934
|
+
**Hash<String, Object>**
|
|
2935
|
+
|
|
2936
|
+
### Authorization
|
|
2937
|
+
|
|
2938
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2939
|
+
|
|
2940
|
+
### HTTP request headers
|
|
2941
|
+
|
|
2942
|
+
- **Content-Type**: Not defined
|
|
2943
|
+
- **Accept**: application/json
|
|
2944
|
+
|
|
2945
|
+
|
|
2946
|
+
## workspace_list_mail_drafts
|
|
2947
|
+
|
|
2948
|
+
> Hash<String, Object> workspace_list_mail_drafts(org, workspace)
|
|
2949
|
+
|
|
2950
|
+
|
|
2951
|
+
|
|
2952
|
+
### Examples
|
|
2953
|
+
|
|
2954
|
+
```ruby
|
|
2955
|
+
require 'time'
|
|
2956
|
+
require 'spatio-sdk'
|
|
2957
|
+
# setup authorization
|
|
2958
|
+
Spatio.configure do |config|
|
|
2959
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2960
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2961
|
+
end
|
|
2962
|
+
|
|
2963
|
+
api_instance = Spatio::MailApi.new
|
|
2964
|
+
org = 'org_example' # String |
|
|
2965
|
+
workspace = 'workspace_example' # String |
|
|
2966
|
+
|
|
2967
|
+
begin
|
|
2968
|
+
|
|
2969
|
+
result = api_instance.workspace_list_mail_drafts(org, workspace)
|
|
2970
|
+
p result
|
|
2971
|
+
rescue Spatio::ApiError => e
|
|
2972
|
+
puts "Error when calling MailApi->workspace_list_mail_drafts: #{e}"
|
|
2973
|
+
end
|
|
2974
|
+
```
|
|
2975
|
+
|
|
2976
|
+
#### Using the workspace_list_mail_drafts_with_http_info variant
|
|
2977
|
+
|
|
2978
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2979
|
+
|
|
2980
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_mail_drafts_with_http_info(org, workspace)
|
|
2981
|
+
|
|
2982
|
+
```ruby
|
|
2983
|
+
begin
|
|
2984
|
+
|
|
2985
|
+
data, status_code, headers = api_instance.workspace_list_mail_drafts_with_http_info(org, workspace)
|
|
2986
|
+
p status_code # => 2xx
|
|
2987
|
+
p headers # => { ... }
|
|
2988
|
+
p data # => Hash<String, Object>
|
|
2989
|
+
rescue Spatio::ApiError => e
|
|
2990
|
+
puts "Error when calling MailApi->workspace_list_mail_drafts_with_http_info: #{e}"
|
|
2991
|
+
end
|
|
2992
|
+
```
|
|
2993
|
+
|
|
2994
|
+
### Parameters
|
|
2995
|
+
|
|
2996
|
+
| Name | Type | Description | Notes |
|
|
2997
|
+
| ---- | ---- | ----------- | ----- |
|
|
2998
|
+
| **org** | **String** | | |
|
|
2999
|
+
| **workspace** | **String** | | |
|
|
3000
|
+
|
|
3001
|
+
### Return type
|
|
3002
|
+
|
|
3003
|
+
**Hash<String, Object>**
|
|
3004
|
+
|
|
3005
|
+
### Authorization
|
|
3006
|
+
|
|
3007
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3008
|
+
|
|
3009
|
+
### HTTP request headers
|
|
3010
|
+
|
|
3011
|
+
- **Content-Type**: Not defined
|
|
3012
|
+
- **Accept**: application/json
|
|
3013
|
+
|
|
3014
|
+
|
|
3015
|
+
## workspace_list_mail_labels
|
|
3016
|
+
|
|
3017
|
+
> Hash<String, Object> workspace_list_mail_labels(org, workspace)
|
|
3018
|
+
|
|
3019
|
+
|
|
3020
|
+
|
|
3021
|
+
### Examples
|
|
3022
|
+
|
|
3023
|
+
```ruby
|
|
3024
|
+
require 'time'
|
|
3025
|
+
require 'spatio-sdk'
|
|
3026
|
+
# setup authorization
|
|
3027
|
+
Spatio.configure do |config|
|
|
3028
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3029
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3030
|
+
end
|
|
3031
|
+
|
|
3032
|
+
api_instance = Spatio::MailApi.new
|
|
3033
|
+
org = 'org_example' # String |
|
|
3034
|
+
workspace = 'workspace_example' # String |
|
|
3035
|
+
|
|
3036
|
+
begin
|
|
3037
|
+
|
|
3038
|
+
result = api_instance.workspace_list_mail_labels(org, workspace)
|
|
3039
|
+
p result
|
|
3040
|
+
rescue Spatio::ApiError => e
|
|
3041
|
+
puts "Error when calling MailApi->workspace_list_mail_labels: #{e}"
|
|
3042
|
+
end
|
|
3043
|
+
```
|
|
3044
|
+
|
|
3045
|
+
#### Using the workspace_list_mail_labels_with_http_info variant
|
|
3046
|
+
|
|
3047
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3048
|
+
|
|
3049
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_mail_labels_with_http_info(org, workspace)
|
|
3050
|
+
|
|
3051
|
+
```ruby
|
|
3052
|
+
begin
|
|
3053
|
+
|
|
3054
|
+
data, status_code, headers = api_instance.workspace_list_mail_labels_with_http_info(org, workspace)
|
|
3055
|
+
p status_code # => 2xx
|
|
3056
|
+
p headers # => { ... }
|
|
3057
|
+
p data # => Hash<String, Object>
|
|
3058
|
+
rescue Spatio::ApiError => e
|
|
3059
|
+
puts "Error when calling MailApi->workspace_list_mail_labels_with_http_info: #{e}"
|
|
3060
|
+
end
|
|
3061
|
+
```
|
|
3062
|
+
|
|
3063
|
+
### Parameters
|
|
3064
|
+
|
|
3065
|
+
| Name | Type | Description | Notes |
|
|
3066
|
+
| ---- | ---- | ----------- | ----- |
|
|
3067
|
+
| **org** | **String** | | |
|
|
3068
|
+
| **workspace** | **String** | | |
|
|
3069
|
+
|
|
3070
|
+
### Return type
|
|
3071
|
+
|
|
3072
|
+
**Hash<String, Object>**
|
|
3073
|
+
|
|
3074
|
+
### Authorization
|
|
3075
|
+
|
|
3076
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3077
|
+
|
|
3078
|
+
### HTTP request headers
|
|
3079
|
+
|
|
3080
|
+
- **Content-Type**: Not defined
|
|
3081
|
+
- **Accept**: application/json
|
|
3082
|
+
|
|
3083
|
+
|
|
3084
|
+
## workspace_patch_mail
|
|
3085
|
+
|
|
3086
|
+
> Hash<String, Object> workspace_patch_mail(org, workspace, id, request_body)
|
|
3087
|
+
|
|
3088
|
+
|
|
3089
|
+
|
|
3090
|
+
### Examples
|
|
3091
|
+
|
|
3092
|
+
```ruby
|
|
3093
|
+
require 'time'
|
|
3094
|
+
require 'spatio-sdk'
|
|
3095
|
+
# setup authorization
|
|
3096
|
+
Spatio.configure do |config|
|
|
3097
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3098
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3099
|
+
end
|
|
3100
|
+
|
|
3101
|
+
api_instance = Spatio::MailApi.new
|
|
3102
|
+
org = 'org_example' # String |
|
|
3103
|
+
workspace = 'workspace_example' # String |
|
|
3104
|
+
id = 'id_example' # String |
|
|
3105
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
3106
|
+
|
|
3107
|
+
begin
|
|
3108
|
+
|
|
3109
|
+
result = api_instance.workspace_patch_mail(org, workspace, id, request_body)
|
|
3110
|
+
p result
|
|
3111
|
+
rescue Spatio::ApiError => e
|
|
3112
|
+
puts "Error when calling MailApi->workspace_patch_mail: #{e}"
|
|
3113
|
+
end
|
|
3114
|
+
```
|
|
3115
|
+
|
|
3116
|
+
#### Using the workspace_patch_mail_with_http_info variant
|
|
3117
|
+
|
|
3118
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3119
|
+
|
|
3120
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_patch_mail_with_http_info(org, workspace, id, request_body)
|
|
3121
|
+
|
|
3122
|
+
```ruby
|
|
3123
|
+
begin
|
|
3124
|
+
|
|
3125
|
+
data, status_code, headers = api_instance.workspace_patch_mail_with_http_info(org, workspace, id, request_body)
|
|
3126
|
+
p status_code # => 2xx
|
|
3127
|
+
p headers # => { ... }
|
|
3128
|
+
p data # => Hash<String, Object>
|
|
3129
|
+
rescue Spatio::ApiError => e
|
|
3130
|
+
puts "Error when calling MailApi->workspace_patch_mail_with_http_info: #{e}"
|
|
3131
|
+
end
|
|
3132
|
+
```
|
|
3133
|
+
|
|
3134
|
+
### Parameters
|
|
3135
|
+
|
|
3136
|
+
| Name | Type | Description | Notes |
|
|
3137
|
+
| ---- | ---- | ----------- | ----- |
|
|
3138
|
+
| **org** | **String** | | |
|
|
3139
|
+
| **workspace** | **String** | | |
|
|
3140
|
+
| **id** | **String** | | |
|
|
3141
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
3142
|
+
|
|
3143
|
+
### Return type
|
|
3144
|
+
|
|
3145
|
+
**Hash<String, Object>**
|
|
3146
|
+
|
|
3147
|
+
### Authorization
|
|
3148
|
+
|
|
3149
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3150
|
+
|
|
3151
|
+
### HTTP request headers
|
|
3152
|
+
|
|
3153
|
+
- **Content-Type**: application/json
|
|
3154
|
+
- **Accept**: application/json
|
|
3155
|
+
|
|
3156
|
+
|
|
3157
|
+
## workspace_remove_mail_message_label
|
|
3158
|
+
|
|
3159
|
+
> workspace_remove_mail_message_label(org, workspace, message_id, label_id)
|
|
3160
|
+
|
|
3161
|
+
|
|
3162
|
+
|
|
3163
|
+
### Examples
|
|
3164
|
+
|
|
3165
|
+
```ruby
|
|
3166
|
+
require 'time'
|
|
3167
|
+
require 'spatio-sdk'
|
|
3168
|
+
# setup authorization
|
|
3169
|
+
Spatio.configure do |config|
|
|
3170
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3171
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3172
|
+
end
|
|
3173
|
+
|
|
3174
|
+
api_instance = Spatio::MailApi.new
|
|
3175
|
+
org = 'org_example' # String |
|
|
3176
|
+
workspace = 'workspace_example' # String |
|
|
3177
|
+
message_id = 'message_id_example' # String |
|
|
3178
|
+
label_id = 'label_id_example' # String |
|
|
3179
|
+
|
|
3180
|
+
begin
|
|
3181
|
+
|
|
3182
|
+
api_instance.workspace_remove_mail_message_label(org, workspace, message_id, label_id)
|
|
3183
|
+
rescue Spatio::ApiError => e
|
|
3184
|
+
puts "Error when calling MailApi->workspace_remove_mail_message_label: #{e}"
|
|
3185
|
+
end
|
|
3186
|
+
```
|
|
3187
|
+
|
|
3188
|
+
#### Using the workspace_remove_mail_message_label_with_http_info variant
|
|
3189
|
+
|
|
3190
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
3191
|
+
|
|
3192
|
+
> <Array(nil, Integer, Hash)> workspace_remove_mail_message_label_with_http_info(org, workspace, message_id, label_id)
|
|
3193
|
+
|
|
3194
|
+
```ruby
|
|
3195
|
+
begin
|
|
3196
|
+
|
|
3197
|
+
data, status_code, headers = api_instance.workspace_remove_mail_message_label_with_http_info(org, workspace, message_id, label_id)
|
|
3198
|
+
p status_code # => 2xx
|
|
3199
|
+
p headers # => { ... }
|
|
3200
|
+
p data # => nil
|
|
3201
|
+
rescue Spatio::ApiError => e
|
|
3202
|
+
puts "Error when calling MailApi->workspace_remove_mail_message_label_with_http_info: #{e}"
|
|
3203
|
+
end
|
|
3204
|
+
```
|
|
3205
|
+
|
|
3206
|
+
### Parameters
|
|
3207
|
+
|
|
3208
|
+
| Name | Type | Description | Notes |
|
|
3209
|
+
| ---- | ---- | ----------- | ----- |
|
|
3210
|
+
| **org** | **String** | | |
|
|
3211
|
+
| **workspace** | **String** | | |
|
|
3212
|
+
| **message_id** | **String** | | |
|
|
3213
|
+
| **label_id** | **String** | | |
|
|
3214
|
+
|
|
3215
|
+
### Return type
|
|
3216
|
+
|
|
3217
|
+
nil (empty response body)
|
|
3218
|
+
|
|
3219
|
+
### Authorization
|
|
3220
|
+
|
|
3221
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3222
|
+
|
|
3223
|
+
### HTTP request headers
|
|
3224
|
+
|
|
3225
|
+
- **Content-Type**: Not defined
|
|
3226
|
+
- **Accept**: application/json
|
|
3227
|
+
|
|
3228
|
+
|
|
3229
|
+
## workspace_reply_mail
|
|
3230
|
+
|
|
3231
|
+
> Hash<String, Object> workspace_reply_mail(org, workspace, request_body)
|
|
3232
|
+
|
|
3233
|
+
|
|
3234
|
+
|
|
3235
|
+
### Examples
|
|
3236
|
+
|
|
3237
|
+
```ruby
|
|
3238
|
+
require 'time'
|
|
3239
|
+
require 'spatio-sdk'
|
|
3240
|
+
# setup authorization
|
|
3241
|
+
Spatio.configure do |config|
|
|
3242
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3243
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3244
|
+
end
|
|
3245
|
+
|
|
3246
|
+
api_instance = Spatio::MailApi.new
|
|
3247
|
+
org = 'org_example' # String |
|
|
3248
|
+
workspace = 'workspace_example' # String |
|
|
3249
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
3250
|
+
|
|
3251
|
+
begin
|
|
3252
|
+
|
|
3253
|
+
result = api_instance.workspace_reply_mail(org, workspace, request_body)
|
|
3254
|
+
p result
|
|
3255
|
+
rescue Spatio::ApiError => e
|
|
3256
|
+
puts "Error when calling MailApi->workspace_reply_mail: #{e}"
|
|
3257
|
+
end
|
|
3258
|
+
```
|
|
3259
|
+
|
|
3260
|
+
#### Using the workspace_reply_mail_with_http_info variant
|
|
3261
|
+
|
|
3262
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3263
|
+
|
|
3264
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_reply_mail_with_http_info(org, workspace, request_body)
|
|
3265
|
+
|
|
3266
|
+
```ruby
|
|
3267
|
+
begin
|
|
3268
|
+
|
|
3269
|
+
data, status_code, headers = api_instance.workspace_reply_mail_with_http_info(org, workspace, request_body)
|
|
3270
|
+
p status_code # => 2xx
|
|
3271
|
+
p headers # => { ... }
|
|
3272
|
+
p data # => Hash<String, Object>
|
|
3273
|
+
rescue Spatio::ApiError => e
|
|
3274
|
+
puts "Error when calling MailApi->workspace_reply_mail_with_http_info: #{e}"
|
|
3275
|
+
end
|
|
3276
|
+
```
|
|
3277
|
+
|
|
3278
|
+
### Parameters
|
|
3279
|
+
|
|
3280
|
+
| Name | Type | Description | Notes |
|
|
3281
|
+
| ---- | ---- | ----------- | ----- |
|
|
3282
|
+
| **org** | **String** | | |
|
|
3283
|
+
| **workspace** | **String** | | |
|
|
3284
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
3285
|
+
|
|
3286
|
+
### Return type
|
|
3287
|
+
|
|
3288
|
+
**Hash<String, Object>**
|
|
3289
|
+
|
|
3290
|
+
### Authorization
|
|
3291
|
+
|
|
3292
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3293
|
+
|
|
3294
|
+
### HTTP request headers
|
|
3295
|
+
|
|
3296
|
+
- **Content-Type**: application/json
|
|
3297
|
+
- **Accept**: application/json
|
|
3298
|
+
|
|
3299
|
+
|
|
3300
|
+
## workspace_search_mail
|
|
3301
|
+
|
|
3302
|
+
> Hash<String, Object> workspace_search_mail(org, workspace, opts)
|
|
3303
|
+
|
|
3304
|
+
|
|
3305
|
+
|
|
3306
|
+
### Examples
|
|
3307
|
+
|
|
3308
|
+
```ruby
|
|
3309
|
+
require 'time'
|
|
3310
|
+
require 'spatio-sdk'
|
|
3311
|
+
# setup authorization
|
|
3312
|
+
Spatio.configure do |config|
|
|
3313
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3314
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3315
|
+
end
|
|
3316
|
+
|
|
3317
|
+
api_instance = Spatio::MailApi.new
|
|
3318
|
+
org = 'org_example' # String |
|
|
3319
|
+
workspace = 'workspace_example' # String |
|
|
3320
|
+
opts = {
|
|
3321
|
+
q: 'q_example' # String |
|
|
3322
|
+
}
|
|
3323
|
+
|
|
3324
|
+
begin
|
|
3325
|
+
|
|
3326
|
+
result = api_instance.workspace_search_mail(org, workspace, opts)
|
|
3327
|
+
p result
|
|
3328
|
+
rescue Spatio::ApiError => e
|
|
3329
|
+
puts "Error when calling MailApi->workspace_search_mail: #{e}"
|
|
3330
|
+
end
|
|
3331
|
+
```
|
|
3332
|
+
|
|
3333
|
+
#### Using the workspace_search_mail_with_http_info variant
|
|
3334
|
+
|
|
3335
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3336
|
+
|
|
3337
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_search_mail_with_http_info(org, workspace, opts)
|
|
3338
|
+
|
|
3339
|
+
```ruby
|
|
3340
|
+
begin
|
|
3341
|
+
|
|
3342
|
+
data, status_code, headers = api_instance.workspace_search_mail_with_http_info(org, workspace, opts)
|
|
3343
|
+
p status_code # => 2xx
|
|
3344
|
+
p headers # => { ... }
|
|
3345
|
+
p data # => Hash<String, Object>
|
|
3346
|
+
rescue Spatio::ApiError => e
|
|
3347
|
+
puts "Error when calling MailApi->workspace_search_mail_with_http_info: #{e}"
|
|
3348
|
+
end
|
|
3349
|
+
```
|
|
3350
|
+
|
|
3351
|
+
### Parameters
|
|
3352
|
+
|
|
3353
|
+
| Name | Type | Description | Notes |
|
|
3354
|
+
| ---- | ---- | ----------- | ----- |
|
|
3355
|
+
| **org** | **String** | | |
|
|
3356
|
+
| **workspace** | **String** | | |
|
|
3357
|
+
| **q** | **String** | | [optional] |
|
|
3358
|
+
|
|
3359
|
+
### Return type
|
|
3360
|
+
|
|
3361
|
+
**Hash<String, Object>**
|
|
3362
|
+
|
|
3363
|
+
### Authorization
|
|
3364
|
+
|
|
3365
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3366
|
+
|
|
3367
|
+
### HTTP request headers
|
|
3368
|
+
|
|
3369
|
+
- **Content-Type**: Not defined
|
|
3370
|
+
- **Accept**: application/json
|
|
3371
|
+
|
|
3372
|
+
|
|
3373
|
+
## workspace_send_mail
|
|
3374
|
+
|
|
3375
|
+
> Hash<String, Object> workspace_send_mail(org, workspace, request_body)
|
|
3376
|
+
|
|
3377
|
+
|
|
3378
|
+
|
|
3379
|
+
### Examples
|
|
3380
|
+
|
|
3381
|
+
```ruby
|
|
3382
|
+
require 'time'
|
|
3383
|
+
require 'spatio-sdk'
|
|
3384
|
+
# setup authorization
|
|
3385
|
+
Spatio.configure do |config|
|
|
3386
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3387
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3388
|
+
end
|
|
3389
|
+
|
|
3390
|
+
api_instance = Spatio::MailApi.new
|
|
3391
|
+
org = 'org_example' # String |
|
|
3392
|
+
workspace = 'workspace_example' # String |
|
|
3393
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
3394
|
+
|
|
3395
|
+
begin
|
|
3396
|
+
|
|
3397
|
+
result = api_instance.workspace_send_mail(org, workspace, request_body)
|
|
3398
|
+
p result
|
|
3399
|
+
rescue Spatio::ApiError => e
|
|
3400
|
+
puts "Error when calling MailApi->workspace_send_mail: #{e}"
|
|
3401
|
+
end
|
|
3402
|
+
```
|
|
3403
|
+
|
|
3404
|
+
#### Using the workspace_send_mail_with_http_info variant
|
|
3405
|
+
|
|
3406
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3407
|
+
|
|
3408
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_send_mail_with_http_info(org, workspace, request_body)
|
|
3409
|
+
|
|
3410
|
+
```ruby
|
|
3411
|
+
begin
|
|
3412
|
+
|
|
3413
|
+
data, status_code, headers = api_instance.workspace_send_mail_with_http_info(org, workspace, request_body)
|
|
3414
|
+
p status_code # => 2xx
|
|
3415
|
+
p headers # => { ... }
|
|
3416
|
+
p data # => Hash<String, Object>
|
|
3417
|
+
rescue Spatio::ApiError => e
|
|
3418
|
+
puts "Error when calling MailApi->workspace_send_mail_with_http_info: #{e}"
|
|
3419
|
+
end
|
|
3420
|
+
```
|
|
3421
|
+
|
|
3422
|
+
### Parameters
|
|
3423
|
+
|
|
3424
|
+
| Name | Type | Description | Notes |
|
|
3425
|
+
| ---- | ---- | ----------- | ----- |
|
|
3426
|
+
| **org** | **String** | | |
|
|
3427
|
+
| **workspace** | **String** | | |
|
|
3428
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
3429
|
+
|
|
3430
|
+
### Return type
|
|
3431
|
+
|
|
3432
|
+
**Hash<String, Object>**
|
|
3433
|
+
|
|
3434
|
+
### Authorization
|
|
3435
|
+
|
|
3436
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3437
|
+
|
|
3438
|
+
### HTTP request headers
|
|
3439
|
+
|
|
3440
|
+
- **Content-Type**: application/json
|
|
3441
|
+
- **Accept**: application/json
|
|
3442
|
+
|
|
3443
|
+
|
|
3444
|
+
## workspace_send_mail_draft
|
|
3445
|
+
|
|
3446
|
+
> Hash<String, Object> workspace_send_mail_draft(org, workspace, id)
|
|
3447
|
+
|
|
3448
|
+
|
|
3449
|
+
|
|
3450
|
+
### Examples
|
|
3451
|
+
|
|
3452
|
+
```ruby
|
|
3453
|
+
require 'time'
|
|
3454
|
+
require 'spatio-sdk'
|
|
3455
|
+
# setup authorization
|
|
3456
|
+
Spatio.configure do |config|
|
|
3457
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3458
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3459
|
+
end
|
|
3460
|
+
|
|
3461
|
+
api_instance = Spatio::MailApi.new
|
|
3462
|
+
org = 'org_example' # String |
|
|
3463
|
+
workspace = 'workspace_example' # String |
|
|
3464
|
+
id = 'id_example' # String |
|
|
3465
|
+
|
|
3466
|
+
begin
|
|
3467
|
+
|
|
3468
|
+
result = api_instance.workspace_send_mail_draft(org, workspace, id)
|
|
3469
|
+
p result
|
|
3470
|
+
rescue Spatio::ApiError => e
|
|
3471
|
+
puts "Error when calling MailApi->workspace_send_mail_draft: #{e}"
|
|
3472
|
+
end
|
|
3473
|
+
```
|
|
3474
|
+
|
|
3475
|
+
#### Using the workspace_send_mail_draft_with_http_info variant
|
|
3476
|
+
|
|
3477
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3478
|
+
|
|
3479
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_send_mail_draft_with_http_info(org, workspace, id)
|
|
3480
|
+
|
|
3481
|
+
```ruby
|
|
3482
|
+
begin
|
|
3483
|
+
|
|
3484
|
+
data, status_code, headers = api_instance.workspace_send_mail_draft_with_http_info(org, workspace, id)
|
|
3485
|
+
p status_code # => 2xx
|
|
3486
|
+
p headers # => { ... }
|
|
3487
|
+
p data # => Hash<String, Object>
|
|
3488
|
+
rescue Spatio::ApiError => e
|
|
3489
|
+
puts "Error when calling MailApi->workspace_send_mail_draft_with_http_info: #{e}"
|
|
3490
|
+
end
|
|
3491
|
+
```
|
|
3492
|
+
|
|
3493
|
+
### Parameters
|
|
3494
|
+
|
|
3495
|
+
| Name | Type | Description | Notes |
|
|
3496
|
+
| ---- | ---- | ----------- | ----- |
|
|
3497
|
+
| **org** | **String** | | |
|
|
3498
|
+
| **workspace** | **String** | | |
|
|
3499
|
+
| **id** | **String** | | |
|
|
3500
|
+
|
|
3501
|
+
### Return type
|
|
3502
|
+
|
|
3503
|
+
**Hash<String, Object>**
|
|
3504
|
+
|
|
3505
|
+
### Authorization
|
|
3506
|
+
|
|
3507
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3508
|
+
|
|
3509
|
+
### HTTP request headers
|
|
3510
|
+
|
|
3511
|
+
- **Content-Type**: Not defined
|
|
3512
|
+
- **Accept**: application/json
|
|
3513
|
+
|
|
3514
|
+
|
|
3515
|
+
## workspace_send_mail_email_alias
|
|
3516
|
+
|
|
3517
|
+
> Hash<String, Object> workspace_send_mail_email_alias(org, workspace, request_body)
|
|
3518
|
+
|
|
3519
|
+
Renderer-compat alias for /mail/send.
|
|
3520
|
+
|
|
3521
|
+
### Examples
|
|
3522
|
+
|
|
3523
|
+
```ruby
|
|
3524
|
+
require 'time'
|
|
3525
|
+
require 'spatio-sdk'
|
|
3526
|
+
# setup authorization
|
|
3527
|
+
Spatio.configure do |config|
|
|
3528
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3529
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3530
|
+
end
|
|
3531
|
+
|
|
3532
|
+
api_instance = Spatio::MailApi.new
|
|
3533
|
+
org = 'org_example' # String |
|
|
3534
|
+
workspace = 'workspace_example' # String |
|
|
3535
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
3536
|
+
|
|
3537
|
+
begin
|
|
3538
|
+
# Renderer-compat alias for /mail/send.
|
|
3539
|
+
result = api_instance.workspace_send_mail_email_alias(org, workspace, request_body)
|
|
3540
|
+
p result
|
|
3541
|
+
rescue Spatio::ApiError => e
|
|
3542
|
+
puts "Error when calling MailApi->workspace_send_mail_email_alias: #{e}"
|
|
3543
|
+
end
|
|
3544
|
+
```
|
|
3545
|
+
|
|
3546
|
+
#### Using the workspace_send_mail_email_alias_with_http_info variant
|
|
3547
|
+
|
|
3548
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3549
|
+
|
|
3550
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_send_mail_email_alias_with_http_info(org, workspace, request_body)
|
|
3551
|
+
|
|
3552
|
+
```ruby
|
|
3553
|
+
begin
|
|
3554
|
+
# Renderer-compat alias for /mail/send.
|
|
3555
|
+
data, status_code, headers = api_instance.workspace_send_mail_email_alias_with_http_info(org, workspace, request_body)
|
|
3556
|
+
p status_code # => 2xx
|
|
3557
|
+
p headers # => { ... }
|
|
3558
|
+
p data # => Hash<String, Object>
|
|
3559
|
+
rescue Spatio::ApiError => e
|
|
3560
|
+
puts "Error when calling MailApi->workspace_send_mail_email_alias_with_http_info: #{e}"
|
|
3561
|
+
end
|
|
3562
|
+
```
|
|
3563
|
+
|
|
3564
|
+
### Parameters
|
|
3565
|
+
|
|
3566
|
+
| Name | Type | Description | Notes |
|
|
3567
|
+
| ---- | ---- | ----------- | ----- |
|
|
3568
|
+
| **org** | **String** | | |
|
|
3569
|
+
| **workspace** | **String** | | |
|
|
3570
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
3571
|
+
|
|
3572
|
+
### Return type
|
|
3573
|
+
|
|
3574
|
+
**Hash<String, Object>**
|
|
3575
|
+
|
|
3576
|
+
### Authorization
|
|
3577
|
+
|
|
3578
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3579
|
+
|
|
3580
|
+
### HTTP request headers
|
|
3581
|
+
|
|
3582
|
+
- **Content-Type**: application/json
|
|
3583
|
+
- **Accept**: application/json
|
|
3584
|
+
|
|
3585
|
+
|
|
3586
|
+
## workspace_update_mail
|
|
3587
|
+
|
|
3588
|
+
> Hash<String, Object> workspace_update_mail(org, workspace, id, request_body)
|
|
3589
|
+
|
|
3590
|
+
|
|
3591
|
+
|
|
3592
|
+
### Examples
|
|
3593
|
+
|
|
3594
|
+
```ruby
|
|
3595
|
+
require 'time'
|
|
3596
|
+
require 'spatio-sdk'
|
|
3597
|
+
# setup authorization
|
|
3598
|
+
Spatio.configure do |config|
|
|
3599
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3600
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3601
|
+
end
|
|
3602
|
+
|
|
3603
|
+
api_instance = Spatio::MailApi.new
|
|
3604
|
+
org = 'org_example' # String |
|
|
3605
|
+
workspace = 'workspace_example' # String |
|
|
3606
|
+
id = 'id_example' # String |
|
|
3607
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
3608
|
+
|
|
3609
|
+
begin
|
|
3610
|
+
|
|
3611
|
+
result = api_instance.workspace_update_mail(org, workspace, id, request_body)
|
|
3612
|
+
p result
|
|
3613
|
+
rescue Spatio::ApiError => e
|
|
3614
|
+
puts "Error when calling MailApi->workspace_update_mail: #{e}"
|
|
3615
|
+
end
|
|
3616
|
+
```
|
|
3617
|
+
|
|
3618
|
+
#### Using the workspace_update_mail_with_http_info variant
|
|
3619
|
+
|
|
3620
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3621
|
+
|
|
3622
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_update_mail_with_http_info(org, workspace, id, request_body)
|
|
3623
|
+
|
|
3624
|
+
```ruby
|
|
3625
|
+
begin
|
|
3626
|
+
|
|
3627
|
+
data, status_code, headers = api_instance.workspace_update_mail_with_http_info(org, workspace, id, request_body)
|
|
3628
|
+
p status_code # => 2xx
|
|
3629
|
+
p headers # => { ... }
|
|
3630
|
+
p data # => Hash<String, Object>
|
|
3631
|
+
rescue Spatio::ApiError => e
|
|
3632
|
+
puts "Error when calling MailApi->workspace_update_mail_with_http_info: #{e}"
|
|
3633
|
+
end
|
|
3634
|
+
```
|
|
3635
|
+
|
|
3636
|
+
### Parameters
|
|
3637
|
+
|
|
3638
|
+
| Name | Type | Description | Notes |
|
|
3639
|
+
| ---- | ---- | ----------- | ----- |
|
|
3640
|
+
| **org** | **String** | | |
|
|
3641
|
+
| **workspace** | **String** | | |
|
|
3642
|
+
| **id** | **String** | | |
|
|
3643
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
3644
|
+
|
|
3645
|
+
### Return type
|
|
3646
|
+
|
|
3647
|
+
**Hash<String, Object>**
|
|
3648
|
+
|
|
3649
|
+
### Authorization
|
|
3650
|
+
|
|
3651
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3652
|
+
|
|
3653
|
+
### HTTP request headers
|
|
3654
|
+
|
|
3655
|
+
- **Content-Type**: application/json
|
|
3656
|
+
- **Accept**: application/json
|
|
3657
|
+
|
|
3658
|
+
|
|
3659
|
+
## workspace_update_mail_draft
|
|
3660
|
+
|
|
3661
|
+
> Hash<String, Object> workspace_update_mail_draft(org, workspace, id, request_body)
|
|
3662
|
+
|
|
3663
|
+
|
|
3664
|
+
|
|
3665
|
+
### Examples
|
|
3666
|
+
|
|
3667
|
+
```ruby
|
|
3668
|
+
require 'time'
|
|
3669
|
+
require 'spatio-sdk'
|
|
3670
|
+
# setup authorization
|
|
3671
|
+
Spatio.configure do |config|
|
|
3672
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3673
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3674
|
+
end
|
|
3675
|
+
|
|
3676
|
+
api_instance = Spatio::MailApi.new
|
|
3677
|
+
org = 'org_example' # String |
|
|
3678
|
+
workspace = 'workspace_example' # String |
|
|
3679
|
+
id = 'id_example' # String |
|
|
3680
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
3681
|
+
|
|
3682
|
+
begin
|
|
3683
|
+
|
|
3684
|
+
result = api_instance.workspace_update_mail_draft(org, workspace, id, request_body)
|
|
3685
|
+
p result
|
|
3686
|
+
rescue Spatio::ApiError => e
|
|
3687
|
+
puts "Error when calling MailApi->workspace_update_mail_draft: #{e}"
|
|
3688
|
+
end
|
|
3689
|
+
```
|
|
3690
|
+
|
|
3691
|
+
#### Using the workspace_update_mail_draft_with_http_info variant
|
|
3692
|
+
|
|
3693
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3694
|
+
|
|
3695
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_update_mail_draft_with_http_info(org, workspace, id, request_body)
|
|
3696
|
+
|
|
3697
|
+
```ruby
|
|
3698
|
+
begin
|
|
3699
|
+
|
|
3700
|
+
data, status_code, headers = api_instance.workspace_update_mail_draft_with_http_info(org, workspace, id, request_body)
|
|
3701
|
+
p status_code # => 2xx
|
|
3702
|
+
p headers # => { ... }
|
|
3703
|
+
p data # => Hash<String, Object>
|
|
3704
|
+
rescue Spatio::ApiError => e
|
|
3705
|
+
puts "Error when calling MailApi->workspace_update_mail_draft_with_http_info: #{e}"
|
|
3706
|
+
end
|
|
3707
|
+
```
|
|
3708
|
+
|
|
3709
|
+
### Parameters
|
|
3710
|
+
|
|
3711
|
+
| Name | Type | Description | Notes |
|
|
3712
|
+
| ---- | ---- | ----------- | ----- |
|
|
3713
|
+
| **org** | **String** | | |
|
|
3714
|
+
| **workspace** | **String** | | |
|
|
3715
|
+
| **id** | **String** | | |
|
|
3716
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
3717
|
+
|
|
3718
|
+
### Return type
|
|
3719
|
+
|
|
3720
|
+
**Hash<String, Object>**
|
|
3721
|
+
|
|
3722
|
+
### Authorization
|
|
3723
|
+
|
|
3724
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3725
|
+
|
|
3726
|
+
### HTTP request headers
|
|
3727
|
+
|
|
3728
|
+
- **Content-Type**: application/json
|
|
3729
|
+
- **Accept**: application/json
|
|
3730
|
+
|
|
3731
|
+
|
|
3732
|
+
## workspace_update_mail_label
|
|
3733
|
+
|
|
3734
|
+
> Hash<String, Object> workspace_update_mail_label(org, workspace, id, request_body)
|
|
3735
|
+
|
|
3736
|
+
|
|
3737
|
+
|
|
3738
|
+
### Examples
|
|
3739
|
+
|
|
3740
|
+
```ruby
|
|
3741
|
+
require 'time'
|
|
3742
|
+
require 'spatio-sdk'
|
|
3743
|
+
# setup authorization
|
|
3744
|
+
Spatio.configure do |config|
|
|
3745
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
3746
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3747
|
+
end
|
|
3748
|
+
|
|
3749
|
+
api_instance = Spatio::MailApi.new
|
|
3750
|
+
org = 'org_example' # String |
|
|
3751
|
+
workspace = 'workspace_example' # String |
|
|
3752
|
+
id = 'id_example' # String |
|
|
3753
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
3754
|
+
|
|
3755
|
+
begin
|
|
3756
|
+
|
|
3757
|
+
result = api_instance.workspace_update_mail_label(org, workspace, id, request_body)
|
|
3758
|
+
p result
|
|
3759
|
+
rescue Spatio::ApiError => e
|
|
3760
|
+
puts "Error when calling MailApi->workspace_update_mail_label: #{e}"
|
|
3761
|
+
end
|
|
3762
|
+
```
|
|
3763
|
+
|
|
3764
|
+
#### Using the workspace_update_mail_label_with_http_info variant
|
|
3765
|
+
|
|
3766
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3767
|
+
|
|
3768
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_update_mail_label_with_http_info(org, workspace, id, request_body)
|
|
3769
|
+
|
|
3770
|
+
```ruby
|
|
3771
|
+
begin
|
|
3772
|
+
|
|
3773
|
+
data, status_code, headers = api_instance.workspace_update_mail_label_with_http_info(org, workspace, id, request_body)
|
|
3774
|
+
p status_code # => 2xx
|
|
3775
|
+
p headers # => { ... }
|
|
3776
|
+
p data # => Hash<String, Object>
|
|
3777
|
+
rescue Spatio::ApiError => e
|
|
3778
|
+
puts "Error when calling MailApi->workspace_update_mail_label_with_http_info: #{e}"
|
|
3779
|
+
end
|
|
3780
|
+
```
|
|
3781
|
+
|
|
3782
|
+
### Parameters
|
|
3783
|
+
|
|
3784
|
+
| Name | Type | Description | Notes |
|
|
3785
|
+
| ---- | ---- | ----------- | ----- |
|
|
3786
|
+
| **org** | **String** | | |
|
|
3787
|
+
| **workspace** | **String** | | |
|
|
3788
|
+
| **id** | **String** | | |
|
|
3789
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
3790
|
+
|
|
3791
|
+
### Return type
|
|
3792
|
+
|
|
3793
|
+
**Hash<String, Object>**
|
|
3794
|
+
|
|
3795
|
+
### Authorization
|
|
3796
|
+
|
|
3797
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3798
|
+
|
|
3799
|
+
### HTTP request headers
|
|
3800
|
+
|
|
3801
|
+
- **Content-Type**: application/json
|
|
3802
|
+
- **Accept**: application/json
|
|
3803
|
+
|