@octostar/platform-types 0.5.34 → 0.5.35

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.
Files changed (285) hide show
  1. package/dist/docs/enums/ProcessingStatusCode.html +16 -16
  2. package/dist/docs/enums/SortOrder.html +3 -3
  3. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  4. package/dist/docs/functions/isWorkspaceFileItem.html +1 -1
  5. package/dist/docs/hierarchy.html +1 -1
  6. package/dist/docs/index.html +2 -2
  7. package/dist/docs/interfaces/AIClient.html +4 -4
  8. package/dist/docs/interfaces/ActionContext.html +4 -4
  9. package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
  10. package/dist/docs/interfaces/ChartDataResponseResult.html +5 -5
  11. package/dist/docs/interfaces/ChatMessage.html +6 -6
  12. package/dist/docs/interfaces/Colorful.html +3 -3
  13. package/dist/docs/interfaces/Concept.html +12 -12
  14. package/dist/docs/interfaces/DeleteResponse.html +2 -2
  15. package/dist/docs/interfaces/Desktop.html +101 -101
  16. package/dist/docs/interfaces/DesktopActionContext.html +7 -7
  17. package/dist/docs/interfaces/DesktopSettings.html +6 -6
  18. package/dist/docs/interfaces/DeveloperSettings.html +4 -4
  19. package/dist/docs/interfaces/DownloadOptions.html +2 -2
  20. package/dist/docs/interfaces/EntityUiState.html +2 -2
  21. package/dist/docs/interfaces/FetchOptions.html +4 -4
  22. package/dist/docs/interfaces/FileListResponse.html +2 -2
  23. package/dist/docs/interfaces/FilesAPIClient.html +12 -12
  24. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  25. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  26. package/dist/docs/interfaces/IndexSearchHitSource.html +3 -3
  27. package/dist/docs/interfaces/Inheritance.html +5 -5
  28. package/dist/docs/interfaces/LiveContext.html +11 -11
  29. package/dist/docs/interfaces/MoveOptions.html +2 -2
  30. package/dist/docs/interfaces/MoveResponse.html +27 -27
  31. package/dist/docs/interfaces/NativeFilterColumn.html +2 -2
  32. package/dist/docs/interfaces/NativeFilterScope.html +2 -2
  33. package/dist/docs/interfaces/NativeFilterTarget.html +2 -2
  34. package/dist/docs/interfaces/Ontology.html +25 -25
  35. package/dist/docs/interfaces/OsAPIClient.html +8 -8
  36. package/dist/docs/interfaces/ProcessingStatus.html +7 -7
  37. package/dist/docs/interfaces/Property.html +5 -5
  38. package/dist/docs/interfaces/RecordData.html +5 -5
  39. package/dist/docs/interfaces/RecordProvider.html +6 -6
  40. package/dist/docs/interfaces/RefObject.html +3 -3
  41. package/dist/docs/interfaces/Relationship.html +20 -20
  42. package/dist/docs/interfaces/S3Headers.html +2 -2
  43. package/dist/docs/interfaces/S3UploadResponse.html +2 -2
  44. package/dist/docs/interfaces/SavedDatasource.html +2 -2
  45. package/dist/docs/interfaces/SavedSearchAPIInterface.html +2 -2
  46. package/dist/docs/interfaces/SavedSearchContent.html +2 -2
  47. package/dist/docs/interfaces/SavedSetContent.html +2 -2
  48. package/dist/docs/interfaces/SearchOptions.html +3 -3
  49. package/dist/docs/interfaces/SearchProps.html +10 -10
  50. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  51. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  52. package/dist/docs/interfaces/SemanticBindingProps.html +5 -5
  53. package/dist/docs/interfaces/StreamJsonOptions.html +5 -5
  54. package/dist/docs/interfaces/StreamTextOptions.html +5 -5
  55. package/dist/docs/interfaces/StylerContext.html +11 -11
  56. package/dist/docs/interfaces/TagAttributes.html +7 -7
  57. package/dist/docs/interfaces/UiStateManager.html +2 -2
  58. package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
  59. package/dist/docs/interfaces/UnzipOptions.html +2 -2
  60. package/dist/docs/interfaces/UploadOptions.html +2 -2
  61. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +5 -5
  62. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  63. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  64. package/dist/docs/modules.html +2 -2
  65. package/dist/docs/types/ActionHandler.html +2 -2
  66. package/dist/docs/types/AddCommentParams.html +2 -2
  67. package/dist/docs/types/AddListener.html +2 -2
  68. package/dist/docs/types/ApiErrorResult.html +2 -2
  69. package/dist/docs/types/ApiResult.html +2 -2
  70. package/dist/docs/types/ApiSuccessResult.html +2 -2
  71. package/dist/docs/types/App.html +2 -2
  72. package/dist/docs/types/AppRegistry.html +2 -2
  73. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  74. package/dist/docs/types/AppServiceCallProps.html +2 -2
  75. package/dist/docs/types/AsyncFilter.html +2 -2
  76. package/dist/docs/types/AttachmentResponseType.html +2 -2
  77. package/dist/docs/types/AttachmentType.html +2 -2
  78. package/dist/docs/types/Behaviour.html +2 -2
  79. package/dist/docs/types/BinaryOperator.html +2 -2
  80. package/dist/docs/types/Callback.html +2 -2
  81. package/dist/docs/types/ChatApiResponse.html +1 -1
  82. package/dist/docs/types/ChatModel.html +2 -2
  83. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  84. package/dist/docs/types/CommonOptions.html +1 -1
  85. package/dist/docs/types/Comparator.html +2 -2
  86. package/dist/docs/types/ConceptFilter.html +2 -2
  87. package/dist/docs/types/ConceptMap.html +2 -2
  88. package/dist/docs/types/ConceptName.html +1 -1
  89. package/dist/docs/types/ConceptWithParents.html +2 -2
  90. package/dist/docs/types/ConnectedEntity.html +2 -2
  91. package/dist/docs/types/ContextMenuGroup.html +2 -2
  92. package/dist/docs/types/ContextMenuLabels.html +2 -2
  93. package/dist/docs/types/ContextMenuOptions.html +2 -2
  94. package/dist/docs/types/ContextMenuParams.html +2 -2
  95. package/dist/docs/types/ContextMenuRequest.html +2 -2
  96. package/dist/docs/types/CopyOptions.html +2 -2
  97. package/dist/docs/types/CreateEntityFormProps.html +2 -2
  98. package/dist/docs/types/CreateLinkChartFn.html +1 -1
  99. package/dist/docs/types/CreateLinkChartParams.html +1 -1
  100. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  101. package/dist/docs/types/CustomEventListener.html +2 -2
  102. package/dist/docs/types/CustomTemplate.html +2 -2
  103. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  104. package/dist/docs/types/DataContextType.html +2 -2
  105. package/dist/docs/types/DataMask.html +1 -1
  106. package/dist/docs/types/DefaultLiveContextData.html +1 -1
  107. package/dist/docs/types/DesktopAction.html +2 -2
  108. package/dist/docs/types/DesktopActionFilter.html +2 -2
  109. package/dist/docs/types/DesktopActionMenuItem.html +2 -2
  110. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  111. package/dist/docs/types/DesktopActionOptions.html +2 -2
  112. package/dist/docs/types/DesktopOpenParams.html +2 -2
  113. package/dist/docs/types/DesktopStylerContext.html +2 -2
  114. package/dist/docs/types/DraftWorkspaceItem.html +2 -2
  115. package/dist/docs/types/DragEndParams.html +2 -2
  116. package/dist/docs/types/DragStartParams.html +2 -2
  117. package/dist/docs/types/DropZoneRequestFn.html +1 -1
  118. package/dist/docs/types/DropZoneRequestResult.html +1 -1
  119. package/dist/docs/types/EConnection.html +2 -2
  120. package/dist/docs/types/EdgeSpec.html +2 -2
  121. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  122. package/dist/docs/types/Entity.html +2 -2
  123. package/dist/docs/types/EntityBase.html +2 -2
  124. package/dist/docs/types/EntityEdge.html +2 -2
  125. package/dist/docs/types/EntityOTM.html +2 -2
  126. package/dist/docs/types/EntityPasteContext.html +2 -2
  127. package/dist/docs/types/EvalContext.html +1 -1
  128. package/dist/docs/types/EventContextType.html +2 -2
  129. package/dist/docs/types/EventEmitterType.html +2 -2
  130. package/dist/docs/types/EventName.html +2 -2
  131. package/dist/docs/types/EventProducer.html +2 -2
  132. package/dist/docs/types/EventPublisher.html +2 -2
  133. package/dist/docs/types/EventSubscriber.html +2 -2
  134. package/dist/docs/types/EventUnsubscriber.html +2 -2
  135. package/dist/docs/types/ExportOptions.html +2 -2
  136. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  137. package/dist/docs/types/ExtrasApi.html +1 -1
  138. package/dist/docs/types/FetchEntityOptions.html +2 -2
  139. package/dist/docs/types/FileCode.html +2 -2
  140. package/dist/docs/types/FileTreeOptions.html +2 -2
  141. package/dist/docs/types/Filter.html +1 -1
  142. package/dist/docs/types/FilterDefinition.html +2 -2
  143. package/dist/docs/types/FilterDefinitions.html +2 -2
  144. package/dist/docs/types/FilterName.html +2 -2
  145. package/dist/docs/types/FilterQuery.html +2 -2
  146. package/dist/docs/types/FilterReference.html +2 -2
  147. package/dist/docs/types/FilterState.html +1 -1
  148. package/dist/docs/types/FilterValue.html +2 -2
  149. package/dist/docs/types/FocusListItem.html +2 -2
  150. package/dist/docs/types/FolderPasteOptions.html +2 -2
  151. package/dist/docs/types/GetSystemSettingResponse.html +1 -1
  152. package/dist/docs/types/GraphDataSpec.html +1 -1
  153. package/dist/docs/types/GraphSpec.html +2 -2
  154. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  155. package/dist/docs/types/Icon.html +2 -2
  156. package/dist/docs/types/IconProps.html +2 -2
  157. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  158. package/dist/docs/types/ImageInfo.html +2 -2
  159. package/dist/docs/types/ImportZipOptions.html +2 -2
  160. package/dist/docs/types/InlineCode.html +2 -2
  161. package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
  162. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  163. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  164. package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
  165. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  166. package/dist/docs/types/JavascriptType.html +2 -2
  167. package/dist/docs/types/JobManifest.html +2 -2
  168. package/dist/docs/types/KnownCounts.html +2 -2
  169. package/dist/docs/types/ListByParentFolder.html +1 -1
  170. package/dist/docs/types/ListByPath.html +1 -1
  171. package/dist/docs/types/ListFolderOptions.html +1 -1
  172. package/dist/docs/types/LiveContextAPISetParams.html +1 -1
  173. package/dist/docs/types/LiveContextListener.html +1 -1
  174. package/dist/docs/types/ManifestSecrets.html +1 -1
  175. package/dist/docs/types/MkdirResponse.html +1 -1
  176. package/dist/docs/types/ModalTemplateProps.html +2 -2
  177. package/dist/docs/types/NamedEntityGroup.html +2 -2
  178. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  179. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  180. package/dist/docs/types/NunjucksType.html +2 -2
  181. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  182. package/dist/docs/types/OntologyTags.html +2 -2
  183. package/dist/docs/types/OsAuditFields.html +2 -2
  184. package/dist/docs/types/OsConfirmProps.html +2 -2
  185. package/dist/docs/types/OsNotification.html +2 -2
  186. package/dist/docs/types/OsProgress.html +2 -2
  187. package/dist/docs/types/OsTag.html +2 -2
  188. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  189. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  190. package/dist/docs/types/PasteContextOptions.html +2 -2
  191. package/dist/docs/types/Permission.html +2 -2
  192. package/dist/docs/types/Point.html +2 -2
  193. package/dist/docs/types/PromptOptions.html +2 -2
  194. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  195. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  196. package/dist/docs/types/Query.html +2 -2
  197. package/dist/docs/types/QueryBatchResult.html +2 -2
  198. package/dist/docs/types/QueryErrorResult.html +2 -2
  199. package/dist/docs/types/QueryExecutor.html +2 -2
  200. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  201. package/dist/docs/types/QueryResponse.html +2 -2
  202. package/dist/docs/types/QueryResult.html +2 -2
  203. package/dist/docs/types/QuerySuccessResult.html +2 -2
  204. package/dist/docs/types/ReactCssProperties.html +2 -2
  205. package/dist/docs/types/ReactNode.html +2 -2
  206. package/dist/docs/types/ReactRef.html +2 -2
  207. package/dist/docs/types/ReasonedBoolean.html +2 -2
  208. package/dist/docs/types/RecordFetchOptions.html +1 -1
  209. package/dist/docs/types/RefCallback.html +2 -2
  210. package/dist/docs/types/RelationshipCountResult.html +2 -2
  211. package/dist/docs/types/RemoteAppApi.html +1 -1
  212. package/dist/docs/types/RenameTabProps.html +2 -2
  213. package/dist/docs/types/SaveAsModalProps.html +2 -2
  214. package/dist/docs/types/SaveFileOptions.html +2 -2
  215. package/dist/docs/types/SaveOptions.html +2 -2
  216. package/dist/docs/types/SavedTemplate.html +2 -2
  217. package/dist/docs/types/SearchFilter.html +2 -2
  218. package/dist/docs/types/SemanticBinding.html +2 -2
  219. package/dist/docs/types/SemanticBindingType.html +2 -2
  220. package/dist/docs/types/SemanticBindings.html +2 -2
  221. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  222. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  223. package/dist/docs/types/SendQueryOptions.html +2 -2
  224. package/dist/docs/types/ServiceDefinition.html +2 -2
  225. package/dist/docs/types/ServiceDefinitions.html +2 -2
  226. package/dist/docs/types/ServiceRole.html +2 -2
  227. package/dist/docs/types/SetTransformResultFn.html +1 -1
  228. package/dist/docs/types/SetsOptions.html +2 -2
  229. package/dist/docs/types/ShowOntology.html +2 -2
  230. package/dist/docs/types/ShowTabProps.html +2 -2
  231. package/dist/docs/types/Styler.html +2 -2
  232. package/dist/docs/types/StylerConfig.html +2 -2
  233. package/dist/docs/types/StylerDefinition.html +2 -2
  234. package/dist/docs/types/StylerDefinitions.html +2 -2
  235. package/dist/docs/types/StylerOption.html +2 -2
  236. package/dist/docs/types/StylerProducer.html +2 -2
  237. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  238. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  239. package/dist/docs/types/Tag.html +2 -2
  240. package/dist/docs/types/TagInfo.html +2 -2
  241. package/dist/docs/types/TagWithRelationship.html +2 -2
  242. package/dist/docs/types/TaskCleanupReason.html +2 -2
  243. package/dist/docs/types/TemplateMetadata.html +2 -2
  244. package/dist/docs/types/TemplateType.html +2 -2
  245. package/dist/docs/types/TemplateVariant.html +2 -2
  246. package/dist/docs/types/TransformAction.html +2 -2
  247. package/dist/docs/types/TransformActionContext.html +2 -2
  248. package/dist/docs/types/TransformDefinition.html +2 -2
  249. package/dist/docs/types/TransformDefinitions.html +2 -2
  250. package/dist/docs/types/Unsubscribe.html +2 -2
  251. package/dist/docs/types/UnsubscribeFn.html +1 -1
  252. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  253. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  254. package/dist/docs/types/UserProfile.html +2 -2
  255. package/dist/docs/types/VirtualEntity.html +2 -2
  256. package/dist/docs/types/Watcher.html +2 -2
  257. package/dist/docs/types/Whoami.html +2 -2
  258. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  259. package/dist/docs/types/Workspace.html +2 -2
  260. package/dist/docs/types/WorkspaceConfig.html +2 -2
  261. package/dist/docs/types/WorkspaceFlags.html +2 -2
  262. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  263. package/dist/docs/types/WorkspaceItem.html +2 -2
  264. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  265. package/dist/docs/types/WorkspaceItemDocumentFields.html +1 -1
  266. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  267. package/dist/docs/types/WorkspaceItemModel.html +2 -2
  268. package/dist/docs/types/WorkspaceItemTitleProps.html +2 -2
  269. package/dist/docs/types/WorkspaceItems.html +2 -2
  270. package/dist/docs/types/WorkspacePermission.html +2 -2
  271. package/dist/docs/types/WorkspaceRecord.html +2 -2
  272. package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
  273. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  274. package/dist/docs/types/WorkspaceRecords.html +2 -2
  275. package/dist/docs/types/WorkspaceRelationship.html +2 -2
  276. package/dist/docs/types/WorkspaceSettings.html +2 -2
  277. package/dist/docs/types/trigger.html +2 -2
  278. package/dist/docs/types/uuid.html +2 -2
  279. package/dist/docs/variables/ORIGINAL_OS_PARENT_FOLDER.html +1 -1
  280. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  281. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  282. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  283. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -1
  284. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -1
  285. package/package.json +1 -1
