@squonk/data-manager-client 4.2.0 → 4.3.0

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 (140) hide show
  1. package/accounting/accounting.cjs +96 -95
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.cts +47 -47
  4. package/accounting/accounting.d.ts +47 -47
  5. package/accounting/accounting.js +102 -101
  6. package/accounting/accounting.js.map +1 -1
  7. package/admin/admin.cjs +120 -145
  8. package/admin/admin.cjs.map +1 -1
  9. package/admin/admin.d.cts +121 -121
  10. package/admin/admin.d.ts +121 -121
  11. package/admin/admin.js +127 -152
  12. package/admin/admin.js.map +1 -1
  13. package/application/application.cjs +39 -43
  14. package/application/application.cjs.map +1 -1
  15. package/application/application.d.cts +25 -25
  16. package/application/application.d.ts +25 -25
  17. package/application/application.js +42 -46
  18. package/application/application.js.map +1 -1
  19. package/chunk-OYRETEBZ.js +25 -0
  20. package/chunk-OYRETEBZ.js.map +1 -0
  21. package/{chunk-TKLTUR4R.cjs → chunk-RB2KVIEK.cjs} +1 -1
  22. package/chunk-RB2KVIEK.cjs.map +1 -0
  23. package/{chunk-EBOQPVLG.js → chunk-XYDLYMQ2.js} +1 -1
  24. package/chunk-XYDLYMQ2.js.map +1 -0
  25. package/chunk-ZLY5XEOQ.cjs +25 -0
  26. package/chunk-ZLY5XEOQ.cjs.map +1 -0
  27. package/configuration/configuration.cjs +38 -45
  28. package/configuration/configuration.cjs.map +1 -1
  29. package/configuration/configuration.d.cts +25 -25
  30. package/configuration/configuration.d.ts +25 -25
  31. package/configuration/configuration.js +42 -49
  32. package/configuration/configuration.js.map +1 -1
  33. package/dataset/dataset.cjs +126 -141
  34. package/dataset/dataset.cjs.map +1 -1
  35. package/dataset/dataset.d.cts +102 -102
  36. package/dataset/dataset.d.ts +102 -102
  37. package/dataset/dataset.js +132 -147
  38. package/dataset/dataset.js.map +1 -1
  39. package/digest/digest.cjs +22 -24
  40. package/digest/digest.cjs.map +1 -1
  41. package/digest/digest.d.cts +14 -14
  42. package/digest/digest.d.ts +14 -14
  43. package/digest/digest.js +24 -26
  44. package/digest/digest.js.map +1 -1
  45. package/exchange-rate/exchange-rate.cjs +111 -109
  46. package/exchange-rate/exchange-rate.cjs.map +1 -1
  47. package/exchange-rate/exchange-rate.d.cts +69 -69
  48. package/exchange-rate/exchange-rate.d.ts +69 -69
  49. package/exchange-rate/exchange-rate.js +117 -115
  50. package/exchange-rate/exchange-rate.js.map +1 -1
  51. package/file-and-path/file-and-path.cjs +93 -138
  52. package/file-and-path/file-and-path.cjs.map +1 -1
  53. package/file-and-path/file-and-path.d.cts +102 -102
  54. package/file-and-path/file-and-path.d.ts +102 -102
  55. package/file-and-path/file-and-path.js +105 -150
  56. package/file-and-path/file-and-path.js.map +1 -1
  57. package/index.cjs +80 -102
  58. package/index.cjs.map +1 -1
  59. package/index.d.cts +2401 -2326
  60. package/index.d.ts +2401 -2326
  61. package/index.js +79 -101
  62. package/index.js.map +1 -1
  63. package/instance/instance.cjs +100 -107
  64. package/instance/instance.cjs.map +1 -1
  65. package/instance/instance.d.cts +76 -76
  66. package/instance/instance.d.ts +76 -76
  67. package/instance/instance.js +105 -112
  68. package/instance/instance.js.map +1 -1
  69. package/inventory/inventory.cjs +22 -25
  70. package/inventory/inventory.cjs.map +1 -1
  71. package/inventory/inventory.d.cts +14 -14
  72. package/inventory/inventory.d.ts +14 -14
  73. package/inventory/inventory.js +24 -27
  74. package/inventory/inventory.js.map +1 -1
  75. package/job/job.cjs +55 -67
  76. package/job/job.cjs.map +1 -1
  77. package/job/job.d.cts +36 -36
  78. package/job/job.d.ts +36 -36
  79. package/job/job.js +60 -72
  80. package/job/job.js.map +1 -1
  81. package/metadata/metadata.cjs +61 -59
  82. package/metadata/metadata.cjs.map +1 -1
  83. package/metadata/metadata.d.cts +47 -47
  84. package/metadata/metadata.d.ts +47 -47
  85. package/metadata/metadata.js +65 -63
  86. package/metadata/metadata.js.map +1 -1
  87. package/package.json +13 -16
  88. package/project/project.cjs +165 -186
  89. package/project/project.cjs.map +1 -1
  90. package/project/project.d.cts +157 -157
  91. package/project/project.d.ts +157 -157
  92. package/project/project.js +172 -193
  93. package/project/project.js.map +1 -1
  94. package/src/accounting/accounting.ts +767 -461
  95. package/src/admin/admin.ts +1187 -787
  96. package/src/application/application.ts +377 -231
  97. package/src/configuration/configuration.ts +348 -237
  98. package/src/custom-instance.ts +3 -3
  99. package/src/data-manager-api.schemas.ts +2538 -2492
  100. package/src/dataset/dataset.ts +1199 -792
  101. package/src/digest/digest.ts +198 -122
  102. package/src/exchange-rate/exchange-rate.ts +1088 -612
  103. package/src/file-and-path/file-and-path.ts +869 -616
  104. package/src/index.ts +2 -2
  105. package/src/instance/instance.ts +804 -539
  106. package/src/inventory/inventory.ts +200 -122
  107. package/src/job/job.ts +556 -348
  108. package/src/metadata/metadata.ts +587 -371
  109. package/src/options-mutator.ts +27 -0
  110. package/src/project/project.ts +1576 -1034
  111. package/src/task/task.ts +434 -295
  112. package/src/type/type.ts +180 -126
  113. package/src/user/user.ts +846 -398
  114. package/src/workflow/workflow.ts +1750 -1089
  115. package/task/task.cjs +45 -59
  116. package/task/task.cjs.map +1 -1
  117. package/task/task.d.cts +33 -33
  118. package/task/task.d.ts +33 -33
  119. package/task/task.js +51 -65
  120. package/task/task.js.map +1 -1
  121. package/type/type.cjs +21 -26
  122. package/type/type.cjs.map +1 -1
  123. package/type/type.d.cts +14 -14
  124. package/type/type.d.ts +14 -14
  125. package/type/type.js +24 -29
  126. package/type/type.js.map +1 -1
  127. package/user/user.cjs +114 -80
  128. package/user/user.cjs.map +1 -1
  129. package/user/user.d.cts +107 -48
  130. package/user/user.d.ts +107 -48
  131. package/user/user.js +120 -86
  132. package/user/user.js.map +1 -1
  133. package/workflow/workflow.cjs +179 -193
  134. package/workflow/workflow.cjs.map +1 -1
  135. package/workflow/workflow.d.cts +146 -146
  136. package/workflow/workflow.d.ts +146 -146
  137. package/workflow/workflow.js +187 -201
  138. package/workflow/workflow.js.map +1 -1
  139. package/chunk-EBOQPVLG.js.map +0 -1
  140. package/chunk-TKLTUR4R.cjs.map +0 -1
