@squonk/data-manager-client 4.2.0 → 5.0.0-5-0.2173777171

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 (141) hide show
  1. package/accounting/accounting.cjs +140 -94
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.cts +104 -47
  4. package/accounting/accounting.d.ts +104 -47
  5. package/accounting/accounting.js +146 -100
  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 +123 -121
  10. package/admin/admin.d.ts +123 -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-76ADQBHZ.js +25 -0
  20. package/chunk-76ADQBHZ.js.map +1 -0
  21. package/chunk-KHB5TJT7.cjs +25 -0
  22. package/chunk-KHB5TJT7.cjs.map +1 -0
  23. package/{chunk-TKLTUR4R.cjs → chunk-RB2KVIEK.cjs} +1 -1
  24. package/chunk-RB2KVIEK.cjs.map +1 -0
  25. package/{chunk-EBOQPVLG.js → chunk-XYDLYMQ2.js} +1 -1
  26. package/chunk-XYDLYMQ2.js.map +1 -0
  27. package/configuration/configuration.cjs +38 -45
  28. package/configuration/configuration.cjs.map +1 -1
  29. package/configuration/configuration.d.cts +26 -26
  30. package/configuration/configuration.d.ts +26 -26
  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/file-and-path/file-and-path.cjs +212 -135
  46. package/file-and-path/file-and-path.cjs.map +1 -1
  47. package/file-and-path/file-and-path.d.cts +263 -103
  48. package/file-and-path/file-and-path.d.ts +263 -103
  49. package/file-and-path/file-and-path.js +222 -145
  50. package/file-and-path/file-and-path.js.map +1 -1
  51. package/index.cjs +83 -103
  52. package/index.cjs.map +1 -1
  53. package/index.d.cts +2434 -2343
  54. package/index.d.ts +2434 -2343
  55. package/index.js +82 -102
  56. package/index.js.map +1 -1
  57. package/instance/instance.cjs +100 -107
  58. package/instance/instance.cjs.map +1 -1
  59. package/instance/instance.d.cts +76 -76
  60. package/instance/instance.d.ts +76 -76
  61. package/instance/instance.js +105 -112
  62. package/instance/instance.js.map +1 -1
  63. package/inventory/inventory.cjs +22 -25
  64. package/inventory/inventory.cjs.map +1 -1
  65. package/inventory/inventory.d.cts +14 -14
  66. package/inventory/inventory.d.ts +14 -14
  67. package/inventory/inventory.js +24 -27
  68. package/inventory/inventory.js.map +1 -1
  69. package/job/job.cjs +170 -66
  70. package/job/job.cjs.map +1 -1
  71. package/job/job.d.cts +193 -37
  72. package/job/job.d.ts +193 -37
  73. package/job/job.js +176 -72
  74. package/job/job.js.map +1 -1
  75. package/metadata/metadata.cjs +61 -59
  76. package/metadata/metadata.cjs.map +1 -1
  77. package/metadata/metadata.d.cts +47 -47
  78. package/metadata/metadata.d.ts +47 -47
  79. package/metadata/metadata.js +65 -63
  80. package/metadata/metadata.js.map +1 -1
  81. package/package.json +13 -16
  82. package/project/project.cjs +113 -256
  83. package/project/project.cjs.map +1 -1
  84. package/project/project.d.cts +122 -282
  85. package/project/project.d.ts +122 -282
  86. package/project/project.js +118 -261
  87. package/project/project.js.map +1 -1
  88. package/src/{data-manager-api.schemas.ts → API_TARGET_NAME.schemas.ts} +2538 -2483
  89. package/src/accounting/accounting.ts +1003 -455
  90. package/src/admin/admin.ts +1190 -788
  91. package/src/application/application.ts +378 -232
  92. package/src/configuration/configuration.ts +350 -243
  93. package/src/custom-instance.ts +3 -3
  94. package/src/dataset/dataset.ts +1200 -793
  95. package/src/digest/digest.ts +199 -123
  96. package/src/file-and-path/file-and-path.ts +1456 -603
  97. package/src/index.ts +3 -3
  98. package/src/instance/instance.ts +805 -540
  99. package/src/inventory/inventory.ts +201 -123
  100. package/src/job/job.ts +1134 -330
  101. package/src/metadata/metadata.ts +588 -372
  102. package/src/options-mutator.ts +27 -0
  103. package/src/project/project.ts +1064 -1121
  104. package/src/task/task.ts +435 -296
  105. package/src/type/type.ts +181 -127
  106. package/src/user/user.ts +847 -399
  107. package/src/workflow/workflow.ts +1754 -1091
  108. package/task/task.cjs +45 -59
  109. package/task/task.cjs.map +1 -1
  110. package/task/task.d.cts +33 -33
  111. package/task/task.d.ts +33 -33
  112. package/task/task.js +51 -65
  113. package/task/task.js.map +1 -1
  114. package/type/type.cjs +21 -26
  115. package/type/type.cjs.map +1 -1
  116. package/type/type.d.cts +14 -14
  117. package/type/type.d.ts +14 -14
  118. package/type/type.js +24 -29
  119. package/type/type.js.map +1 -1
  120. package/user/user.cjs +114 -80
  121. package/user/user.cjs.map +1 -1
  122. package/user/user.d.cts +107 -48
  123. package/user/user.d.ts +107 -48
  124. package/user/user.js +120 -86
  125. package/user/user.js.map +1 -1
  126. package/workflow/workflow.cjs +179 -193
  127. package/workflow/workflow.cjs.map +1 -1
  128. package/workflow/workflow.d.cts +149 -147
  129. package/workflow/workflow.d.ts +149 -147
  130. package/workflow/workflow.js +187 -201
  131. package/workflow/workflow.js.map +1 -1
  132. package/chunk-EBOQPVLG.js.map +0 -1
  133. package/chunk-TKLTUR4R.cjs.map +0 -1
  134. package/exchange-rate/exchange-rate.cjs +0 -253
  135. package/exchange-rate/exchange-rate.cjs.map +0 -1
  136. package/exchange-rate/exchange-rate.d.cts +0 -319
  137. package/exchange-rate/exchange-rate.d.ts +0 -319
  138. package/exchange-rate/exchange-rate.js +0 -253
  139. package/exchange-rate/exchange-rate.js.map +0 -1
  140. package/exchange-rate/package.json +0 -7
  141. package/src/exchange-rate/exchange-rate.ts +0 -800