package/dist/docs/interfaces/FilesAPIClient.html CHANGED
@@ -1,5 +1,5 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FilesAPIClient | @octostar/platform-types - v0.5.34</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.34</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="FilesAPIClient.html">FilesAPIClient</a></li></ul><h1>Interface FilesAPIClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Files service for interacting with the file system</p>
2
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FilesAPIClient</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#createFile">createFile</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#deleteFile">deleteFile</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#deleteRecursive">deleteRecursive</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#getDownloadUrl">getDownloadUrl</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="DownloadOptions.html" class="tsd-signature-type tsd-kind-interface">DownloadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#getUploadUrl">getUploadUrl</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">entity_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="UploadOptions.html" class="tsd-signature-type tsd-kind-interface">UploadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="S3UploadResponse.html" class="tsd-signature-type tsd-kind-interface">S3UploadResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#listFolder">listFolder</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/ListFolderOptions.html" class="tsd-signature-type tsd-kind-type-alias">ListFolderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#mkdir">mkdir</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#moveOrRename">moveOrRename</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="MoveOptions.html" class="tsd-signature-type tsd-kind-interface">MoveOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="MoveResponse.html" class="tsd-signature-type tsd-kind-interface">MoveResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#stat">stat</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#unzipByEntity">unzipByEntity</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">entity_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="UnzipOptions.html" class="tsd-signature-type tsd-kind-interface">UnzipOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">status_url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">tracking_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L100">files.ts:100</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FilesAPIClient.html#createFile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>File</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FilesAPIClient | @octostar/platform-types - v0.5.35</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.35</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="FilesAPIClient.html">FilesAPIClient</a></li></ul><h1>Interface FilesAPIClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Files service for interacting with the file system</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FilesAPIClient</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#createFile">createFile</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#deleteFile">deleteFile</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#deleteRecursive">deleteRecursive</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#getDownloadUrl">getDownloadUrl</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="DownloadOptions.html" class="tsd-signature-type tsd-kind-interface">DownloadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#getUploadUrl">getUploadUrl</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">entity_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="UploadOptions.html" class="tsd-signature-type tsd-kind-interface">UploadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="S3UploadResponse.html" class="tsd-signature-type tsd-kind-interface">S3UploadResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#listFolder">listFolder</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/ListFolderOptions.html" class="tsd-signature-type tsd-kind-type-alias">ListFolderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#mkdir">mkdir</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#moveOrRename">moveOrRename</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="MoveOptions.html" class="tsd-signature-type tsd-kind-interface">MoveOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="MoveResponse.html" class="tsd-signature-type tsd-kind-interface">MoveResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#stat">stat</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="FilesAPIClient.html#unzipByEntity">unzipByEntity</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">entity_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="UnzipOptions.html" class="tsd-signature-type tsd-kind-interface">UnzipOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">status_url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">tracking_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L100">files.ts:100</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FilesAPIClient.html#createFile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>File</span></a>
3
3
  <a href="FilesAPIClient.html#deleteFile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>File</span></a>