@@ -1,8 +1,8 @@
1
- import { UseMutationOptions, UseMutationResult, UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
1
+ import { UseMutationOptions, QueryClient, UseMutationResult, UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
2
2
  import { CreatePathParams, customInstance, ErrorType, DmError, DeletePathParams, MovePathParams, GetFilesParams, FilesGetResponse, FilePostBodyBody, FilePostResponse, DeleteUnmanagedFileParams, MoveFileInProjectParams } from '../index.cjs';
3
3
  import 'axios';
4
4
 
5
- type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
5
+ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
6
6
  /**
7
7
  * Creates a new Path within a Project. Every directory in the Path will be created. The path will belong to the User and Project.
8
8
 
@@ -11,93 +11,93 @@ Only Project editors can create Paths.
11
11
  * @summary Create a new Project Path
12
12
  */
13
13
  declare const createPath: (params: CreatePathParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
14
- declare const getCreatePathMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
15
- mutation?: UseMutationOptions<TData, TError, {
14
+ declare const useCreatePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
15
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
16
16
  params: CreatePathParams;
17
17
  }, TContext>;
18
18
  request?: SecondParameter<typeof customInstance>;
19
- }) => UseMutationOptions<TData, TError, {
19
+ }) => UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
20
20
  params: CreatePathParams;
