@squonk/account-server-client 2.1.0-rc.1 → 2.1.0-rc.10

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 (78) hide show
  1. package/README.md +1 -1
  2. package/admin/admin.cjs +30 -8
  3. package/admin/admin.cjs.map +1 -1
  4. package/admin/admin.d.cts +50 -0
  5. package/admin/admin.d.ts +26 -6
  6. package/admin/admin.js +30 -8
  7. package/admin/admin.js.map +1 -1
  8. package/asset/asset.cjs +62 -22
  9. package/asset/asset.cjs.map +1 -1
  10. package/asset/asset.d.cts +260 -0
  11. package/asset/asset.d.ts +79 -36
  12. package/asset/asset.js +54 -14
  13. package/asset/asset.js.map +1 -1
  14. package/{chunk-3RNIDX7T.js → chunk-EBOQPVLG.js} +2 -2
  15. package/{chunk-3RNIDX7T.js.map → chunk-EBOQPVLG.js.map} +1 -1
  16. package/{chunk-UZTHSGDT.cjs → chunk-TKLTUR4R.cjs} +2 -2
  17. package/chunk-TKLTUR4R.cjs.map +1 -0
  18. package/event-stream/event-stream.cjs +64 -19
  19. package/event-stream/event-stream.cjs.map +1 -1
  20. package/event-stream/event-stream.d.cts +142 -0
  21. package/event-stream/event-stream.d.ts +66 -20
  22. package/event-stream/event-stream.js +61 -16
  23. package/event-stream/event-stream.js.map +1 -1
  24. package/index.cjs +10 -10
  25. package/index.cjs.map +1 -1
  26. package/{custom-instance-35e5d4fd.d.ts → index.d.cts} +163 -163
  27. package/index.d.ts +700 -2
  28. package/index.js +9 -9
  29. package/index.js.map +1 -1
  30. package/merchant/merchant.cjs +53 -14
  31. package/merchant/merchant.cjs.map +1 -1
  32. package/merchant/merchant.d.cts +91 -0
  33. package/merchant/merchant.d.ts +48 -8
  34. package/merchant/merchant.js +52 -13
  35. package/merchant/merchant.js.map +1 -1
  36. package/organisation/organisation.cjs +110 -28
  37. package/organisation/organisation.cjs.map +1 -1
  38. package/organisation/organisation.d.cts +271 -0
  39. package/organisation/organisation.d.ts +114 -25
  40. package/organisation/organisation.js +103 -21
  41. package/organisation/organisation.js.map +1 -1
  42. package/package.json +12 -12
  43. package/product/product.cjs +182 -47
  44. package/product/product.cjs.map +1 -1
  45. package/product/product.d.cts +399 -0
  46. package/product/product.d.ts +180 -31
  47. package/product/product.js +172 -37
  48. package/product/product.js.map +1 -1
  49. package/src/account-server-api.schemas.ts +272 -280
  50. package/src/admin/admin.ts +114 -84
  51. package/src/asset/asset.ts +480 -565
  52. package/src/custom-instance.ts +3 -4
  53. package/src/event-stream/event-stream.ts +300 -275
  54. package/src/merchant/merchant.ts +206 -142
  55. package/src/organisation/organisation.ts +549 -490
  56. package/src/product/product.ts +829 -688
  57. package/src/state/state.ts +112 -75
  58. package/src/unit/unit.ts +645 -599
  59. package/src/user/user.ts +489 -469
  60. package/state/state.cjs +29 -8
  61. package/state/state.cjs.map +1 -1
  62. package/state/state.d.cts +46 -0
  63. package/state/state.d.ts +26 -6
  64. package/state/state.js +29 -8
  65. package/state/state.js.map +1 -1
  66. package/unit/unit.cjs +120 -32
  67. package/unit/unit.cjs.map +1 -1
  68. package/unit/unit.d.cts +322 -0
  69. package/unit/unit.d.ts +133 -38
  70. package/unit/unit.js +112 -24
  71. package/unit/unit.js.map +1 -1
  72. package/user/user.cjs +96 -22
  73. package/user/user.cjs.map +1 -1
  74. package/user/user.d.cts +271 -0
  75. package/user/user.d.ts +96 -24
  76. package/user/user.js +90 -16
  77. package/user/user.js.map +1 -1
  78. package/chunk-UZTHSGDT.cjs.map +0 -1
package/unit/unit.d.ts CHANGED
@@ -1,9 +1,9 @@
1
- import { aF as customInstance, ap as OrganisationUnitsGetResponse, aG as ErrorType, aB as AsError, o as OrganisationUnitPostBodyBody, as as OrganisationUnitPostResponse, w as UnitDetail, n as UnitPatchBodyBody, a4 as UnitsGetResponse, p as PersonalUnitPutBodyBody, ar as PersonalUnitPutResponse, k as GetUnitChargesParams, ab as UnitChargesGetResponse } from '../custom-instance-35e5d4fd.js';
2
- import * as _tanstack_react_query from '@tanstack/react-query';
3
- import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from '@tanstack/react-query';
1
+ import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
2
+ import { UseQueryOptions, QueryKey, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseMutationOptions } from '@tanstack/react-query';
3
+ import { customInstance, OrganisationUnitsGetResponse, ErrorType, AsError, OrganisationUnitPostBodyBody, OrganisationUnitPostResponse, UnitDetail, UnitPatchBodyBody, UnitsGetResponse, PersonalUnitPutBodyBody, PersonalUnitPutResponse, GetUnitChargesParams, UnitChargesGetResponse } from '../index.js';
4
4
  import 'axios';