4
4
  <a href="FilesAPIClient.html#deleteRecursive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Recursive</span></a>
5
5
  <a href="FilesAPIClient.html#getDownloadUrl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Download<wbr/>Url</span></a>
@@ -12,24 +12,24 @@
12
12
  </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="createFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>File</span><a href="#createFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">create<wbr/>File</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Create a new file</p>
13
13
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createFile.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">item</span>: <a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a></span><div class="tsd-comment tsd-typography"><p>The file item to create</p>
14
14
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The created entity</p>
15
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L175">files.ts:175</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="deleteFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>File</span><a href="#deleteFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">delete<wbr/>File</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Delete a file or directory</p>
15
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L175">files.ts:175</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="deleteFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>File</span><a href="#deleteFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">delete<wbr/>File</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Delete a file or directory</p>
16
16
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="deleteFile.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
17
17
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to delete</p>
18
18
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The deleted entity</p>
19
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L159">files.ts:159</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="deleteRecursive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Recursive</span><a href="#deleteRecursive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">delete<wbr/>Recursive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Delete a file or directory recursively</p>
19
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L159">files.ts:159</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="deleteRecursive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Recursive</span><a href="#deleteRecursive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">delete<wbr/>Recursive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Delete a file or directory recursively</p>
20
20
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="deleteRecursive.__type-4.__type-5"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
21
21
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to delete</p>
22
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L167">files.ts:167</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getDownloadUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Download<wbr/>Url</span><a href="#getDownloadUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Download<wbr/>Url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="DownloadOptions.html" class="tsd-signature-type tsd-kind-interface">DownloadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Get a download URL for a file</p>
22
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L167">files.ts:167</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getDownloadUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Download<wbr/>Url</span><a href="#getDownloadUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Download<wbr/>Url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="DownloadOptions.html" class="tsd-signature-type tsd-kind-interface">DownloadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Get a download URL for a file</p>
23
23
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getDownloadUrl.__type-6.__type-7"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
24
24
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to get the download URL for</p>
25
25
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="DownloadOptions.html" class="tsd-signature-type tsd-kind-interface">DownloadOptions</a></span><div class="tsd-comment tsd-typography"><p>Optional parameters for the download</p>
26
26
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The download URL</p>
27
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L185">files.ts:185</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getUploadUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Upload<wbr/>Url</span><a href="#getUploadUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Upload<wbr/>Url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">entity_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="UploadOptions.html" class="tsd-signature-type tsd-kind-interface">UploadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="S3UploadResponse.html" class="tsd-signature-type tsd-kind-interface">S3UploadResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Get an upload URL for a file</p>
27
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L185">files.ts:185</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getUploadUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Upload<wbr/>Url</span><a href="#getUploadUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Upload<wbr/>Url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">entity_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="UploadOptions.html" class="tsd-signature-type tsd-kind-interface">UploadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="S3UploadResponse.html" class="tsd-signature-type tsd-kind-interface">S3UploadResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Get an upload URL for a file</p>
28
28
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getUploadUrl.__type-8.__type-9"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">entity_id</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="S3UploadResponse.html" class="tsd-signature-type tsd-kind-interface">S3UploadResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
29
29
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">entity_id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The entity ID</p>
30
30
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="UploadOptions.html" class="tsd-signature-type tsd-kind-interface">UploadOptions</a></span><div class="tsd-comment tsd-typography"><p>Upload options including content_type and optional TTL in minutes</p>
31
31
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="S3UploadResponse.html" class="tsd-signature-type tsd-kind-interface">S3UploadResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The upload URL and fields</p>
32
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L209">files.ts:209</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="listFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Folder</span><a href="#listFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">list<wbr/>Folder</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/ListFolderOptions.html" class="tsd-signature-type tsd-kind-type-alias">ListFolderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Main entry point for listing workspace or folder contents
32
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L209">files.ts:209</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="listFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Folder</span><a href="#listFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">list<wbr/>Folder</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/ListFolderOptions.html" class="tsd-signature-type tsd-kind-type-alias">ListFolderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Main entry point for listing workspace or folder contents
33
33
  Supports listing by path, parent folder ID, or root level</p>