21
21
  }, TContext>;
22
22
  type CreatePathMutationResult = NonNullable<Awaited<ReturnType<typeof createPath>>>;
23
23
  type CreatePathMutationError = ErrorType<void | DmError>;
24
24
  /**
25
- * @summary Create a new Project Path
26
- */
27
- declare const useCreatePath: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
28
- mutation?: UseMutationOptions<TData, TError, {
25
+ * @summary Create a new Project Path
26
+ */
27
+ declare const useCreatePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
28
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
29
29
  params: CreatePathParams;
30
30
  }, TContext>;
31
31
  request?: SecondParameter<typeof customInstance>;
32
- }) => UseMutationResult<TData, TError, {
32
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createPath>>, TError, {
33
33
  params: CreatePathParams;
34
34
  }, TContext>;
35
35
  /**
36
- * Deletes a Path within the Project. Be aware that the deletion of a Path will result in the contents of the Path also being deleted. If there are files in Path or sub-directories, they will all be deleted.
36
+ * Deletes a Path within the Project. Be aware that the deletion of a Path will result in the contents of the Path also being deleted. If there are files in Path or sub-directories, they will all be deleted.
37
37
 
38
38
  Only Project editors can delete Paths.
39
39
 
40
- * @summary Delete a Project Path
41
- */
40
+ * @summary Delete a Project Path
41
+ */
42
42
  declare const deletePath: (params: DeletePathParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
43
- declare const getDeletePathMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
44
- mutation?: UseMutationOptions<TData, TError, {
43
+ declare const useDeletePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
44
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
45
45
  params: DeletePathParams;
46
46
  }, TContext>;
47
47
  request?: SecondParameter<typeof customInstance>;
48
- }) => UseMutationOptions<TData, TError, {
48
+ }) => UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
49
49
  params: DeletePathParams;
50
50
  }, TContext>;
51
51
  type DeletePathMutationResult = NonNullable<Awaited<ReturnType<typeof deletePath>>>;
52
52
  type DeletePathMutationError = ErrorType<void | DmError>;
53
53
  /**
54
- * @summary Delete a Project Path
55
- */
56
- declare const useDeletePath: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
57
- mutation?: UseMutationOptions<TData, TError, {
54
+ * @summary Delete a Project Path
55
+ */
56
+ declare const useDeletePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
57
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
58
58
  params: DeletePathParams;
59
59
  }, TContext>;
60
60
  request?: SecondParameter<typeof customInstance>;
