@squonk/data-manager-client 4.1.5 → 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 +112 -68
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.cts +93 -36
  4. package/accounting/accounting.d.ts +93 -36
  5. package/accounting/accounting.js +117 -73
  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 +87 -100
  58. package/index.cjs.map +1 -1
  59. package/index.d.cts +2426 -2311
  60. package/index.d.ts +2426 -2311
  61. package/index.js +86 -99
  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 +78 -76
  66. package/instance/instance.d.ts +78 -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 +790 -343
  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 +2529 -2439
  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 +806 -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 { InstancePostBodyBody, customInstance, InstancePostResponse, ErrorType, DmError, GetInstancesParams, InstancesGetResponse, InstanceDryRunPostResponse, InstanceGetResponse, TaskIdentity, PatchInstanceParams } 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
  * Launches a new Application or Job instance, returning an Instance and Task ID. The Task ID should be used against the `/task` endpoint to determine the availability of the the running instance.
8
8
 
@@ -15,36 +15,38 @@ A Job instance typically runs to completion, reaching the **TaskState** _SUCCESS
15
15
  * @summary Creates a new Job or Application instance
16
16
  */
17
17
  declare const createInstance: (instancePostBodyBody: InstancePostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<InstancePostResponse>;
18
- declare const getCreateInstanceMutationOptions: <TData = InstancePostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
19
- mutation?: UseMutationOptions<TData, TError, {
18
+ declare const useCreateInstanceMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
19
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError, {
20
20
  data: InstancePostBodyBody;
21
21
  }, TContext>;
22
22
  request?: SecondParameter<typeof customInstance>;
23
- }) => UseMutationOptions<TData, TError, {
23
+ }) => UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError, {
24
24
  data: InstancePostBodyBody;
25
25
  }, TContext>;
26
26
  type CreateInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof createInstance>>>;
27
27
  type CreateInstanceMutationBody = InstancePostBodyBody;
28
28
  type CreateInstanceMutationError = ErrorType<void | DmError>;
29
29
  /**
30
- * @summary Creates a new Job or Application instance
31
- */
32
- declare const useCreateInstance: <TData = InstancePostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
33
- mutation?: UseMutationOptions<TData, TError, {
30
+ * @summary Creates a new Job or Application instance
31
+ */
32
+ declare const useCreateInstance: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
33
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError, {
34
34
  data: InstancePostBodyBody;
35
35
  }, TContext>;
36
36
  request?: SecondParameter<typeof customInstance>;
37
- }) => UseMutationResult<TData, TError, {
37
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createInstance>>, TError, {
38
38
  data: InstancePostBodyBody;
39
39
  }, TContext>;
40
40
  /**
41
- * Returns a summary of all running instances. Instances can be running as an Application or as a Job. The response will contain an `application_type` field that is either `job` or `application`
41
+ * Returns a summary of all running instances. Instances can be running as an Application or as a Job. The response will contain an `application_type` field that is either `job` or `application`
42
42
 
43
- * @summary Get summary information about all Job and Application instances
44
- */
43
+ Results can be filtered by **Project**, **Unit** or **Organisation**.
44
+
45
+ * @summary Get summary information about all Job and Application instances
46
+ */
45
47
  declare const getInstances: (params?: GetInstancesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<InstancesGetResponse>;
46
- declare const getGetInstancesQueryKey: (params?: GetInstancesParams) => readonly ["data-manager-api", "/instance", ...GetInstancesParams[]];
47
- declare const getGetInstancesQueryOptions: <TData = InstancesGetResponse, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
48
+ declare const getGetInstancesQueryKey: (params?: GetInstancesParams) => readonly ["/instance", ...GetInstancesParams[]];
49
+ declare const useGetInstancesQueryOptions: <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
48
50
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
49
51
  request?: SecondParameter<typeof customInstance>;
50
52
  }) => UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData> & {
@@ -53,24 +55,24 @@ declare const getGetInstancesQueryOptions: <TData = InstancesGetResponse, TError
53
55
  type GetInstancesQueryResult = NonNullable<Awaited<ReturnType<typeof getInstances>>>;
54
56
  type GetInstancesQueryError = ErrorType<void | DmError>;
55
57
  declare function useGetInstances<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params: undefined | GetInstancesParams, options: {
56
- query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>, 'initialData'>;
58
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getInstances>>, TError, Awaited<ReturnType<typeof getInstances>>>, "initialData">;
57
59
  request?: SecondParameter<typeof customInstance>;
58
- }): DefinedUseQueryResult<TData, TError> & {
60
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
59
61
  queryKey: DataTag<QueryKey, TData, TError>;
60
62
  };