34
34
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="listFolder.__type-10.__type-11"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace identifier</p>
35
35
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/ListFolderOptions.html" class="tsd-signature-type tsd-kind-type-alias">ListFolderOptions</a></span><div class="tsd-comment tsd-typography"><p>Configuration object that determines listing strategy:
@@ -37,9 +37,9 @@ Supports listing by path, parent folder ID, or root level</p>
37
37
  - If options.os_parent_folder is provided, lists contents of that folder
38
38
  - If neither is provided, lists root level contents</p>
39
39
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Paginated list of files and folders</p>
40
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L121">files.ts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mkdir" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mkdir</span><a href="#mkdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mkdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Create a new directory</p>
40
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L121">files.ts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mkdir" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mkdir</span><a href="#mkdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mkdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Create a new directory</p>
41
41
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="mkdir.__type-12.__type-13"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">item</span>: <a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MkdirResponse.html" class="tsd-signature-type tsd-kind-type-alias">MkdirResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The created entity</p>
42
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L150">files.ts:150</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="moveOrRename" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>move<wbr/>Or<wbr/>Rename</span><a href="#moveOrRename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">move<wbr/>Or<wbr/>Rename</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="MoveOptions.html" class="tsd-signature-type tsd-kind-interface">MoveOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="MoveResponse.html" class="tsd-signature-type tsd-kind-interface">MoveResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Move a file or folder to a new path</p>
42
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L150">files.ts:150</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="moveOrRename" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>move<wbr/>Or<wbr/>Rename</span><a href="#moveOrRename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">move<wbr/>Or<wbr/>Rename</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="MoveOptions.html" class="tsd-signature-type tsd-kind-interface">MoveOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="MoveResponse.html" class="tsd-signature-type tsd-kind-interface">MoveResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Move a file or folder to a new path</p>
43
43
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="moveOrRename.__type-14.__type-15"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="MoveResponse.html" class="tsd-signature-type tsd-kind-interface">MoveResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace identifier</p>
44
44
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Current path of the file or folder to move/rename</p>
45
45
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="MoveOptions.html" class="tsd-signature-type tsd-kind-interface">MoveOptions</a></span><div class="tsd-comment tsd-typography"><p>Move configuration</p>
@@ -47,13 +47,13 @@ Supports listing by path, parent folder ID, or root level</p>
47
47
  - entity_id: Unique identifier of the moved/renamed entity