61
- }) => UseMutationResult<TData, TError, {
61
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deletePath>>, TError, {
62
62
  params: DeletePathParams;
63
63
  }, TContext>;
64
64
  /**
65
- * Moves and existing Path within a Project. The path will belong to the User and Project. Any ProjectFile instances on the path will be moved to the new path.
65
+ * Moves and existing Path within a Project. The path will belong to the User and Project. Any ProjectFile instances on the path will be moved to the new path.
66
66
 
67
67
  Only Project editors can move Paths.
68
68
 
69
- * @summary Move a Project Path
70
- */
69
+ * @summary Move a Project Path
70
+ */
71
71
  declare const movePath: (params: MovePathParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
72
- declare const getMovePathMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
73
- mutation?: UseMutationOptions<TData, TError, {
72
+ declare const useMovePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
73
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
74
74
  params: MovePathParams;
75
75
  }, TContext>;
76
76
  request?: SecondParameter<typeof customInstance>;
77
- }) => UseMutationOptions<TData, TError, {
77
+ }) => UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
78
78
  params: MovePathParams;
79
79
  }, TContext>;
80
80
  type MovePathMutationResult = NonNullable<Awaited<ReturnType<typeof movePath>>>;
81
81
  type MovePathMutationError = ErrorType<void | DmError>;
82
82
  /**
83
- * @summary Move a Project Path
84
- */
85
- declare const useMovePath: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
86
- mutation?: UseMutationOptions<TData, TError, {
83
+ * @summary Move a Project Path
84
+ */
85
+ declare const useMovePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
86
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
87
87
  params: MovePathParams;
88
88
  }, TContext>;
89
89
  request?: SecondParameter<typeof customInstance>;
90
- }) => UseMutationResult<TData, TError, {
90
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof movePath>>, TError, {
91
91
  params: MovePathParams;
92
92
  }, TContext>;
93
93
  /**
94
- * Given a Project and Path the files available to you on that path will be returned along with any additional paths (sub-directories).
94
+ * Given a Project and Path the files available to you on that path will be returned along with any additional paths (sub-directories).
95
95
 
96
- * @summary Gets the Files on a Project Path
97
- */
96
+ * @summary Gets the Files on a Project Path
97
+ */
98
98
  declare const getFiles: (params: GetFilesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<FilesGetResponse>;
99
- declare const getGetFilesQueryKey: (params: GetFilesParams) => readonly ["data-manager-api", "/file", ...GetFilesParams[]];
100
- declare const getGetFilesQueryOptions: <TData = FilesGetResponse, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
99
+ declare const getGetFilesQueryKey: (params: GetFilesParams) => readonly ["/file", ...GetFilesParams[]];
100
+ declare const useGetFilesQueryOptions: <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
101
101
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
102
102
  request?: SecondParameter<typeof customInstance>;
103
103
  }) => UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData> & {
@@ -106,24 +106,24 @@ declare const getGetFilesQueryOptions: <TData = FilesGetResponse, TError = Error
106
106
  type GetFilesQueryResult = NonNullable<Awaited<ReturnType<typeof getFiles>>>;
107
107
  type GetFilesQueryError = ErrorType<void | DmError>;
108
108
  declare function useGetFiles<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options: {
109
- query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>, 'initialData'>;
109
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getFiles>>, TError, Awaited<ReturnType<typeof getFiles>>>, "initialData">;
110
110
  request?: SecondParameter<typeof customInstance>;
111
- }): DefinedUseQueryResult<TData, TError> & {
111
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
112
112
  queryKey: DataTag<QueryKey, TData, TError>;
113
113
  };
114
114
  declare function useGetFiles<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
115
- query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>, 'initialData'>;
115
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getFiles>>, TError, Awaited<ReturnType<typeof getFiles>>>, "initialData">;
116
116
  request?: SecondParameter<typeof customInstance>;
117
- }): UseQueryResult<TData, TError> & {
117
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
118
118
  queryKey: DataTag<QueryKey, TData, TError>;
119
119
  };
120
120
  declare function useGetFiles<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
121
121
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
122
122
  request?: SecondParameter<typeof customInstance>;