61
63
  declare function useGetInstances<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
62
- query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>, 'initialData'>;
64
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getInstances>>, TError, Awaited<ReturnType<typeof getInstances>>>, "initialData">;
63
65
  request?: SecondParameter<typeof customInstance>;
64
- }): UseQueryResult<TData, TError> & {
66
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
65
67
  queryKey: DataTag<QueryKey, TData, TError>;
66
68
  };
67
69
  declare function useGetInstances<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
68
70
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
69
71
  request?: SecondParameter<typeof customInstance>;
70
- }): UseQueryResult<TData, TError> & {
72
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
71
73
  queryKey: DataTag<QueryKey, TData, TError>;
72
74
  };
73
- declare const getGetInstancesSuspenseQueryOptions: <TData = InstancesGetResponse, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
75
+ declare const useGetInstancesSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
74
76
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
75
77
  request?: SecondParameter<typeof customInstance>;
76
78
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData> & {
@@ -81,19 +83,19 @@ type GetInstancesSuspenseQueryError = ErrorType<void | DmError>;
81
83
  declare function useGetInstancesSuspense<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params: undefined | GetInstancesParams, options: {
82
84
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
83
85
  request?: SecondParameter<typeof customInstance>;
84
- }): UseSuspenseQueryResult<TData, TError> & {
86
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
85
87
  queryKey: DataTag<QueryKey, TData, TError>;
86
88
  };
87
89
  declare function useGetInstancesSuspense<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
88
90
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
89
91
  request?: SecondParameter<typeof customInstance>;
90
- }): UseSuspenseQueryResult<TData, TError> & {
92
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
91
93
  queryKey: DataTag<QueryKey, TData, TError>;
92
94
  };
93
95
  declare function useGetInstancesSuspense<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
94
96
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
95
97
  request?: SecondParameter<typeof customInstance>;
96
- }): UseSuspenseQueryResult<TData, TError> & {
98
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
97
99
  queryKey: DataTag<QueryKey, TData, TError>;
98
100
  };
99
101
  /**
@@ -104,34 +106,34 @@ The test result is only valid at the time of the call, whether an actual instanc
104
106
  * @summary Used to check the execution of new Job or Application instance
105
107
  */
106
108
  declare const dryRunInstance: (instancePostBodyBody: InstancePostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<InstanceDryRunPostResponse>;
107
- declare const getDryRunInstanceMutationOptions: <TData = InstanceDryRunPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
108
- mutation?: UseMutationOptions<TData, TError, {
109
+ declare const useDryRunInstanceMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
110
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError, {
109
111
  data: InstancePostBodyBody;
110
112
  }, TContext>;
111
113
  request?: SecondParameter<typeof customInstance>;
112
- }) => UseMutationOptions<TData, TError, {
114
+ }) => UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError, {
113
115
  data: InstancePostBodyBody;
114
116
  }, TContext>;
115
117
  type DryRunInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof dryRunInstance>>>;
116
118
  type DryRunInstanceMutationBody = InstancePostBodyBody;
117
119
  type DryRunInstanceMutationError = ErrorType<void | DmError>;
