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/FilesApi.md
ADDED
|
@@ -0,0 +1,2471 @@
|
|
|
1
|
+
# Spatio::FilesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spatio.app*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**bulk_delete_files**](FilesApi.md#bulk_delete_files) | **POST** /v1/files/delete | Delete multiple files in one call. |
|
|
8
|
+
| [**bulk_move_files**](FilesApi.md#bulk_move_files) | **POST** /v1/files/move | Move multiple files to a target folder. |
|
|
9
|
+
| [**commit_chunked_upload**](FilesApi.md#commit_chunked_upload) | **POST** /v1/files/upload/chunked/commit | Finalize a chunked-upload session and create the file row. |
|
|
10
|
+
| [**create_file_folder**](FilesApi.md#create_file_folder) | **POST** /v1/files/folders | Create a folder. |
|
|
11
|
+
| [**delete_file**](FilesApi.md#delete_file) | **DELETE** /v1/files/{id} | Delete a file. |
|
|
12
|
+
| [**extract_file_text**](FilesApi.md#extract_file_text) | **GET** /v1/files/{id}/extract-text | Extract text content from a PDF (or other supported file). |
|
|
13
|
+
| [**get_chunked_file_manifest**](FilesApi.md#get_chunked_file_manifest) | **GET** /v1/files/{id}/manifest | Fetch the block manifest for a chunked-uploaded file. |
|
|
14
|
+
| [**get_file**](FilesApi.md#get_file) | **GET** /v1/files/{id} | Fetch one file's metadata. |
|
|
15
|
+
| [**get_file_download_url**](FilesApi.md#get_file_download_url) | **GET** /v1/files/{id}/download | Mint a fresh signed download URL. |
|
|
16
|
+
| [**init_chunked_upload**](FilesApi.md#init_chunked_upload) | **POST** /v1/files/upload/chunked/init | Begin a content-addressed chunked upload session. |
|
|
17
|
+
| [**list_file_folders**](FilesApi.md#list_file_folders) | **GET** /v1/files/folders | List folders across connected file providers. |
|
|
18
|
+
| [**list_files**](FilesApi.md#list_files) | **GET** /v1/files | List files across connected file providers. |
|
|
19
|
+
| [**list_files_and_folders**](FilesApi.md#list_files_and_folders) | **GET** /v1/files/list | Aggregate list of files + folders for renderer file-browser views. |
|
|
20
|
+
| [**move_file**](FilesApi.md#move_file) | **POST** /v1/files/{id}/move | Move a single file to a target folder. |
|
|
21
|
+
| [**search_files**](FilesApi.md#search_files) | **GET** /v1/files/search | Substring-match search across the caller's files. |
|
|
22
|
+
| [**update_file**](FilesApi.md#update_file) | **PATCH** /v1/files/{id} | Update a file's metadata (name, folder, custom fields). |
|
|
23
|
+
| [**upload_chunked_block**](FilesApi.md#upload_chunked_block) | **POST** /v1/files/upload/chunked/blocks | Upload one block for an open chunked-upload session. |
|
|
24
|
+
| [**upload_file**](FilesApi.md#upload_file) | **POST** /v1/files/upload | Upload a file via multipart form. |
|
|
25
|
+
| [**upload_file_base64**](FilesApi.md#upload_file_base64) | **POST** /v1/files/upload/base64 | Upload a file via JSON with base64-encoded content. |
|
|
26
|
+
| [**workspace_commit_chunked_upload**](FilesApi.md#workspace_commit_chunked_upload) | **POST** /v1/organizations/{org}/workspaces/{workspace}/files/upload/chunked/commit | Workspace-scoped chunked-upload commit (RBAC-protected). |
|
|
27
|
+
| [**workspace_create_file_folder**](FilesApi.md#workspace_create_file_folder) | **POST** /v1/organizations/{org}/workspaces/{workspace}/files/folders | Workspace-scoped create-folder (RBAC-protected). |
|
|
28
|
+
| [**workspace_delete_file**](FilesApi.md#workspace_delete_file) | **DELETE** /v1/organizations/{org}/workspaces/{workspace}/files/{id} | Workspace-scoped delete-file. |
|
|
29
|
+
| [**workspace_get_file**](FilesApi.md#workspace_get_file) | **GET** /v1/organizations/{org}/workspaces/{workspace}/files/{id} | Workspace-scoped get-file. |
|
|
30
|
+
| [**workspace_get_file_download**](FilesApi.md#workspace_get_file_download) | **GET** /v1/organizations/{org}/workspaces/{workspace}/files/{id}/download | Workspace-scoped signed-download URL. |
|
|
31
|
+
| [**workspace_get_file_manifest**](FilesApi.md#workspace_get_file_manifest) | **GET** /v1/organizations/{org}/workspaces/{workspace}/files/{id}/manifest | Workspace-scoped chunked-file manifest. |
|
|
32
|
+
| [**workspace_init_chunked_upload**](FilesApi.md#workspace_init_chunked_upload) | **POST** /v1/organizations/{org}/workspaces/{workspace}/files/upload/chunked/init | Workspace-scoped chunked-upload init (RBAC-protected). |
|
|
33
|
+
| [**workspace_list_file_folders**](FilesApi.md#workspace_list_file_folders) | **GET** /v1/organizations/{org}/workspaces/{workspace}/files/folders | Workspace-scoped list-folders (RBAC-protected). |
|
|
34
|
+
| [**workspace_list_files**](FilesApi.md#workspace_list_files) | **GET** /v1/organizations/{org}/workspaces/{workspace}/files | Workspace-scoped list-files (RBAC-protected). |
|
|
35
|
+
| [**workspace_move_file**](FilesApi.md#workspace_move_file) | **POST** /v1/organizations/{org}/workspaces/{workspace}/files/{id}/move | Workspace-scoped move-file. |
|
|
36
|
+
| [**workspace_update_file**](FilesApi.md#workspace_update_file) | **PATCH** /v1/organizations/{org}/workspaces/{workspace}/files/{id} | Workspace-scoped update-file. |
|
|
37
|
+
| [**workspace_upload_chunked_block**](FilesApi.md#workspace_upload_chunked_block) | **POST** /v1/organizations/{org}/workspaces/{workspace}/files/upload/chunked/blocks | Workspace-scoped chunked-upload block (RBAC-protected). |
|
|
38
|
+
| [**workspace_upload_file**](FilesApi.md#workspace_upload_file) | **POST** /v1/organizations/{org}/workspaces/{workspace}/files/upload | Workspace-scoped multipart upload (RBAC-protected). |
|
|
39
|
+
| [**workspace_upload_file_base64**](FilesApi.md#workspace_upload_file_base64) | **POST** /v1/organizations/{org}/workspaces/{workspace}/files/upload/base64 | Workspace-scoped base64 upload (RBAC-protected). |
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
## bulk_delete_files
|
|
43
|
+
|
|
44
|
+
> <BulkFilesResponse> bulk_delete_files(bulk_delete_files_request)
|
|
45
|
+
|
|
46
|
+
Delete multiple files in one call.
|
|
47
|
+
|
|
48
|
+
### Examples
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
require 'time'
|
|
52
|
+
require 'spatio-sdk'
|
|
53
|
+
# setup authorization
|
|
54
|
+
Spatio.configure do |config|
|
|
55
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
56
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
api_instance = Spatio::FilesApi.new
|
|
60
|
+
bulk_delete_files_request = Spatio::BulkDeleteFilesRequest.new # BulkDeleteFilesRequest |
|
|
61
|
+
|
|
62
|
+
begin
|
|
63
|
+
# Delete multiple files in one call.
|
|
64
|
+
result = api_instance.bulk_delete_files(bulk_delete_files_request)
|
|
65
|
+
p result
|
|
66
|
+
rescue Spatio::ApiError => e
|
|
67
|
+
puts "Error when calling FilesApi->bulk_delete_files: #{e}"
|
|
68
|
+
end
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
#### Using the bulk_delete_files_with_http_info variant
|
|
72
|
+
|
|
73
|
+
This returns an Array which contains the response data, status code and headers.
|
|
74
|
+
|
|
75
|
+
> <Array(<BulkFilesResponse>, Integer, Hash)> bulk_delete_files_with_http_info(bulk_delete_files_request)
|
|
76
|
+
|
|
77
|
+
```ruby
|
|
78
|
+
begin
|
|
79
|
+
# Delete multiple files in one call.
|
|
80
|
+
data, status_code, headers = api_instance.bulk_delete_files_with_http_info(bulk_delete_files_request)
|
|
81
|
+
p status_code # => 2xx
|
|
82
|
+
p headers # => { ... }
|
|
83
|
+
p data # => <BulkFilesResponse>
|
|
84
|
+
rescue Spatio::ApiError => e
|
|
85
|
+
puts "Error when calling FilesApi->bulk_delete_files_with_http_info: #{e}"
|
|
86
|
+
end
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
| Name | Type | Description | Notes |
|
|
92
|
+
| ---- | ---- | ----------- | ----- |
|
|
93
|
+
| **bulk_delete_files_request** | [**BulkDeleteFilesRequest**](BulkDeleteFilesRequest.md) | | |
|
|
94
|
+
|
|
95
|
+
### Return type
|
|
96
|
+
|
|
97
|
+
[**BulkFilesResponse**](BulkFilesResponse.md)
|
|
98
|
+
|
|
99
|
+
### Authorization
|
|
100
|
+
|
|
101
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
102
|
+
|
|
103
|
+
### HTTP request headers
|
|
104
|
+
|
|
105
|
+
- **Content-Type**: application/json
|
|
106
|
+
- **Accept**: application/json
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
## bulk_move_files
|
|
110
|
+
|
|
111
|
+
> <BulkFilesResponse> bulk_move_files(bulk_move_files_request)
|
|
112
|
+
|
|
113
|
+
Move multiple files to a target folder.
|
|
114
|
+
|
|
115
|
+
### Examples
|
|
116
|
+
|
|
117
|
+
```ruby
|
|
118
|
+
require 'time'
|
|
119
|
+
require 'spatio-sdk'
|
|
120
|
+
# setup authorization
|
|
121
|
+
Spatio.configure do |config|
|
|
122
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
123
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
api_instance = Spatio::FilesApi.new
|
|
127
|
+
bulk_move_files_request = Spatio::BulkMoveFilesRequest.new # BulkMoveFilesRequest |
|
|
128
|
+
|
|
129
|
+
begin
|
|
130
|
+
# Move multiple files to a target folder.
|
|
131
|
+
result = api_instance.bulk_move_files(bulk_move_files_request)
|
|
132
|
+
p result
|
|
133
|
+
rescue Spatio::ApiError => e
|
|
134
|
+
puts "Error when calling FilesApi->bulk_move_files: #{e}"
|
|
135
|
+
end
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
#### Using the bulk_move_files_with_http_info variant
|
|
139
|
+
|
|
140
|
+
This returns an Array which contains the response data, status code and headers.
|
|
141
|
+
|
|
142
|
+
> <Array(<BulkFilesResponse>, Integer, Hash)> bulk_move_files_with_http_info(bulk_move_files_request)
|
|
143
|
+
|
|
144
|
+
```ruby
|
|
145
|
+
begin
|
|
146
|
+
# Move multiple files to a target folder.
|
|
147
|
+
data, status_code, headers = api_instance.bulk_move_files_with_http_info(bulk_move_files_request)
|
|
148
|
+
p status_code # => 2xx
|
|
149
|
+
p headers # => { ... }
|
|
150
|
+
p data # => <BulkFilesResponse>
|
|
151
|
+
rescue Spatio::ApiError => e
|
|
152
|
+
puts "Error when calling FilesApi->bulk_move_files_with_http_info: #{e}"
|
|
153
|
+
end
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Parameters
|
|
157
|
+
|
|
158
|
+
| Name | Type | Description | Notes |
|
|
159
|
+
| ---- | ---- | ----------- | ----- |
|
|
160
|
+
| **bulk_move_files_request** | [**BulkMoveFilesRequest**](BulkMoveFilesRequest.md) | | |
|
|
161
|
+
|
|
162
|
+
### Return type
|
|
163
|
+
|
|
164
|
+
[**BulkFilesResponse**](BulkFilesResponse.md)
|
|
165
|
+
|
|
166
|
+
### Authorization
|
|
167
|
+
|
|
168
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
169
|
+
|
|
170
|
+
### HTTP request headers
|
|
171
|
+
|
|
172
|
+
- **Content-Type**: application/json
|
|
173
|
+
- **Accept**: application/json
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
## commit_chunked_upload
|
|
177
|
+
|
|
178
|
+
> <CommitChunkedUploadResponse> commit_chunked_upload(commit_chunked_upload_request)
|
|
179
|
+
|
|
180
|
+
Finalize a chunked-upload session and create the file row.
|
|
181
|
+
|
|
182
|
+
### Examples
|
|
183
|
+
|
|
184
|
+
```ruby
|
|
185
|
+
require 'time'
|
|
186
|
+
require 'spatio-sdk'
|
|
187
|
+
# setup authorization
|
|
188
|
+
Spatio.configure do |config|
|
|
189
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
190
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
api_instance = Spatio::FilesApi.new
|
|
194
|
+
commit_chunked_upload_request = Spatio::CommitChunkedUploadRequest.new({session_id: 'session_id_example'}) # CommitChunkedUploadRequest |
|
|
195
|
+
|
|
196
|
+
begin
|
|
197
|
+
# Finalize a chunked-upload session and create the file row.
|
|
198
|
+
result = api_instance.commit_chunked_upload(commit_chunked_upload_request)
|
|
199
|
+
p result
|
|
200
|
+
rescue Spatio::ApiError => e
|
|
201
|
+
puts "Error when calling FilesApi->commit_chunked_upload: #{e}"
|
|
202
|
+
end
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
#### Using the commit_chunked_upload_with_http_info variant
|
|
206
|
+
|
|
207
|
+
This returns an Array which contains the response data, status code and headers.
|
|
208
|
+
|
|
209
|
+
> <Array(<CommitChunkedUploadResponse>, Integer, Hash)> commit_chunked_upload_with_http_info(commit_chunked_upload_request)
|
|
210
|
+
|
|
211
|
+
```ruby
|
|
212
|
+
begin
|
|
213
|
+
# Finalize a chunked-upload session and create the file row.
|
|
214
|
+
data, status_code, headers = api_instance.commit_chunked_upload_with_http_info(commit_chunked_upload_request)
|
|
215
|
+
p status_code # => 2xx
|
|
216
|
+
p headers # => { ... }
|
|
217
|
+
p data # => <CommitChunkedUploadResponse>
|
|
218
|
+
rescue Spatio::ApiError => e
|
|
219
|
+
puts "Error when calling FilesApi->commit_chunked_upload_with_http_info: #{e}"
|
|
220
|
+
end
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
| Name | Type | Description | Notes |
|
|
226
|
+
| ---- | ---- | ----------- | ----- |
|
|
227
|
+
| **commit_chunked_upload_request** | [**CommitChunkedUploadRequest**](CommitChunkedUploadRequest.md) | | |
|
|
228
|
+
|
|
229
|
+
### Return type
|
|
230
|
+
|
|
231
|
+
[**CommitChunkedUploadResponse**](CommitChunkedUploadResponse.md)
|
|
232
|
+
|
|
233
|
+
### Authorization
|
|
234
|
+
|
|
235
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
236
|
+
|
|
237
|
+
### HTTP request headers
|
|
238
|
+
|
|
239
|
+
- **Content-Type**: application/json
|
|
240
|
+
- **Accept**: application/json
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
## create_file_folder
|
|
244
|
+
|
|
245
|
+
> <Folder> create_file_folder(create_folder_request, opts)
|
|
246
|
+
|
|
247
|
+
Create a folder.
|
|
248
|
+
|
|
249
|
+
### Examples
|
|
250
|
+
|
|
251
|
+
```ruby
|
|
252
|
+
require 'time'
|
|
253
|
+
require 'spatio-sdk'
|
|
254
|
+
# setup authorization
|
|
255
|
+
Spatio.configure do |config|
|
|
256
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
257
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
api_instance = Spatio::FilesApi.new
|
|
261
|
+
create_folder_request = Spatio::CreateFolderRequest.new({name: 'name_example'}) # CreateFolderRequest |
|
|
262
|
+
opts = {
|
|
263
|
+
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.
|
|
264
|
+
provider: 'provider_example', # String | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`.
|
|
265
|
+
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.
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
begin
|
|
269
|
+
# Create a folder.
|
|
270
|
+
result = api_instance.create_file_folder(create_folder_request, opts)
|
|
271
|
+
p result
|
|
272
|
+
rescue Spatio::ApiError => e
|
|
273
|
+
puts "Error when calling FilesApi->create_file_folder: #{e}"
|
|
274
|
+
end
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
#### Using the create_file_folder_with_http_info variant
|
|
278
|
+
|
|
279
|
+
This returns an Array which contains the response data, status code and headers.
|
|
280
|
+
|
|
281
|
+
> <Array(<Folder>, Integer, Hash)> create_file_folder_with_http_info(create_folder_request, opts)
|
|
282
|
+
|
|
283
|
+
```ruby
|
|
284
|
+
begin
|
|
285
|
+
# Create a folder.
|
|
286
|
+
data, status_code, headers = api_instance.create_file_folder_with_http_info(create_folder_request, opts)
|
|
287
|
+
p status_code # => 2xx
|
|
288
|
+
p headers # => { ... }
|
|
289
|
+
p data # => <Folder>
|
|
290
|
+
rescue Spatio::ApiError => e
|
|
291
|
+
puts "Error when calling FilesApi->create_file_folder_with_http_info: #{e}"
|
|
292
|
+
end
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### Parameters
|
|
296
|
+
|
|
297
|
+
| Name | Type | Description | Notes |
|
|
298
|
+
| ---- | ---- | ----------- | ----- |
|
|
299
|
+
| **create_folder_request** | [**CreateFolderRequest**](CreateFolderRequest.md) | | |
|
|
300
|
+
| **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] |
|
|
301
|
+
| **provider** | **String** | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`. | [optional] |
|
|
302
|
+
| **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] |
|
|
303
|
+
|
|
304
|
+
### Return type
|
|
305
|
+
|
|
306
|
+
[**Folder**](Folder.md)
|
|
307
|
+
|
|
308
|
+
### Authorization
|
|
309
|
+
|
|
310
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
311
|
+
|
|
312
|
+
### HTTP request headers
|
|
313
|
+
|
|
314
|
+
- **Content-Type**: application/json
|
|
315
|
+
- **Accept**: application/json
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
## delete_file
|
|
319
|
+
|
|
320
|
+
> delete_file(id, opts)
|
|
321
|
+
|
|
322
|
+
Delete a file.
|
|
323
|
+
|
|
324
|
+
### Examples
|
|
325
|
+
|
|
326
|
+
```ruby
|
|
327
|
+
require 'time'
|
|
328
|
+
require 'spatio-sdk'
|
|
329
|
+
# setup authorization
|
|
330
|
+
Spatio.configure do |config|
|
|
331
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
332
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
api_instance = Spatio::FilesApi.new
|
|
336
|
+
id = 'id_example' # String | File id.
|
|
337
|
+
opts = {
|
|
338
|
+
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.
|
|
339
|
+
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.
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
begin
|
|
343
|
+
# Delete a file.
|
|
344
|
+
api_instance.delete_file(id, opts)
|
|
345
|
+
rescue Spatio::ApiError => e
|
|
346
|
+
puts "Error when calling FilesApi->delete_file: #{e}"
|
|
347
|
+
end
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
#### Using the delete_file_with_http_info variant
|
|
351
|
+
|
|
352
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
353
|
+
|
|
354
|
+
> <Array(nil, Integer, Hash)> delete_file_with_http_info(id, opts)
|
|
355
|
+
|
|
356
|
+
```ruby
|
|
357
|
+
begin
|
|
358
|
+
# Delete a file.
|
|
359
|
+
data, status_code, headers = api_instance.delete_file_with_http_info(id, opts)
|
|
360
|
+
p status_code # => 2xx
|
|
361
|
+
p headers # => { ... }
|
|
362
|
+
p data # => nil
|
|
363
|
+
rescue Spatio::ApiError => e
|
|
364
|
+
puts "Error when calling FilesApi->delete_file_with_http_info: #{e}"
|
|
365
|
+
end
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
### Parameters
|
|
369
|
+
|
|
370
|
+
| Name | Type | Description | Notes |
|
|
371
|
+
| ---- | ---- | ----------- | ----- |
|
|
372
|
+
| **id** | **String** | File id. | |
|
|
373
|
+
| **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] |
|
|
374
|
+
| **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] |
|
|
375
|
+
|
|
376
|
+
### Return type
|
|
377
|
+
|
|
378
|
+
nil (empty response body)
|
|
379
|
+
|
|
380
|
+
### Authorization
|
|
381
|
+
|
|
382
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
383
|
+
|
|
384
|
+
### HTTP request headers
|
|
385
|
+
|
|
386
|
+
- **Content-Type**: Not defined
|
|
387
|
+
- **Accept**: application/json
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
## extract_file_text
|
|
391
|
+
|
|
392
|
+
> <ExtractTextResult> extract_file_text(id, opts)
|
|
393
|
+
|
|
394
|
+
Extract text content from a PDF (or other supported file).
|
|
395
|
+
|
|
396
|
+
### Examples
|
|
397
|
+
|
|
398
|
+
```ruby
|
|
399
|
+
require 'time'
|
|
400
|
+
require 'spatio-sdk'
|
|
401
|
+
# setup authorization
|
|
402
|
+
Spatio.configure do |config|
|
|
403
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
404
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
405
|
+
end
|
|
406
|
+
|
|
407
|
+
api_instance = Spatio::FilesApi.new
|
|
408
|
+
id = 'id_example' # String | File id.
|
|
409
|
+
opts = {
|
|
410
|
+
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.
|
|
411
|
+
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.
|
|
412
|
+
page_start: 56, # Integer |
|
|
413
|
+
page_end: 56, # Integer |
|
|
414
|
+
max_chars: 56 # Integer | Truncation limit; sets `truncated: true` when hit.
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
begin
|
|
418
|
+
# Extract text content from a PDF (or other supported file).
|
|
419
|
+
result = api_instance.extract_file_text(id, opts)
|
|
420
|
+
p result
|
|
421
|
+
rescue Spatio::ApiError => e
|
|
422
|
+
puts "Error when calling FilesApi->extract_file_text: #{e}"
|
|
423
|
+
end
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
#### Using the extract_file_text_with_http_info variant
|
|
427
|
+
|
|
428
|
+
This returns an Array which contains the response data, status code and headers.
|
|
429
|
+
|
|
430
|
+
> <Array(<ExtractTextResult>, Integer, Hash)> extract_file_text_with_http_info(id, opts)
|
|
431
|
+
|
|
432
|
+
```ruby
|
|
433
|
+
begin
|
|
434
|
+
# Extract text content from a PDF (or other supported file).
|
|
435
|
+
data, status_code, headers = api_instance.extract_file_text_with_http_info(id, opts)
|
|
436
|
+
p status_code # => 2xx
|
|
437
|
+
p headers # => { ... }
|
|
438
|
+
p data # => <ExtractTextResult>
|
|
439
|
+
rescue Spatio::ApiError => e
|
|
440
|
+
puts "Error when calling FilesApi->extract_file_text_with_http_info: #{e}"
|
|
441
|
+
end
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### Parameters
|
|
445
|
+
|
|
446
|
+
| Name | Type | Description | Notes |
|
|
447
|
+
| ---- | ---- | ----------- | ----- |
|
|
448
|
+
| **id** | **String** | File id. | |
|
|
449
|
+
| **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] |
|
|
450
|
+
| **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] |
|
|
451
|
+
| **page_start** | **Integer** | | [optional] |
|
|
452
|
+
| **page_end** | **Integer** | | [optional] |
|
|
453
|
+
| **max_chars** | **Integer** | Truncation limit; sets `truncated: true` when hit. | [optional] |
|
|
454
|
+
|
|
455
|
+
### Return type
|
|
456
|
+
|
|
457
|
+
[**ExtractTextResult**](ExtractTextResult.md)
|
|
458
|
+
|
|
459
|
+
### Authorization
|
|
460
|
+
|
|
461
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
462
|
+
|
|
463
|
+
### HTTP request headers
|
|
464
|
+
|
|
465
|
+
- **Content-Type**: Not defined
|
|
466
|
+
- **Accept**: application/json
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
## get_chunked_file_manifest
|
|
470
|
+
|
|
471
|
+
> <ChunkedFileManifest> get_chunked_file_manifest(id, opts)
|
|
472
|
+
|
|
473
|
+
Fetch the block manifest for a chunked-uploaded file.
|
|
474
|
+
|
|
475
|
+
Only meaningful for files uploaded via `upload/chunked/*`. Files uploaded via `upload` or `upload/base64` return `404`.
|
|
476
|
+
|
|
477
|
+
### Examples
|
|
478
|
+
|
|
479
|
+
```ruby
|
|
480
|
+
require 'time'
|
|
481
|
+
require 'spatio-sdk'
|
|
482
|
+
# setup authorization
|
|
483
|
+
Spatio.configure do |config|
|
|
484
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
485
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
486
|
+
end
|
|
487
|
+
|
|
488
|
+
api_instance = Spatio::FilesApi.new
|
|
489
|
+
id = 'id_example' # String | File id.
|
|
490
|
+
opts = {
|
|
491
|
+
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.
|
|
492
|
+
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.
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
begin
|
|
496
|
+
# Fetch the block manifest for a chunked-uploaded file.
|
|
497
|
+
result = api_instance.get_chunked_file_manifest(id, opts)
|
|
498
|
+
p result
|
|
499
|
+
rescue Spatio::ApiError => e
|
|
500
|
+
puts "Error when calling FilesApi->get_chunked_file_manifest: #{e}"
|
|
501
|
+
end
|
|
502
|
+
```
|
|
503
|
+
|
|
504
|
+
#### Using the get_chunked_file_manifest_with_http_info variant
|
|
505
|
+
|
|
506
|
+
This returns an Array which contains the response data, status code and headers.
|
|
507
|
+
|
|
508
|
+
> <Array(<ChunkedFileManifest>, Integer, Hash)> get_chunked_file_manifest_with_http_info(id, opts)
|
|
509
|
+
|
|
510
|
+
```ruby
|
|
511
|
+
begin
|
|
512
|
+
# Fetch the block manifest for a chunked-uploaded file.
|
|
513
|
+
data, status_code, headers = api_instance.get_chunked_file_manifest_with_http_info(id, opts)
|
|
514
|
+
p status_code # => 2xx
|
|
515
|
+
p headers # => { ... }
|
|
516
|
+
p data # => <ChunkedFileManifest>
|
|
517
|
+
rescue Spatio::ApiError => e
|
|
518
|
+
puts "Error when calling FilesApi->get_chunked_file_manifest_with_http_info: #{e}"
|
|
519
|
+
end
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
### Parameters
|
|
523
|
+
|
|
524
|
+
| Name | Type | Description | Notes |
|
|
525
|
+
| ---- | ---- | ----------- | ----- |
|
|
526
|
+
| **id** | **String** | File id. | |
|
|
527
|
+
| **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] |
|
|
528
|
+
| **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] |
|
|
529
|
+
|
|
530
|
+
### Return type
|
|
531
|
+
|
|
532
|
+
[**ChunkedFileManifest**](ChunkedFileManifest.md)
|
|
533
|
+
|
|
534
|
+
### Authorization
|
|
535
|
+
|
|
536
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
537
|
+
|
|
538
|
+
### HTTP request headers
|
|
539
|
+
|
|
540
|
+
- **Content-Type**: Not defined
|
|
541
|
+
- **Accept**: application/json
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
## get_file
|
|
545
|
+
|
|
546
|
+
> <SpatioFile> get_file(id, opts)
|
|
547
|
+
|
|
548
|
+
Fetch one file's metadata.
|
|
549
|
+
|
|
550
|
+
### Examples
|
|
551
|
+
|
|
552
|
+
```ruby
|
|
553
|
+
require 'time'
|
|
554
|
+
require 'spatio-sdk'
|
|
555
|
+
# setup authorization
|
|
556
|
+
Spatio.configure do |config|
|
|
557
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
558
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
559
|
+
end
|
|
560
|
+
|
|
561
|
+
api_instance = Spatio::FilesApi.new
|
|
562
|
+
id = 'id_example' # String | File id.
|
|
563
|
+
opts = {
|
|
564
|
+
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.
|
|
565
|
+
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.
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
begin
|
|
569
|
+
# Fetch one file's metadata.
|
|
570
|
+
result = api_instance.get_file(id, opts)
|
|
571
|
+
p result
|
|
572
|
+
rescue Spatio::ApiError => e
|
|
573
|
+
puts "Error when calling FilesApi->get_file: #{e}"
|
|
574
|
+
end
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
#### Using the get_file_with_http_info variant
|
|
578
|
+
|
|
579
|
+
This returns an Array which contains the response data, status code and headers.
|
|
580
|
+
|
|
581
|
+
> <Array(<SpatioFile>, Integer, Hash)> get_file_with_http_info(id, opts)
|
|
582
|
+
|
|
583
|
+
```ruby
|
|
584
|
+
begin
|
|
585
|
+
# Fetch one file's metadata.
|
|
586
|
+
data, status_code, headers = api_instance.get_file_with_http_info(id, opts)
|
|
587
|
+
p status_code # => 2xx
|
|
588
|
+
p headers # => { ... }
|
|
589
|
+
p data # => <SpatioFile>
|
|
590
|
+
rescue Spatio::ApiError => e
|
|
591
|
+
puts "Error when calling FilesApi->get_file_with_http_info: #{e}"
|
|
592
|
+
end
|
|
593
|
+
```
|
|
594
|
+
|
|
595
|
+
### Parameters
|
|
596
|
+
|
|
597
|
+
| Name | Type | Description | Notes |
|
|
598
|
+
| ---- | ---- | ----------- | ----- |
|
|
599
|
+
| **id** | **String** | File id. | |
|
|
600
|
+
| **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] |
|
|
601
|
+
| **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] |
|
|
602
|
+
|
|
603
|
+
### Return type
|
|
604
|
+
|
|
605
|
+
[**SpatioFile**](SpatioFile.md)
|
|
606
|
+
|
|
607
|
+
### Authorization
|
|
608
|
+
|
|
609
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
610
|
+
|
|
611
|
+
### HTTP request headers
|
|
612
|
+
|
|
613
|
+
- **Content-Type**: Not defined
|
|
614
|
+
- **Accept**: application/json
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
## get_file_download_url
|
|
618
|
+
|
|
619
|
+
> <DownloadFileResponse> get_file_download_url(id, opts)
|
|
620
|
+
|
|
621
|
+
Mint a fresh signed download URL.
|
|
622
|
+
|
|
623
|
+
Returns a JSON envelope with a pre-signed URL pointing at the backing storage. Clients follow the URL — the platform does not stream bytes through itself.
|
|
624
|
+
|
|
625
|
+
### Examples
|
|
626
|
+
|
|
627
|
+
```ruby
|
|
628
|
+
require 'time'
|
|
629
|
+
require 'spatio-sdk'
|
|
630
|
+
# setup authorization
|
|
631
|
+
Spatio.configure do |config|
|
|
632
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
633
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
634
|
+
end
|
|
635
|
+
|
|
636
|
+
api_instance = Spatio::FilesApi.new
|
|
637
|
+
id = 'id_example' # String | File id.
|
|
638
|
+
opts = {
|
|
639
|
+
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.
|
|
640
|
+
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.
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
begin
|
|
644
|
+
# Mint a fresh signed download URL.
|
|
645
|
+
result = api_instance.get_file_download_url(id, opts)
|
|
646
|
+
p result
|
|
647
|
+
rescue Spatio::ApiError => e
|
|
648
|
+
puts "Error when calling FilesApi->get_file_download_url: #{e}"
|
|
649
|
+
end
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
#### Using the get_file_download_url_with_http_info variant
|
|
653
|
+
|
|
654
|
+
This returns an Array which contains the response data, status code and headers.
|
|
655
|
+
|
|
656
|
+
> <Array(<DownloadFileResponse>, Integer, Hash)> get_file_download_url_with_http_info(id, opts)
|
|
657
|
+
|
|
658
|
+
```ruby
|
|
659
|
+
begin
|
|
660
|
+
# Mint a fresh signed download URL.
|
|
661
|
+
data, status_code, headers = api_instance.get_file_download_url_with_http_info(id, opts)
|
|
662
|
+
p status_code # => 2xx
|
|
663
|
+
p headers # => { ... }
|
|
664
|
+
p data # => <DownloadFileResponse>
|
|
665
|
+
rescue Spatio::ApiError => e
|
|
666
|
+
puts "Error when calling FilesApi->get_file_download_url_with_http_info: #{e}"
|
|
667
|
+
end
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
### Parameters
|
|
671
|
+
|
|
672
|
+
| Name | Type | Description | Notes |
|
|
673
|
+
| ---- | ---- | ----------- | ----- |
|
|
674
|
+
| **id** | **String** | File id. | |
|
|
675
|
+
| **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] |
|
|
676
|
+
| **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] |
|
|
677
|
+
|
|
678
|
+
### Return type
|
|
679
|
+
|
|
680
|
+
[**DownloadFileResponse**](DownloadFileResponse.md)
|
|
681
|
+
|
|
682
|
+
### Authorization
|
|
683
|
+
|
|
684
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
685
|
+
|
|
686
|
+
### HTTP request headers
|
|
687
|
+
|
|
688
|
+
- **Content-Type**: Not defined
|
|
689
|
+
- **Accept**: application/json
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
## init_chunked_upload
|
|
693
|
+
|
|
694
|
+
> <InitChunkedUploadResponse> init_chunked_upload(init_chunked_upload_request)
|
|
695
|
+
|
|
696
|
+
Begin a content-addressed chunked upload session.
|
|
697
|
+
|
|
698
|
+
Client computes per-block hashes ahead of time and submits the list. The server replies with which blocks need uploading vs. already-on-server (deduplicated). Subsequent calls upload the missing blocks via `uploadChunkedBlock`, then `commit`.
|
|
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::FilesApi.new
|
|
712
|
+
init_chunked_upload_request = Spatio::InitChunkedUploadRequest.new({file_name: 'file_name_example', total_size: 3.56, mime_type: 'mime_type_example', expected_blocks: ['expected_blocks_example']}) # InitChunkedUploadRequest |
|
|
713
|
+
|
|
714
|
+
begin
|
|
715
|
+
# Begin a content-addressed chunked upload session.
|
|
716
|
+
result = api_instance.init_chunked_upload(init_chunked_upload_request)
|
|
717
|
+
p result
|
|
718
|
+
rescue Spatio::ApiError => e
|
|
719
|
+
puts "Error when calling FilesApi->init_chunked_upload: #{e}"
|
|
720
|
+
end
|
|
721
|
+
```
|
|
722
|
+
|
|
723
|
+
#### Using the init_chunked_upload_with_http_info variant
|
|
724
|
+
|
|
725
|
+
This returns an Array which contains the response data, status code and headers.
|
|
726
|
+
|
|
727
|
+
> <Array(<InitChunkedUploadResponse>, Integer, Hash)> init_chunked_upload_with_http_info(init_chunked_upload_request)
|
|
728
|
+
|
|
729
|
+
```ruby
|
|
730
|
+
begin
|
|
731
|
+
# Begin a content-addressed chunked upload session.
|
|
732
|
+
data, status_code, headers = api_instance.init_chunked_upload_with_http_info(init_chunked_upload_request)
|
|
733
|
+
p status_code # => 2xx
|
|
734
|
+
p headers # => { ... }
|
|
735
|
+
p data # => <InitChunkedUploadResponse>
|
|
736
|
+
rescue Spatio::ApiError => e
|
|
737
|
+
puts "Error when calling FilesApi->init_chunked_upload_with_http_info: #{e}"
|
|
738
|
+
end
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
### Parameters
|
|
742
|
+
|
|
743
|
+
| Name | Type | Description | Notes |
|
|
744
|
+
| ---- | ---- | ----------- | ----- |
|
|
745
|
+
| **init_chunked_upload_request** | [**InitChunkedUploadRequest**](InitChunkedUploadRequest.md) | | |
|
|
746
|
+
|
|
747
|
+
### Return type
|
|
748
|
+
|
|
749
|
+
[**InitChunkedUploadResponse**](InitChunkedUploadResponse.md)
|
|
750
|
+
|
|
751
|
+
### Authorization
|
|
752
|
+
|
|
753
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
754
|
+
|
|
755
|
+
### HTTP request headers
|
|
756
|
+
|
|
757
|
+
- **Content-Type**: application/json
|
|
758
|
+
- **Accept**: application/json
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
## list_file_folders
|
|
762
|
+
|
|
763
|
+
> <FolderListEnvelope> list_file_folders(opts)
|
|
764
|
+
|
|
765
|
+
List folders across connected file providers.
|
|
766
|
+
|
|
767
|
+
### Examples
|
|
768
|
+
|
|
769
|
+
```ruby
|
|
770
|
+
require 'time'
|
|
771
|
+
require 'spatio-sdk'
|
|
772
|
+
# setup authorization
|
|
773
|
+
Spatio.configure do |config|
|
|
774
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
775
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
776
|
+
end
|
|
777
|
+
|
|
778
|
+
api_instance = Spatio::FilesApi.new
|
|
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
|
+
provider: 'provider_example', # String | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`.
|
|
782
|
+
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.
|
|
783
|
+
parent_id: 'parent_id_example', # String | Filter to children of this folder. Omit for root.
|
|
784
|
+
workspace_id: 'workspace_id_example', # String |
|
|
785
|
+
organization_id: 'organization_id_example', # String |
|
|
786
|
+
limit: 56, # Integer |
|
|
787
|
+
offset: 56 # Integer |
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
begin
|
|
791
|
+
# List folders across connected file providers.
|
|
792
|
+
result = api_instance.list_file_folders(opts)
|
|
793
|
+
p result
|
|
794
|
+
rescue Spatio::ApiError => e
|
|
795
|
+
puts "Error when calling FilesApi->list_file_folders: #{e}"
|
|
796
|
+
end
|
|
797
|
+
```
|
|
798
|
+
|
|
799
|
+
#### Using the list_file_folders_with_http_info variant
|
|
800
|
+
|
|
801
|
+
This returns an Array which contains the response data, status code and headers.
|
|
802
|
+
|
|
803
|
+
> <Array(<FolderListEnvelope>, Integer, Hash)> list_file_folders_with_http_info(opts)
|
|
804
|
+
|
|
805
|
+
```ruby
|
|
806
|
+
begin
|
|
807
|
+
# List folders across connected file providers.
|
|
808
|
+
data, status_code, headers = api_instance.list_file_folders_with_http_info(opts)
|
|
809
|
+
p status_code # => 2xx
|
|
810
|
+
p headers # => { ... }
|
|
811
|
+
p data # => <FolderListEnvelope>
|
|
812
|
+
rescue Spatio::ApiError => e
|
|
813
|
+
puts "Error when calling FilesApi->list_file_folders_with_http_info: #{e}"
|
|
814
|
+
end
|
|
815
|
+
```
|
|
816
|
+
|
|
817
|
+
### Parameters
|
|
818
|
+
|
|
819
|
+
| Name | Type | Description | Notes |
|
|
820
|
+
| ---- | ---- | ----------- | ----- |
|
|
821
|
+
| **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] |
|
|
822
|
+
| **provider** | **String** | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`. | [optional] |
|
|
823
|
+
| **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] |
|
|
824
|
+
| **parent_id** | **String** | Filter to children of this folder. Omit for root. | [optional] |
|
|
825
|
+
| **workspace_id** | **String** | | [optional] |
|
|
826
|
+
| **organization_id** | **String** | | [optional] |
|
|
827
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
828
|
+
| **offset** | **Integer** | | [optional][default to 0] |
|
|
829
|
+
|
|
830
|
+
### Return type
|
|
831
|
+
|
|
832
|
+
[**FolderListEnvelope**](FolderListEnvelope.md)
|
|
833
|
+
|
|
834
|
+
### Authorization
|
|
835
|
+
|
|
836
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
837
|
+
|
|
838
|
+
### HTTP request headers
|
|
839
|
+
|
|
840
|
+
- **Content-Type**: Not defined
|
|
841
|
+
- **Accept**: application/json
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
## list_files
|
|
845
|
+
|
|
846
|
+
> <FileListEnvelope> list_files(opts)
|
|
847
|
+
|
|
848
|
+
List files across connected file providers.
|
|
849
|
+
|
|
850
|
+
Fan-out list. Returns files from every connected file provider unless filtered by `?accountId=` or `?provider=`. Folder contents are scoped via `?folderId=`; omit for account root.
|
|
851
|
+
|
|
852
|
+
### Examples
|
|
853
|
+
|
|
854
|
+
```ruby
|
|
855
|
+
require 'time'
|
|
856
|
+
require 'spatio-sdk'
|
|
857
|
+
# setup authorization
|
|
858
|
+
Spatio.configure do |config|
|
|
859
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
860
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
861
|
+
end
|
|
862
|
+
|
|
863
|
+
api_instance = Spatio::FilesApi.new
|
|
864
|
+
opts = {
|
|
865
|
+
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.
|
|
866
|
+
provider: 'provider_example', # String | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`.
|
|
867
|
+
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.
|
|
868
|
+
folder_id: 'folder_id_example', # String | Filter to one folder. Omit for the account root.
|
|
869
|
+
workspace_id: 'workspace_id_example', # String |
|
|
870
|
+
organization_id: 'organization_id_example', # String |
|
|
871
|
+
limit: 56, # Integer |
|
|
872
|
+
offset: 56, # Integer |
|
|
873
|
+
sort_by: 'sort_by_example', # String | Provider-dependent. Common values: `created_at`, `name`, `size`.
|
|
874
|
+
sort_order: 'ASC' # String |
|
|
875
|
+
}
|
|
876
|
+
|
|
877
|
+
begin
|
|
878
|
+
# List files across connected file providers.
|
|
879
|
+
result = api_instance.list_files(opts)
|
|
880
|
+
p result
|
|
881
|
+
rescue Spatio::ApiError => e
|
|
882
|
+
puts "Error when calling FilesApi->list_files: #{e}"
|
|
883
|
+
end
|
|
884
|
+
```
|
|
885
|
+
|
|
886
|
+
#### Using the list_files_with_http_info variant
|
|
887
|
+
|
|
888
|
+
This returns an Array which contains the response data, status code and headers.
|
|
889
|
+
|
|
890
|
+
> <Array(<FileListEnvelope>, Integer, Hash)> list_files_with_http_info(opts)
|
|
891
|
+
|
|
892
|
+
```ruby
|
|
893
|
+
begin
|
|
894
|
+
# List files across connected file providers.
|
|
895
|
+
data, status_code, headers = api_instance.list_files_with_http_info(opts)
|
|
896
|
+
p status_code # => 2xx
|
|
897
|
+
p headers # => { ... }
|
|
898
|
+
p data # => <FileListEnvelope>
|
|
899
|
+
rescue Spatio::ApiError => e
|
|
900
|
+
puts "Error when calling FilesApi->list_files_with_http_info: #{e}"
|
|
901
|
+
end
|
|
902
|
+
```
|
|
903
|
+
|
|
904
|
+
### Parameters
|
|
905
|
+
|
|
906
|
+
| Name | Type | Description | Notes |
|
|
907
|
+
| ---- | ---- | ----------- | ----- |
|
|
908
|
+
| **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] |
|
|
909
|
+
| **provider** | **String** | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`. | [optional] |
|
|
910
|
+
| **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] |
|
|
911
|
+
| **folder_id** | **String** | Filter to one folder. Omit for the account root. | [optional] |
|
|
912
|
+
| **workspace_id** | **String** | | [optional] |
|
|
913
|
+
| **organization_id** | **String** | | [optional] |
|
|
914
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
915
|
+
| **offset** | **Integer** | | [optional][default to 0] |
|
|
916
|
+
| **sort_by** | **String** | Provider-dependent. Common values: `created_at`, `name`, `size`. | [optional][default to 'created_at'] |
|
|
917
|
+
| **sort_order** | **String** | | [optional][default to 'DESC'] |
|
|
918
|
+
|
|
919
|
+
### Return type
|
|
920
|
+
|
|
921
|
+
[**FileListEnvelope**](FileListEnvelope.md)
|
|
922
|
+
|
|
923
|
+
### Authorization
|
|
924
|
+
|
|
925
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
926
|
+
|
|
927
|
+
### HTTP request headers
|
|
928
|
+
|
|
929
|
+
- **Content-Type**: Not defined
|
|
930
|
+
- **Accept**: application/json
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
## list_files_and_folders
|
|
934
|
+
|
|
935
|
+
> <FilesAndFoldersResponse> list_files_and_folders(opts)
|
|
936
|
+
|
|
937
|
+
Aggregate list of files + folders for renderer file-browser views.
|
|
938
|
+
|
|
939
|
+
Calls `listFiles` and `listFileFolders` in parallel and merges the results. Saves a round-trip when the UI shows both side-by-side.
|
|
940
|
+
|
|
941
|
+
### Examples
|
|
942
|
+
|
|
943
|
+
```ruby
|
|
944
|
+
require 'time'
|
|
945
|
+
require 'spatio-sdk'
|
|
946
|
+
# setup authorization
|
|
947
|
+
Spatio.configure do |config|
|
|
948
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
949
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
950
|
+
end
|
|
951
|
+
|
|
952
|
+
api_instance = Spatio::FilesApi.new
|
|
953
|
+
opts = {
|
|
954
|
+
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.
|
|
955
|
+
provider: 'provider_example', # String | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`.
|
|
956
|
+
folder_id: 'folder_id_example', # String | Filter to one folder. Omit for the account root.
|
|
957
|
+
workspace_id: 'workspace_id_example', # String |
|
|
958
|
+
organization_id: 'organization_id_example', # String |
|
|
959
|
+
limit: 56, # Integer |
|
|
960
|
+
offset: 56, # Integer |
|
|
961
|
+
sort_by: 'sort_by_example', # String |
|
|
962
|
+
sort_order: 'sort_order_example' # String |
|
|
963
|
+
}
|
|
964
|
+
|
|
965
|
+
begin
|
|
966
|
+
# Aggregate list of files + folders for renderer file-browser views.
|
|
967
|
+
result = api_instance.list_files_and_folders(opts)
|
|
968
|
+
p result
|
|
969
|
+
rescue Spatio::ApiError => e
|
|
970
|
+
puts "Error when calling FilesApi->list_files_and_folders: #{e}"
|
|
971
|
+
end
|
|
972
|
+
```
|
|
973
|
+
|
|
974
|
+
#### Using the list_files_and_folders_with_http_info variant
|
|
975
|
+
|
|
976
|
+
This returns an Array which contains the response data, status code and headers.
|
|
977
|
+
|
|
978
|
+
> <Array(<FilesAndFoldersResponse>, Integer, Hash)> list_files_and_folders_with_http_info(opts)
|
|
979
|
+
|
|
980
|
+
```ruby
|
|
981
|
+
begin
|
|
982
|
+
# Aggregate list of files + folders for renderer file-browser views.
|
|
983
|
+
data, status_code, headers = api_instance.list_files_and_folders_with_http_info(opts)
|
|
984
|
+
p status_code # => 2xx
|
|
985
|
+
p headers # => { ... }
|
|
986
|
+
p data # => <FilesAndFoldersResponse>
|
|
987
|
+
rescue Spatio::ApiError => e
|
|
988
|
+
puts "Error when calling FilesApi->list_files_and_folders_with_http_info: #{e}"
|
|
989
|
+
end
|
|
990
|
+
```
|
|
991
|
+
|
|
992
|
+
### Parameters
|
|
993
|
+
|
|
994
|
+
| Name | Type | Description | Notes |
|
|
995
|
+
| ---- | ---- | ----------- | ----- |
|
|
996
|
+
| **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] |
|
|
997
|
+
| **provider** | **String** | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`. | [optional] |
|
|
998
|
+
| **folder_id** | **String** | Filter to one folder. Omit for the account root. | [optional] |
|
|
999
|
+
| **workspace_id** | **String** | | [optional] |
|
|
1000
|
+
| **organization_id** | **String** | | [optional] |
|
|
1001
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
1002
|
+
| **offset** | **Integer** | | [optional][default to 0] |
|
|
1003
|
+
| **sort_by** | **String** | | [optional] |
|
|
1004
|
+
| **sort_order** | **String** | | [optional] |
|
|
1005
|
+
|
|
1006
|
+
### Return type
|
|
1007
|
+
|
|
1008
|
+
[**FilesAndFoldersResponse**](FilesAndFoldersResponse.md)
|
|
1009
|
+
|
|
1010
|
+
### Authorization
|
|
1011
|
+
|
|
1012
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1013
|
+
|
|
1014
|
+
### HTTP request headers
|
|
1015
|
+
|
|
1016
|
+
- **Content-Type**: Not defined
|
|
1017
|
+
- **Accept**: application/json
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
## move_file
|
|
1021
|
+
|
|
1022
|
+
> <MoveFileResponse> move_file(id, move_file_request, opts)
|
|
1023
|
+
|
|
1024
|
+
Move a single file to a target folder.
|
|
1025
|
+
|
|
1026
|
+
### Examples
|
|
1027
|
+
|
|
1028
|
+
```ruby
|
|
1029
|
+
require 'time'
|
|
1030
|
+
require 'spatio-sdk'
|
|
1031
|
+
# setup authorization
|
|
1032
|
+
Spatio.configure do |config|
|
|
1033
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1034
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1035
|
+
end
|
|
1036
|
+
|
|
1037
|
+
api_instance = Spatio::FilesApi.new
|
|
1038
|
+
id = 'id_example' # String | File id.
|
|
1039
|
+
move_file_request = Spatio::MoveFileRequest.new # MoveFileRequest |
|
|
1040
|
+
opts = {
|
|
1041
|
+
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.
|
|
1042
|
+
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.
|
|
1043
|
+
}
|
|
1044
|
+
|
|
1045
|
+
begin
|
|
1046
|
+
# Move a single file to a target folder.
|
|
1047
|
+
result = api_instance.move_file(id, move_file_request, opts)
|
|
1048
|
+
p result
|
|
1049
|
+
rescue Spatio::ApiError => e
|
|
1050
|
+
puts "Error when calling FilesApi->move_file: #{e}"
|
|
1051
|
+
end
|
|
1052
|
+
```
|
|
1053
|
+
|
|
1054
|
+
#### Using the move_file_with_http_info variant
|
|
1055
|
+
|
|
1056
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1057
|
+
|
|
1058
|
+
> <Array(<MoveFileResponse>, Integer, Hash)> move_file_with_http_info(id, move_file_request, opts)
|
|
1059
|
+
|
|
1060
|
+
```ruby
|
|
1061
|
+
begin
|
|
1062
|
+
# Move a single file to a target folder.
|
|
1063
|
+
data, status_code, headers = api_instance.move_file_with_http_info(id, move_file_request, opts)
|
|
1064
|
+
p status_code # => 2xx
|
|
1065
|
+
p headers # => { ... }
|
|
1066
|
+
p data # => <MoveFileResponse>
|
|
1067
|
+
rescue Spatio::ApiError => e
|
|
1068
|
+
puts "Error when calling FilesApi->move_file_with_http_info: #{e}"
|
|
1069
|
+
end
|
|
1070
|
+
```
|
|
1071
|
+
|
|
1072
|
+
### Parameters
|
|
1073
|
+
|
|
1074
|
+
| Name | Type | Description | Notes |
|
|
1075
|
+
| ---- | ---- | ----------- | ----- |
|
|
1076
|
+
| **id** | **String** | File id. | |
|
|
1077
|
+
| **move_file_request** | [**MoveFileRequest**](MoveFileRequest.md) | | |
|
|
1078
|
+
| **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] |
|
|
1079
|
+
| **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] |
|
|
1080
|
+
|
|
1081
|
+
### Return type
|
|
1082
|
+
|
|
1083
|
+
[**MoveFileResponse**](MoveFileResponse.md)
|
|
1084
|
+
|
|
1085
|
+
### Authorization
|
|
1086
|
+
|
|
1087
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1088
|
+
|
|
1089
|
+
### HTTP request headers
|
|
1090
|
+
|
|
1091
|
+
- **Content-Type**: application/json
|
|
1092
|
+
- **Accept**: application/json
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
## search_files
|
|
1096
|
+
|
|
1097
|
+
> <SearchFilesResponse> search_files(query, opts)
|
|
1098
|
+
|
|
1099
|
+
Substring-match search across the caller's files.
|
|
1100
|
+
|
|
1101
|
+
In-memory search — the platform lists up to ~500 files and filters locally on `name` (case-insensitive substring). Not suitable for global search across very large file libraries.
|
|
1102
|
+
|
|
1103
|
+
### Examples
|
|
1104
|
+
|
|
1105
|
+
```ruby
|
|
1106
|
+
require 'time'
|
|
1107
|
+
require 'spatio-sdk'
|
|
1108
|
+
# setup authorization
|
|
1109
|
+
Spatio.configure do |config|
|
|
1110
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1111
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1112
|
+
end
|
|
1113
|
+
|
|
1114
|
+
api_instance = Spatio::FilesApi.new
|
|
1115
|
+
query = 'query_example' # String |
|
|
1116
|
+
opts = {
|
|
1117
|
+
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.
|
|
1118
|
+
provider: 'provider_example', # String | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`.
|
|
1119
|
+
folder_id: 'folder_id_example', # String | Filter to one folder. Omit for the account root.
|
|
1120
|
+
workspace_id: 'workspace_id_example', # String |
|
|
1121
|
+
organization_id: 'organization_id_example', # String |
|
|
1122
|
+
limit: 56, # Integer |
|
|
1123
|
+
offset: 56 # Integer |
|
|
1124
|
+
}
|
|
1125
|
+
|
|
1126
|
+
begin
|
|
1127
|
+
# Substring-match search across the caller's files.
|
|
1128
|
+
result = api_instance.search_files(query, opts)
|
|
1129
|
+
p result
|
|
1130
|
+
rescue Spatio::ApiError => e
|
|
1131
|
+
puts "Error when calling FilesApi->search_files: #{e}"
|
|
1132
|
+
end
|
|
1133
|
+
```
|
|
1134
|
+
|
|
1135
|
+
#### Using the search_files_with_http_info variant
|
|
1136
|
+
|
|
1137
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1138
|
+
|
|
1139
|
+
> <Array(<SearchFilesResponse>, Integer, Hash)> search_files_with_http_info(query, opts)
|
|
1140
|
+
|
|
1141
|
+
```ruby
|
|
1142
|
+
begin
|
|
1143
|
+
# Substring-match search across the caller's files.
|
|
1144
|
+
data, status_code, headers = api_instance.search_files_with_http_info(query, opts)
|
|
1145
|
+
p status_code # => 2xx
|
|
1146
|
+
p headers # => { ... }
|
|
1147
|
+
p data # => <SearchFilesResponse>
|
|
1148
|
+
rescue Spatio::ApiError => e
|
|
1149
|
+
puts "Error when calling FilesApi->search_files_with_http_info: #{e}"
|
|
1150
|
+
end
|
|
1151
|
+
```
|
|
1152
|
+
|
|
1153
|
+
### Parameters
|
|
1154
|
+
|
|
1155
|
+
| Name | Type | Description | Notes |
|
|
1156
|
+
| ---- | ---- | ----------- | ----- |
|
|
1157
|
+
| **query** | **String** | | |
|
|
1158
|
+
| **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] |
|
|
1159
|
+
| **provider** | **String** | Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`. | [optional] |
|
|
1160
|
+
| **folder_id** | **String** | Filter to one folder. Omit for the account root. | [optional] |
|
|
1161
|
+
| **workspace_id** | **String** | | [optional] |
|
|
1162
|
+
| **organization_id** | **String** | | [optional] |
|
|
1163
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
1164
|
+
| **offset** | **Integer** | | [optional][default to 0] |
|
|
1165
|
+
|
|
1166
|
+
### Return type
|
|
1167
|
+
|
|
1168
|
+
[**SearchFilesResponse**](SearchFilesResponse.md)
|
|
1169
|
+
|
|
1170
|
+
### Authorization
|
|
1171
|
+
|
|
1172
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1173
|
+
|
|
1174
|
+
### HTTP request headers
|
|
1175
|
+
|
|
1176
|
+
- **Content-Type**: Not defined
|
|
1177
|
+
- **Accept**: application/json
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
## update_file
|
|
1181
|
+
|
|
1182
|
+
> <SpatioFile> update_file(id, update_file_request, opts)
|
|
1183
|
+
|
|
1184
|
+
Update a file's metadata (name, folder, custom fields).
|
|
1185
|
+
|
|
1186
|
+
### Examples
|
|
1187
|
+
|
|
1188
|
+
```ruby
|
|
1189
|
+
require 'time'
|
|
1190
|
+
require 'spatio-sdk'
|
|
1191
|
+
# setup authorization
|
|
1192
|
+
Spatio.configure do |config|
|
|
1193
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1194
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1195
|
+
end
|
|
1196
|
+
|
|
1197
|
+
api_instance = Spatio::FilesApi.new
|
|
1198
|
+
id = 'id_example' # String | File id.
|
|
1199
|
+
update_file_request = Spatio::UpdateFileRequest.new # UpdateFileRequest |
|
|
1200
|
+
opts = {
|
|
1201
|
+
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.
|
|
1202
|
+
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.
|
|
1203
|
+
}
|
|
1204
|
+
|
|
1205
|
+
begin
|
|
1206
|
+
# Update a file's metadata (name, folder, custom fields).
|
|
1207
|
+
result = api_instance.update_file(id, update_file_request, opts)
|
|
1208
|
+
p result
|
|
1209
|
+
rescue Spatio::ApiError => e
|
|
1210
|
+
puts "Error when calling FilesApi->update_file: #{e}"
|
|
1211
|
+
end
|
|
1212
|
+
```
|
|
1213
|
+
|
|
1214
|
+
#### Using the update_file_with_http_info variant
|
|
1215
|
+
|
|
1216
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1217
|
+
|
|
1218
|
+
> <Array(<SpatioFile>, Integer, Hash)> update_file_with_http_info(id, update_file_request, opts)
|
|
1219
|
+
|
|
1220
|
+
```ruby
|
|
1221
|
+
begin
|
|
1222
|
+
# Update a file's metadata (name, folder, custom fields).
|
|
1223
|
+
data, status_code, headers = api_instance.update_file_with_http_info(id, update_file_request, opts)
|
|
1224
|
+
p status_code # => 2xx
|
|
1225
|
+
p headers # => { ... }
|
|
1226
|
+
p data # => <SpatioFile>
|
|
1227
|
+
rescue Spatio::ApiError => e
|
|
1228
|
+
puts "Error when calling FilesApi->update_file_with_http_info: #{e}"
|
|
1229
|
+
end
|
|
1230
|
+
```
|
|
1231
|
+
|
|
1232
|
+
### Parameters
|
|
1233
|
+
|
|
1234
|
+
| Name | Type | Description | Notes |
|
|
1235
|
+
| ---- | ---- | ----------- | ----- |
|
|
1236
|
+
| **id** | **String** | File id. | |
|
|
1237
|
+
| **update_file_request** | [**UpdateFileRequest**](UpdateFileRequest.md) | | |
|
|
1238
|
+
| **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] |
|
|
1239
|
+
| **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] |
|
|
1240
|
+
|
|
1241
|
+
### Return type
|
|
1242
|
+
|
|
1243
|
+
[**SpatioFile**](SpatioFile.md)
|
|
1244
|
+
|
|
1245
|
+
### Authorization
|
|
1246
|
+
|
|
1247
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1248
|
+
|
|
1249
|
+
### HTTP request headers
|
|
1250
|
+
|
|
1251
|
+
- **Content-Type**: application/json
|
|
1252
|
+
- **Accept**: application/json
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
## upload_chunked_block
|
|
1256
|
+
|
|
1257
|
+
> <UploadChunkedBlockResponse> upload_chunked_block(session_id, block_hash, block, opts)
|
|
1258
|
+
|
|
1259
|
+
Upload one block for an open chunked-upload session.
|
|
1260
|
+
|
|
1261
|
+
### Examples
|
|
1262
|
+
|
|
1263
|
+
```ruby
|
|
1264
|
+
require 'time'
|
|
1265
|
+
require 'spatio-sdk'
|
|
1266
|
+
# setup authorization
|
|
1267
|
+
Spatio.configure do |config|
|
|
1268
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1269
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1270
|
+
end
|
|
1271
|
+
|
|
1272
|
+
api_instance = Spatio::FilesApi.new
|
|
1273
|
+
session_id = 'session_id_example' # String |
|
|
1274
|
+
block_hash = 'block_hash_example' # String |
|
|
1275
|
+
block = File.new('/path/to/some/file') # File |
|
|
1276
|
+
opts = {
|
|
1277
|
+
block_index: 56 # Integer |
|
|
1278
|
+
}
|
|
1279
|
+
|
|
1280
|
+
begin
|
|
1281
|
+
# Upload one block for an open chunked-upload session.
|
|
1282
|
+
result = api_instance.upload_chunked_block(session_id, block_hash, block, opts)
|
|
1283
|
+
p result
|
|
1284
|
+
rescue Spatio::ApiError => e
|
|
1285
|
+
puts "Error when calling FilesApi->upload_chunked_block: #{e}"
|
|
1286
|
+
end
|
|
1287
|
+
```
|
|
1288
|
+
|
|
1289
|
+
#### Using the upload_chunked_block_with_http_info variant
|
|
1290
|
+
|
|
1291
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1292
|
+
|
|
1293
|
+
> <Array(<UploadChunkedBlockResponse>, Integer, Hash)> upload_chunked_block_with_http_info(session_id, block_hash, block, opts)
|
|
1294
|
+
|
|
1295
|
+
```ruby
|
|
1296
|
+
begin
|
|
1297
|
+
# Upload one block for an open chunked-upload session.
|
|
1298
|
+
data, status_code, headers = api_instance.upload_chunked_block_with_http_info(session_id, block_hash, block, opts)
|
|
1299
|
+
p status_code # => 2xx
|
|
1300
|
+
p headers # => { ... }
|
|
1301
|
+
p data # => <UploadChunkedBlockResponse>
|
|
1302
|
+
rescue Spatio::ApiError => e
|
|
1303
|
+
puts "Error when calling FilesApi->upload_chunked_block_with_http_info: #{e}"
|
|
1304
|
+
end
|
|
1305
|
+
```
|
|
1306
|
+
|
|
1307
|
+
### Parameters
|
|
1308
|
+
|
|
1309
|
+
| Name | Type | Description | Notes |
|
|
1310
|
+
| ---- | ---- | ----------- | ----- |
|
|
1311
|
+
| **session_id** | **String** | | |
|
|
1312
|
+
| **block_hash** | **String** | | |
|
|
1313
|
+
| **block** | **File** | | |
|
|
1314
|
+
| **block_index** | **Integer** | | [optional] |
|
|
1315
|
+
|
|
1316
|
+
### Return type
|
|
1317
|
+
|
|
1318
|
+
[**UploadChunkedBlockResponse**](UploadChunkedBlockResponse.md)
|
|
1319
|
+
|
|
1320
|
+
### Authorization
|
|
1321
|
+
|
|
1322
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1323
|
+
|
|
1324
|
+
### HTTP request headers
|
|
1325
|
+
|
|
1326
|
+
- **Content-Type**: multipart/form-data
|
|
1327
|
+
- **Accept**: application/json
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
## upload_file
|
|
1331
|
+
|
|
1332
|
+
> <SpatioFile> upload_file(file, opts)
|
|
1333
|
+
|
|
1334
|
+
Upload a file via multipart form.
|
|
1335
|
+
|
|
1336
|
+
Multipart upload. Form field `file` carries the binary; auxiliary form fields scope the upload (`folderId`, `workspaceId`, `organizationId`, `accountId`). Max body size is currently 100 MB.
|
|
1337
|
+
|
|
1338
|
+
### Examples
|
|
1339
|
+
|
|
1340
|
+
```ruby
|
|
1341
|
+
require 'time'
|
|
1342
|
+
require 'spatio-sdk'
|
|
1343
|
+
# setup authorization
|
|
1344
|
+
Spatio.configure do |config|
|
|
1345
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1346
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1347
|
+
end
|
|
1348
|
+
|
|
1349
|
+
api_instance = Spatio::FilesApi.new
|
|
1350
|
+
file = File.new('/path/to/some/file') # File | File bytes (multipart form field name `file`).
|
|
1351
|
+
opts = {
|
|
1352
|
+
folder_id: 'folder_id_example', # String |
|
|
1353
|
+
workspace_id: 'workspace_id_example', # String |
|
|
1354
|
+
organization_id: 'organization_id_example', # String |
|
|
1355
|
+
account_id: 'account_id_example' # String |
|
|
1356
|
+
}
|
|
1357
|
+
|
|
1358
|
+
begin
|
|
1359
|
+
# Upload a file via multipart form.
|
|
1360
|
+
result = api_instance.upload_file(file, opts)
|
|
1361
|
+
p result
|
|
1362
|
+
rescue Spatio::ApiError => e
|
|
1363
|
+
puts "Error when calling FilesApi->upload_file: #{e}"
|
|
1364
|
+
end
|
|
1365
|
+
```
|
|
1366
|
+
|
|
1367
|
+
#### Using the upload_file_with_http_info variant
|
|
1368
|
+
|
|
1369
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1370
|
+
|
|
1371
|
+
> <Array(<SpatioFile>, Integer, Hash)> upload_file_with_http_info(file, opts)
|
|
1372
|
+
|
|
1373
|
+
```ruby
|
|
1374
|
+
begin
|
|
1375
|
+
# Upload a file via multipart form.
|
|
1376
|
+
data, status_code, headers = api_instance.upload_file_with_http_info(file, opts)
|
|
1377
|
+
p status_code # => 2xx
|
|
1378
|
+
p headers # => { ... }
|
|
1379
|
+
p data # => <SpatioFile>
|
|
1380
|
+
rescue Spatio::ApiError => e
|
|
1381
|
+
puts "Error when calling FilesApi->upload_file_with_http_info: #{e}"
|
|
1382
|
+
end
|
|
1383
|
+
```
|
|
1384
|
+
|
|
1385
|
+
### Parameters
|
|
1386
|
+
|
|
1387
|
+
| Name | Type | Description | Notes |
|
|
1388
|
+
| ---- | ---- | ----------- | ----- |
|
|
1389
|
+
| **file** | **File** | File bytes (multipart form field name `file`). | |
|
|
1390
|
+
| **folder_id** | **String** | | [optional] |
|
|
1391
|
+
| **workspace_id** | **String** | | [optional] |
|
|
1392
|
+
| **organization_id** | **String** | | [optional] |
|
|
1393
|
+
| **account_id** | **String** | | [optional] |
|
|
1394
|
+
|
|
1395
|
+
### Return type
|
|
1396
|
+
|
|
1397
|
+
[**SpatioFile**](SpatioFile.md)
|
|
1398
|
+
|
|
1399
|
+
### Authorization
|
|
1400
|
+
|
|
1401
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1402
|
+
|
|
1403
|
+
### HTTP request headers
|
|
1404
|
+
|
|
1405
|
+
- **Content-Type**: multipart/form-data
|
|
1406
|
+
- **Accept**: application/json
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
## upload_file_base64
|
|
1410
|
+
|
|
1411
|
+
> <SpatioFile> upload_file_base64(upload_file_base64_request)
|
|
1412
|
+
|
|
1413
|
+
Upload a file via JSON with base64-encoded content.
|
|
1414
|
+
|
|
1415
|
+
Equivalent to `uploadFile` for clients that can't post multipart bodies (e.g. browser fetch with strict CSP).
|
|
1416
|
+
|
|
1417
|
+
### Examples
|
|
1418
|
+
|
|
1419
|
+
```ruby
|
|
1420
|
+
require 'time'
|
|
1421
|
+
require 'spatio-sdk'
|
|
1422
|
+
# setup authorization
|
|
1423
|
+
Spatio.configure do |config|
|
|
1424
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1425
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1426
|
+
end
|
|
1427
|
+
|
|
1428
|
+
api_instance = Spatio::FilesApi.new
|
|
1429
|
+
upload_file_base64_request = Spatio::UploadFileBase64Request.new({name: 'name_example', content: 'content_example', mime_type: 'mime_type_example'}) # UploadFileBase64Request |
|
|
1430
|
+
|
|
1431
|
+
begin
|
|
1432
|
+
# Upload a file via JSON with base64-encoded content.
|
|
1433
|
+
result = api_instance.upload_file_base64(upload_file_base64_request)
|
|
1434
|
+
p result
|
|
1435
|
+
rescue Spatio::ApiError => e
|
|
1436
|
+
puts "Error when calling FilesApi->upload_file_base64: #{e}"
|
|
1437
|
+
end
|
|
1438
|
+
```
|
|
1439
|
+
|
|
1440
|
+
#### Using the upload_file_base64_with_http_info variant
|
|
1441
|
+
|
|
1442
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1443
|
+
|
|
1444
|
+
> <Array(<SpatioFile>, Integer, Hash)> upload_file_base64_with_http_info(upload_file_base64_request)
|
|
1445
|
+
|
|
1446
|
+
```ruby
|
|
1447
|
+
begin
|
|
1448
|
+
# Upload a file via JSON with base64-encoded content.
|
|
1449
|
+
data, status_code, headers = api_instance.upload_file_base64_with_http_info(upload_file_base64_request)
|
|
1450
|
+
p status_code # => 2xx
|
|
1451
|
+
p headers # => { ... }
|
|
1452
|
+
p data # => <SpatioFile>
|
|
1453
|
+
rescue Spatio::ApiError => e
|
|
1454
|
+
puts "Error when calling FilesApi->upload_file_base64_with_http_info: #{e}"
|
|
1455
|
+
end
|
|
1456
|
+
```
|
|
1457
|
+
|
|
1458
|
+
### Parameters
|
|
1459
|
+
|
|
1460
|
+
| Name | Type | Description | Notes |
|
|
1461
|
+
| ---- | ---- | ----------- | ----- |
|
|
1462
|
+
| **upload_file_base64_request** | [**UploadFileBase64Request**](UploadFileBase64Request.md) | | |
|
|
1463
|
+
|
|
1464
|
+
### Return type
|
|
1465
|
+
|
|
1466
|
+
[**SpatioFile**](SpatioFile.md)
|
|
1467
|
+
|
|
1468
|
+
### Authorization
|
|
1469
|
+
|
|
1470
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1471
|
+
|
|
1472
|
+
### HTTP request headers
|
|
1473
|
+
|
|
1474
|
+
- **Content-Type**: application/json
|
|
1475
|
+
- **Accept**: application/json
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
## workspace_commit_chunked_upload
|
|
1479
|
+
|
|
1480
|
+
> Hash<String, Object> workspace_commit_chunked_upload(org, workspace, request_body)
|
|
1481
|
+
|
|
1482
|
+
Workspace-scoped chunked-upload commit (RBAC-protected).
|
|
1483
|
+
|
|
1484
|
+
### Examples
|
|
1485
|
+
|
|
1486
|
+
```ruby
|
|
1487
|
+
require 'time'
|
|
1488
|
+
require 'spatio-sdk'
|
|
1489
|
+
# setup authorization
|
|
1490
|
+
Spatio.configure do |config|
|
|
1491
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1492
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1493
|
+
end
|
|
1494
|
+
|
|
1495
|
+
api_instance = Spatio::FilesApi.new
|
|
1496
|
+
org = 'org_example' # String |
|
|
1497
|
+
workspace = 'workspace_example' # String |
|
|
1498
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1499
|
+
|
|
1500
|
+
begin
|
|
1501
|
+
# Workspace-scoped chunked-upload commit (RBAC-protected).
|
|
1502
|
+
result = api_instance.workspace_commit_chunked_upload(org, workspace, request_body)
|
|
1503
|
+
p result
|
|
1504
|
+
rescue Spatio::ApiError => e
|
|
1505
|
+
puts "Error when calling FilesApi->workspace_commit_chunked_upload: #{e}"
|
|
1506
|
+
end
|
|
1507
|
+
```
|
|
1508
|
+
|
|
1509
|
+
#### Using the workspace_commit_chunked_upload_with_http_info variant
|
|
1510
|
+
|
|
1511
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1512
|
+
|
|
1513
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_commit_chunked_upload_with_http_info(org, workspace, request_body)
|
|
1514
|
+
|
|
1515
|
+
```ruby
|
|
1516
|
+
begin
|
|
1517
|
+
# Workspace-scoped chunked-upload commit (RBAC-protected).
|
|
1518
|
+
data, status_code, headers = api_instance.workspace_commit_chunked_upload_with_http_info(org, workspace, request_body)
|
|
1519
|
+
p status_code # => 2xx
|
|
1520
|
+
p headers # => { ... }
|
|
1521
|
+
p data # => Hash<String, Object>
|
|
1522
|
+
rescue Spatio::ApiError => e
|
|
1523
|
+
puts "Error when calling FilesApi->workspace_commit_chunked_upload_with_http_info: #{e}"
|
|
1524
|
+
end
|
|
1525
|
+
```
|
|
1526
|
+
|
|
1527
|
+
### Parameters
|
|
1528
|
+
|
|
1529
|
+
| Name | Type | Description | Notes |
|
|
1530
|
+
| ---- | ---- | ----------- | ----- |
|
|
1531
|
+
| **org** | **String** | | |
|
|
1532
|
+
| **workspace** | **String** | | |
|
|
1533
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1534
|
+
|
|
1535
|
+
### Return type
|
|
1536
|
+
|
|
1537
|
+
**Hash<String, Object>**
|
|
1538
|
+
|
|
1539
|
+
### Authorization
|
|
1540
|
+
|
|
1541
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1542
|
+
|
|
1543
|
+
### HTTP request headers
|
|
1544
|
+
|
|
1545
|
+
- **Content-Type**: application/json
|
|
1546
|
+
- **Accept**: application/json
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
## workspace_create_file_folder
|
|
1550
|
+
|
|
1551
|
+
> Hash<String, Object> workspace_create_file_folder(org, workspace, request_body)
|
|
1552
|
+
|
|
1553
|
+
Workspace-scoped create-folder (RBAC-protected).
|
|
1554
|
+
|
|
1555
|
+
### Examples
|
|
1556
|
+
|
|
1557
|
+
```ruby
|
|
1558
|
+
require 'time'
|
|
1559
|
+
require 'spatio-sdk'
|
|
1560
|
+
# setup authorization
|
|
1561
|
+
Spatio.configure do |config|
|
|
1562
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1563
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1564
|
+
end
|
|
1565
|
+
|
|
1566
|
+
api_instance = Spatio::FilesApi.new
|
|
1567
|
+
org = 'org_example' # String |
|
|
1568
|
+
workspace = 'workspace_example' # String |
|
|
1569
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1570
|
+
|
|
1571
|
+
begin
|
|
1572
|
+
# Workspace-scoped create-folder (RBAC-protected).
|
|
1573
|
+
result = api_instance.workspace_create_file_folder(org, workspace, request_body)
|
|
1574
|
+
p result
|
|
1575
|
+
rescue Spatio::ApiError => e
|
|
1576
|
+
puts "Error when calling FilesApi->workspace_create_file_folder: #{e}"
|
|
1577
|
+
end
|
|
1578
|
+
```
|
|
1579
|
+
|
|
1580
|
+
#### Using the workspace_create_file_folder_with_http_info variant
|
|
1581
|
+
|
|
1582
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1583
|
+
|
|
1584
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_create_file_folder_with_http_info(org, workspace, request_body)
|
|
1585
|
+
|
|
1586
|
+
```ruby
|
|
1587
|
+
begin
|
|
1588
|
+
# Workspace-scoped create-folder (RBAC-protected).
|
|
1589
|
+
data, status_code, headers = api_instance.workspace_create_file_folder_with_http_info(org, workspace, request_body)
|
|
1590
|
+
p status_code # => 2xx
|
|
1591
|
+
p headers # => { ... }
|
|
1592
|
+
p data # => Hash<String, Object>
|
|
1593
|
+
rescue Spatio::ApiError => e
|
|
1594
|
+
puts "Error when calling FilesApi->workspace_create_file_folder_with_http_info: #{e}"
|
|
1595
|
+
end
|
|
1596
|
+
```
|
|
1597
|
+
|
|
1598
|
+
### Parameters
|
|
1599
|
+
|
|
1600
|
+
| Name | Type | Description | Notes |
|
|
1601
|
+
| ---- | ---- | ----------- | ----- |
|
|
1602
|
+
| **org** | **String** | | |
|
|
1603
|
+
| **workspace** | **String** | | |
|
|
1604
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1605
|
+
|
|
1606
|
+
### Return type
|
|
1607
|
+
|
|
1608
|
+
**Hash<String, Object>**
|
|
1609
|
+
|
|
1610
|
+
### Authorization
|
|
1611
|
+
|
|
1612
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1613
|
+
|
|
1614
|
+
### HTTP request headers
|
|
1615
|
+
|
|
1616
|
+
- **Content-Type**: application/json
|
|
1617
|
+
- **Accept**: application/json
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
## workspace_delete_file
|
|
1621
|
+
|
|
1622
|
+
> workspace_delete_file(org, workspace, id)
|
|
1623
|
+
|
|
1624
|
+
Workspace-scoped delete-file.
|
|
1625
|
+
|
|
1626
|
+
### Examples
|
|
1627
|
+
|
|
1628
|
+
```ruby
|
|
1629
|
+
require 'time'
|
|
1630
|
+
require 'spatio-sdk'
|
|
1631
|
+
# setup authorization
|
|
1632
|
+
Spatio.configure do |config|
|
|
1633
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1634
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1635
|
+
end
|
|
1636
|
+
|
|
1637
|
+
api_instance = Spatio::FilesApi.new
|
|
1638
|
+
org = 'org_example' # String |
|
|
1639
|
+
workspace = 'workspace_example' # String |
|
|
1640
|
+
id = 'id_example' # String |
|
|
1641
|
+
|
|
1642
|
+
begin
|
|
1643
|
+
# Workspace-scoped delete-file.
|
|
1644
|
+
api_instance.workspace_delete_file(org, workspace, id)
|
|
1645
|
+
rescue Spatio::ApiError => e
|
|
1646
|
+
puts "Error when calling FilesApi->workspace_delete_file: #{e}"
|
|
1647
|
+
end
|
|
1648
|
+
```
|
|
1649
|
+
|
|
1650
|
+
#### Using the workspace_delete_file_with_http_info variant
|
|
1651
|
+
|
|
1652
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1653
|
+
|
|
1654
|
+
> <Array(nil, Integer, Hash)> workspace_delete_file_with_http_info(org, workspace, id)
|
|
1655
|
+
|
|
1656
|
+
```ruby
|
|
1657
|
+
begin
|
|
1658
|
+
# Workspace-scoped delete-file.
|
|
1659
|
+
data, status_code, headers = api_instance.workspace_delete_file_with_http_info(org, workspace, id)
|
|
1660
|
+
p status_code # => 2xx
|
|
1661
|
+
p headers # => { ... }
|
|
1662
|
+
p data # => nil
|
|
1663
|
+
rescue Spatio::ApiError => e
|
|
1664
|
+
puts "Error when calling FilesApi->workspace_delete_file_with_http_info: #{e}"
|
|
1665
|
+
end
|
|
1666
|
+
```
|
|
1667
|
+
|
|
1668
|
+
### Parameters
|
|
1669
|
+
|
|
1670
|
+
| Name | Type | Description | Notes |
|
|
1671
|
+
| ---- | ---- | ----------- | ----- |
|
|
1672
|
+
| **org** | **String** | | |
|
|
1673
|
+
| **workspace** | **String** | | |
|
|
1674
|
+
| **id** | **String** | | |
|
|
1675
|
+
|
|
1676
|
+
### Return type
|
|
1677
|
+
|
|
1678
|
+
nil (empty response body)
|
|
1679
|
+
|
|
1680
|
+
### Authorization
|
|
1681
|
+
|
|
1682
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1683
|
+
|
|
1684
|
+
### HTTP request headers
|
|
1685
|
+
|
|
1686
|
+
- **Content-Type**: Not defined
|
|
1687
|
+
- **Accept**: application/json
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
## workspace_get_file
|
|
1691
|
+
|
|
1692
|
+
> Hash<String, Object> workspace_get_file(org, workspace, id)
|
|
1693
|
+
|
|
1694
|
+
Workspace-scoped get-file.
|
|
1695
|
+
|
|
1696
|
+
### Examples
|
|
1697
|
+
|
|
1698
|
+
```ruby
|
|
1699
|
+
require 'time'
|
|
1700
|
+
require 'spatio-sdk'
|
|
1701
|
+
# setup authorization
|
|
1702
|
+
Spatio.configure do |config|
|
|
1703
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1704
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1705
|
+
end
|
|
1706
|
+
|
|
1707
|
+
api_instance = Spatio::FilesApi.new
|
|
1708
|
+
org = 'org_example' # String |
|
|
1709
|
+
workspace = 'workspace_example' # String |
|
|
1710
|
+
id = 'id_example' # String |
|
|
1711
|
+
|
|
1712
|
+
begin
|
|
1713
|
+
# Workspace-scoped get-file.
|
|
1714
|
+
result = api_instance.workspace_get_file(org, workspace, id)
|
|
1715
|
+
p result
|
|
1716
|
+
rescue Spatio::ApiError => e
|
|
1717
|
+
puts "Error when calling FilesApi->workspace_get_file: #{e}"
|
|
1718
|
+
end
|
|
1719
|
+
```
|
|
1720
|
+
|
|
1721
|
+
#### Using the workspace_get_file_with_http_info variant
|
|
1722
|
+
|
|
1723
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1724
|
+
|
|
1725
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_file_with_http_info(org, workspace, id)
|
|
1726
|
+
|
|
1727
|
+
```ruby
|
|
1728
|
+
begin
|
|
1729
|
+
# Workspace-scoped get-file.
|
|
1730
|
+
data, status_code, headers = api_instance.workspace_get_file_with_http_info(org, workspace, id)
|
|
1731
|
+
p status_code # => 2xx
|
|
1732
|
+
p headers # => { ... }
|
|
1733
|
+
p data # => Hash<String, Object>
|
|
1734
|
+
rescue Spatio::ApiError => e
|
|
1735
|
+
puts "Error when calling FilesApi->workspace_get_file_with_http_info: #{e}"
|
|
1736
|
+
end
|
|
1737
|
+
```
|
|
1738
|
+
|
|
1739
|
+
### Parameters
|
|
1740
|
+
|
|
1741
|
+
| Name | Type | Description | Notes |
|
|
1742
|
+
| ---- | ---- | ----------- | ----- |
|
|
1743
|
+
| **org** | **String** | | |
|
|
1744
|
+
| **workspace** | **String** | | |
|
|
1745
|
+
| **id** | **String** | | |
|
|
1746
|
+
|
|
1747
|
+
### Return type
|
|
1748
|
+
|
|
1749
|
+
**Hash<String, Object>**
|
|
1750
|
+
|
|
1751
|
+
### Authorization
|
|
1752
|
+
|
|
1753
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1754
|
+
|
|
1755
|
+
### HTTP request headers
|
|
1756
|
+
|
|
1757
|
+
- **Content-Type**: Not defined
|
|
1758
|
+
- **Accept**: application/json
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
## workspace_get_file_download
|
|
1762
|
+
|
|
1763
|
+
> Hash<String, Object> workspace_get_file_download(org, workspace, id)
|
|
1764
|
+
|
|
1765
|
+
Workspace-scoped signed-download URL.
|
|
1766
|
+
|
|
1767
|
+
### Examples
|
|
1768
|
+
|
|
1769
|
+
```ruby
|
|
1770
|
+
require 'time'
|
|
1771
|
+
require 'spatio-sdk'
|
|
1772
|
+
# setup authorization
|
|
1773
|
+
Spatio.configure do |config|
|
|
1774
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1775
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1776
|
+
end
|
|
1777
|
+
|
|
1778
|
+
api_instance = Spatio::FilesApi.new
|
|
1779
|
+
org = 'org_example' # String |
|
|
1780
|
+
workspace = 'workspace_example' # String |
|
|
1781
|
+
id = 'id_example' # String |
|
|
1782
|
+
|
|
1783
|
+
begin
|
|
1784
|
+
# Workspace-scoped signed-download URL.
|
|
1785
|
+
result = api_instance.workspace_get_file_download(org, workspace, id)
|
|
1786
|
+
p result
|
|
1787
|
+
rescue Spatio::ApiError => e
|
|
1788
|
+
puts "Error when calling FilesApi->workspace_get_file_download: #{e}"
|
|
1789
|
+
end
|
|
1790
|
+
```
|
|
1791
|
+
|
|
1792
|
+
#### Using the workspace_get_file_download_with_http_info variant
|
|
1793
|
+
|
|
1794
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1795
|
+
|
|
1796
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_file_download_with_http_info(org, workspace, id)
|
|
1797
|
+
|
|
1798
|
+
```ruby
|
|
1799
|
+
begin
|
|
1800
|
+
# Workspace-scoped signed-download URL.
|
|
1801
|
+
data, status_code, headers = api_instance.workspace_get_file_download_with_http_info(org, workspace, id)
|
|
1802
|
+
p status_code # => 2xx
|
|
1803
|
+
p headers # => { ... }
|
|
1804
|
+
p data # => Hash<String, Object>
|
|
1805
|
+
rescue Spatio::ApiError => e
|
|
1806
|
+
puts "Error when calling FilesApi->workspace_get_file_download_with_http_info: #{e}"
|
|
1807
|
+
end
|
|
1808
|
+
```
|
|
1809
|
+
|
|
1810
|
+
### Parameters
|
|
1811
|
+
|
|
1812
|
+
| Name | Type | Description | Notes |
|
|
1813
|
+
| ---- | ---- | ----------- | ----- |
|
|
1814
|
+
| **org** | **String** | | |
|
|
1815
|
+
| **workspace** | **String** | | |
|
|
1816
|
+
| **id** | **String** | | |
|
|
1817
|
+
|
|
1818
|
+
### Return type
|
|
1819
|
+
|
|
1820
|
+
**Hash<String, Object>**
|
|
1821
|
+
|
|
1822
|
+
### Authorization
|
|
1823
|
+
|
|
1824
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1825
|
+
|
|
1826
|
+
### HTTP request headers
|
|
1827
|
+
|
|
1828
|
+
- **Content-Type**: Not defined
|
|
1829
|
+
- **Accept**: application/json
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
## workspace_get_file_manifest
|
|
1833
|
+
|
|
1834
|
+
> Hash<String, Object> workspace_get_file_manifest(org, workspace, id)
|
|
1835
|
+
|
|
1836
|
+
Workspace-scoped chunked-file manifest.
|
|
1837
|
+
|
|
1838
|
+
### Examples
|
|
1839
|
+
|
|
1840
|
+
```ruby
|
|
1841
|
+
require 'time'
|
|
1842
|
+
require 'spatio-sdk'
|
|
1843
|
+
# setup authorization
|
|
1844
|
+
Spatio.configure do |config|
|
|
1845
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1846
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1847
|
+
end
|
|
1848
|
+
|
|
1849
|
+
api_instance = Spatio::FilesApi.new
|
|
1850
|
+
org = 'org_example' # String |
|
|
1851
|
+
workspace = 'workspace_example' # String |
|
|
1852
|
+
id = 'id_example' # String |
|
|
1853
|
+
|
|
1854
|
+
begin
|
|
1855
|
+
# Workspace-scoped chunked-file manifest.
|
|
1856
|
+
result = api_instance.workspace_get_file_manifest(org, workspace, id)
|
|
1857
|
+
p result
|
|
1858
|
+
rescue Spatio::ApiError => e
|
|
1859
|
+
puts "Error when calling FilesApi->workspace_get_file_manifest: #{e}"
|
|
1860
|
+
end
|
|
1861
|
+
```
|
|
1862
|
+
|
|
1863
|
+
#### Using the workspace_get_file_manifest_with_http_info variant
|
|
1864
|
+
|
|
1865
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1866
|
+
|
|
1867
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_get_file_manifest_with_http_info(org, workspace, id)
|
|
1868
|
+
|
|
1869
|
+
```ruby
|
|
1870
|
+
begin
|
|
1871
|
+
# Workspace-scoped chunked-file manifest.
|
|
1872
|
+
data, status_code, headers = api_instance.workspace_get_file_manifest_with_http_info(org, workspace, id)
|
|
1873
|
+
p status_code # => 2xx
|
|
1874
|
+
p headers # => { ... }
|
|
1875
|
+
p data # => Hash<String, Object>
|
|
1876
|
+
rescue Spatio::ApiError => e
|
|
1877
|
+
puts "Error when calling FilesApi->workspace_get_file_manifest_with_http_info: #{e}"
|
|
1878
|
+
end
|
|
1879
|
+
```
|
|
1880
|
+
|
|
1881
|
+
### Parameters
|
|
1882
|
+
|
|
1883
|
+
| Name | Type | Description | Notes |
|
|
1884
|
+
| ---- | ---- | ----------- | ----- |
|
|
1885
|
+
| **org** | **String** | | |
|
|
1886
|
+
| **workspace** | **String** | | |
|
|
1887
|
+
| **id** | **String** | | |
|
|
1888
|
+
|
|
1889
|
+
### Return type
|
|
1890
|
+
|
|
1891
|
+
**Hash<String, Object>**
|
|
1892
|
+
|
|
1893
|
+
### Authorization
|
|
1894
|
+
|
|
1895
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1896
|
+
|
|
1897
|
+
### HTTP request headers
|
|
1898
|
+
|
|
1899
|
+
- **Content-Type**: Not defined
|
|
1900
|
+
- **Accept**: application/json
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
## workspace_init_chunked_upload
|
|
1904
|
+
|
|
1905
|
+
> Hash<String, Object> workspace_init_chunked_upload(org, workspace, request_body)
|
|
1906
|
+
|
|
1907
|
+
Workspace-scoped chunked-upload init (RBAC-protected).
|
|
1908
|
+
|
|
1909
|
+
### Examples
|
|
1910
|
+
|
|
1911
|
+
```ruby
|
|
1912
|
+
require 'time'
|
|
1913
|
+
require 'spatio-sdk'
|
|
1914
|
+
# setup authorization
|
|
1915
|
+
Spatio.configure do |config|
|
|
1916
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1917
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1918
|
+
end
|
|
1919
|
+
|
|
1920
|
+
api_instance = Spatio::FilesApi.new
|
|
1921
|
+
org = 'org_example' # String |
|
|
1922
|
+
workspace = 'workspace_example' # String |
|
|
1923
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1924
|
+
|
|
1925
|
+
begin
|
|
1926
|
+
# Workspace-scoped chunked-upload init (RBAC-protected).
|
|
1927
|
+
result = api_instance.workspace_init_chunked_upload(org, workspace, request_body)
|
|
1928
|
+
p result
|
|
1929
|
+
rescue Spatio::ApiError => e
|
|
1930
|
+
puts "Error when calling FilesApi->workspace_init_chunked_upload: #{e}"
|
|
1931
|
+
end
|
|
1932
|
+
```
|
|
1933
|
+
|
|
1934
|
+
#### Using the workspace_init_chunked_upload_with_http_info variant
|
|
1935
|
+
|
|
1936
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1937
|
+
|
|
1938
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_init_chunked_upload_with_http_info(org, workspace, request_body)
|
|
1939
|
+
|
|
1940
|
+
```ruby
|
|
1941
|
+
begin
|
|
1942
|
+
# Workspace-scoped chunked-upload init (RBAC-protected).
|
|
1943
|
+
data, status_code, headers = api_instance.workspace_init_chunked_upload_with_http_info(org, workspace, request_body)
|
|
1944
|
+
p status_code # => 2xx
|
|
1945
|
+
p headers # => { ... }
|
|
1946
|
+
p data # => Hash<String, Object>
|
|
1947
|
+
rescue Spatio::ApiError => e
|
|
1948
|
+
puts "Error when calling FilesApi->workspace_init_chunked_upload_with_http_info: #{e}"
|
|
1949
|
+
end
|
|
1950
|
+
```
|
|
1951
|
+
|
|
1952
|
+
### Parameters
|
|
1953
|
+
|
|
1954
|
+
| Name | Type | Description | Notes |
|
|
1955
|
+
| ---- | ---- | ----------- | ----- |
|
|
1956
|
+
| **org** | **String** | | |
|
|
1957
|
+
| **workspace** | **String** | | |
|
|
1958
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
1959
|
+
|
|
1960
|
+
### Return type
|
|
1961
|
+
|
|
1962
|
+
**Hash<String, Object>**
|
|
1963
|
+
|
|
1964
|
+
### Authorization
|
|
1965
|
+
|
|
1966
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1967
|
+
|
|
1968
|
+
### HTTP request headers
|
|
1969
|
+
|
|
1970
|
+
- **Content-Type**: application/json
|
|
1971
|
+
- **Accept**: application/json
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
## workspace_list_file_folders
|
|
1975
|
+
|
|
1976
|
+
> Hash<String, Object> workspace_list_file_folders(org, workspace)
|
|
1977
|
+
|
|
1978
|
+
Workspace-scoped list-folders (RBAC-protected).
|
|
1979
|
+
|
|
1980
|
+
### Examples
|
|
1981
|
+
|
|
1982
|
+
```ruby
|
|
1983
|
+
require 'time'
|
|
1984
|
+
require 'spatio-sdk'
|
|
1985
|
+
# setup authorization
|
|
1986
|
+
Spatio.configure do |config|
|
|
1987
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
1988
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1989
|
+
end
|
|
1990
|
+
|
|
1991
|
+
api_instance = Spatio::FilesApi.new
|
|
1992
|
+
org = 'org_example' # String |
|
|
1993
|
+
workspace = 'workspace_example' # String |
|
|
1994
|
+
|
|
1995
|
+
begin
|
|
1996
|
+
# Workspace-scoped list-folders (RBAC-protected).
|
|
1997
|
+
result = api_instance.workspace_list_file_folders(org, workspace)
|
|
1998
|
+
p result
|
|
1999
|
+
rescue Spatio::ApiError => e
|
|
2000
|
+
puts "Error when calling FilesApi->workspace_list_file_folders: #{e}"
|
|
2001
|
+
end
|
|
2002
|
+
```
|
|
2003
|
+
|
|
2004
|
+
#### Using the workspace_list_file_folders_with_http_info variant
|
|
2005
|
+
|
|
2006
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2007
|
+
|
|
2008
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_file_folders_with_http_info(org, workspace)
|
|
2009
|
+
|
|
2010
|
+
```ruby
|
|
2011
|
+
begin
|
|
2012
|
+
# Workspace-scoped list-folders (RBAC-protected).
|
|
2013
|
+
data, status_code, headers = api_instance.workspace_list_file_folders_with_http_info(org, workspace)
|
|
2014
|
+
p status_code # => 2xx
|
|
2015
|
+
p headers # => { ... }
|
|
2016
|
+
p data # => Hash<String, Object>
|
|
2017
|
+
rescue Spatio::ApiError => e
|
|
2018
|
+
puts "Error when calling FilesApi->workspace_list_file_folders_with_http_info: #{e}"
|
|
2019
|
+
end
|
|
2020
|
+
```
|
|
2021
|
+
|
|
2022
|
+
### Parameters
|
|
2023
|
+
|
|
2024
|
+
| Name | Type | Description | Notes |
|
|
2025
|
+
| ---- | ---- | ----------- | ----- |
|
|
2026
|
+
| **org** | **String** | | |
|
|
2027
|
+
| **workspace** | **String** | | |
|
|
2028
|
+
|
|
2029
|
+
### Return type
|
|
2030
|
+
|
|
2031
|
+
**Hash<String, Object>**
|
|
2032
|
+
|
|
2033
|
+
### Authorization
|
|
2034
|
+
|
|
2035
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2036
|
+
|
|
2037
|
+
### HTTP request headers
|
|
2038
|
+
|
|
2039
|
+
- **Content-Type**: Not defined
|
|
2040
|
+
- **Accept**: application/json
|
|
2041
|
+
|
|
2042
|
+
|
|
2043
|
+
## workspace_list_files
|
|
2044
|
+
|
|
2045
|
+
> Hash<String, Object> workspace_list_files(org, workspace)
|
|
2046
|
+
|
|
2047
|
+
Workspace-scoped list-files (RBAC-protected).
|
|
2048
|
+
|
|
2049
|
+
### Examples
|
|
2050
|
+
|
|
2051
|
+
```ruby
|
|
2052
|
+
require 'time'
|
|
2053
|
+
require 'spatio-sdk'
|
|
2054
|
+
# setup authorization
|
|
2055
|
+
Spatio.configure do |config|
|
|
2056
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2057
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2058
|
+
end
|
|
2059
|
+
|
|
2060
|
+
api_instance = Spatio::FilesApi.new
|
|
2061
|
+
org = 'org_example' # String |
|
|
2062
|
+
workspace = 'workspace_example' # String |
|
|
2063
|
+
|
|
2064
|
+
begin
|
|
2065
|
+
# Workspace-scoped list-files (RBAC-protected).
|
|
2066
|
+
result = api_instance.workspace_list_files(org, workspace)
|
|
2067
|
+
p result
|
|
2068
|
+
rescue Spatio::ApiError => e
|
|
2069
|
+
puts "Error when calling FilesApi->workspace_list_files: #{e}"
|
|
2070
|
+
end
|
|
2071
|
+
```
|
|
2072
|
+
|
|
2073
|
+
#### Using the workspace_list_files_with_http_info variant
|
|
2074
|
+
|
|
2075
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2076
|
+
|
|
2077
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_list_files_with_http_info(org, workspace)
|
|
2078
|
+
|
|
2079
|
+
```ruby
|
|
2080
|
+
begin
|
|
2081
|
+
# Workspace-scoped list-files (RBAC-protected).
|
|
2082
|
+
data, status_code, headers = api_instance.workspace_list_files_with_http_info(org, workspace)
|
|
2083
|
+
p status_code # => 2xx
|
|
2084
|
+
p headers # => { ... }
|
|
2085
|
+
p data # => Hash<String, Object>
|
|
2086
|
+
rescue Spatio::ApiError => e
|
|
2087
|
+
puts "Error when calling FilesApi->workspace_list_files_with_http_info: #{e}"
|
|
2088
|
+
end
|
|
2089
|
+
```
|
|
2090
|
+
|
|
2091
|
+
### Parameters
|
|
2092
|
+
|
|
2093
|
+
| Name | Type | Description | Notes |
|
|
2094
|
+
| ---- | ---- | ----------- | ----- |
|
|
2095
|
+
| **org** | **String** | | |
|
|
2096
|
+
| **workspace** | **String** | | |
|
|
2097
|
+
|
|
2098
|
+
### Return type
|
|
2099
|
+
|
|
2100
|
+
**Hash<String, Object>**
|
|
2101
|
+
|
|
2102
|
+
### Authorization
|
|
2103
|
+
|
|
2104
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2105
|
+
|
|
2106
|
+
### HTTP request headers
|
|
2107
|
+
|
|
2108
|
+
- **Content-Type**: Not defined
|
|
2109
|
+
- **Accept**: application/json
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
## workspace_move_file
|
|
2113
|
+
|
|
2114
|
+
> Hash<String, Object> workspace_move_file(org, workspace, id, request_body)
|
|
2115
|
+
|
|
2116
|
+
Workspace-scoped move-file.
|
|
2117
|
+
|
|
2118
|
+
### Examples
|
|
2119
|
+
|
|
2120
|
+
```ruby
|
|
2121
|
+
require 'time'
|
|
2122
|
+
require 'spatio-sdk'
|
|
2123
|
+
# setup authorization
|
|
2124
|
+
Spatio.configure do |config|
|
|
2125
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2126
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2127
|
+
end
|
|
2128
|
+
|
|
2129
|
+
api_instance = Spatio::FilesApi.new
|
|
2130
|
+
org = 'org_example' # String |
|
|
2131
|
+
workspace = 'workspace_example' # String |
|
|
2132
|
+
id = 'id_example' # String |
|
|
2133
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2134
|
+
|
|
2135
|
+
begin
|
|
2136
|
+
# Workspace-scoped move-file.
|
|
2137
|
+
result = api_instance.workspace_move_file(org, workspace, id, request_body)
|
|
2138
|
+
p result
|
|
2139
|
+
rescue Spatio::ApiError => e
|
|
2140
|
+
puts "Error when calling FilesApi->workspace_move_file: #{e}"
|
|
2141
|
+
end
|
|
2142
|
+
```
|
|
2143
|
+
|
|
2144
|
+
#### Using the workspace_move_file_with_http_info variant
|
|
2145
|
+
|
|
2146
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2147
|
+
|
|
2148
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_move_file_with_http_info(org, workspace, id, request_body)
|
|
2149
|
+
|
|
2150
|
+
```ruby
|
|
2151
|
+
begin
|
|
2152
|
+
# Workspace-scoped move-file.
|
|
2153
|
+
data, status_code, headers = api_instance.workspace_move_file_with_http_info(org, workspace, id, request_body)
|
|
2154
|
+
p status_code # => 2xx
|
|
2155
|
+
p headers # => { ... }
|
|
2156
|
+
p data # => Hash<String, Object>
|
|
2157
|
+
rescue Spatio::ApiError => e
|
|
2158
|
+
puts "Error when calling FilesApi->workspace_move_file_with_http_info: #{e}"
|
|
2159
|
+
end
|
|
2160
|
+
```
|
|
2161
|
+
|
|
2162
|
+
### Parameters
|
|
2163
|
+
|
|
2164
|
+
| Name | Type | Description | Notes |
|
|
2165
|
+
| ---- | ---- | ----------- | ----- |
|
|
2166
|
+
| **org** | **String** | | |
|
|
2167
|
+
| **workspace** | **String** | | |
|
|
2168
|
+
| **id** | **String** | | |
|
|
2169
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2170
|
+
|
|
2171
|
+
### Return type
|
|
2172
|
+
|
|
2173
|
+
**Hash<String, Object>**
|
|
2174
|
+
|
|
2175
|
+
### Authorization
|
|
2176
|
+
|
|
2177
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2178
|
+
|
|
2179
|
+
### HTTP request headers
|
|
2180
|
+
|
|
2181
|
+
- **Content-Type**: application/json
|
|
2182
|
+
- **Accept**: application/json
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
## workspace_update_file
|
|
2186
|
+
|
|
2187
|
+
> Hash<String, Object> workspace_update_file(org, workspace, id, request_body)
|
|
2188
|
+
|
|
2189
|
+
Workspace-scoped update-file.
|
|
2190
|
+
|
|
2191
|
+
### Examples
|
|
2192
|
+
|
|
2193
|
+
```ruby
|
|
2194
|
+
require 'time'
|
|
2195
|
+
require 'spatio-sdk'
|
|
2196
|
+
# setup authorization
|
|
2197
|
+
Spatio.configure do |config|
|
|
2198
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2199
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2200
|
+
end
|
|
2201
|
+
|
|
2202
|
+
api_instance = Spatio::FilesApi.new
|
|
2203
|
+
org = 'org_example' # String |
|
|
2204
|
+
workspace = 'workspace_example' # String |
|
|
2205
|
+
id = 'id_example' # String |
|
|
2206
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2207
|
+
|
|
2208
|
+
begin
|
|
2209
|
+
# Workspace-scoped update-file.
|
|
2210
|
+
result = api_instance.workspace_update_file(org, workspace, id, request_body)
|
|
2211
|
+
p result
|
|
2212
|
+
rescue Spatio::ApiError => e
|
|
2213
|
+
puts "Error when calling FilesApi->workspace_update_file: #{e}"
|
|
2214
|
+
end
|
|
2215
|
+
```
|
|
2216
|
+
|
|
2217
|
+
#### Using the workspace_update_file_with_http_info variant
|
|
2218
|
+
|
|
2219
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2220
|
+
|
|
2221
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_update_file_with_http_info(org, workspace, id, request_body)
|
|
2222
|
+
|
|
2223
|
+
```ruby
|
|
2224
|
+
begin
|
|
2225
|
+
# Workspace-scoped update-file.
|
|
2226
|
+
data, status_code, headers = api_instance.workspace_update_file_with_http_info(org, workspace, id, request_body)
|
|
2227
|
+
p status_code # => 2xx
|
|
2228
|
+
p headers # => { ... }
|
|
2229
|
+
p data # => Hash<String, Object>
|
|
2230
|
+
rescue Spatio::ApiError => e
|
|
2231
|
+
puts "Error when calling FilesApi->workspace_update_file_with_http_info: #{e}"
|
|
2232
|
+
end
|
|
2233
|
+
```
|
|
2234
|
+
|
|
2235
|
+
### Parameters
|
|
2236
|
+
|
|
2237
|
+
| Name | Type | Description | Notes |
|
|
2238
|
+
| ---- | ---- | ----------- | ----- |
|
|
2239
|
+
| **org** | **String** | | |
|
|
2240
|
+
| **workspace** | **String** | | |
|
|
2241
|
+
| **id** | **String** | | |
|
|
2242
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2243
|
+
|
|
2244
|
+
### Return type
|
|
2245
|
+
|
|
2246
|
+
**Hash<String, Object>**
|
|
2247
|
+
|
|
2248
|
+
### Authorization
|
|
2249
|
+
|
|
2250
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2251
|
+
|
|
2252
|
+
### HTTP request headers
|
|
2253
|
+
|
|
2254
|
+
- **Content-Type**: application/json
|
|
2255
|
+
- **Accept**: application/json
|
|
2256
|
+
|
|
2257
|
+
|
|
2258
|
+
## workspace_upload_chunked_block
|
|
2259
|
+
|
|
2260
|
+
> Hash<String, Object> workspace_upload_chunked_block(org, workspace, body)
|
|
2261
|
+
|
|
2262
|
+
Workspace-scoped chunked-upload block (RBAC-protected).
|
|
2263
|
+
|
|
2264
|
+
### Examples
|
|
2265
|
+
|
|
2266
|
+
```ruby
|
|
2267
|
+
require 'time'
|
|
2268
|
+
require 'spatio-sdk'
|
|
2269
|
+
# setup authorization
|
|
2270
|
+
Spatio.configure do |config|
|
|
2271
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2272
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2273
|
+
end
|
|
2274
|
+
|
|
2275
|
+
api_instance = Spatio::FilesApi.new
|
|
2276
|
+
org = 'org_example' # String |
|
|
2277
|
+
workspace = 'workspace_example' # String |
|
|
2278
|
+
body = File.new('/path/to/some/file') # File |
|
|
2279
|
+
|
|
2280
|
+
begin
|
|
2281
|
+
# Workspace-scoped chunked-upload block (RBAC-protected).
|
|
2282
|
+
result = api_instance.workspace_upload_chunked_block(org, workspace, body)
|
|
2283
|
+
p result
|
|
2284
|
+
rescue Spatio::ApiError => e
|
|
2285
|
+
puts "Error when calling FilesApi->workspace_upload_chunked_block: #{e}"
|
|
2286
|
+
end
|
|
2287
|
+
```
|
|
2288
|
+
|
|
2289
|
+
#### Using the workspace_upload_chunked_block_with_http_info variant
|
|
2290
|
+
|
|
2291
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2292
|
+
|
|
2293
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_upload_chunked_block_with_http_info(org, workspace, body)
|
|
2294
|
+
|
|
2295
|
+
```ruby
|
|
2296
|
+
begin
|
|
2297
|
+
# Workspace-scoped chunked-upload block (RBAC-protected).
|
|
2298
|
+
data, status_code, headers = api_instance.workspace_upload_chunked_block_with_http_info(org, workspace, body)
|
|
2299
|
+
p status_code # => 2xx
|
|
2300
|
+
p headers # => { ... }
|
|
2301
|
+
p data # => Hash<String, Object>
|
|
2302
|
+
rescue Spatio::ApiError => e
|
|
2303
|
+
puts "Error when calling FilesApi->workspace_upload_chunked_block_with_http_info: #{e}"
|
|
2304
|
+
end
|
|
2305
|
+
```
|
|
2306
|
+
|
|
2307
|
+
### Parameters
|
|
2308
|
+
|
|
2309
|
+
| Name | Type | Description | Notes |
|
|
2310
|
+
| ---- | ---- | ----------- | ----- |
|
|
2311
|
+
| **org** | **String** | | |
|
|
2312
|
+
| **workspace** | **String** | | |
|
|
2313
|
+
| **body** | **File** | | |
|
|
2314
|
+
|
|
2315
|
+
### Return type
|
|
2316
|
+
|
|
2317
|
+
**Hash<String, Object>**
|
|
2318
|
+
|
|
2319
|
+
### Authorization
|
|
2320
|
+
|
|
2321
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2322
|
+
|
|
2323
|
+
### HTTP request headers
|
|
2324
|
+
|
|
2325
|
+
- **Content-Type**: application/octet-stream
|
|
2326
|
+
- **Accept**: application/json
|
|
2327
|
+
|
|
2328
|
+
|
|
2329
|
+
## workspace_upload_file
|
|
2330
|
+
|
|
2331
|
+
> Hash<String, Object> workspace_upload_file(org, workspace, opts)
|
|
2332
|
+
|
|
2333
|
+
Workspace-scoped multipart upload (RBAC-protected).
|
|
2334
|
+
|
|
2335
|
+
### Examples
|
|
2336
|
+
|
|
2337
|
+
```ruby
|
|
2338
|
+
require 'time'
|
|
2339
|
+
require 'spatio-sdk'
|
|
2340
|
+
# setup authorization
|
|
2341
|
+
Spatio.configure do |config|
|
|
2342
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2343
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2344
|
+
end
|
|
2345
|
+
|
|
2346
|
+
api_instance = Spatio::FilesApi.new
|
|
2347
|
+
org = 'org_example' # String |
|
|
2348
|
+
workspace = 'workspace_example' # String |
|
|
2349
|
+
opts = {
|
|
2350
|
+
file: File.new('/path/to/some/file') # File |
|
|
2351
|
+
}
|
|
2352
|
+
|
|
2353
|
+
begin
|
|
2354
|
+
# Workspace-scoped multipart upload (RBAC-protected).
|
|
2355
|
+
result = api_instance.workspace_upload_file(org, workspace, opts)
|
|
2356
|
+
p result
|
|
2357
|
+
rescue Spatio::ApiError => e
|
|
2358
|
+
puts "Error when calling FilesApi->workspace_upload_file: #{e}"
|
|
2359
|
+
end
|
|
2360
|
+
```
|
|
2361
|
+
|
|
2362
|
+
#### Using the workspace_upload_file_with_http_info variant
|
|
2363
|
+
|
|
2364
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2365
|
+
|
|
2366
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_upload_file_with_http_info(org, workspace, opts)
|
|
2367
|
+
|
|
2368
|
+
```ruby
|
|
2369
|
+
begin
|
|
2370
|
+
# Workspace-scoped multipart upload (RBAC-protected).
|
|
2371
|
+
data, status_code, headers = api_instance.workspace_upload_file_with_http_info(org, workspace, opts)
|
|
2372
|
+
p status_code # => 2xx
|
|
2373
|
+
p headers # => { ... }
|
|
2374
|
+
p data # => Hash<String, Object>
|
|
2375
|
+
rescue Spatio::ApiError => e
|
|
2376
|
+
puts "Error when calling FilesApi->workspace_upload_file_with_http_info: #{e}"
|
|
2377
|
+
end
|
|
2378
|
+
```
|
|
2379
|
+
|
|
2380
|
+
### Parameters
|
|
2381
|
+
|
|
2382
|
+
| Name | Type | Description | Notes |
|
|
2383
|
+
| ---- | ---- | ----------- | ----- |
|
|
2384
|
+
| **org** | **String** | | |
|
|
2385
|
+
| **workspace** | **String** | | |
|
|
2386
|
+
| **file** | **File** | | [optional] |
|
|
2387
|
+
|
|
2388
|
+
### Return type
|
|
2389
|
+
|
|
2390
|
+
**Hash<String, Object>**
|
|
2391
|
+
|
|
2392
|
+
### Authorization
|
|
2393
|
+
|
|
2394
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2395
|
+
|
|
2396
|
+
### HTTP request headers
|
|
2397
|
+
|
|
2398
|
+
- **Content-Type**: multipart/form-data
|
|
2399
|
+
- **Accept**: application/json
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
## workspace_upload_file_base64
|
|
2403
|
+
|
|
2404
|
+
> Hash<String, Object> workspace_upload_file_base64(org, workspace, request_body)
|
|
2405
|
+
|
|
2406
|
+
Workspace-scoped base64 upload (RBAC-protected).
|
|
2407
|
+
|
|
2408
|
+
### Examples
|
|
2409
|
+
|
|
2410
|
+
```ruby
|
|
2411
|
+
require 'time'
|
|
2412
|
+
require 'spatio-sdk'
|
|
2413
|
+
# setup authorization
|
|
2414
|
+
Spatio.configure do |config|
|
|
2415
|
+
# Configure Bearer authorization (Personal Access Token (pat_...)): bearerAuth
|
|
2416
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2417
|
+
end
|
|
2418
|
+
|
|
2419
|
+
api_instance = Spatio::FilesApi.new
|
|
2420
|
+
org = 'org_example' # String |
|
|
2421
|
+
workspace = 'workspace_example' # String |
|
|
2422
|
+
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2423
|
+
|
|
2424
|
+
begin
|
|
2425
|
+
# Workspace-scoped base64 upload (RBAC-protected).
|
|
2426
|
+
result = api_instance.workspace_upload_file_base64(org, workspace, request_body)
|
|
2427
|
+
p result
|
|
2428
|
+
rescue Spatio::ApiError => e
|
|
2429
|
+
puts "Error when calling FilesApi->workspace_upload_file_base64: #{e}"
|
|
2430
|
+
end
|
|
2431
|
+
```
|
|
2432
|
+
|
|
2433
|
+
#### Using the workspace_upload_file_base64_with_http_info variant
|
|
2434
|
+
|
|
2435
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2436
|
+
|
|
2437
|
+
> <Array(Hash<String, Object>, Integer, Hash)> workspace_upload_file_base64_with_http_info(org, workspace, request_body)
|
|
2438
|
+
|
|
2439
|
+
```ruby
|
|
2440
|
+
begin
|
|
2441
|
+
# Workspace-scoped base64 upload (RBAC-protected).
|
|
2442
|
+
data, status_code, headers = api_instance.workspace_upload_file_base64_with_http_info(org, workspace, request_body)
|
|
2443
|
+
p status_code # => 2xx
|
|
2444
|
+
p headers # => { ... }
|
|
2445
|
+
p data # => Hash<String, Object>
|
|
2446
|
+
rescue Spatio::ApiError => e
|
|
2447
|
+
puts "Error when calling FilesApi->workspace_upload_file_base64_with_http_info: #{e}"
|
|
2448
|
+
end
|
|
2449
|
+
```
|
|
2450
|
+
|
|
2451
|
+
### Parameters
|
|
2452
|
+
|
|
2453
|
+
| Name | Type | Description | Notes |
|
|
2454
|
+
| ---- | ---- | ----------- | ----- |
|
|
2455
|
+
| **org** | **String** | | |
|
|
2456
|
+
| **workspace** | **String** | | |
|
|
2457
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2458
|
+
|
|
2459
|
+
### Return type
|
|
2460
|
+
|
|
2461
|
+
**Hash<String, Object>**
|
|
2462
|
+
|
|
2463
|
+
### Authorization
|
|
2464
|
+
|
|
2465
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2466
|
+
|
|
2467
|
+
### HTTP request headers
|
|
2468
|
+
|
|
2469
|
+
- **Content-Type**: application/json
|
|
2470
|
+
- **Accept**: application/json
|
|
2471
|
+
|