123
- }): UseQueryResult<TData, TError> & {
123
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
124
124
  queryKey: DataTag<QueryKey, TData, TError>;
125
125
  };
126
- declare const getGetFilesSuspenseQueryOptions: <TData = FilesGetResponse, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
126
+ declare const useGetFilesSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
127
127
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
128
128
  request?: SecondParameter<typeof customInstance>;
129
129
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData> & {
@@ -134,19 +134,19 @@ type GetFilesSuspenseQueryError = ErrorType<void | DmError>;
134
134
  declare function useGetFilesSuspense<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options: {
135
135
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
136
136
  request?: SecondParameter<typeof customInstance>;
137
- }): UseSuspenseQueryResult<TData, TError> & {
137
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
138
138
  queryKey: DataTag<QueryKey, TData, TError>;
139
139
  };
140
140
  declare function useGetFilesSuspense<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
141
141
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
142
142
  request?: SecondParameter<typeof customInstance>;
143
- }): UseSuspenseQueryResult<TData, TError> & {
143
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
144
144
  queryKey: DataTag<QueryKey, TData, TError>;
145
145
  };
146
146
  declare function useGetFilesSuspense<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
147
147
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
148
148
  request?: SecondParameter<typeof customInstance>;
149
- }): UseSuspenseQueryResult<TData, TError> & {
149
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
150
150
  queryKey: DataTag<QueryKey, TData, TError>;
151
151
  };
152
152
  /**
@@ -163,127 +163,127 @@ You cannot add a Dataset to a Project until its upload is complete.
163
163
  * @summary Attach a Dataset, as a File, to a Project
164
164
  */
165
165
  declare const attachFile: (filePostBodyBody: FilePostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<FilePostResponse>;
166
- declare const getAttachFileMutationOptions: <TData = FilePostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
167
- mutation?: UseMutationOptions<TData, TError, {
166
+ declare const useAttachFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
167
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
168
168
  data: FilePostBodyBody;
169
169
  }, TContext>;
170
170
  request?: SecondParameter<typeof customInstance>;
171
- }) => UseMutationOptions<TData, TError, {
171
+ }) => UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
172
172
  data: FilePostBodyBody;
173
173
  }, TContext>;
174
174
  type AttachFileMutationResult = NonNullable<Awaited<ReturnType<typeof attachFile>>>;
175
175
  type AttachFileMutationBody = FilePostBodyBody;
176
176
  type AttachFileMutationError = ErrorType<void | DmError>;
177
177
  /**
178
- * @summary Attach a Dataset, as a File, to a Project
179
- */
180
- declare const useAttachFile: <TData = FilePostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
181
- mutation?: UseMutationOptions<TData, TError, {
178
+ * @summary Attach a Dataset, as a File, to a Project
179
+ */
180
+ declare const useAttachFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
181
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
182
182
  data: FilePostBodyBody;
183
183
  }, TContext>;
184
184
  request?: SecondParameter<typeof customInstance>;
185
- }) => UseMutationResult<TData, TError, {
185
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof attachFile>>, TError, {
186
186
  data: FilePostBodyBody;
187
187
  }, TContext>;
188
188
  /**
189
- * Removes an unmanaged file from a Project. You cannot use this endpoint to delete managed project files.
189
+ * Removes an unmanaged file from a Project. You cannot use this endpoint to delete managed project files.
190
190
 
191
191
  You must be an `editor` of the Project to delete a file from a Project.
192
192
 
193
- * @summary Delete an unmanaged Project File
194
- */
193
+ * @summary Delete an unmanaged Project File
194
+ */
195
195
  declare const deleteUnmanagedFile: (params: DeleteUnmanagedFileParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
196
- declare const getDeleteUnmanagedFileMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
197
- mutation?: UseMutationOptions<TData, TError, {
196
+ declare const useDeleteUnmanagedFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
197
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
198
198
  params: DeleteUnmanagedFileParams;
199
199
  }, TContext>;
200
200
  request?: SecondParameter<typeof customInstance>;
201
- }) => UseMutationOptions<TData, TError, {
201
+ }) => UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
202
202
  params: DeleteUnmanagedFileParams;