48
48
  - entity_label: Display name of the entity
49
49
  - new_path: Full path to the entity after move/rename</p>
50
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L141">files.ts:141</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stat</span><a href="#stat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stat</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Check if file/folder/workspace exists and return its complete entity data</p>
50
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L141">files.ts:141</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stat</span><a href="#stat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stat</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Check if file/folder/workspace exists and return its complete entity data</p>
51
51
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="stat.__type-16.__type-17"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
52
52
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to check (empty string for workspace info)</p>
53
53
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Complete entity data if found</p>
54
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L108">files.ts:108</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unzipByEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unzip<wbr/>By<wbr/>Entity</span><a href="#unzipByEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unzip<wbr/>By<wbr/>Entity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">entity_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="UnzipOptions.html" class="tsd-signature-type tsd-kind-interface">UnzipOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">status_url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">tracking_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Unzip a file by entity ID</p>
54
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L108">files.ts:108</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unzipByEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unzip<wbr/>By<wbr/>Entity</span><a href="#unzipByEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unzip<wbr/>By<wbr/>Entity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">entity_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="UnzipOptions.html" class="tsd-signature-type tsd-kind-interface">UnzipOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">status_url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">tracking_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Unzip a file by entity ID</p>
55
55
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="unzipByEntity.__type-18.__type-19"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">entity_id</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">status_url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">tracking_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
56
56
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">entity_id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The entity ID</p>
57
57
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="UnzipOptions.html" class="tsd-signature-type tsd-kind-interface">UnzipOptions</a></span><div class="tsd-comment tsd-typography"><p>Optional unzip configuration (e.g., destination)</p>
58
58
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">status_url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">tracking_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The tracking ID and status URL</p>
59
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L195">files.ts:195</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#createFile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>File</span></a><a href="#deleteFile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>File</span></a><a href="#deleteRecursive" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Recursive</span></a><a href="#getDownloadUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Download<wbr/>Url</span></a><a href="#getUploadUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Upload<wbr/>Url</span></a><a href="#listFolder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list<wbr/>Folder</span></a><a href="#mkdir" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mkdir</span></a><a href="#moveOrRename" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move<wbr/>Or<wbr/>Rename</span></a><a href="#stat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stat</span></a><a href="#unzipByEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unzip<wbr/>By<wbr/>Entity</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.34</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
59
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/files.ts#L195">files.ts:195</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#createFile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>File</span></a><a href="#deleteFile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>File</span></a><a href="#deleteRecursive" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Recursive</span></a><a href="#getDownloadUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Download<wbr/>Url</span></a><a href="#getUploadUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Upload<wbr/>Url</span></a><a href="#listFolder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list<wbr/>Folder</span></a><a href="#mkdir" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mkdir</span></a><a href="#moveOrRename" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move<wbr/>Or<wbr/>Rename</span></a><a href="#stat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stat</span></a><a href="#unzipByEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unzip<wbr/>By<wbr/>Entity</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.35</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/interfaces/GetAttachmentOptions.html CHANGED
@@ -1,8 +1,8 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetAttachmentOptions | @octostar/platform-types - v0.5.34</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.34</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="GetAttachmentOptions.html">GetAttachmentOptions</a></li></ul><h1>Interface GetAttachmentOptions&lt;T&gt;<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options for getting attachments.</p>
2
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GetAttachmentOptions</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="GetAttachmentOptions.html#T">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="GetAttachmentOptions.html#default">default</a><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="GetAttachmentOptions.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="GetAttachmentOptions.html#path">path</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="GetAttachmentOptions.html#responseType">responseType</a><span class="tsd-signature-symbol">?: </span><a href="../types/AttachmentResponseType.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentResponseType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../types/AttachmentType.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentType</a></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/desktop.ts#L706">desktop.ts:706</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="GetAttachmentOptions.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default?</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetAttachmentOptions | @octostar/platform-types - v0.5.35</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.35</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="GetAttachmentOptions.html">GetAttachmentOptions</a></li></ul><h1>Interface GetAttachmentOptions&lt;T&gt;<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options for getting attachments.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GetAttachmentOptions</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="GetAttachmentOptions.html#T">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="GetAttachmentOptions.html#default">default</a><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="GetAttachmentOptions.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="GetAttachmentOptions.html#path">path</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="GetAttachmentOptions.html#responseType">responseType</a><span class="tsd-signature-symbol">?: </span><a href="../types/AttachmentResponseType.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentResponseType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../types/AttachmentType.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentType</a></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/desktop.ts#L706">desktop.ts:706</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="GetAttachmentOptions.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default?</span></a>
3
3
  <a href="GetAttachmentOptions.html#path" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path?</span></a>