118
120
  /**
119
- * @summary Used to check the execution of new Job or Application instance
120
- */
121
- declare const useDryRunInstance: <TData = InstanceDryRunPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
122
- mutation?: UseMutationOptions<TData, TError, {
121
+ * @summary Used to check the execution of new Job or Application instance
122
+ */
123
+ declare const useDryRunInstance: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
124
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError, {
123
125
  data: InstancePostBodyBody;
124
126
  }, TContext>;
125
127
  request?: SecondParameter<typeof customInstance>;
126
- }) => UseMutationResult<TData, TError, {
128
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof dryRunInstance>>, TError, {
127
129
  data: InstancePostBodyBody;
128
130
  }, TContext>;
129
131
  /**
130
- * @summary Get detailed information about an Instance
131
- */
132
+ * @summary Get detailed information about an Instance
133
+ */
132
134
  declare const getInstance: (instanceId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<InstanceGetResponse>;
133
- declare const getGetInstanceQueryKey: (instanceId: string) => readonly ["data-manager-api", `/instance/${string}`];
134
- declare const getGetInstanceQueryOptions: <TData = InstanceGetResponse, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
135
+ declare const getGetInstanceQueryKey: (instanceId: string) => readonly [`/instance/${string}`];
136
+ declare const useGetInstanceQueryOptions: <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
135
137
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
136
138
  request?: SecondParameter<typeof customInstance>;
137
139
  }) => UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData> & {
@@ -140,24 +142,24 @@ declare const getGetInstanceQueryOptions: <TData = InstanceGetResponse, TError =
140
142
  type GetInstanceQueryResult = NonNullable<Awaited<ReturnType<typeof getInstance>>>;
141
143
  type GetInstanceQueryError = ErrorType<void | DmError>;
142
144
  declare function useGetInstance<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options: {
143
- query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>, 'initialData'>;
145
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getInstance>>, TError, Awaited<ReturnType<typeof getInstance>>>, "initialData">;
144
146
  request?: SecondParameter<typeof customInstance>;
145
- }): DefinedUseQueryResult<TData, TError> & {
147
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
146
148
  queryKey: DataTag<QueryKey, TData, TError>;
147
149
  };
148
150
  declare function useGetInstance<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
149
- query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>, 'initialData'>;
151
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getInstance>>, TError, Awaited<ReturnType<typeof getInstance>>>, "initialData">;
150
152
  request?: SecondParameter<typeof customInstance>;
151
- }): UseQueryResult<TData, TError> & {
153
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
152
154
  queryKey: DataTag<QueryKey, TData, TError>;
153
155
  };
154
156
  declare function useGetInstance<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
155
157
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
156
158
  request?: SecondParameter<typeof customInstance>;
157
- }): UseQueryResult<TData, TError> & {
159
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
158
160
  queryKey: DataTag<QueryKey, TData, TError>;
159
161
  };
160
- declare const getGetInstanceSuspenseQueryOptions: <TData = InstanceGetResponse, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
162
+ declare const useGetInstanceSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
161
163
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
162
164
  request?: SecondParameter<typeof customInstance>;
163
165
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData> & {
@@ -168,19 +170,19 @@ type GetInstanceSuspenseQueryError = ErrorType<void | DmError>;
168
170
  declare function useGetInstanceSuspense<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options: {
169
171
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
170
172
  request?: SecondParameter<typeof customInstance>;
171
- }): UseSuspenseQueryResult<TData, TError> & {
173
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
172
174
  queryKey: DataTag<QueryKey, TData, TError>;
173
175
  };
174
176
  declare function useGetInstanceSuspense<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
175
177
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
176
178
  request?: SecondParameter<typeof customInstance>;
177
- }): UseSuspenseQueryResult<TData, TError> & {
179
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
178
180
  queryKey: DataTag<QueryKey, TData, TError>;
179
181
  };
180
182
  declare function useGetInstanceSuspense<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
181
183
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
182
184
  request?: SecondParameter<typeof customInstance>;
183
- }): UseSuspenseQueryResult<TData, TError> & {
185
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
184
186
  queryKey: DataTag<QueryKey, TData, TError>;
185
187
  };
186
188
  /**
@@ -191,94 +193,94 @@ You must be the `owner` or an `editor` of the Instance to delete it
191
193
  * @summary Delete a Job or Application Instance
192
194
  */
193
195
  declare const terminateInstance: (instanceId: string, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
194
- declare const getTerminateInstanceMutationOptions: <TData = TaskIdentity, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
195
- mutation?: UseMutationOptions<TData, TError, {
196
+ declare const useTerminateInstanceMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
197
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError, {
196
198
  instanceId: string;
197
199
  }, TContext>;
198
200
  request?: SecondParameter<typeof customInstance>;
199
- }) => UseMutationOptions<TData, TError, {
201
+ }) => UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError, {
200
202
  instanceId: string;
201
203
  }, TContext>;