203
203
  }, TContext>;
204
204
  type DeleteUnmanagedFileMutationResult = NonNullable<Awaited<ReturnType<typeof deleteUnmanagedFile>>>;
205
205
  type DeleteUnmanagedFileMutationError = ErrorType<void | DmError>;
206
206
  /**
207
- * @summary Delete an unmanaged Project File
208
- */
209
- declare const useDeleteUnmanagedFile: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
210
- mutation?: UseMutationOptions<TData, TError, {
207
+ * @summary Delete an unmanaged Project File
208
+ */
209
+ declare const useDeleteUnmanagedFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
210
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
211
211
  params: DeleteUnmanagedFileParams;
212
212
  }, TContext>;
213
213
  request?: SecondParameter<typeof customInstance>;
214
- }) => UseMutationResult<TData, TError, {
214
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
215
215
  params: DeleteUnmanagedFileParams;
216
216
  }, TContext>;
217
217
  /**
218
- * Move an **Unmanaged** file, optionally renaming it, to a new path.
218
+ * Move an **Unmanaged** file, optionally renaming it, to a new path.
219
219
 
220
220
  You must be an `editor` of the project
221
221
 
222
- * @summary Move an unmanaged file in a Project
223
- */
222
+ * @summary Move an unmanaged file in a Project
223
+ */
224
224
  declare const moveFileInProject: (params: MoveFileInProjectParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
225
- declare const getMoveFileInProjectMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
226
- mutation?: UseMutationOptions<TData, TError, {
225
+ declare const useMoveFileInProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
226
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
227
227
  params: MoveFileInProjectParams;
228
228
  }, TContext>;
229
229
  request?: SecondParameter<typeof customInstance>;
230
- }) => UseMutationOptions<TData, TError, {
230
+ }) => UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
231
231
  params: MoveFileInProjectParams;
232
232
  }, TContext>;
233
233
  type MoveFileInProjectMutationResult = NonNullable<Awaited<ReturnType<typeof moveFileInProject>>>;
234
234
  type MoveFileInProjectMutationError = ErrorType<void | DmError>;
235
235
  /**
236
- * @summary Move an unmanaged file in a Project
237
- */
238
- declare const useMoveFileInProject: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
239
- mutation?: UseMutationOptions<TData, TError, {
236
+ * @summary Move an unmanaged file in a Project
237
+ */
238
+ declare const useMoveFileInProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
239
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
240
240
  params: MoveFileInProjectParams;
241
241
  }, TContext>;
242
242
  request?: SecondParameter<typeof customInstance>;
243
- }) => UseMutationResult<TData, TError, {
243
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
244
244
  params: MoveFileInProjectParams;
245
245
  }, TContext>;
246
246
  /**
247
- * Given a `file_id` the file will be removed from the Project it's attached to.
247
+ * Given a `file_id` the file will be removed from the Project it's attached to.
248
248
 
249
249
  You must be an `editor` of the project to delete a file from a Project. Being an `editor` of the original Dataset does not give you the ability to detach it from the Project.
250
250
 
251
251
  You cannot delete a Project File until the attach is complete.
252
252
 
253
- * @summary Delete/detach a File (from a Project)
254
- */
253
+ * @summary Delete/detach a File (from a Project)
254
+ */
255
255
  declare const deleteFile: (fileId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
256
- declare const getDeleteFileMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
257
- mutation?: UseMutationOptions<TData, TError, {
256
+ declare const useDeleteFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
257
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
258
258
  fileId: string;
259
259
  }, TContext>;
260
260
  request?: SecondParameter<typeof customInstance>;
261
- }) => UseMutationOptions<TData, TError, {
261
+ }) => UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
262
262
  fileId: string;
