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

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
@@ -0,0 +1,271 @@
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, OrganisationsGetResponse, ErrorType, AsError, OrganisationPostBodyBody, OrganisationPostResponse, OrganisationDetail, OrganisationPatchBodyBody, GetOrganisationChargesParams, OrganisationChargesGetResponse, OrganisationGetDefaultResponse } from '../index.cjs';
4
+ import 'axios';
5
+
6
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
7
+ /**
8
+ * Gets all the Organisations that you are a member of or are public. Admin users are members of all Organisations
9
+
10
+ * @summary Gets Organisations
11
+ */
12
+ declare const getOrganisations: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationsGetResponse>;
13
+ declare const getGetOrganisationsQueryKey: () => readonly ["account-server-api", "/organisation"];
14
+ declare const getGetOrganisationsQueryOptions: <TData = OrganisationsGetResponse, TError = ErrorType<void | AsError>>(options?: {
15
+ query?: Partial<UseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey>> | undefined;
16
+ request?: SecondParameter<typeof customInstance>;
17
+ } | undefined) => UseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey> & {
18
+ queryKey: QueryKey;
19
+ };
20
+ type GetOrganisationsQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisations>>>;
21
+ type GetOrganisationsQueryError = ErrorType<void | AsError>;
22
+ /**
23
+ * @summary Gets Organisations
24
+ */
25
+ declare const useGetOrganisations: <TData = OrganisationsGetResponse, TError = ErrorType<void | AsError>>(options?: {
26
+ query?: Partial<UseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey>> | undefined;
27
+ request?: SecondParameter<typeof customInstance>;
28
+ } | undefined) => UseQueryResult<TData, TError> & {
29
+ queryKey: QueryKey;
30
+ };
31
+ declare const getGetOrganisationsSuspenseQueryOptions: <TData = OrganisationsGetResponse, TError = ErrorType<void | AsError>>(options?: {
32
+ query?: Partial<UseSuspenseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey>> | undefined;
33
+ request?: SecondParameter<typeof customInstance>;
34
+ } | undefined) => UseSuspenseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey> & {
35
+ queryKey: QueryKey;
36
+ };
37
+ type GetOrganisationsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisations>>>;
38
+ type GetOrganisationsSuspenseQueryError = ErrorType<void | AsError>;
39
+ /**
40
+ * @summary Gets Organisations
41
+ */
42
+ declare const useGetOrganisationsSuspense: <TData = OrganisationsGetResponse, TError = ErrorType<void | AsError>>(options?: {
43
+ query?: Partial<UseSuspenseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey>> | undefined;
44
+ request?: SecondParameter<typeof customInstance>;
45
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
46
+ queryKey: QueryKey;
47
+ };
48
+ /**
49
+ * Creates a new Organisation
50
+
51
+ You need admin rights to use this method
52
+
53
+ * @summary Create a new organisation
54
+ */
55
+ declare const createOrganisation: (organisationPostBodyBody: OrganisationPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<OrganisationPostResponse>;
56
+ declare const getCreateOrganisationMutationOptions: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
57
+ mutation?: UseMutationOptions<OrganisationPostResponse, TError, {
58
+ data: OrganisationPostBodyBody;
59
+ }, TContext> | undefined;
60
+ request?: SecondParameter<typeof customInstance>;
61
+ } | undefined) => UseMutationOptions<OrganisationPostResponse, TError, {
62
+ data: OrganisationPostBodyBody;
63
+ }, TContext>;
64
+ type CreateOrganisationMutationResult = NonNullable<Awaited<ReturnType<typeof createOrganisation>>>;
65
+ type CreateOrganisationMutationBody = OrganisationPostBodyBody;
66
+ type CreateOrganisationMutationError = ErrorType<AsError | void>;
67
+ /**
68
+ * @summary Create a new organisation
69
+ */
70
+ declare const useCreateOrganisation: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
71
+ mutation?: UseMutationOptions<OrganisationPostResponse, TError, {
72
+ data: OrganisationPostBodyBody;
73
+ }, TContext> | undefined;
74
+ request?: SecondParameter<typeof customInstance>;
75
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<OrganisationPostResponse, TError, {
76
+ data: OrganisationPostBodyBody;
77
+ }, TContext>;
78
+ /**
79
+ * Gets a specific Organisation. To see the Organisation you need admin rights or need to be a member of the Organisation.
80
+
81
+ Members of an Organisation's **Unit** do not necessarily have access to the Organisation.
82
+
83
+ * @summary Gets an Organisation
84
+ */
85
+ declare const getOrganisation: (orgId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationDetail>;
86
+ declare const getGetOrganisationQueryKey: (orgId: string) => readonly ["account-server-api", `/organisation/${string}`];
87
+ declare const getGetOrganisationQueryOptions: <TData = OrganisationDetail, TError = ErrorType<void | AsError>>(orgId: string, options?: {
88
+ query?: Partial<UseQueryOptions<OrganisationDetail, TError, TData, QueryKey>> | undefined;
89
+ request?: SecondParameter<typeof customInstance>;
90
+ } | undefined) => UseQueryOptions<OrganisationDetail, TError, TData, QueryKey> & {
91
+ queryKey: QueryKey;
92
+ };
93
+ type GetOrganisationQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisation>>>;
94
+ type GetOrganisationQueryError = ErrorType<void | AsError>;
95
+ /**
96
+ * @summary Gets an Organisation
97
+ */
98
+ declare const useGetOrganisation: <TData = OrganisationDetail, TError = ErrorType<void | AsError>>(orgId: string, options?: {
99
+ query?: Partial<UseQueryOptions<OrganisationDetail, TError, TData, QueryKey>> | undefined;
100
+ request?: SecondParameter<typeof customInstance>;
101
+ } | undefined) => UseQueryResult<TData, TError> & {
102
+ queryKey: QueryKey;
103
+ };
104
+ declare const getGetOrganisationSuspenseQueryOptions: <TData = OrganisationDetail, TError = ErrorType<void | AsError>>(orgId: string, options?: {
105
+ query?: Partial<UseSuspenseQueryOptions<OrganisationDetail, TError, TData, QueryKey>> | undefined;
106
+ request?: SecondParameter<typeof customInstance>;
107
+ } | undefined) => UseSuspenseQueryOptions<OrganisationDetail, TError, TData, QueryKey> & {
108
+ queryKey: QueryKey;
109
+ };
110
+ type GetOrganisationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisation>>>;
111
+ type GetOrganisationSuspenseQueryError = ErrorType<void | AsError>;
112
+ /**
113
+ * @summary Gets an Organisation
114
+ */
115
+ declare const useGetOrganisationSuspense: <TData = OrganisationDetail, TError = ErrorType<void | AsError>>(orgId: string, options?: {
116
+ query?: Partial<UseSuspenseQueryOptions<OrganisationDetail, TError, TData, QueryKey>> | undefined;
117
+ request?: SecondParameter<typeof customInstance>;
118
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
119
+ queryKey: QueryKey;
120
+ };
121
+ /**
122
+ * Used to update existing Organisation.
123
+
124
+ You have to be the Organisation owner (or an administrator) to patch an Organisation.
125
+
126
+ * @summary Adjust an existing Organisation
127
+ */
128
+ declare const patchOrganisation: (orgId: string, organisationPatchBodyBody: OrganisationPatchBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
129
+ declare const getPatchOrganisationMutationOptions: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
130
+ mutation?: UseMutationOptions<void, TError, {
131
+ orgId: string;
132
+ data: OrganisationPatchBodyBody;
133
+ }, TContext> | undefined;
134
+ request?: SecondParameter<typeof customInstance>;
135
+ } | undefined) => UseMutationOptions<void, TError, {
136
+ orgId: string;
137
+ data: OrganisationPatchBodyBody;
138
+ }, TContext>;
139
+ type PatchOrganisationMutationResult = NonNullable<Awaited<ReturnType<typeof patchOrganisation>>>;
140
+ type PatchOrganisationMutationBody = OrganisationPatchBodyBody;
141
+ type PatchOrganisationMutationError = ErrorType<AsError>;
142
+ /**
143
+ * @summary Adjust an existing Organisation
144
+ */
145
+ declare const usePatchOrganisation: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
146
+ mutation?: UseMutationOptions<void, TError, {
147
+ orgId: string;
148
+ data: OrganisationPatchBodyBody;
149
+ }, TContext> | undefined;
150
+ request?: SecondParameter<typeof customInstance>;
151
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
152
+ orgId: string;
153
+ data: OrganisationPatchBodyBody;
154
+ }, TContext>;
155
+ /**
156
+ * Before an Organisation can be deleted all its underlying **Units** must also be deleted, remembering that **Units** that have undeleted **Products** cannot be deleted.
157
+
158
+ You need admin rights to use this method
159
+
160
+ * @summary Deletes an Organisation
161
+ */
162
+ declare const deleteOrganisation: (orgId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
163
+ declare const getDeleteOrganisationMutationOptions: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
164
+ mutation?: UseMutationOptions<void, TError, {
165
+ orgId: string;
166
+ }, TContext> | undefined;
167
+ request?: SecondParameter<typeof customInstance>;
168
+ } | undefined) => UseMutationOptions<void, TError, {
169
+ orgId: string;
170
+ }, TContext>;
171
+ type DeleteOrganisationMutationResult = NonNullable<Awaited<ReturnType<typeof deleteOrganisation>>>;
172
+ type DeleteOrganisationMutationError = ErrorType<AsError>;
173
+ /**
174
+ * @summary Deletes an Organisation
175
+ */
176
+ declare const useDeleteOrganisation: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
177
+ mutation?: UseMutationOptions<void, TError, {
178
+ orgId: string;
179
+ }, TContext> | undefined;
180
+ request?: SecondParameter<typeof customInstance>;
181
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
182
+ orgId: string;
183
+ }, TContext>;
184
+ /**
185
+ * Gets a Organisation charges.
186
+
187
+ The Organisation cannot be the **Default Organisation** and you need to be a member of the Organisation to use this endpoint
188
+
189
+ * @summary Gets charges for all Units in an Organisation
190
+ */
191
+ declare const getOrganisationCharges: (orgId: string, params?: GetOrganisationChargesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationChargesGetResponse>;
192
+ declare const getGetOrganisationChargesQueryKey: (orgId: string, params?: GetOrganisationChargesParams) => readonly ["account-server-api", `/organisation/${string}/charges`, ...GetOrganisationChargesParams[]];
193
+ declare const getGetOrganisationChargesQueryOptions: <TData = OrganisationChargesGetResponse, TError = ErrorType<void | AsError>>(orgId: string, params?: GetOrganisationChargesParams, options?: {
194
+ query?: Partial<UseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey>> | undefined;
195
+ request?: SecondParameter<typeof customInstance>;
196
+ } | undefined) => UseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey> & {
197
+ queryKey: QueryKey;
198
+ };
199
+ type GetOrganisationChargesQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisationCharges>>>;
200
+ type GetOrganisationChargesQueryError = ErrorType<void | AsError>;
201
+ /**
202
+ * @summary Gets charges for all Units in an Organisation
203
+ */
204
+ declare const useGetOrganisationCharges: <TData = OrganisationChargesGetResponse, TError = ErrorType<void | AsError>>(orgId: string, params?: GetOrganisationChargesParams, options?: {
205
+ query?: Partial<UseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey>> | undefined;
206
+ request?: SecondParameter<typeof customInstance>;
207
+ } | undefined) => UseQueryResult<TData, TError> & {
208
+ queryKey: QueryKey;
209
+ };
210
+ declare const getGetOrganisationChargesSuspenseQueryOptions: <TData = OrganisationChargesGetResponse, TError = ErrorType<void | AsError>>(orgId: string, params?: GetOrganisationChargesParams, options?: {
211
+ query?: Partial<UseSuspenseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey>> | undefined;
212
+ request?: SecondParameter<typeof customInstance>;
213
+ } | undefined) => UseSuspenseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey> & {
214
+ queryKey: QueryKey;
215
+ };
216
+ type GetOrganisationChargesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisationCharges>>>;
217
+ type GetOrganisationChargesSuspenseQueryError = ErrorType<void | AsError>;
218
+ /**
219
+ * @summary Gets charges for all Units in an Organisation
220
+ */
221
+ declare const useGetOrganisationChargesSuspense: <TData = OrganisationChargesGetResponse, TError = ErrorType<void | AsError>>(orgId: string, params?: GetOrganisationChargesParams, options?: {
222
+ query?: Partial<UseSuspenseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey>> | undefined;
223
+ request?: SecondParameter<typeof customInstance>;
224
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
225
+ queryKey: QueryKey;
226
+ };
227
+ /**
228
+ * Gets the Default Organisation, a built-in Organisation used exclusively for **Personal Units**.
229
+
230
+ Any authorised user can see the Default Organisation.
231
+
232
+ * @summary Gets the Default Organisation
233
+ */
234
+ declare const getDefaultOrganisation: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationGetDefaultResponse>;
235
+ declare const getGetDefaultOrganisationQueryKey: () => readonly ["account-server-api", "/organisation/default"];
236
+ declare const getGetDefaultOrganisationQueryOptions: <TData = OrganisationGetDefaultResponse, TError = ErrorType<void | AsError>>(options?: {
237
+ query?: Partial<UseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey>> | undefined;
238
+ request?: SecondParameter<typeof customInstance>;
239
+ } | undefined) => UseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey> & {
240
+ queryKey: QueryKey;
241
+ };
242
+ type GetDefaultOrganisationQueryResult = NonNullable<Awaited<ReturnType<typeof getDefaultOrganisation>>>;
243
+ type GetDefaultOrganisationQueryError = ErrorType<void | AsError>;
244
+ /**
245
+ * @summary Gets the Default Organisation
246
+ */
247
+ declare const useGetDefaultOrganisation: <TData = OrganisationGetDefaultResponse, TError = ErrorType<void | AsError>>(options?: {
248
+ query?: Partial<UseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey>> | undefined;
249
+ request?: SecondParameter<typeof customInstance>;
250
+ } | undefined) => UseQueryResult<TData, TError> & {
251
+ queryKey: QueryKey;
252
+ };
253
+ declare const getGetDefaultOrganisationSuspenseQueryOptions: <TData = OrganisationGetDefaultResponse, TError = ErrorType<void | AsError>>(options?: {
254
+ query?: Partial<UseSuspenseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey>> | undefined;
255
+ request?: SecondParameter<typeof customInstance>;
256
+ } | undefined) => UseSuspenseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey> & {
257
+ queryKey: QueryKey;
258
+ };
259
+ type GetDefaultOrganisationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDefaultOrganisation>>>;
260
+ type GetDefaultOrganisationSuspenseQueryError = ErrorType<void | AsError>;
261
+ /**
262
+ * @summary Gets the Default Organisation
263
+ */
264
+ declare const useGetDefaultOrganisationSuspense: <TData = OrganisationGetDefaultResponse, TError = ErrorType<void | AsError>>(options?: {
265
+ query?: Partial<UseSuspenseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey>> | undefined;
266
+ request?: SecondParameter<typeof customInstance>;
267
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
268
+ queryKey: QueryKey;
269
+ };
270
+
271
+ export { type CreateOrganisationMutationBody, type CreateOrganisationMutationError, type CreateOrganisationMutationResult, type DeleteOrganisationMutationError, type DeleteOrganisationMutationResult, type GetDefaultOrganisationQueryError, type GetDefaultOrganisationQueryResult, type GetDefaultOrganisationSuspenseQueryError, type GetDefaultOrganisationSuspenseQueryResult, type GetOrganisationChargesQueryError, type GetOrganisationChargesQueryResult, type GetOrganisationChargesSuspenseQueryError, type GetOrganisationChargesSuspenseQueryResult, type GetOrganisationQueryError, type GetOrganisationQueryResult, type GetOrganisationSuspenseQueryError, type GetOrganisationSuspenseQueryResult, type GetOrganisationsQueryError, type GetOrganisationsQueryResult, type GetOrganisationsSuspenseQueryError, type GetOrganisationsSuspenseQueryResult, type PatchOrganisationMutationBody, type PatchOrganisationMutationError, type PatchOrganisationMutationResult, createOrganisation, deleteOrganisation, getCreateOrganisationMutationOptions, getDefaultOrganisation, getDeleteOrganisationMutationOptions, getGetDefaultOrganisationQueryKey, getGetDefaultOrganisationQueryOptions, getGetDefaultOrganisationSuspenseQueryOptions, getGetOrganisationChargesQueryKey, getGetOrganisationChargesQueryOptions, getGetOrganisationChargesSuspenseQueryOptions, getGetOrganisationQueryKey, getGetOrganisationQueryOptions, getGetOrganisationSuspenseQueryOptions, getGetOrganisationsQueryKey, getGetOrganisationsQueryOptions, getGetOrganisationsSuspenseQueryOptions, getOrganisation, getOrganisationCharges, getOrganisations, getPatchOrganisationMutationOptions, patchOrganisation, useCreateOrganisation, useDeleteOrganisation, useGetDefaultOrganisation, useGetDefaultOrganisationSuspense, useGetOrganisation, useGetOrganisationCharges, useGetOrganisationChargesSuspense, useGetOrganisationSuspense, useGetOrganisations, useGetOrganisationsSuspense, usePatchOrganisation };
@@ -1,9 +1,9 @@
1
- import { aF as customInstance, am as OrganisationsGetResponse, aG as ErrorType, aB as AsError, q as OrganisationPostBodyBody, av as OrganisationPostResponse, B as OrganisationDetail, O as OrganisationPatchBodyBody, G as GetOrganisationChargesParams, ao as OrganisationChargesGetResponse, at as OrganisationGetDefaultResponse } 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, OrganisationsGetResponse, ErrorType, AsError, OrganisationPostBodyBody, OrganisationPostResponse, OrganisationDetail, OrganisationPatchBodyBody, GetOrganisationChargesParams, OrganisationChargesGetResponse, OrganisationGetDefaultResponse } 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 all the Organisations that you are a member of or are public. Admin users are members of all Organisations
9
9
 
@@ -12,19 +12,39 @@ type SecondParameter<T extends (...args: any) => any> = T extends (config: any,
12
12
  declare const getOrganisations: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationsGetResponse>;
13
13
  declare const getGetOrganisationsQueryKey: () => readonly ["account-server-api", "/organisation"];
14
14
  declare const getGetOrganisationsQueryOptions: <TData = OrganisationsGetResponse, TError = ErrorType<void | AsError>>(options?: {
15
- query?: UseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey> | undefined;
15
+ query?: Partial<UseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey>> | undefined;
16
16
  request?: SecondParameter<typeof customInstance>;
17
17
  } | undefined) => UseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey> & {
18
18
  queryKey: QueryKey;
19
19
  };
20
20
  type GetOrganisationsQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisations>>>;
21
21
  type GetOrganisationsQueryError = ErrorType<void | AsError>;
22
+ /**
23
+ * @summary Gets Organisations
24
+ */
22
25
  declare const useGetOrganisations: <TData = OrganisationsGetResponse, TError = ErrorType<void | AsError>>(options?: {
23
- query?: UseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey> | undefined;
26
+ query?: Partial<UseQueryOptions<OrganisationsGetResponse, 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 getGetOrganisationsSuspenseQueryOptions: <TData = OrganisationsGetResponse, TError = ErrorType<void | AsError>>(options?: {
32
+ query?: Partial<UseSuspenseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey>> | undefined;
33
+ request?: SecondParameter<typeof customInstance>;
34
+ } | undefined) => UseSuspenseQueryOptions<OrganisationsGetResponse, TError, TData, QueryKey> & {
35
+ queryKey: QueryKey;
36
+ };
37
+ type GetOrganisationsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisations>>>;
38
+ type GetOrganisationsSuspenseQueryError = ErrorType<void | AsError>;
39
+ /**
40
+ * @summary Gets Organisations
41
+ */
42
+ declare const useGetOrganisationsSuspense: <TData = OrganisationsGetResponse, TError = ErrorType<void | AsError>>(options?: {
43
+ query?: Partial<UseSuspenseQueryOptions<OrganisationsGetResponse, 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
30
50
 
@@ -44,37 +64,60 @@ declare const getCreateOrganisationMutationOptions: <TError = ErrorType<void | A
44
64
  type CreateOrganisationMutationResult = NonNullable<Awaited<ReturnType<typeof createOrganisation>>>;
45
65
  type CreateOrganisationMutationBody = OrganisationPostBodyBody;
46
66
  type CreateOrganisationMutationError = ErrorType<AsError | void>;
67
+ /**
68
+ * @summary Create a new organisation
69
+ */
47
70
  declare const useCreateOrganisation: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
48
71
  mutation?: UseMutationOptions<OrganisationPostResponse, TError, {
49
72
  data: OrganisationPostBodyBody;
50
73
  }, TContext> | undefined;
51
74
  request?: SecondParameter<typeof customInstance>;
52
- } | undefined) => _tanstack_react_query.UseMutationResult<OrganisationPostResponse, TError, {
75
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<OrganisationPostResponse, TError, {
53
76
  data: OrganisationPostBodyBody;
54
77
  }, TContext>;
55
78
  /**
56
- * Gets a specific Organisation. To see the Organisation you need admin rights or need to be a member of the Organisation.
79
+ * Gets a specific Organisation. To see the Organisation you need admin rights or need to be a member of the Organisation.
57
80
 
58
81
  Members of an Organisation's **Unit** do not necessarily have access to the Organisation.
59
82
 
60
- * @summary Gets an Organisation
61
- */
83
+ * @summary Gets an Organisation
84
+ */
62
85
  declare const getOrganisation: (orgId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationDetail>;
63
86
  declare const getGetOrganisationQueryKey: (orgId: string) => readonly ["account-server-api", `/organisation/${string}`];
64
87
  declare const getGetOrganisationQueryOptions: <TData = OrganisationDetail, TError = ErrorType<void | AsError>>(orgId: string, options?: {
65
- query?: UseQueryOptions<OrganisationDetail, TError, TData, QueryKey> | undefined;
88
+ query?: Partial<UseQueryOptions<OrganisationDetail, TError, TData, QueryKey>> | undefined;
66
89
  request?: SecondParameter<typeof customInstance>;
67
90
  } | undefined) => UseQueryOptions<OrganisationDetail, TError, TData, QueryKey> & {
68
91
  queryKey: QueryKey;
69
92
  };
70
93
  type GetOrganisationQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisation>>>;
71
94
  type GetOrganisationQueryError = ErrorType<void | AsError>;
95
+ /**
96
+ * @summary Gets an Organisation
97
+ */
72
98
  declare const useGetOrganisation: <TData = OrganisationDetail, TError = ErrorType<void | AsError>>(orgId: string, options?: {
73
- query?: UseQueryOptions<OrganisationDetail, TError, TData, QueryKey> | undefined;
99
+ query?: Partial<UseQueryOptions<OrganisationDetail, 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 getGetOrganisationSuspenseQueryOptions: <TData = OrganisationDetail, TError = ErrorType<void | AsError>>(orgId: string, options?: {
105
+ query?: Partial<UseSuspenseQueryOptions<OrganisationDetail, TError, TData, QueryKey>> | undefined;
106
+ request?: SecondParameter<typeof customInstance>;
107
+ } | undefined) => UseSuspenseQueryOptions<OrganisationDetail, TError, TData, QueryKey> & {
108
+ queryKey: QueryKey;
109
+ };
110
+ type GetOrganisationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisation>>>;
111
+ type GetOrganisationSuspenseQueryError = ErrorType<void | AsError>;
112
+ /**
113
+ * @summary Gets an Organisation
114
+ */
115
+ declare const useGetOrganisationSuspense: <TData = OrganisationDetail, TError = ErrorType<void | AsError>>(orgId: string, options?: {
116
+ query?: Partial<UseSuspenseQueryOptions<OrganisationDetail, 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 Organisation.
80
123
 
@@ -96,23 +139,26 @@ declare const getPatchOrganisationMutationOptions: <TError = ErrorType<AsError>,
96
139
  type PatchOrganisationMutationResult = NonNullable<Awaited<ReturnType<typeof patchOrganisation>>>;
97
140
  type PatchOrganisationMutationBody = OrganisationPatchBodyBody;
98
141
  type PatchOrganisationMutationError = ErrorType<AsError>;
142
+ /**
143
+ * @summary Adjust an existing Organisation
144
+ */
99
145
  declare const usePatchOrganisation: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
100
146
  mutation?: UseMutationOptions<void, TError, {
101
147
  orgId: string;
102
148
  data: OrganisationPatchBodyBody;
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
  orgId: string;
107
153
  data: OrganisationPatchBodyBody;
108
154
  }, TContext>;
109
155
  /**
110
- * Before an Organisation can be deleted all its underlying **Units** must also be deleted, remembering that **Units** that have undeleted **Products** cannot be deleted.
156
+ * Before an Organisation can be deleted all its underlying **Units** must also be deleted, remembering that **Units** that have undeleted **Products** cannot be deleted.
111
157
 
112
158
  You need admin rights to use this method
113
159
 
114
- * @summary Deletes an Organisation
115
- */
160
+ * @summary Deletes an Organisation
161
+ */
116
162
  declare const deleteOrganisation: (orgId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
117
163
  declare const getDeleteOrganisationMutationOptions: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
118
164
  mutation?: UseMutationOptions<void, TError, {
@@ -124,37 +170,60 @@ declare const getDeleteOrganisationMutationOptions: <TError = ErrorType<AsError>
124
170
  }, TContext>;
125
171
  type DeleteOrganisationMutationResult = NonNullable<Awaited<ReturnType<typeof deleteOrganisation>>>;
126
172
  type DeleteOrganisationMutationError = ErrorType<AsError>;
173
+ /**
174
+ * @summary Deletes an Organisation
175
+ */
127
176
  declare const useDeleteOrganisation: <TError = ErrorType<AsError>, TContext = unknown>(options?: {
128
177
  mutation?: UseMutationOptions<void, TError, {
129
178
  orgId: string;
130
179
  }, TContext> | undefined;
131
180
  request?: SecondParameter<typeof customInstance>;
132
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
181
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
133
182
  orgId: string;
134
183
  }, TContext>;
135
184
  /**
136
- * Gets a Organisation charges.
185
+ * Gets a Organisation charges.
137
186
 
138
187
  The Organisation cannot be the **Default Organisation** and you need to be a member of the Organisation to use this endpoint
139
188
 
140
- * @summary Gets charges for all Units in an Organisation
141
- */
189
+ * @summary Gets charges for all Units in an Organisation
190
+ */
142
191
  declare const getOrganisationCharges: (orgId: string, params?: GetOrganisationChargesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationChargesGetResponse>;
143
192
  declare const getGetOrganisationChargesQueryKey: (orgId: string, params?: GetOrganisationChargesParams) => readonly ["account-server-api", `/organisation/${string}/charges`, ...GetOrganisationChargesParams[]];
144
193
  declare const getGetOrganisationChargesQueryOptions: <TData = OrganisationChargesGetResponse, TError = ErrorType<void | AsError>>(orgId: string, params?: GetOrganisationChargesParams, options?: {
145
- query?: UseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey> | undefined;
194
+ query?: Partial<UseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey>> | undefined;
146
195
  request?: SecondParameter<typeof customInstance>;
147
196
  } | undefined) => UseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey> & {
148
197
  queryKey: QueryKey;
149
198
  };
150
199
  type GetOrganisationChargesQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisationCharges>>>;
151
200
  type GetOrganisationChargesQueryError = ErrorType<void | AsError>;
201
+ /**
202
+ * @summary Gets charges for all Units in an Organisation
203
+ */
152
204
  declare const useGetOrganisationCharges: <TData = OrganisationChargesGetResponse, TError = ErrorType<void | AsError>>(orgId: string, params?: GetOrganisationChargesParams, options?: {
153
- query?: UseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey> | undefined;
205
+ query?: Partial<UseQueryOptions<OrganisationChargesGetResponse, 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 getGetOrganisationChargesSuspenseQueryOptions: <TData = OrganisationChargesGetResponse, TError = ErrorType<void | AsError>>(orgId: string, params?: GetOrganisationChargesParams, options?: {
211
+ query?: Partial<UseSuspenseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey>> | undefined;
212
+ request?: SecondParameter<typeof customInstance>;
213
+ } | undefined) => UseSuspenseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey> & {
214
+ queryKey: QueryKey;
215
+ };
216
+ type GetOrganisationChargesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisationCharges>>>;
217
+ type GetOrganisationChargesSuspenseQueryError = ErrorType<void | AsError>;
218
+ /**
219
+ * @summary Gets charges for all Units in an Organisation
220
+ */
221
+ declare const useGetOrganisationChargesSuspense: <TData = OrganisationChargesGetResponse, TError = ErrorType<void | AsError>>(orgId: string, params?: GetOrganisationChargesParams, options?: {
222
+ query?: Partial<UseSuspenseQueryOptions<OrganisationChargesGetResponse, TError, TData, QueryKey>> | undefined;
223
+ request?: SecondParameter<typeof customInstance>;
224
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
225
+ queryKey: QueryKey;
226
+ };
158
227
  /**
159
228
  * Gets the Default Organisation, a built-in Organisation used exclusively for **Personal Units**.
160
229
 
@@ -165,18 +234,38 @@ Any authorised user can see the Default Organisation.
165
234
  declare const getDefaultOrganisation: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<OrganisationGetDefaultResponse>;
166
235
  declare const getGetDefaultOrganisationQueryKey: () => readonly ["account-server-api", "/organisation/default"];
167
236
  declare const getGetDefaultOrganisationQueryOptions: <TData = OrganisationGetDefaultResponse, TError = ErrorType<void | AsError>>(options?: {
168
- query?: UseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey> | undefined;
237
+ query?: Partial<UseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey>> | undefined;
169
238
  request?: SecondParameter<typeof customInstance>;
170
239
  } | undefined) => UseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey> & {
171
240
  queryKey: QueryKey;
172
241
  };
173
242
  type GetDefaultOrganisationQueryResult = NonNullable<Awaited<ReturnType<typeof getDefaultOrganisation>>>;
174
243
  type GetDefaultOrganisationQueryError = ErrorType<void | AsError>;
244
+ /**
245
+ * @summary Gets the Default Organisation
246
+ */
175
247
  declare const useGetDefaultOrganisation: <TData = OrganisationGetDefaultResponse, TError = ErrorType<void | AsError>>(options?: {
176
- query?: UseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey> | undefined;
248
+ query?: Partial<UseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey>> | undefined;
177
249
  request?: SecondParameter<typeof customInstance>;
178
250
  } | undefined) => UseQueryResult<TData, TError> & {
179
251
  queryKey: QueryKey;
180
252
  };
253
+ declare const getGetDefaultOrganisationSuspenseQueryOptions: <TData = OrganisationGetDefaultResponse, TError = ErrorType<void | AsError>>(options?: {
254
+ query?: Partial<UseSuspenseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey>> | undefined;
255
+ request?: SecondParameter<typeof customInstance>;
256
+ } | undefined) => UseSuspenseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey> & {
257
+ queryKey: QueryKey;
258
+ };
259
+ type GetDefaultOrganisationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDefaultOrganisation>>>;
260
+ type GetDefaultOrganisationSuspenseQueryError = ErrorType<void | AsError>;
261
+ /**
262
+ * @summary Gets the Default Organisation
263
+ */
264
+ declare const useGetDefaultOrganisationSuspense: <TData = OrganisationGetDefaultResponse, TError = ErrorType<void | AsError>>(options?: {
265
+ query?: Partial<UseSuspenseQueryOptions<OrganisationGetDefaultResponse, TError, TData, QueryKey>> | undefined;
266
+ request?: SecondParameter<typeof customInstance>;
267
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
268
+ queryKey: QueryKey;
269
+ };
181
270
 
182
- export { CreateOrganisationMutationBody, CreateOrganisationMutationError, CreateOrganisationMutationResult, DeleteOrganisationMutationError, DeleteOrganisationMutationResult, GetDefaultOrganisationQueryError, GetDefaultOrganisationQueryResult, GetOrganisationChargesQueryError, GetOrganisationChargesQueryResult, GetOrganisationQueryError, GetOrganisationQueryResult, GetOrganisationsQueryError, GetOrganisationsQueryResult, PatchOrganisationMutationBody, PatchOrganisationMutationError, PatchOrganisationMutationResult, createOrganisation, deleteOrganisation, getCreateOrganisationMutationOptions, getDefaultOrganisation, getDeleteOrganisationMutationOptions, getGetDefaultOrganisationQueryKey, getGetDefaultOrganisationQueryOptions, getGetOrganisationChargesQueryKey, getGetOrganisationChargesQueryOptions, getGetOrganisationQueryKey, getGetOrganisationQueryOptions, getGetOrganisationsQueryKey, getGetOrganisationsQueryOptions, getOrganisation, getOrganisationCharges, getOrganisations, getPatchOrganisationMutationOptions, patchOrganisation, useCreateOrganisation, useDeleteOrganisation, useGetDefaultOrganisation, useGetOrganisation, useGetOrganisationCharges, useGetOrganisations, usePatchOrganisation };
271
+ export { type CreateOrganisationMutationBody, type CreateOrganisationMutationError, type CreateOrganisationMutationResult, type DeleteOrganisationMutationError, type DeleteOrganisationMutationResult, type GetDefaultOrganisationQueryError, type GetDefaultOrganisationQueryResult, type GetDefaultOrganisationSuspenseQueryError, type GetDefaultOrganisationSuspenseQueryResult, type GetOrganisationChargesQueryError, type GetOrganisationChargesQueryResult, type GetOrganisationChargesSuspenseQueryError, type GetOrganisationChargesSuspenseQueryResult, type GetOrganisationQueryError, type GetOrganisationQueryResult, type GetOrganisationSuspenseQueryError, type GetOrganisationSuspenseQueryResult, type GetOrganisationsQueryError, type GetOrganisationsQueryResult, type GetOrganisationsSuspenseQueryError, type GetOrganisationsSuspenseQueryResult, type PatchOrganisationMutationBody, type PatchOrganisationMutationError, type PatchOrganisationMutationResult, createOrganisation, deleteOrganisation, getCreateOrganisationMutationOptions, getDefaultOrganisation, getDeleteOrganisationMutationOptions, getGetDefaultOrganisationQueryKey, getGetDefaultOrganisationQueryOptions, getGetDefaultOrganisationSuspenseQueryOptions, getGetOrganisationChargesQueryKey, getGetOrganisationChargesQueryOptions, getGetOrganisationChargesSuspenseQueryOptions, getGetOrganisationQueryKey, getGetOrganisationQueryOptions, getGetOrganisationSuspenseQueryOptions, getGetOrganisationsQueryKey, getGetOrganisationsQueryOptions, getGetOrganisationsSuspenseQueryOptions, getOrganisation, getOrganisationCharges, getOrganisations, getPatchOrganisationMutationOptions, patchOrganisation, useCreateOrganisation, useDeleteOrganisation, useGetDefaultOrganisation, useGetDefaultOrganisationSuspense, useGetOrganisation, useGetOrganisationCharges, useGetOrganisationChargesSuspense, useGetOrganisationSuspense, useGetOrganisations, useGetOrganisationsSuspense, usePatchOrganisation };