@@ -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,38 +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
43
  Results can be filtered by **Project**, **Unit** or **Organisation**.
44
44
 
45
- * @summary Get summary information about all Job and Application instances
46
- */
45
+ * @summary Get summary information about all Job and Application instances
46
+ */
47
47
  declare const getInstances: (params?: GetInstancesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<InstancesGetResponse>;
48
- declare const getGetInstancesQueryKey: (params?: GetInstancesParams) => readonly ["data-manager-api", "/instance", ...GetInstancesParams[]];
49
- 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?: {
50
50
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
51
51
  request?: SecondParameter<typeof customInstance>;
52
52
  }) => UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData> & {
@@ -55,24 +55,24 @@ declare const getGetInstancesQueryOptions: <TData = InstancesGetResponse, TError
55
55
  type GetInstancesQueryResult = NonNullable<Awaited<ReturnType<typeof getInstances>>>;
56
56
  type GetInstancesQueryError = ErrorType<void | DmError>;
57
57
  declare function useGetInstances<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params: undefined | GetInstancesParams, options: {
58
- 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">;
59
59
  request?: SecondParameter<typeof customInstance>;
60
- }): DefinedUseQueryResult<TData, TError> & {
60
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
61
61
  queryKey: DataTag<QueryKey, TData, TError>;
62
62
  };
63
63
  declare function useGetInstances<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
64
- 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">;
65
65
  request?: SecondParameter<typeof customInstance>;
66
- }): UseQueryResult<TData, TError> & {
66
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
67
67
  queryKey: DataTag<QueryKey, TData, TError>;
68
68
  };
69
69
  declare function useGetInstances<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
70
70
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
71
71
  request?: SecondParameter<typeof customInstance>;
72
- }): UseQueryResult<TData, TError> & {
72
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
73
73
  queryKey: DataTag<QueryKey, TData, TError>;
74
74
  };
75
- 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?: {
76
76
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
77
77
  request?: SecondParameter<typeof customInstance>;
78
78
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData> & {
@@ -83,19 +83,19 @@ type GetInstancesSuspenseQueryError = ErrorType<void | DmError>;
83
83
  declare function useGetInstancesSuspense<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params: undefined | GetInstancesParams, options: {
84
84
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
85
85
  request?: SecondParameter<typeof customInstance>;
86
- }): UseSuspenseQueryResult<TData, TError> & {
86
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
87
87
  queryKey: DataTag<QueryKey, TData, TError>;
88
88
  };
89
89
  declare function useGetInstancesSuspense<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
90
90
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
91
91
  request?: SecondParameter<typeof customInstance>;
92
- }): UseSuspenseQueryResult<TData, TError> & {
92
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
93
93
  queryKey: DataTag<QueryKey, TData, TError>;
94
94
  };
95
95
  declare function useGetInstancesSuspense<TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: {
96
96
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
97
97
  request?: SecondParameter<typeof customInstance>;
98
- }): UseSuspenseQueryResult<TData, TError> & {
98
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
99
99
  queryKey: DataTag<QueryKey, TData, TError>;
100
100
  };