263
263
  }, TContext>;
264
264
  type DeleteFileMutationResult = NonNullable<Awaited<ReturnType<typeof deleteFile>>>;
265
265
  type DeleteFileMutationError = ErrorType<void | DmError>;
266
266
  /**
267
- * @summary Delete/detach a File (from a Project)
268
- */
269
- declare const useDeleteFile: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
270
- mutation?: UseMutationOptions<TData, TError, {
267
+ * @summary Delete/detach a File (from a Project)
268
+ */
269
+ declare const useDeleteFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
270
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
271
271
  fileId: string;
272
272
  }, TContext>;
273
273
  request?: SecondParameter<typeof customInstance>;
274
- }) => UseMutationResult<TData, TError, {
274
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteFile>>, TError, {
275
275
  fileId: string;
276
276
  }, TContext>;
277
277
  /**
278
- * Given a `file_id` the file will be returned if available.
278
+ * Given a `file_id` the file will be returned if available.
279
279
 
280
280
  You cannot get a Project File until the attach is complete.
281
281
 
282
- * @summary Download a File (from a project)
283
- */
282
+ * @summary Download a File (from a project)
283
+ */
284
284
  declare const downloadFile: (fileId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
285
- declare const getDownloadFileQueryKey: (fileId: string) => readonly ["data-manager-api", `/file/${string}`];
286
- declare const getDownloadFileQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(fileId: string, options?: {
285
+ declare const getDownloadFileQueryKey: (fileId: string) => readonly [`/file/${string}`];
286
+ declare const useDownloadFileQueryOptions: <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
287
287
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
288
288
  request?: SecondParameter<typeof customInstance>;
289
289
  }) => UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData> & {
@@ -292,24 +292,24 @@ declare const getDownloadFileQueryOptions: <TData = void, TError = ErrorType<voi
292
292
  type DownloadFileQueryResult = NonNullable<Awaited<ReturnType<typeof downloadFile>>>;
293
293
  type DownloadFileQueryError = ErrorType<void | DmError>;
294
294
  declare function useDownloadFile<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options: {
295
- query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>, 'initialData'>;
295
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof downloadFile>>, TError, Awaited<ReturnType<typeof downloadFile>>>, "initialData">;
296
296
  request?: SecondParameter<typeof customInstance>;
297
- }): DefinedUseQueryResult<TData, TError> & {
297
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
298
298
  queryKey: DataTag<QueryKey, TData, TError>;
299
299
  };
300
300
  declare function useDownloadFile<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
301
- query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>, 'initialData'>;
301
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof downloadFile>>, TError, Awaited<ReturnType<typeof downloadFile>>>, "initialData">;
302
302
  request?: SecondParameter<typeof customInstance>;
303
- }): UseQueryResult<TData, TError> & {
303
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
304
304
  queryKey: DataTag<QueryKey, TData, TError>;
305
305
  };
306
306
  declare function useDownloadFile<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
307
307
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
308
308
  request?: SecondParameter<typeof customInstance>;
309
- }): UseQueryResult<TData, TError> & {
309
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
310
310
  queryKey: DataTag<QueryKey, TData, TError>;
311
311
  };
312
- declare const getDownloadFileSuspenseQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(fileId: string, options?: {
312
+ declare const useDownloadFileSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
313
313
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
314
314
  request?: SecondParameter<typeof customInstance>;
315
315
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData> & {
@@ -320,20 +320,20 @@ type DownloadFileSuspenseQueryError = ErrorType<void | DmError>;
320
320
  declare function useDownloadFileSuspense<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options: {
321
321
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
322
322
  request?: SecondParameter<typeof customInstance>;
323
- }): UseSuspenseQueryResult<TData, TError> & {
323
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
324
324
  queryKey: DataTag<QueryKey, TData, TError>;
325
325
  };
326
326
  declare function useDownloadFileSuspense<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
327
327
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
328
328
  request?: SecondParameter<typeof customInstance>;
329
- }): UseSuspenseQueryResult<TData, TError> & {
329
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
330
330
  queryKey: DataTag<QueryKey, TData, TError>;
331
331
  };
