@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
package/job/job.d.ts CHANGED
@@ -1,8 +1,8 @@
1
- import { UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
2
- import { GetJobsParams, customInstance, JobsGetResponse, ErrorType, DmError, GetJobByVersionParams, JobGetResponse, GetJobParams } from '../index.js';
1
+ import { UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, QueryClient, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
2
+ import { GetJobsParams, customInstance, JobsGetResponse, ErrorType, DmError, GetJobByVersionParams, JobGetResponse, GetJobParams, GetAllJobExchangeRatesParams, GetAllExchangeRatesResponse, ExchangeRatePutBodyBody, GetJobExchangeRatesParams, GetExchangeRatesResponse } from '../index.js';
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
  * Get a list of all Jobs available to you that can be instantiated via the `/instance` endpoint.
8
8
 
@@ -11,8 +11,8 @@ Job availability will vary as Jobs are added to the service.
11
11
  * @summary Get all Jobs available to you
12
12
  */
13
13
  declare const getJobs: (params?: GetJobsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<JobsGetResponse>;
14
- declare const getGetJobsQueryKey: (params?: GetJobsParams) => readonly ["data-manager-api", "/job", ...GetJobsParams[]];
15
- declare const getGetJobsQueryOptions: <TData = JobsGetResponse, TError = ErrorType<DmError>>(params?: GetJobsParams, options?: {
14
+ declare const getGetJobsQueryKey: (params?: GetJobsParams) => readonly ["/job", ...GetJobsParams[]];
15
+ declare const useGetJobsQueryOptions: <TData = Awaited<ReturnType<typeof getJobs>>, TError = ErrorType<DmError>>(params?: GetJobsParams, options?: {
16
16
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>>;
17
17
  request?: SecondParameter<typeof customInstance>;
18
18
  }) => UseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData> & {
@@ -21,24 +21,24 @@ declare const getGetJobsQueryOptions: <TData = JobsGetResponse, TError = ErrorTy
21
21
  type GetJobsQueryResult = NonNullable<Awaited<ReturnType<typeof getJobs>>>;
22
22
  type GetJobsQueryError = ErrorType<DmError>;
23
23
  declare function useGetJobs<TData = Awaited<ReturnType<typeof getJobs>>, TError = ErrorType<DmError>>(params: undefined | GetJobsParams, options: {
24
- query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>, 'initialData'>;
24
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getJobs>>, TError, Awaited<ReturnType<typeof getJobs>>>, "initialData">;
25
25
  request?: SecondParameter<typeof customInstance>;
26
- }): DefinedUseQueryResult<TData, TError> & {
26
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
27
27
  queryKey: DataTag<QueryKey, TData, TError>;
28
28
  };
29
29
  declare function useGetJobs<TData = Awaited<ReturnType<typeof getJobs>>, TError = ErrorType<DmError>>(params?: GetJobsParams, options?: {
30
- query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>, 'initialData'>;
30
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getJobs>>, TError, Awaited<ReturnType<typeof getJobs>>>, "initialData">;
31
31
  request?: SecondParameter<typeof customInstance>;
32
- }): UseQueryResult<TData, TError> & {
32
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
33
33
  queryKey: DataTag<QueryKey, TData, TError>;
34
34
  };
35
35
  declare function useGetJobs<TData = Awaited<ReturnType<typeof getJobs>>, TError = ErrorType<DmError>>(params?: GetJobsParams, options?: {
36
36
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>>;
37
37
  request?: SecondParameter<typeof customInstance>;
38
- }): UseQueryResult<TData, TError> & {
38
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
39
39
  queryKey: DataTag<QueryKey, TData, TError>;
40
40
  };
41
- declare const getGetJobsSuspenseQueryOptions: <TData = JobsGetResponse, TError = ErrorType<DmError>>(params?: GetJobsParams, options?: {
41
+ declare const useGetJobsSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getJobs>>, TError = ErrorType<DmError>>(params?: GetJobsParams, options?: {
42
42
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>>;
43
43
  request?: SecondParameter<typeof customInstance>;
44
44
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData> & {
@@ -49,19 +49,19 @@ type GetJobsSuspenseQueryError = ErrorType<DmError>;
49
49
  declare function useGetJobsSuspense<TData = Awaited<ReturnType<typeof getJobs>>, TError = ErrorType<DmError>>(params: undefined | GetJobsParams, options: {
50
50
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>>;
51
51
  request?: SecondParameter<typeof customInstance>;
52
- }): UseSuspenseQueryResult<TData, TError> & {
52
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
53
53
  queryKey: DataTag<QueryKey, TData, TError>;
54
54
  };
55
55
  declare function useGetJobsSuspense<TData = Awaited<ReturnType<typeof getJobs>>, TError = ErrorType<DmError>>(params?: GetJobsParams, options?: {
56
56
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>>;
57
57
  request?: SecondParameter<typeof customInstance>;
58
- }): UseSuspenseQueryResult<TData, TError> & {
58
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
59
59
  queryKey: DataTag<QueryKey, TData, TError>;
60
60
  };
61
61
  declare function useGetJobsSuspense<TData = Awaited<ReturnType<typeof getJobs>>, TError = ErrorType<DmError>>(params?: GetJobsParams, options?: {
62
62
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobs>>, TError, TData>>;
63
63
  request?: SecondParameter<typeof customInstance>;
64
- }): UseSuspenseQueryResult<TData, TError> & {
64
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
65
65
  queryKey: DataTag<QueryKey, TData, TError>;
66
66
  };
67
67
  /**
@@ -72,8 +72,8 @@ Job availability will vary as Jobs are added to the service. Jobs that have been
72
72
  * @summary Get a Job by its version
73
73
  */
74
74
  declare const getJobByVersion: (params: GetJobByVersionParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<JobGetResponse>;
75
- declare const getGetJobByVersionQueryKey: (params: GetJobByVersionParams) => readonly ["data-manager-api", "/job/get-by-version", ...GetJobByVersionParams[]];
76
- declare const getGetJobByVersionQueryOptions: <TData = JobGetResponse, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options?: {
75
+ declare const getGetJobByVersionQueryKey: (params: GetJobByVersionParams) => readonly ["/job/get-by-version", ...GetJobByVersionParams[]];
76
+ declare const useGetJobByVersionQueryOptions: <TData = Awaited<ReturnType<typeof getJobByVersion>>, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options?: {
77
77
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>>;
78
78
  request?: SecondParameter<typeof customInstance>;
79
79
  }) => UseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData> & {
@@ -82,24 +82,24 @@ declare const getGetJobByVersionQueryOptions: <TData = JobGetResponse, TError =
82
82
  type GetJobByVersionQueryResult = NonNullable<Awaited<ReturnType<typeof getJobByVersion>>>;
83
83
  type GetJobByVersionQueryError = ErrorType<DmError>;
84
84
  declare function useGetJobByVersion<TData = Awaited<ReturnType<typeof getJobByVersion>>, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options: {
85
- query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>, 'initialData'>;
85
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, Awaited<ReturnType<typeof getJobByVersion>>>, "initialData">;
86
86
  request?: SecondParameter<typeof customInstance>;
87
- }): DefinedUseQueryResult<TData, TError> & {
87
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
88
88
  queryKey: DataTag<QueryKey, TData, TError>;
89
89
  };
90
90
  declare function useGetJobByVersion<TData = Awaited<ReturnType<typeof getJobByVersion>>, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options?: {
91
- query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>, 'initialData'>;
91
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, Awaited<ReturnType<typeof getJobByVersion>>>, "initialData">;
92
92
  request?: SecondParameter<typeof customInstance>;
93
- }): UseQueryResult<TData, TError> & {
93
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
94
94
  queryKey: DataTag<QueryKey, TData, TError>;
95
95
  };
96
96
  declare function useGetJobByVersion<TData = Awaited<ReturnType<typeof getJobByVersion>>, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options?: {
97
97
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>>;
98
98
  request?: SecondParameter<typeof customInstance>;
99
- }): UseQueryResult<TData, TError> & {
99
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
100
100
  queryKey: DataTag<QueryKey, TData, TError>;
101
101
  };
102
- declare const getGetJobByVersionSuspenseQueryOptions: <TData = JobGetResponse, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options?: {
102
+ declare const useGetJobByVersionSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getJobByVersion>>, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options?: {
103
103
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>>;
104
104
  request?: SecondParameter<typeof customInstance>;
105
105
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData> & {
@@ -110,19 +110,19 @@ type GetJobByVersionSuspenseQueryError = ErrorType<DmError>;
110
110
  declare function useGetJobByVersionSuspense<TData = Awaited<ReturnType<typeof getJobByVersion>>, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options: {
111
111
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>>;
112
112
  request?: SecondParameter<typeof customInstance>;
113
- }): UseSuspenseQueryResult<TData, TError> & {
113
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
114
114
  queryKey: DataTag<QueryKey, TData, TError>;
115
115
  };
116
116
  declare function useGetJobByVersionSuspense<TData = Awaited<ReturnType<typeof getJobByVersion>>, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options?: {
117
117
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>>;
118
118
  request?: SecondParameter<typeof customInstance>;
119
- }): UseSuspenseQueryResult<TData, TError> & {
119
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
120
120
  queryKey: DataTag<QueryKey, TData, TError>;
121
121
  };
122
122
  declare function useGetJobByVersionSuspense<TData = Awaited<ReturnType<typeof getJobByVersion>>, TError = ErrorType<DmError>>(params: GetJobByVersionParams, options?: {
123
123
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobByVersion>>, TError, TData>>;
124
124
  request?: SecondParameter<typeof customInstance>;
125
- }): UseSuspenseQueryResult<TData, TError> & {
125
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
126
126
  queryKey: DataTag<QueryKey, TData, TError>;
127
127
  };
128
128
  /**
@@ -133,8 +133,8 @@ To run a job you need to use the `/instance` endpoint. The Job is controlled thr
133
133
  * @summary Get details of a specific Job
134
134
  */
135
135
  declare const getJob: (jobId: number, params?: GetJobParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<JobGetResponse>;
136
- declare const getGetJobQueryKey: (jobId: number, params?: GetJobParams) => readonly ["data-manager-api", `/job/${number}`, ...GetJobParams[]];
137
- declare const getGetJobQueryOptions: <TData = JobGetResponse, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobParams, options?: {
136
+ declare const getGetJobQueryKey: (jobId: number, params?: GetJobParams) => readonly [`/job/${number}`, ...GetJobParams[]];
137
+ declare const useGetJobQueryOptions: <TData = Awaited<ReturnType<typeof getJob>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobParams, options?: {
138
138
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>>;
139
139
  request?: SecondParameter<typeof customInstance>;
140
140
  }) => UseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData> & {
@@ -143,24 +143,24 @@ declare const getGetJobQueryOptions: <TData = JobGetResponse, TError = ErrorType
143
143
  type GetJobQueryResult = NonNullable<Awaited<ReturnType<typeof getJob>>>;
144
144
  type GetJobQueryError = ErrorType<void | DmError>;
145
145
  declare function useGetJob<TData = Awaited<ReturnType<typeof getJob>>, TError = ErrorType<void | DmError>>(jobId: number, params: undefined | GetJobParams, options: {
146
- query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>, 'initialData'>;
146
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getJob>>, TError, Awaited<ReturnType<typeof getJob>>>, "initialData">;
147
147
  request?: SecondParameter<typeof customInstance>;
148
- }): DefinedUseQueryResult<TData, TError> & {
148
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
149
149
  queryKey: DataTag<QueryKey, TData, TError>;
150
150
  };
151
151
  declare function useGetJob<TData = Awaited<ReturnType<typeof getJob>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobParams, options?: {
152
- query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>, 'initialData'>;
152
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getJob>>, TError, Awaited<ReturnType<typeof getJob>>>, "initialData">;
153
153
  request?: SecondParameter<typeof customInstance>;
154
- }): UseQueryResult<TData, TError> & {
154
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
155
155
  queryKey: DataTag<QueryKey, TData, TError>;
156
156
  };
157
157
  declare function useGetJob<TData = Awaited<ReturnType<typeof getJob>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobParams, options?: {
158
158
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>>;
159
159
  request?: SecondParameter<typeof customInstance>;
160
- }): UseQueryResult<TData, TError> & {
160
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
161
161
  queryKey: DataTag<QueryKey, TData, TError>;
162
162
  };
163
- declare const getGetJobSuspenseQueryOptions: <TData = JobGetResponse, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobParams, options?: {
163
+ declare const useGetJobSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getJob>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobParams, options?: {
164
164
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>>;
165
165
  request?: SecondParameter<typeof customInstance>;
166
166
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData> & {
@@ -171,20 +171,176 @@ type GetJobSuspenseQueryError = ErrorType<void | DmError>;
171
171
  declare function useGetJobSuspense<TData = Awaited<ReturnType<typeof getJob>>, TError = ErrorType<void | DmError>>(jobId: number, params: undefined | GetJobParams, options: {
172
172
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>>;
173
173
  request?: SecondParameter<typeof customInstance>;
174
- }): UseSuspenseQueryResult<TData, TError> & {
174
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
175
175
  queryKey: DataTag<QueryKey, TData, TError>;
176
176
  };
177
177
  declare function useGetJobSuspense<TData = Awaited<ReturnType<typeof getJob>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobParams, options?: {
178
178
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>>;
179
179
  request?: SecondParameter<typeof customInstance>;
180
- }): UseSuspenseQueryResult<TData, TError> & {
180
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
181
181
  queryKey: DataTag<QueryKey, TData, TError>;
182
182
  };
183
183
  declare function useGetJobSuspense<TData = Awaited<ReturnType<typeof getJob>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobParams, options?: {
184
184
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJob>>, TError, TData>>;
185
185
  request?: SecondParameter<typeof customInstance>;
186
- }): UseSuspenseQueryResult<TData, TError> & {
186
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
187
+ queryKey: DataTag<QueryKey, TData, TError>;
188
+ };
189
+ /**
190
+ * For every Job that has an exchange rate the current rate is returned. If you want a list of all Jobs that have no exchange rate, set the `only_undefined` query option.
191
+
192
+ * @summary Gets Exchange Rates for all Jobs
193
+ */
194
+ declare const getAllJobExchangeRates: (params?: GetAllJobExchangeRatesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<GetAllExchangeRatesResponse>;
195
+ declare const getGetAllJobExchangeRatesQueryKey: (params?: GetAllJobExchangeRatesParams) => readonly ["/job-exchange-rates", ...GetAllJobExchangeRatesParams[]];
196
+ declare const useGetAllJobExchangeRatesQueryOptions: <TData = Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError = ErrorType<void | DmError>>(params?: GetAllJobExchangeRatesParams, options?: {
197
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData>>;
198
+ request?: SecondParameter<typeof customInstance>;
199
+ }) => UseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData> & {
200
+ queryKey: DataTag<QueryKey, TData, TError>;
201
+ };
202
+ type GetAllJobExchangeRatesQueryResult = NonNullable<Awaited<ReturnType<typeof getAllJobExchangeRates>>>;
203
+ type GetAllJobExchangeRatesQueryError = ErrorType<void | DmError>;
204
+ declare function useGetAllJobExchangeRates<TData = Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError = ErrorType<void | DmError>>(params: undefined | GetAllJobExchangeRatesParams, options: {
205
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, Awaited<ReturnType<typeof getAllJobExchangeRates>>>, "initialData">;
206
+ request?: SecondParameter<typeof customInstance>;
207
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
208
+ queryKey: DataTag<QueryKey, TData, TError>;
209
+ };
210
+ declare function useGetAllJobExchangeRates<TData = Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError = ErrorType<void | DmError>>(params?: GetAllJobExchangeRatesParams, options?: {
211
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, Awaited<ReturnType<typeof getAllJobExchangeRates>>>, "initialData">;
212
+ request?: SecondParameter<typeof customInstance>;
213
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
214
+ queryKey: DataTag<QueryKey, TData, TError>;
215
+ };
216
+ declare function useGetAllJobExchangeRates<TData = Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError = ErrorType<void | DmError>>(params?: GetAllJobExchangeRatesParams, options?: {
217
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData>>;
218
+ request?: SecondParameter<typeof customInstance>;
219
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
220
+ queryKey: DataTag<QueryKey, TData, TError>;
221
+ };
222
+ declare const useGetAllJobExchangeRatesSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError = ErrorType<void | DmError>>(params?: GetAllJobExchangeRatesParams, options?: {
223
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData>>;
224
+ request?: SecondParameter<typeof customInstance>;
225
+ }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData> & {
226
+ queryKey: DataTag<QueryKey, TData, TError>;
227
+ };
228
+ type GetAllJobExchangeRatesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getAllJobExchangeRates>>>;
229
+ type GetAllJobExchangeRatesSuspenseQueryError = ErrorType<void | DmError>;
230
+ declare function useGetAllJobExchangeRatesSuspense<TData = Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError = ErrorType<void | DmError>>(params: undefined | GetAllJobExchangeRatesParams, options: {
231
+ query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData>>;
232
+ request?: SecondParameter<typeof customInstance>;
233
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
234
+ queryKey: DataTag<QueryKey, TData, TError>;
235
+ };
236
+ declare function useGetAllJobExchangeRatesSuspense<TData = Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError = ErrorType<void | DmError>>(params?: GetAllJobExchangeRatesParams, options?: {
237
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData>>;
238
+ request?: SecondParameter<typeof customInstance>;
239
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
240
+ queryKey: DataTag<QueryKey, TData, TError>;
241
+ };
242
+ declare function useGetAllJobExchangeRatesSuspense<TData = Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError = ErrorType<void | DmError>>(params?: GetAllJobExchangeRatesParams, options?: {
243
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllJobExchangeRates>>, TError, TData>>;
244
+ request?: SecondParameter<typeof customInstance>;
245
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
246
+ queryKey: DataTag<QueryKey, TData, TError>;
247
+ };
248
+ /**
249
+ * Sets the Exchange Rate for a specific job. The rate replaces any existing rate for the Job and applies immediately and future job executions for this Job will inherit this rate.
250
+
251
+ Exchange rates are divided by an internal **scale factor** prior to being applied. The scale factor has a value of 1,000. The scale factor is used to make the exchange rates a little easier to digest, because without this on some jobs we would need to support values ike '0.00001'. With a scale factor of `1,000` the exchange rate is a much more humanly-digestible, e.g. '0.00001' becomes '0.01'.
252
+
253
+ If a Job has no specific rate it adopts the current value of the default Job Exchange Rate.
254
+
255
+ You need `admin` privilege to use this method.
256
+
257
+ * @summary Sets the Exchange Rate for a specific Job
258
+ */
259
+ declare const setJobPricing: (jobId: number, exchangeRatePutBodyBody: ExchangeRatePutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
260
+ declare const useSetJobPricingMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
261
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof setJobPricing>>, TError, {
262
+ jobId: number;
263
+ data: ExchangeRatePutBodyBody;
264
+ }, TContext>;
265
+ request?: SecondParameter<typeof customInstance>;
266
+ }) => UseMutationOptions<Awaited<ReturnType<typeof setJobPricing>>, TError, {
267
+ jobId: number;
268
+ data: ExchangeRatePutBodyBody;
269
+ }, TContext>;
270
+ type SetJobPricingMutationResult = NonNullable<Awaited<ReturnType<typeof setJobPricing>>>;
271
+ type SetJobPricingMutationBody = ExchangeRatePutBodyBody;
272
+ type SetJobPricingMutationError = ErrorType<void | DmError>;
273
+ /**
274
+ * @summary Sets the Exchange Rate for a specific Job
275
+ */
276
+ declare const useSetJobPricing: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
277
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof setJobPricing>>, TError, {
278
+ jobId: number;
279
+ data: ExchangeRatePutBodyBody;
280
+ }, TContext>;
281
+ request?: SecondParameter<typeof customInstance>;
282
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof setJobPricing>>, TError, {
283
+ jobId: number;
284
+ data: ExchangeRatePutBodyBody;
285
+ }, TContext>;
286
+ /**
287
+ * Gets all the exchange rate history for a specific Job. Rates are returned in reverse chronological order, with the most recent rate, the current rate, as the first entry in the list.
288
+
289
+ * @summary Gets Job Exchange Rates
290
+ */
291
+ declare const getJobExchangeRates: (jobId: number, params?: GetJobExchangeRatesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<GetExchangeRatesResponse>;
292
+ declare const getGetJobExchangeRatesQueryKey: (jobId: number, params?: GetJobExchangeRatesParams) => readonly [`/job/${number}/exchange-rate`, ...GetJobExchangeRatesParams[]];
293
+ declare const useGetJobExchangeRatesQueryOptions: <TData = Awaited<ReturnType<typeof getJobExchangeRates>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobExchangeRatesParams, options?: {
294
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData>>;
295
+ request?: SecondParameter<typeof customInstance>;
296
+ }) => UseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData> & {
297
+ queryKey: DataTag<QueryKey, TData, TError>;
298
+ };
299
+ type GetJobExchangeRatesQueryResult = NonNullable<Awaited<ReturnType<typeof getJobExchangeRates>>>;
300
+ type GetJobExchangeRatesQueryError = ErrorType<void | DmError>;
301
+ declare function useGetJobExchangeRates<TData = Awaited<ReturnType<typeof getJobExchangeRates>>, TError = ErrorType<void | DmError>>(jobId: number, params: undefined | GetJobExchangeRatesParams, options: {
302
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, Awaited<ReturnType<typeof getJobExchangeRates>>>, "initialData">;
303
+ request?: SecondParameter<typeof customInstance>;
304
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
305
+ queryKey: DataTag<QueryKey, TData, TError>;
306
+ };
307
+ declare function useGetJobExchangeRates<TData = Awaited<ReturnType<typeof getJobExchangeRates>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobExchangeRatesParams, options?: {
308
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, Awaited<ReturnType<typeof getJobExchangeRates>>>, "initialData">;
309
+ request?: SecondParameter<typeof customInstance>;
310
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
311
+ queryKey: DataTag<QueryKey, TData, TError>;
312
+ };
313
+ declare function useGetJobExchangeRates<TData = Awaited<ReturnType<typeof getJobExchangeRates>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobExchangeRatesParams, options?: {
314
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData>>;
315
+ request?: SecondParameter<typeof customInstance>;
316
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
317
+ queryKey: DataTag<QueryKey, TData, TError>;
318
+ };
319
+ declare const useGetJobExchangeRatesSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getJobExchangeRates>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobExchangeRatesParams, options?: {
320
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData>>;
321
+ request?: SecondParameter<typeof customInstance>;
322
+ }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData> & {
323
+ queryKey: DataTag<QueryKey, TData, TError>;
324
+ };
325
+ type GetJobExchangeRatesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getJobExchangeRates>>>;
326
+ type GetJobExchangeRatesSuspenseQueryError = ErrorType<void | DmError>;
327
+ declare function useGetJobExchangeRatesSuspense<TData = Awaited<ReturnType<typeof getJobExchangeRates>>, TError = ErrorType<void | DmError>>(jobId: number, params: undefined | GetJobExchangeRatesParams, options: {
328
+ query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData>>;
329
+ request?: SecondParameter<typeof customInstance>;
330
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
331
+ queryKey: DataTag<QueryKey, TData, TError>;
332
+ };
333
+ declare function useGetJobExchangeRatesSuspense<TData = Awaited<ReturnType<typeof getJobExchangeRates>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobExchangeRatesParams, options?: {
334
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData>>;
335
+ request?: SecondParameter<typeof customInstance>;
336
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
337
+ queryKey: DataTag<QueryKey, TData, TError>;
338
+ };
339
+ declare function useGetJobExchangeRatesSuspense<TData = Awaited<ReturnType<typeof getJobExchangeRates>>, TError = ErrorType<void | DmError>>(jobId: number, params?: GetJobExchangeRatesParams, options?: {
340
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getJobExchangeRates>>, TError, TData>>;
341
+ request?: SecondParameter<typeof customInstance>;
342
+ }, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
187
343
  queryKey: DataTag<QueryKey, TData, TError>;
188
344
  };
189
345
 
190
- export { type GetJobByVersionQueryError, type GetJobByVersionQueryResult, type GetJobByVersionSuspenseQueryError, type GetJobByVersionSuspenseQueryResult, type GetJobQueryError, type GetJobQueryResult, type GetJobSuspenseQueryError, type GetJobSuspenseQueryResult, type GetJobsQueryError, type GetJobsQueryResult, type GetJobsSuspenseQueryError, type GetJobsSuspenseQueryResult, getGetJobByVersionQueryKey, getGetJobByVersionQueryOptions, getGetJobByVersionSuspenseQueryOptions, getGetJobQueryKey, getGetJobQueryOptions, getGetJobSuspenseQueryOptions, getGetJobsQueryKey, getGetJobsQueryOptions, getGetJobsSuspenseQueryOptions, getJob, getJobByVersion, getJobs, useGetJob, useGetJobByVersion, useGetJobByVersionSuspense, useGetJobSuspense, useGetJobs, useGetJobsSuspense };
346
+ export { type GetAllJobExchangeRatesQueryError, type GetAllJobExchangeRatesQueryResult, type GetAllJobExchangeRatesSuspenseQueryError, type GetAllJobExchangeRatesSuspenseQueryResult, type GetJobByVersionQueryError, type GetJobByVersionQueryResult, type GetJobByVersionSuspenseQueryError, type GetJobByVersionSuspenseQueryResult, type GetJobExchangeRatesQueryError, type GetJobExchangeRatesQueryResult, type GetJobExchangeRatesSuspenseQueryError, type GetJobExchangeRatesSuspenseQueryResult, type GetJobQueryError, type GetJobQueryResult, type GetJobSuspenseQueryError, type GetJobSuspenseQueryResult, type GetJobsQueryError, type GetJobsQueryResult, type GetJobsSuspenseQueryError, type GetJobsSuspenseQueryResult, type SetJobPricingMutationBody, type SetJobPricingMutationError, type SetJobPricingMutationResult, getAllJobExchangeRates, getGetAllJobExchangeRatesQueryKey, getGetJobByVersionQueryKey, getGetJobExchangeRatesQueryKey, getGetJobQueryKey, getGetJobsQueryKey, getJob, getJobByVersion, getJobExchangeRates, getJobs, setJobPricing, useGetAllJobExchangeRates, useGetAllJobExchangeRatesQueryOptions, useGetAllJobExchangeRatesSuspense, useGetAllJobExchangeRatesSuspenseQueryOptions, useGetJob, useGetJobByVersion, useGetJobByVersionQueryOptions, useGetJobByVersionSuspense, useGetJobByVersionSuspenseQueryOptions, useGetJobExchangeRates, useGetJobExchangeRatesQueryOptions, useGetJobExchangeRatesSuspense, useGetJobExchangeRatesSuspenseQueryOptions, useGetJobQueryOptions, useGetJobSuspense, useGetJobSuspenseQueryOptions, useGetJobs, useGetJobsQueryOptions, useGetJobsSuspense, useGetJobsSuspenseQueryOptions, useSetJobPricing, useSetJobPricingMutationOptions };