5
5
 
6
- type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
6
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
7
7
  /**
8
8
  * Gets Organisational Units you have access to or that are public
9
9
 
@@ -12,19 +12,39 @@ type SecondParameter<T extends (...args: any) => any> = T extends (config: any,
12
12
  declare const getOrganisationUnits: (orgId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationUnitsGetResponse>;
13
13
  declare const getGetOrganisationUnitsQueryKey: (orgId: string) => readonly ["account-server-api", `/organisation/${string}/unit`];
14
14
  declare const getGetOrganisationUnitsQueryOptions: <TData = OrganisationUnitsGetResponse, TError = ErrorType<void | AsError>>(orgId: string, options?: {
15
- query?: UseQueryOptions<OrganisationUnitsGetResponse, TError, TData, QueryKey> | undefined;
15
+ query?: Partial<UseQueryOptions<OrganisationUnitsGetResponse, TError, TData, QueryKey>> | undefined;
16
16
  request?: SecondParameter<typeof customInstance>;
17
17
  } | undefined) => UseQueryOptions<OrganisationUnitsGetResponse, TError, TData, QueryKey> & {
18
18
  queryKey: QueryKey;
19
19
  };
20
20
  type GetOrganisationUnitsQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisationUnits>>>;
21
21
  type GetOrganisationUnitsQueryError = ErrorType<void | AsError>;
22
+ /**
23
+ * @summary Gets Organisational Units
24
+ */
22
25
  declare const useGetOrganisationUnits: <TData = OrganisationUnitsGetResponse, TError = ErrorType<void | AsError>>(orgId: string, options?: {
23
- query?: UseQueryOptions<OrganisationUnitsGetResponse, TError, TData, QueryKey> | undefined;
26
+ query?: Partial<UseQueryOptions<OrganisationUnitsGetResponse, TError, TData, QueryKey>> | undefined;
24
27
  request?: SecondParameter<typeof customInstance>;
25
28
  } | undefined) => UseQueryResult<TData, TError> & {
26
29
  queryKey: QueryKey;
27
30
  };