332
332
  declare function useDownloadFileSuspense<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
333
333
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
334
334
  request?: SecondParameter<typeof customInstance>;
335
- }): UseSuspenseQueryResult<TData, TError> & {
335
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
336
336
  queryKey: DataTag<QueryKey, TData, TError>;
337
337
  };
338
338
 
339
- export { type AttachFileMutationBody, type AttachFileMutationError, type AttachFileMutationResult, type CreatePathMutationError, type CreatePathMutationResult, type DeleteFileMutationError, type DeleteFileMutationResult, type DeletePathMutationError, type DeletePathMutationResult, type DeleteUnmanagedFileMutationError, type DeleteUnmanagedFileMutationResult, type DownloadFileQueryError, type DownloadFileQueryResult, type DownloadFileSuspenseQueryError, type DownloadFileSuspenseQueryResult, type GetFilesQueryError, type GetFilesQueryResult, type GetFilesSuspenseQueryError, type GetFilesSuspenseQueryResult, type MoveFileInProjectMutationError, type MoveFileInProjectMutationResult, type MovePathMutationError, type MovePathMutationResult, attachFile, createPath, deleteFile, deletePath, deleteUnmanagedFile, downloadFile, getAttachFileMutationOptions, getCreatePathMutationOptions, getDeleteFileMutationOptions, getDeletePathMutationOptions, getDeleteUnmanagedFileMutationOptions, getDownloadFileQueryKey, getDownloadFileQueryOptions, getDownloadFileSuspenseQueryOptions, getFiles, getGetFilesQueryKey, getGetFilesQueryOptions, getGetFilesSuspenseQueryOptions, getMoveFileInProjectMutationOptions, getMovePathMutationOptions, moveFileInProject, movePath, useAttachFile, useCreatePath, useDeleteFile, useDeletePath, useDeleteUnmanagedFile, useDownloadFile, useDownloadFileSuspense, useGetFiles, useGetFilesSuspense, useMoveFileInProject, useMovePath };
339
+ export { type AttachFileMutationBody, type AttachFileMutationError, type AttachFileMutationResult, type CreatePathMutationError, type CreatePathMutationResult, type DeleteFileMutationError, type DeleteFileMutationResult, type DeletePathMutationError, type DeletePathMutationResult, type DeleteUnmanagedFileMutationError, type DeleteUnmanagedFileMutationResult, type DownloadFileQueryError, type DownloadFileQueryResult, type DownloadFileSuspenseQueryError, type DownloadFileSuspenseQueryResult, type GetFilesQueryError, type GetFilesQueryResult, type GetFilesSuspenseQueryError, type GetFilesSuspenseQueryResult, type MoveFileInProjectMutationError, type MoveFileInProjectMutationResult, type MovePathMutationError, type MovePathMutationResult, attachFile, createPath, deleteFile, deletePath, deleteUnmanagedFile, downloadFile, getDownloadFileQueryKey, getFiles, getGetFilesQueryKey, moveFileInProject, movePath, useAttachFile, useAttachFileMutationOptions, useCreatePath, useCreatePathMutationOptions, useDeleteFile, useDeleteFileMutationOptions, useDeletePath, useDeletePathMutationOptions, useDeleteUnmanagedFile, useDeleteUnmanagedFileMutationOptions, useDownloadFile, useDownloadFileQueryOptions, useDownloadFileSuspense, useDownloadFileSuspenseQueryOptions, useGetFiles, useGetFilesQueryOptions, useGetFilesSuspense, useGetFilesSuspenseQueryOptions, useMoveFileInProject, useMoveFileInProjectMutationOptions, useMovePath, useMovePathMutationOptions };