101
101
  /**
@@ -106,34 +106,34 @@ The test result is only valid at the time of the call, whether an actual instanc
106
106
  * @summary Used to check the execution of new Job or Application instance
107
107
  */
108
108
  declare const dryRunInstance: (instancePostBodyBody: InstancePostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<InstanceDryRunPostResponse>;
109
- declare const getDryRunInstanceMutationOptions: <TData = InstanceDryRunPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
110
- mutation?: UseMutationOptions<TData, TError, {
109
+ declare const useDryRunInstanceMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
110
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError, {
111
111
  data: InstancePostBodyBody;
112
112
  }, TContext>;
113
113
  request?: SecondParameter<typeof customInstance>;
114
- }) => UseMutationOptions<TData, TError, {
114
+ }) => UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError, {
115
115
  data: InstancePostBodyBody;
116
116
  }, TContext>;
117
117
  type DryRunInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof dryRunInstance>>>;
118
118
  type DryRunInstanceMutationBody = InstancePostBodyBody;
119
119
  type DryRunInstanceMutationError = ErrorType<void | DmError>;
120
120
  /**
121
- * @summary Used to check the execution of new Job or Application instance
122
- */
123
- declare const useDryRunInstance: <TData = InstanceDryRunPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
124
- 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, {
125
125
  data: InstancePostBodyBody;
126
126
  }, TContext>;
127
127
  request?: SecondParameter<typeof customInstance>;
128
- }) => UseMutationResult<TData, TError, {
128
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof dryRunInstance>>, TError, {
129
129
  data: InstancePostBodyBody;
130
130
  }, TContext>;
131
131
  /**
132
- * @summary Get detailed information about an Instance
133
- */
132
+ * @summary Get detailed information about an Instance
133
+ */
134
134
  declare const getInstance: (instanceId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<InstanceGetResponse>;
135
- declare const getGetInstanceQueryKey: (instanceId: string) => readonly ["data-manager-api", `/instance/${string}`];
136
- 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?: {
137
137
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
138
138
  request?: SecondParameter<typeof customInstance>;
139
139
  }) => UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData> & {
@@ -142,24 +142,24 @@ declare const getGetInstanceQueryOptions: <TData = InstanceGetResponse, TError =
142
142
  type GetInstanceQueryResult = NonNullable<Awaited<ReturnType<typeof getInstance>>>;
143
143
  type GetInstanceQueryError = ErrorType<void | DmError>;
144
144
  declare function useGetInstance<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options: {
145
- 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">;
146
146
  request?: SecondParameter<typeof customInstance>;
147
- }): DefinedUseQueryResult<TData, TError> & {
147
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
148
148
  queryKey: DataTag<QueryKey, TData, TError>;
149
149
  };
150
150
  declare function useGetInstance<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
151
- 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">;
152
152
  request?: SecondParameter<typeof customInstance>;
153
- }): UseQueryResult<TData, TError> & {
153
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
154
154
  queryKey: DataTag<QueryKey, TData, TError>;
155
155
  };
156
156
  declare function useGetInstance<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
157
157
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
158
158
  request?: SecondParameter<typeof customInstance>;
159
- }): UseQueryResult<TData, TError> & {
159
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
160
160
  queryKey: DataTag<QueryKey, TData, TError>;
161
161
  };
162
- 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?: {
163
163
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
164
164
  request?: SecondParameter<typeof customInstance>;
165
165
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData> & {
@@ -170,19 +170,19 @@ type GetInstanceSuspenseQueryError = ErrorType<void | DmError>;
170
170
  declare function useGetInstanceSuspense<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options: {
171
171
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
172
172
  request?: SecondParameter<typeof customInstance>;
173
- }): UseSuspenseQueryResult<TData, TError> & {
173
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
174
174
  queryKey: DataTag<QueryKey, TData, TError>;
175
175
  };
176
176
  declare function useGetInstanceSuspense<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
177
177
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
178
178
  request?: SecondParameter<typeof customInstance>;
179
- }): UseSuspenseQueryResult<TData, TError> & {
179
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
180
180
  queryKey: DataTag<QueryKey, TData, TError>;
181
181
  };
182
182
  declare function useGetInstanceSuspense<TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: {
183
183
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
184
184
  request?: SecondParameter<typeof customInstance>;
185
- }): UseSuspenseQueryResult<TData, TError> & {
185
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
186
186
  queryKey: DataTag<QueryKey, TData, TError>;
187
187
  };
188
188
  /**
@@ -193,94 +193,94 @@ You must be the `owner` or an `editor` of the Instance to delete it
193
193
  * @summary Delete a Job or Application Instance
194
194
  */