4
4
  <a href="GetAttachmentOptions.html#responseType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response<wbr/>Type?</span></a>
5
5
  </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="default" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>default</span><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="GetAttachmentOptions.html#T">T</a></div><div class="tsd-comment tsd-typography"><p>Default value for the attachment.</p>
6
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/desktop.ts#L714">desktop.ts:714</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>path</span><a href="#path" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">path</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Path to the attachment.</p>
7
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/desktop.ts#L710">desktop.ts:710</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="responseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>response<wbr/>Type</span><a href="#responseType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/AttachmentResponseType.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentResponseType</a></div><div class="tsd-comment tsd-typography"><p>Response type for the attachment.</p>
8
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/desktop.ts#L718">desktop.ts:718</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#default" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default</span></a><a href="#path" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a><a href="#responseType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response<wbr/>Type</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.34</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
6
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/desktop.ts#L714">desktop.ts:714</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>path</span><a href="#path" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">path</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Path to the attachment.</p>
7
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/desktop.ts#L710">desktop.ts:710</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="responseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>response<wbr/>Type</span><a href="#responseType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/AttachmentResponseType.html" class="tsd-signature-type tsd-kind-type-alias">AttachmentResponseType</a></div><div class="tsd-comment tsd-typography"><p>Response type for the attachment.</p>
8
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/desktop.ts#L718">desktop.ts:718</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#default" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default</span></a><a href="#path" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a><a href="#responseType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response<wbr/>Type</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.35</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>