31
+ declare const getGetOrganisationUnitsSuspenseQueryOptions: <TData = OrganisationUnitsGetResponse, TError = ErrorType<void | AsError>>(orgId: string, options?: {
32
+ query?: Partial<UseSuspenseQueryOptions<OrganisationUnitsGetResponse, TError, TData, QueryKey>> | undefined;
33
+ request?: SecondParameter<typeof customInstance>;
34
+ } | undefined) => UseSuspenseQueryOptions<OrganisationUnitsGetResponse, TError, TData, QueryKey> & {
35
+ queryKey: QueryKey;
36
+ };
37
+ type GetOrganisationUnitsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisationUnits>>>;
38
+ type GetOrganisationUnitsSuspenseQueryError = ErrorType<void | AsError>;
39
+ /**
40
+ * @summary Gets Organisational Units
41
+ */
42
+ declare const useGetOrganisationUnitsSuspense: <TData = OrganisationUnitsGetResponse, TError = ErrorType<void | AsError>>(orgId: string, options?: {
43
+ query?: Partial<UseSuspenseQueryOptions<OrganisationUnitsGetResponse, TError, TData, QueryKey>> | undefined;
44
+ request?: SecondParameter<typeof customInstance>;
45
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
46
+ queryKey: QueryKey;
47
+ };
28
48
  /**
29
49
  * Creates a new Organisation Unit. You need to be a member of the **Organisation** or have administration rights to use this endpoint
30
50
 
@@ -44,37 +64,60 @@ declare const getCreateOrganisationUnitMutationOptions: <TError = ErrorType<void
44
64
  type CreateOrganisationUnitMutationResult = NonNullable<Awaited<ReturnType<typeof createOrganisationUnit>>>;
45
65
  type CreateOrganisationUnitMutationBody = OrganisationUnitPostBodyBody;
46
66
  type CreateOrganisationUnitMutationError = ErrorType<AsError | void>;
67
+ /**
68
+ * @summary Create a new Organisational Unit
69
+ */
47
70
  declare const useCreateOrganisationUnit: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
48
71
  mutation?: UseMutationOptions<OrganisationUnitPostResponse, TError, {
49
72
  orgId: string;
50
73
  data: OrganisationUnitPostBodyBody;
51
74
  }, TContext> | undefined;
52
75
  request?: SecondParameter<typeof customInstance>;
53
- } | undefined) => _tanstack_react_query.UseMutationResult<OrganisationUnitPostResponse, TError, {
76
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<OrganisationUnitPostResponse, TError, {
54
77
  orgId: string;
55
78
  data: OrganisationUnitPostBodyBody;
56
79
  }, TContext>;
57
80
  /**
58
- * Gets a Unit, assuming it is public, you are a member of it or its **Organisation**. Admin users have access to all Units
81
+ * Gets a Unit, assuming it is public, you are a member of it or its **Organisation**. Admin users have access to all Units
59
82
 
60
- * @summary Gets an Organisational Unit
61
- */
83
+ * @summary Gets an Organisational Unit
84
+ */
62
85
  declare const getUnit: (unitId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<UnitDetail>;
63
86
  declare const getGetUnitQueryKey: (unitId: string) => readonly ["account-server-api", `/unit/${string}`];
64
87
  declare const getGetUnitQueryOptions: <TData = UnitDetail, TError = ErrorType<void | AsError>>(unitId: string, options?: {
65
- query?: UseQueryOptions<UnitDetail, TError, TData, QueryKey> | undefined;
88
+ query?: Partial<UseQueryOptions<UnitDetail, TError, TData, QueryKey>> | undefined;
66
89
  request?: SecondParameter<typeof customInstance>;
67
90
  } | undefined) => UseQueryOptions<UnitDetail, TError, TData, QueryKey> & {
68
91
  queryKey: QueryKey;
69
92
  };
70
93
  type GetUnitQueryResult = NonNullable<Awaited<ReturnType<typeof getUnit>>>;
71
94
  type GetUnitQueryError = ErrorType<void | AsError>;
95
+ /**
96
+ * @summary Gets an Organisational Unit
97
+ */
72
98
  declare const useGetUnit: <TData = UnitDetail, TError = ErrorType<void | AsError>>(unitId: string, options?: {
73
- query?: UseQueryOptions<UnitDetail, TError, TData, QueryKey> | undefined;
99
+ query?: Partial<UseQueryOptions<UnitDetail, TError, TData, QueryKey>> | undefined;
74
100
  request?: SecondParameter<typeof customInstance>;
75
101
  } | undefined) => UseQueryResult<TData, TError> & {
76
102
  queryKey: QueryKey;
77
103
  };
104
+ declare const getGetUnitSuspenseQueryOptions: <TData = UnitDetail, TError = ErrorType<void | AsError>>(unitId: string, options?: {
105
+ query?: Partial<UseSuspenseQueryOptions<UnitDetail, TError, TData, QueryKey>> | undefined;
106
+ request?: SecondParameter<typeof customInstance>;
107
+ } | undefined) => UseSuspenseQueryOptions<UnitDetail, TError, TData, QueryKey> & {
108
+ queryKey: QueryKey;
109
+ };
110
+ type GetUnitSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getUnit>>>;
111
+ type GetUnitSuspenseQueryError = ErrorType<void | AsError>;
112
+ /**
113
+ * @summary Gets an Organisational Unit
114
+ */
115
+ declare const useGetUnitSuspense: <TData = UnitDetail, TError = ErrorType<void | AsError>>(unitId: string, options?: {
116
+ query?: Partial<UseSuspenseQueryOptions<UnitDetail, TError, TData, QueryKey>> | undefined;
117
+ request?: SecondParameter<typeof customInstance>;
118
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
119
+ queryKey: QueryKey;
120
+ };
78
121
  /**
79
122
  * Used to update existing Unit.
80
123
 
@@ -96,25 +139,28 @@ declare const getPatchUnitMutationOptions: <TError = ErrorType<AsError>, TContex
96
139
  type PatchUnitMutationResult = NonNullable<Awaited<ReturnType<typeof patchUnit>>>;
97
140
  type PatchUnitMutationBody = UnitPatchBodyBody;
98
141
  type PatchUnitMutationError = ErrorType<AsError>;
142
+ /**
143
+ * @summary Adjust an existing Unit
144
+ */
99
145
  declare const usePatchUnit: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
100
146
  mutation?: UseMutationOptions<void, TError, {
101
147
  unitId: string;
102
148
  data: UnitPatchBodyBody;
103
149
  }, TContext> | undefined;
104
150
  request?: SecondParameter<typeof customInstance>;
105
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
151
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
106
152
  unitId: string;
107
153
  data: UnitPatchBodyBody;
108
154
  }, TContext>;
109
155
  /**
110
- * Deletes an Organisational Unit you have access to. Units can only be deleted by members of the Unit, its Organisation users or admin users.
156
+ * Deletes an Organisational Unit you have access to. Units can only be deleted by members of the Unit, its Organisation users or admin users.
111
157
 
112
158
  You cannot delete Units in the **Default Organisation**. These Units are **Personal Units** and need to be deleted using the `DELETE /unit` endpoint.
113
159
 
114
160
  You cannot delete a Unit that contains undeleted **Products**
115
161
 
116
- * @summary Deletes an Organisational Unit
117
- */
162
+ * @summary Deletes an Organisational Unit
163
+ */
118
164
  declare const deleteOrganisationUnit: (unitId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
119
165
  declare const getDeleteOrganisationUnitMutationOptions: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
120
166
  mutation?: UseMutationOptions<void, TError, {
@@ -126,35 +172,58 @@ declare const getDeleteOrganisationUnitMutationOptions: <TError = ErrorType<AsEr
126
172
  }, TContext>;
127
173
  type DeleteOrganisationUnitMutationResult = NonNullable<Awaited<ReturnType<typeof deleteOrganisationUnit>>>;
128
174
  type DeleteOrganisationUnitMutationError = ErrorType<AsError>;
175
+ /**
176
+ * @summary Deletes an Organisational Unit
177
+ */
129
178
  declare const useDeleteOrganisationUnit: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
130
179
  mutation?: UseMutationOptions<void, TError, {
131
180
  unitId: string;
132
181
  }, TContext> | undefined;
133
182
  request?: SecondParameter<typeof customInstance>;
134
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
183
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
135
184
  unitId: string;
136
185
  }, TContext>;
137
186
  /**
138
- * Gets all the Units that are public or you are a member of. Admin users can see all Units.
187
+ * Gets all the Units that are public or you are a member of. Admin users can see all Units.
139
188
 
140
- * @summary Gets Units
141
- */
189
+ * @summary Gets Units
190
+ */
142
191
  declare const getUnits: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<UnitsGetResponse>;
143
192
  declare const getGetUnitsQueryKey: () => readonly ["account-server-api", "/unit"];
144
193
  declare const getGetUnitsQueryOptions: <TData = UnitsGetResponse, TError = ErrorType<void | AsError>>(options?: {
145
- query?: UseQueryOptions<UnitsGetResponse, TError, TData, QueryKey> | undefined;
194
+ query?: Partial<UseQueryOptions<UnitsGetResponse, TError, TData, QueryKey>> | undefined;
146
195
  request?: SecondParameter<typeof customInstance>;
147
196
  } | undefined) => UseQueryOptions<UnitsGetResponse, TError, TData, QueryKey> & {
148
197
  queryKey: QueryKey;
149
198
  };
150
199
  type GetUnitsQueryResult = NonNullable<Awaited<ReturnType<typeof getUnits>>>;
151
200
  type GetUnitsQueryError = ErrorType<void | AsError>;
201
+ /**
202
+ * @summary Gets Units
203
+ */
152
204
  declare const useGetUnits: <TData = UnitsGetResponse, TError = ErrorType<void | AsError>>(options?: {
153
- query?: UseQueryOptions<UnitsGetResponse, TError, TData, QueryKey> | undefined;
205
+ query?: Partial<UseQueryOptions<UnitsGetResponse, TError, TData, QueryKey>> | undefined;
154
206
  request?: SecondParameter<typeof customInstance>;
155
207
  } | undefined) => UseQueryResult<TData, TError> & {
156
208
  queryKey: QueryKey;
157
209
  };
210
+ declare const getGetUnitsSuspenseQueryOptions: <TData = UnitsGetResponse, TError = ErrorType<void | AsError>>(options?: {
211
+ query?: Partial<UseSuspenseQueryOptions<UnitsGetResponse, TError, TData, QueryKey>> | undefined;
212
+ request?: SecondParameter<typeof customInstance>;
213
+ } | undefined) => UseSuspenseQueryOptions<UnitsGetResponse, TError, TData, QueryKey> & {
214
+ queryKey: QueryKey;
215
+ };
216
+ type GetUnitsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getUnits>>>;
217
+ type GetUnitsSuspenseQueryError = ErrorType<void | AsError>;
218
+ /**
219
+ * @summary Gets Units
220
+ */
221
+ declare const useGetUnitsSuspense: <TData = UnitsGetResponse, TError = ErrorType<void | AsError>>(options?: {
222
+ query?: Partial<UseSuspenseQueryOptions<UnitsGetResponse, TError, TData, QueryKey>> | undefined;
223
+ request?: SecondParameter<typeof customInstance>;
224
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
225
+ queryKey: QueryKey;
226
+ };
158
227
  /**
159
228
  * Creates a Personal Unit for a User. The unit will belong to the built-in **Default Organisation**.
160
229
 
@@ -174,54 +243,80 @@ declare const getCreateDefaultUnitMutationOptions: <TError = ErrorType<void | As
174
243
  type CreateDefaultUnitMutationResult = NonNullable<Awaited<ReturnType<typeof createDefaultUnit>>>;
175
244
  type CreateDefaultUnitMutationBody = PersonalUnitPutBodyBody;
176
245
  type CreateDefaultUnitMutationError = ErrorType<AsError | void>;
246
+ /**
247
+ * @summary Create a new Personal Unit
248
+ */
177
249
  declare const useCreateDefaultUnit: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
178
250
  mutation?: UseMutationOptions<PersonalUnitPutResponse, TError, {
179
251
  data: PersonalUnitPutBodyBody;
180
252
  }, TContext> | undefined;
181
253
  request?: SecondParameter<typeof customInstance>;
182
- } | undefined) => _tanstack_react_query.UseMutationResult<PersonalUnitPutResponse, TError, {
254
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<PersonalUnitPutResponse, TError, {
183
255
  data: PersonalUnitPutBodyBody;
184
256
  }, TContext>;
185
257
  /**
186
- * Deletes a Personal Unit. The Unit is *your* Unit, and belongs to the **Default Organisation**
258
+ * Deletes a Personal Unit. The Unit is *your* Unit, and belongs to the **Default Organisation**
187
259
 
188
- * @summary Deletes a Personal Unit
189
- */
260
+ * @summary Deletes a Personal Unit
261
+ */
190
262
  declare const deleteDefaultUnit: (options?: SecondParameter<typeof customInstance>) => Promise<void>;
191
- declare const getDeleteDefaultUnitMutationOptions: <TError = ErrorType<AsError>, TVariables = void, TContext = unknown>(options?: {
192
- mutation?: UseMutationOptions<void, TError, TVariables, TContext> | undefined;
263
+ declare const getDeleteDefaultUnitMutationOptions: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
264
+ mutation?: UseMutationOptions<void, TError, void, TContext> | undefined;
193
265
  request?: SecondParameter<typeof customInstance>;
194
- } | undefined) => UseMutationOptions<void, TError, TVariables, TContext>;
266
+ } | undefined) => UseMutationOptions<void, TError, void, TContext>;
195
267
  type DeleteDefaultUnitMutationResult = NonNullable<Awaited<ReturnType<typeof deleteDefaultUnit>>>;