195
195
  declare const terminateInstance: (instanceId: string, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
196
- declare const getTerminateInstanceMutationOptions: <TData = TaskIdentity, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
197
- mutation?: UseMutationOptions<TData, TError, {
196
+ declare const useTerminateInstanceMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
197
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError, {
198
198
  instanceId: string;
199
199
  }, TContext>;
200
200
  request?: SecondParameter<typeof customInstance>;
201
- }) => UseMutationOptions<TData, TError, {
201
+ }) => UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError, {
202
202
  instanceId: string;
203
203
  }, TContext>;
204
204
  type TerminateInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof terminateInstance>>>;
205
205
  type TerminateInstanceMutationError = ErrorType<void | DmError>;
206
206
  /**
207
- * @summary Delete a Job or Application Instance
208
- */
209
- declare const useTerminateInstance: <TData = TaskIdentity, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
210
- 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, {
211
211
  instanceId: string;
212
212
  }, TContext>;
213
213
  request?: SecondParameter<typeof customInstance>;
214
- }) => UseMutationResult<TData, TError, {
214
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof terminateInstance>>, TError, {
215
215
  instanceId: string;
216
216
  }, TContext>;
217
217
  /**
218
- * 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.
219
219
 
220
220
  You must be the `owner` or an `editor` of the Instance to patch it
221
221
 
222
- * @summary Update a Job or Application Instance
223
- */
222
+ * @summary Update a Job or Application Instance
223
+ */
224
224
  declare const patchInstance: (instanceId: string, params?: PatchInstanceParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
225
- declare const getPatchInstanceMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
226
- mutation?: UseMutationOptions<TData, TError, {
225
+ declare const usePatchInstanceMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
226
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError, {
227
227
  instanceId: string;
228
228
  params?: PatchInstanceParams;
229
229
  }, TContext>;
230
230
  request?: SecondParameter<typeof customInstance>;
231
- }) => UseMutationOptions<TData, TError, {
231
+ }) => UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError, {
232
232
  instanceId: string;
233
233
  params?: PatchInstanceParams;
234
234
  }, TContext>;
235
235
  type PatchInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof patchInstance>>>;
236
236
  type PatchInstanceMutationError = ErrorType<void | DmError>;
237
237
  /**
238
- * @summary Update a Job or Application Instance
239
- */
240
- declare const usePatchInstance: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
241
- 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, {
242
242
  instanceId: string;
243
243
  params?: PatchInstanceParams;
244
244
  }, TContext>;
245
245
  request?: SecondParameter<typeof customInstance>;
246
- }) => UseMutationResult<TData, TError, {
246
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof patchInstance>>, TError, {
247
247
  instanceId: string;
248
248
  params?: PatchInstanceParams;
249
249
  }, TContext>;
250
250
  /**
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.
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.
252
252
 
253
253
  Tokens automatically expire after a period of time but can be revoked instantly with this endpoint.
254
254
 
255
255
  The remote system will revoke the token when it's finished with it
256
256
 
257
- * @summary Delete (revoke) the Instance Token
258
- */
257
+ * @summary Delete (revoke) the Instance Token
258
+ */
259
259
  declare const deleteInstanceToken: (instanceId: string, token: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
260
- declare const getDeleteInstanceTokenMutationOptions: <TData = void, TError = ErrorType<DmError>, TContext = unknown>(options?: {
261
- mutation?: UseMutationOptions<TData, TError, {
260
+ declare const useDeleteInstanceTokenMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
261
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError, {
262
262
  instanceId: string;
263
263
  token: string;
264
264
  }, TContext>;
265
265
  request?: SecondParameter<typeof customInstance>;
266
- }) => UseMutationOptions<TData, TError, {
266
+ }) => UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError, {
267
267
  instanceId: string;
268
268
  token: string;
269
269
  }, TContext>;
270
270
  type DeleteInstanceTokenMutationResult = NonNullable<Awaited<ReturnType<typeof deleteInstanceToken>>>;
271
271
  type DeleteInstanceTokenMutationError = ErrorType<DmError>;
272
272
  /**
273
- * @summary Delete (revoke) the Instance Token
274
- */
275
- declare const useDeleteInstanceToken: <TData = void, TError = ErrorType<DmError>, TContext = unknown>(options?: {
276
- 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, {
277
277
  instanceId: string;
278
278
  token: string;
279
279
  }, TContext>;
280
280
  request?: SecondParameter<typeof customInstance>;
281
- }) => UseMutationResult<TData, TError, {
281
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteInstanceToken>>, TError, {
282
282
  instanceId: string;
283
283
  token: string;
284
284
  }, TContext>;
285
285
 
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, 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 };