202
204
  type TerminateInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof terminateInstance>>>;
203
205
  type TerminateInstanceMutationError = ErrorType<void | DmError>;
204
206
  /**
205
- * @summary Delete a Job or Application Instance
206
- */
207
- declare const useTerminateInstance: <TData = TaskIdentity, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
208
- mutation?: UseMutationOptions<TData, TError, {
207
+ * @summary Delete a Job or Application Instance
208
+ */
209
+ declare const useTerminateInstance: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
210
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError, {
209
211
  instanceId: string;
210
212
  }, TContext>;
211
213
  request?: SecondParameter<typeof customInstance>;
212
- }) => UseMutationResult<TData, TError, {
214
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof terminateInstance>>, TError, {
213
215
  instanceId: string;
214
216
  }, TContext>;
215
217
  /**
216
- * The Application or Job Instance is updated according to the patch parameters.
218
+ * The Application or Job Instance is updated according to the patch parameters.
217
219
 
218
220
  You must be the `owner` or an `editor` of the Instance to patch it
219
221
 
220
- * @summary Update a Job or Application Instance
221
- */
222
+ * @summary Update a Job or Application Instance
223
+ */
222
224
  declare const patchInstance: (instanceId: string, params?: PatchInstanceParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
223
- declare const getPatchInstanceMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
224
- mutation?: UseMutationOptions<TData, TError, {
225
+ declare const usePatchInstanceMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
226
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError, {
225
227
  instanceId: string;
226
228
  params?: PatchInstanceParams;
227
229
  }, TContext>;
228
230
  request?: SecondParameter<typeof customInstance>;
229
- }) => UseMutationOptions<TData, TError, {
231
+ }) => UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError, {
230
232
  instanceId: string;
231
233
  params?: PatchInstanceParams;
232
234
  }, TContext>;
233
235
  type PatchInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof patchInstance>>>;
234
236
  type PatchInstanceMutationError = ErrorType<void | DmError>;