196
268
  type DeleteDefaultUnitMutationError = ErrorType<AsError>;
197
- declare const useDeleteDefaultUnit: <TError = ErrorType<AsError>, TVariables = void, TContext = unknown>(options?: {
198
- mutation?: UseMutationOptions<void, TError, TVariables, TContext> | undefined;
269
+ /**
270
+ * @summary Deletes a Personal Unit
271
+ */
272
+ declare const useDeleteDefaultUnit: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
273
+ mutation?: UseMutationOptions<void, TError, void, TContext> | undefined;
199
274
  request?: SecondParameter<typeof customInstance>;
200
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, TVariables, TContext>;
275
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, void, TContext>;
201
276
  /**
202
- * Get the charges made against a Unit with optional **from** (inclusive) and **until** (exclusive) dates. If no dates are provided, the charges for the current billing period are returned.
277
+ * Get the charges made against a Unit with optional **from** (inclusive) and **until** (exclusive) dates. If no dates are provided, the charges for the current billing period are returned.
203
278
  Dates are interpreted using the Python `dateutil` parser, so the input strings are extremely flexible with, for example, `1 December 2021` as an acceptable input.
204
279
 
205
280
  **From** must be a date (day) prior to **until**. For example, to see the charges for the 11th July 2022 set **from** to `11 July 2022` and **until** to `12 July 2022`. As an alternative to **From** and **Until** you can provide a **Prior Billing Period**, a value that identifies the prior period to retrieve. A value of `-1` would indicate the *prior period* (month) with an oldest retrieval value of `-23` allowing you to obtain charges for up to two years.
206
281
 
207
282
  You need to be part of the **Unit** or **Organisation** to use this method
208
- * @summary Get charges made against a Unit
209
- */
283
+ * @summary Get charges made against a Unit
284
+ */
210
285
  declare const getUnitCharges: (unitId: string, params?: GetUnitChargesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<UnitChargesGetResponse>;
211
286
  declare const getGetUnitChargesQueryKey: (unitId: string, params?: GetUnitChargesParams) => readonly ["account-server-api", `/unit/${string}/charges`, ...GetUnitChargesParams[]];
212
287
  declare const getGetUnitChargesQueryOptions: <TData = UnitChargesGetResponse, TError = ErrorType<void | AsError>>(unitId: string, params?: GetUnitChargesParams, options?: {
213
- query?: UseQueryOptions<UnitChargesGetResponse, TError, TData, QueryKey> | undefined;
288
+ query?: Partial<UseQueryOptions<UnitChargesGetResponse, TError, TData, QueryKey>> | undefined;
214
289
  request?: SecondParameter<typeof customInstance>;
215
290
  } | undefined) => UseQueryOptions<UnitChargesGetResponse, TError, TData, QueryKey> & {
216
291
  queryKey: QueryKey;
217
292
  };
218
293
  type GetUnitChargesQueryResult = NonNullable<Awaited<ReturnType<typeof getUnitCharges>>>;
219
294
  type GetUnitChargesQueryError = ErrorType<AsError | void>;
295
+ /**
296
+ * @summary Get charges made against a Unit
297
+ */
220
298
  declare const useGetUnitCharges: <TData = UnitChargesGetResponse, TError = ErrorType<void | AsError>>(unitId: string, params?: GetUnitChargesParams, options?: {
221
- query?: UseQueryOptions<UnitChargesGetResponse, TError, TData, QueryKey> | undefined;
299
+ query?: Partial<UseQueryOptions<UnitChargesGetResponse, TError, TData, QueryKey>> | undefined;
222
300
  request?: SecondParameter<typeof customInstance>;
223
301
  } | undefined) => UseQueryResult<TData, TError> & {
224
302
  queryKey: QueryKey;
225
303
  };
304
+ declare const getGetUnitChargesSuspenseQueryOptions: <TData = UnitChargesGetResponse, TError = ErrorType<void | AsError>>(unitId: string, params?: GetUnitChargesParams, options?: {
305
+ query?: Partial<UseSuspenseQueryOptions<UnitChargesGetResponse, TError, TData, QueryKey>> | undefined;
306
+ request?: SecondParameter<typeof customInstance>;
307
+ } | undefined) => UseSuspenseQueryOptions<UnitChargesGetResponse, TError, TData, QueryKey> & {
308
+ queryKey: QueryKey;
309
+ };
310
+ type GetUnitChargesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getUnitCharges>>>;
311
+ type GetUnitChargesSuspenseQueryError = ErrorType<AsError | void>;
312
+ /**
313
+ * @summary Get charges made against a Unit
314
+ */
315
+ declare const useGetUnitChargesSuspense: <TData = UnitChargesGetResponse, TError = ErrorType<void | AsError>>(unitId: string, params?: GetUnitChargesParams, options?: {
316
+ query?: Partial<UseSuspenseQueryOptions<UnitChargesGetResponse, TError, TData, QueryKey>> | undefined;
317
+ request?: SecondParameter<typeof customInstance>;
318
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
319
+ queryKey: QueryKey;
320
+ };
226
321
 
227
- export { CreateDefaultUnitMutationBody, CreateDefaultUnitMutationError, CreateDefaultUnitMutationResult, CreateOrganisationUnitMutationBody, CreateOrganisationUnitMutationError, CreateOrganisationUnitMutationResult, DeleteDefaultUnitMutationError, DeleteDefaultUnitMutationResult, DeleteOrganisationUnitMutationError, DeleteOrganisationUnitMutationResult, GetOrganisationUnitsQueryError, GetOrganisationUnitsQueryResult, GetUnitChargesQueryError, GetUnitChargesQueryResult, GetUnitQueryError, GetUnitQueryResult, GetUnitsQueryError, GetUnitsQueryResult, PatchUnitMutationBody, PatchUnitMutationError, PatchUnitMutationResult, createDefaultUnit, createOrganisationUnit, deleteDefaultUnit, deleteOrganisationUnit, getCreateDefaultUnitMutationOptions, getCreateOrganisationUnitMutationOptions, getDeleteDefaultUnitMutationOptions, getDeleteOrganisationUnitMutationOptions, getGetOrganisationUnitsQueryKey, getGetOrganisationUnitsQueryOptions, getGetUnitChargesQueryKey, getGetUnitChargesQueryOptions, getGetUnitQueryKey, getGetUnitQueryOptions, getGetUnitsQueryKey, getGetUnitsQueryOptions, getOrganisationUnits, getPatchUnitMutationOptions, getUnit, getUnitCharges, getUnits, patchUnit, useCreateDefaultUnit, useCreateOrganisationUnit, useDeleteDefaultUnit, useDeleteOrganisationUnit, useGetOrganisationUnits, useGetUnit, useGetUnitCharges, useGetUnits, usePatchUnit };
322
+ export { type CreateDefaultUnitMutationBody, type CreateDefaultUnitMutationError, type CreateDefaultUnitMutationResult, type CreateOrganisationUnitMutationBody, type CreateOrganisationUnitMutationError, type CreateOrganisationUnitMutationResult, type DeleteDefaultUnitMutationError, type DeleteDefaultUnitMutationResult, type DeleteOrganisationUnitMutationError, type DeleteOrganisationUnitMutationResult, type GetOrganisationUnitsQueryError, type GetOrganisationUnitsQueryResult, type GetOrganisationUnitsSuspenseQueryError, type GetOrganisationUnitsSuspenseQueryResult, type GetUnitChargesQueryError, type GetUnitChargesQueryResult, type GetUnitChargesSuspenseQueryError, type GetUnitChargesSuspenseQueryResult, type GetUnitQueryError, type GetUnitQueryResult, type GetUnitSuspenseQueryError, type GetUnitSuspenseQueryResult, type GetUnitsQueryError, type GetUnitsQueryResult, type GetUnitsSuspenseQueryError, type GetUnitsSuspenseQueryResult, type PatchUnitMutationBody, type PatchUnitMutationError, type PatchUnitMutationResult, createDefaultUnit, createOrganisationUnit, deleteDefaultUnit, deleteOrganisationUnit, getCreateDefaultUnitMutationOptions, getCreateOrganisationUnitMutationOptions, getDeleteDefaultUnitMutationOptions, getDeleteOrganisationUnitMutationOptions, getGetOrganisationUnitsQueryKey, getGetOrganisationUnitsQueryOptions, getGetOrganisationUnitsSuspenseQueryOptions, getGetUnitChargesQueryKey, getGetUnitChargesQueryOptions, getGetUnitChargesSuspenseQueryOptions, getGetUnitQueryKey, getGetUnitQueryOptions, getGetUnitSuspenseQueryOptions, getGetUnitsQueryKey, getGetUnitsQueryOptions, getGetUnitsSuspenseQueryOptions, getOrganisationUnits, getPatchUnitMutationOptions, getUnit, getUnitCharges, getUnits, patchUnit, useCreateDefaultUnit, useCreateOrganisationUnit, useDeleteDefaultUnit, useDeleteOrganisationUnit, useGetOrganisationUnits, useGetOrganisationUnitsSuspense, useGetUnit, useGetUnitCharges, useGetUnitChargesSuspense, useGetUnitSuspense, useGetUnits, useGetUnitsSuspense, usePatchUnit };
package/unit/unit.js CHANGED
@@ -1,16 +1,26 @@
1
1
  import {
2
2
  customInstance
3
- } from "../chunk-3RNIDX7T.js";
3
+ } from "../chunk-EBOQPVLG.js";
4
4
 
5
5
  // src/unit/unit.ts
6
- import { useQuery, useMutation } from "@tanstack/react-query";
6
+ import {
7
+ useMutation,
8
+ useQuery,
9
+ useSuspenseQuery
10
+ } from "@tanstack/react-query";
7
11
  var getOrganisationUnits = (orgId, options, signal) => {
8
12
  return customInstance(
9
- { url: `/organisation/${orgId}/unit`, method: "get", signal },
13
+ {
14
+ url: `/organisation/${orgId}/unit`,
15
+ method: "GET",
16
+ signal
17
+ },
10
18
  options
11
19
  );
12
20
  };
13
- var getGetOrganisationUnitsQueryKey = (orgId) => ["account-server-api", `/organisation/${orgId}/unit`];
21
+ var getGetOrganisationUnitsQueryKey = (orgId) => {
22
+ return ["account-server-api", `/organisation/${orgId}/unit`];
23
+ };
14
24
  var getGetOrganisationUnitsQueryOptions = (orgId, options) => {
15
25
  const { query: queryOptions, request: requestOptions } = options ?? {};
16
26
  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetOrganisationUnitsQueryKey(orgId);
@@ -23,11 +33,23 @@ var useGetOrganisationUnits = (orgId, options) => {
23
33
  query.queryKey = queryOptions.queryKey;
24
34
  return query;
25
35
  };
36
+ var getGetOrganisationUnitsSuspenseQueryOptions = (orgId, options) => {
37
+ const { query: queryOptions, request: requestOptions } = options ?? {};
38
+ const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetOrganisationUnitsQueryKey(orgId);
39
+ const queryFn = ({ signal }) => getOrganisationUnits(orgId, requestOptions, signal);
40
+ return { queryKey, queryFn, enabled: !!orgId, ...queryOptions };
41
+ };
42
+ var useGetOrganisationUnitsSuspense = (orgId, options) => {
43
+ const queryOptions = getGetOrganisationUnitsSuspenseQueryOptions(orgId, options);
44
+ const query = useSuspenseQuery(queryOptions);
45
+ query.queryKey = queryOptions.queryKey;
46
+ return query;
47
+ };
26
48
  var createOrganisationUnit = (orgId, organisationUnitPostBodyBody, options) => {
27
49
  return customInstance(
28
50
  {
29
51
  url: `/organisation/${orgId}/unit`,
30
- method: "post",
52
+ method: "POST",
31
53
  headers: { "Content-Type": "application/json" },
32
54
  data: organisationUnitPostBodyBody
33
55
  },
@@ -48,17 +70,21 @@ var useCreateOrganisationUnit = (options) => {
48
70
  };
49
71
  var getUnit = (unitId, options, signal) => {
50
72
  return customInstance(
51
- { url: `/unit/${unitId}`, method: "get", signal },
73
+ {
74
+ url: `/unit/${unitId}`,
75
+ method: "GET",
76
+ signal
77
+ },
52
78
  options
53
79
  );
54
80
  };
55
- var getGetUnitQueryKey = (unitId) => ["account-server-api", `/unit/${unitId}`];
81
+ var getGetUnitQueryKey = (unitId) => {
82
+ return ["account-server-api", `/unit/${unitId}`];
83
+ };
56
84
  var getGetUnitQueryOptions = (unitId, options) => {
57
85
  const { query: queryOptions, request: requestOptions } = options ?? {};
58
86
  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetUnitQueryKey(unitId);
59
- const queryFn = ({
60
- signal
61
- }) => getUnit(unitId, requestOptions, signal);
87
+ const queryFn = ({ signal }) => getUnit(unitId, requestOptions, signal);
62
88
  return { queryKey, queryFn, enabled: !!unitId, ...queryOptions };
63
89
  };
64
90
  var useGetUnit = (unitId, options) => {
@@ -67,11 +93,23 @@ var useGetUnit = (unitId, options) => {
67
93
  query.queryKey = queryOptions.queryKey;
68
94
  return query;
69
95
  };
96
+ var getGetUnitSuspenseQueryOptions = (unitId, options) => {
97
+ const { query: queryOptions, request: requestOptions } = options ?? {};
98
+ const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetUnitQueryKey(unitId);
99
+ const queryFn = ({ signal }) => getUnit(unitId, requestOptions, signal);
100
+ return { queryKey, queryFn, enabled: !!unitId, ...queryOptions };
101
+ };
102
+ var useGetUnitSuspense = (unitId, options) => {
103
+ const queryOptions = getGetUnitSuspenseQueryOptions(unitId, options);
104
+ const query = useSuspenseQuery(queryOptions);
105
+ query.queryKey = queryOptions.queryKey;
106
+ return query;
107
+ };
70
108
  var patchUnit = (unitId, unitPatchBodyBody, options) => {
71
109
  return customInstance(
72
110
  {
73
111
  url: `/unit/${unitId}`,
74
- method: "patch",
112
+ method: "PATCH",
75
113
  headers: { "Content-Type": "application/json" },
76
114
  data: unitPatchBodyBody
77
115
  },
@@ -92,7 +130,10 @@ var usePatchUnit = (options) => {
92
130
  };
93
131
  var deleteOrganisationUnit = (unitId, options) => {
94
132
  return customInstance(
95
- { url: `/unit/${unitId}`, method: "delete" },
133
+ {
134
+ url: `/unit/${unitId}`,
135
+ method: "DELETE"
136
+ },
96
137
  options
97
138
  );
98
139
  };
@@ -110,17 +151,21 @@ var useDeleteOrganisationUnit = (options) => {
110
151
  };
111
152
  var getUnits = (options, signal) => {
112
153
  return customInstance(
113
- { url: `/unit`, method: "get", signal },
154
+ {
155
+ url: `/unit`,
156
+ method: "GET",
157
+ signal
158
+ },
114
159
  options
115
160
  );
116
161
  };
117
- var getGetUnitsQueryKey = () => ["account-server-api", `/unit`];
162
+ var getGetUnitsQueryKey = () => {
163
+ return ["account-server-api", `/unit`];
164
+ };
118
165
  var getGetUnitsQueryOptions = (options) => {
119
166
  const { query: queryOptions, request: requestOptions } = options ?? {};
120
167
  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetUnitsQueryKey();
121
- const queryFn = ({
122
- signal
123
- }) => getUnits(requestOptions, signal);
168
+ const queryFn = ({ signal }) => getUnits(requestOptions, signal);
124
169
  return { queryKey, queryFn, ...queryOptions };
125
170
  };
126
171
  var useGetUnits = (options) => {
@@ -129,11 +174,23 @@ var useGetUnits = (options) => {
129
174
  query.queryKey = queryOptions.queryKey;
130
175
  return query;
131
176
  };
177
+ var getGetUnitsSuspenseQueryOptions = (options) => {
178
+ const { query: queryOptions, request: requestOptions } = options ?? {};
179
+ const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetUnitsQueryKey();
180
+ const queryFn = ({ signal }) => getUnits(requestOptions, signal);
181
+ return { queryKey, queryFn, ...queryOptions };
182
+ };
183
+ var useGetUnitsSuspense = (options) => {
184
+ const queryOptions = getGetUnitsSuspenseQueryOptions(options);
185
+ const query = useSuspenseQuery(queryOptions);
186
+ query.queryKey = queryOptions.queryKey;
187
+ return query;
188
+ };
132
189
  var createDefaultUnit = (personalUnitPutBodyBody, options) => {
133
190
  return customInstance(
134
191
  {
135
192
  url: `/unit`,
136
- method: "put",
193
+ method: "PUT",
137
194
  headers: { "Content-Type": "application/json" },
138
195
  data: personalUnitPutBodyBody
139
196
  },
@@ -153,7 +210,13 @@ var useCreateDefaultUnit = (options) => {
153
210
  return useMutation(mutationOptions);
154
211
  };
155
212
  var deleteDefaultUnit = (options) => {
156
- return customInstance({ url: `/unit`, method: "delete" }, options);
213
+ return customInstance(
214
+ {
215
+ url: `/unit`,
216
+ method: "DELETE"
217
+ },
218
+ options
219
+ );
157
220
  };
158
221
  var getDeleteDefaultUnitMutationOptions = (options) => {
159
222
  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
@@ -168,17 +231,22 @@ var useDeleteDefaultUnit = (options) => {
168
231
  };
169
232
  var getUnitCharges = (unitId, params, options, signal) => {
170
233
  return customInstance(
171
- { url: `/unit/${unitId}/charges`, method: "get", params, signal },
234
+ {
235
+ url: `/unit/${unitId}/charges`,
236
+ method: "GET",
237
+ params,
238
+ signal
239
+ },
172
240
  options
173
241
  );
174
242
  };
175
- var getGetUnitChargesQueryKey = (unitId, params) => ["account-server-api", `/unit/${unitId}/charges`, ...params ? [params] : []];
243
+ var getGetUnitChargesQueryKey = (unitId, params) => {
244
+ return ["account-server-api", `/unit/${unitId}/charges`, ...params ? [params] : []];
245
+ };
176
246
  var getGetUnitChargesQueryOptions = (unitId, params, options) => {
177
247
  const { query: queryOptions, request: requestOptions } = options ?? {};
178
248
  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetUnitChargesQueryKey(unitId, params);
179
- const queryFn = ({
180
- signal
181
- }) => getUnitCharges(unitId, params, requestOptions, signal);
249
+ const queryFn = ({ signal }) => getUnitCharges(unitId, params, requestOptions, signal);
182
250
  return { queryKey, queryFn, enabled: !!unitId, ...queryOptions };
183
251
  };
184
252
  var useGetUnitCharges = (unitId, params, options) => {
@@ -187,6 +255,18 @@ var useGetUnitCharges = (unitId, params, options) => {
187
255
  query.queryKey = queryOptions.queryKey;
188
256
  return query;
189
257
  };
258
+ var getGetUnitChargesSuspenseQueryOptions = (unitId, params, options) => {
259
+ const { query: queryOptions, request: requestOptions } = options ?? {};
260
+ const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetUnitChargesQueryKey(unitId, params);
261
+ const queryFn = ({ signal }) => getUnitCharges(unitId, params, requestOptions, signal);
262
+ return { queryKey, queryFn, enabled: !!unitId, ...queryOptions };
263
+ };
264
+ var useGetUnitChargesSuspense = (unitId, params, options) => {
265
+ const queryOptions = getGetUnitChargesSuspenseQueryOptions(unitId, params, options);
266
+ const query = useSuspenseQuery(queryOptions);
267
+ query.queryKey = queryOptions.queryKey;
268
+ return query;
269
+ };
190
270
  export {
191
271
  createDefaultUnit,
192
272
  createOrganisationUnit,
@@ -198,12 +278,16 @@ export {
198
278
  getDeleteOrganisationUnitMutationOptions,
199
279
  getGetOrganisationUnitsQueryKey,
200
280
  getGetOrganisationUnitsQueryOptions,
281
+ getGetOrganisationUnitsSuspenseQueryOptions,
201
282
  getGetUnitChargesQueryKey,
202
283
  getGetUnitChargesQueryOptions,
284
+ getGetUnitChargesSuspenseQueryOptions,
203
285
  getGetUnitQueryKey,
204
286
  getGetUnitQueryOptions,
287
+ getGetUnitSuspenseQueryOptions,
205
288
  getGetUnitsQueryKey,
206
289
  getGetUnitsQueryOptions,
290
+ getGetUnitsSuspenseQueryOptions,
207
291
  getOrganisationUnits,
208
292
  getPatchUnitMutationOptions,
209
293
  getUnit,
@@ -215,9 +299,13 @@ export {
215
299
  useDeleteDefaultUnit,
216
300
  useDeleteOrganisationUnit,
217
301
  useGetOrganisationUnits,
302
+ useGetOrganisationUnitsSuspense,
218
303
  useGetUnit,
219
304
  useGetUnitCharges,
305
+ useGetUnitChargesSuspense,
306
+ useGetUnitSuspense,
220
307
  useGetUnits,
308
+ useGetUnitsSuspense,
221
309
  usePatchUnit
222
310
  };
223
311
  //# sourceMappingURL=unit.js.map