235
237
  /**
236
- * @summary Update a Job or Application Instance
237
- */
238
- declare const usePatchInstance: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
239
- mutation?: UseMutationOptions<TData, TError, {
238
+ * @summary Update a Job or Application Instance
239
+ */
240
+ declare const usePatchInstance: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
241
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError, {
240
242
  instanceId: string;
241
243
  params?: PatchInstanceParams;
242
244
  }, TContext>;
243
245
  request?: SecondParameter<typeof customInstance>;
244
- }) => UseMutationResult<TData, TError, {
246
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof patchInstance>>, TError, {
245
247
  instanceId: string;
246
248
  params?: PatchInstanceParams;
247
249
  }, TContext>;
248
250
  /**
249
- * This revokes the instance **Token**, which was optionally generated when the instance was launched. No authentication is required to use this endpoint, which is typically used by a remote system driven by instance callbacks.
251
+ * This revokes the instance **Token**, which was optionally generated when the instance was launched. No authentication is required to use this endpoint, which is typically used by a remote system driven by instance callbacks.
250
252
 
251
253
  Tokens automatically expire after a period of time but can be revoked instantly with this endpoint.
252
254
 
253
255
  The remote system will revoke the token when it's finished with it
254
256
 
255
- * @summary Delete (revoke) the Instance Token
256
- */
257
+ * @summary Delete (revoke) the Instance Token
258
+ */
257
259
  declare const deleteInstanceToken: (instanceId: string, token: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
258
- declare const getDeleteInstanceTokenMutationOptions: <TData = void, TError = ErrorType<DmError>, TContext = unknown>(options?: {
259
- mutation?: UseMutationOptions<TData, TError, {
260
+ declare const useDeleteInstanceTokenMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
261
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError, {
260
262
  instanceId: string;
261
263
  token: string;
262
264
  }, TContext>;
263
265
  request?: SecondParameter<typeof customInstance>;
264
- }) => UseMutationOptions<TData, TError, {
266
+ }) => UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError, {
265
267
  instanceId: string;
266
268
  token: string;
267
269
  }, TContext>;
268
270
  type DeleteInstanceTokenMutationResult = NonNullable<Awaited<ReturnType<typeof deleteInstanceToken>>>;
269
271
  type DeleteInstanceTokenMutationError = ErrorType<DmError>;
270
272
  /**
271
- * @summary Delete (revoke) the Instance Token
272
- */
273
- declare const useDeleteInstanceToken: <TData = void, TError = ErrorType<DmError>, TContext = unknown>(options?: {
274
- mutation?: UseMutationOptions<TData, TError, {
273
+ * @summary Delete (revoke) the Instance Token
274
+ */
275
+ declare const useDeleteInstanceToken: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
276
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError, {
275
277
  instanceId: string;
276
278
  token: string;
277
279
  }, TContext>;
278
280
  request?: SecondParameter<typeof customInstance>;
279
- }) => UseMutationResult<TData, TError, {
281
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteInstanceToken>>, TError, {
280
282
  instanceId: string;
281
283
  token: string;
282
284
  }, TContext>;
283
285
 
284
- export { type CreateInstanceMutationBody, type CreateInstanceMutationError, type CreateInstanceMutationResult, type DeleteInstanceTokenMutationError, type DeleteInstanceTokenMutationResult, type DryRunInstanceMutationBody, type DryRunInstanceMutationError, type DryRunInstanceMutationResult, type GetInstanceQueryError, type GetInstanceQueryResult, type GetInstanceSuspenseQueryError, type GetInstanceSuspenseQueryResult, type GetInstancesQueryError, type GetInstancesQueryResult, type GetInstancesSuspenseQueryError, type GetInstancesSuspenseQueryResult, type PatchInstanceMutationError, type PatchInstanceMutationResult, type TerminateInstanceMutationError, type TerminateInstanceMutationResult, createInstance, deleteInstanceToken, dryRunInstance, getCreateInstanceMutationOptions, getDeleteInstanceTokenMutationOptions, getDryRunInstanceMutationOptions, getGetInstanceQueryKey, getGetInstanceQueryOptions, getGetInstanceSuspenseQueryOptions, getGetInstancesQueryKey, getGetInstancesQueryOptions, getGetInstancesSuspenseQueryOptions, getInstance, getInstances, getPatchInstanceMutationOptions, getTerminateInstanceMutationOptions, patchInstance, terminateInstance, useCreateInstance, useDeleteInstanceToken, useDryRunInstance, useGetInstance, useGetInstanceSuspense, useGetInstances, useGetInstancesSuspense, usePatchInstance, useTerminateInstance };
286
+ export { type CreateInstanceMutationBody, type CreateInstanceMutationError, type CreateInstanceMutationResult, type DeleteInstanceTokenMutationError, type DeleteInstanceTokenMutationResult, type DryRunInstanceMutationBody, type DryRunInstanceMutationError, type DryRunInstanceMutationResult, type GetInstanceQueryError, type GetInstanceQueryResult, type GetInstanceSuspenseQueryError, type GetInstanceSuspenseQueryResult, type GetInstancesQueryError, type GetInstancesQueryResult, type GetInstancesSuspenseQueryError, type GetInstancesSuspenseQueryResult, type PatchInstanceMutationError, type PatchInstanceMutationResult, type TerminateInstanceMutationError, type TerminateInstanceMutationResult, createInstance, deleteInstanceToken, dryRunInstance, getGetInstanceQueryKey, getGetInstancesQueryKey, getInstance, getInstances, patchInstance, terminateInstance, useCreateInstance, useCreateInstanceMutationOptions, useDeleteInstanceToken, useDeleteInstanceTokenMutationOptions, useDryRunInstance, useDryRunInstanceMutationOptions, useGetInstance, useGetInstanceQueryOptions, useGetInstanceSuspense, useGetInstanceSuspenseQueryOptions, useGetInstances, useGetInstancesQueryOptions, useGetInstancesSuspense, useGetInstancesSuspenseQueryOptions, usePatchInstance, usePatchInstanceMutationOptions, useTerminateInstance, useTerminateInstanceMutationOptions };