@squonk/account-server-client 4.4.0-4-4.2175031121 → 4.4.0-4-4.2194834412
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.
- package/dist/api/actions/actions.cjs +5 -5
- package/dist/api/actions/actions.cjs.map +1 -1
- package/dist/api/actions/actions.d.cts +17 -35
- package/dist/api/actions/actions.d.cts.map +1 -1
- package/dist/api/actions/actions.d.ts +17 -35
- package/dist/api/actions/actions.d.ts.map +1 -1
- package/dist/api/actions/actions.js +5 -5
- package/dist/api/actions/actions.js.map +1 -1
- package/dist/api/api.schemas.cjs.map +1 -1
- package/dist/api/api.schemas.d.cts +1 -1
- package/dist/api/api.schemas.d.ts +1 -1
- package/dist/api/api.schemas.js.map +1 -1
- package/dist/api/asset/asset.cjs +23 -23
- package/dist/api/asset/asset.cjs.map +1 -1
- package/dist/api/asset/asset.d.cts +40 -76
- package/dist/api/asset/asset.d.cts.map +1 -1
- package/dist/api/asset/asset.d.ts +40 -76
- package/dist/api/asset/asset.d.ts.map +1 -1
- package/dist/api/asset/asset.js +23 -23
- package/dist/api/asset/asset.js.map +1 -1
- package/dist/api/charges/charges.cjs +17 -17
- package/dist/api/charges/charges.cjs.map +1 -1
- package/dist/api/charges/charges.d.cts +65 -137
- package/dist/api/charges/charges.d.cts.map +1 -1
- package/dist/api/charges/charges.d.ts +65 -137
- package/dist/api/charges/charges.d.ts.map +1 -1
- package/dist/api/charges/charges.js +17 -17
- package/dist/api/charges/charges.js.map +1 -1
- package/dist/api/event-stream/event-stream.cjs +13 -13
- package/dist/api/event-stream/event-stream.cjs.map +1 -1
- package/dist/api/event-stream/event-stream.d.cts +35 -71
- package/dist/api/event-stream/event-stream.d.cts.map +1 -1
- package/dist/api/event-stream/event-stream.d.ts +35 -71
- package/dist/api/event-stream/event-stream.d.ts.map +1 -1
- package/dist/api/event-stream/event-stream.js +13 -13
- package/dist/api/event-stream/event-stream.js.map +1 -1
- package/dist/api/merchant/merchant.cjs +9 -9
- package/dist/api/merchant/merchant.cjs.map +1 -1
- package/dist/api/merchant/merchant.d.cts +33 -69
- package/dist/api/merchant/merchant.d.cts.map +1 -1
- package/dist/api/merchant/merchant.d.ts +33 -69
- package/dist/api/merchant/merchant.d.ts.map +1 -1
- package/dist/api/merchant/merchant.js +9 -9
- package/dist/api/merchant/merchant.js.map +1 -1
- package/dist/api/organisation/organisation.cjs +19 -19
- package/dist/api/organisation/organisation.cjs.map +1 -1
- package/dist/api/organisation/organisation.d.cts +52 -106
- package/dist/api/organisation/organisation.d.cts.map +1 -1
- package/dist/api/organisation/organisation.d.ts +52 -106
- package/dist/api/organisation/organisation.d.ts.map +1 -1
- package/dist/api/organisation/organisation.js +19 -19
- package/dist/api/organisation/organisation.js.map +1 -1
- package/dist/api/product/product.cjs +31 -31
- package/dist/api/product/product.cjs.map +1 -1
- package/dist/api/product/product.d.cts +100 -208
- package/dist/api/product/product.d.cts.map +1 -1
- package/dist/api/product/product.d.ts +100 -208
- package/dist/api/product/product.d.ts.map +1 -1
- package/dist/api/product/product.js +31 -31
- package/dist/api/product/product.js.map +1 -1
- package/dist/api/state/state.cjs +5 -5
- package/dist/api/state/state.cjs.map +1 -1
- package/dist/api/state/state.d.cts +17 -35
- package/dist/api/state/state.d.cts.map +1 -1
- package/dist/api/state/state.d.ts +17 -35
- package/dist/api/state/state.d.ts.map +1 -1
- package/dist/api/state/state.js +5 -5
- package/dist/api/state/state.js.map +1 -1
- package/dist/api/unit/unit.cjs +31 -31
- package/dist/api/unit/unit.cjs.map +1 -1
- package/dist/api/unit/unit.d.cts +72 -144
- package/dist/api/unit/unit.d.cts.map +1 -1
- package/dist/api/unit/unit.d.ts +72 -144
- package/dist/api/unit/unit.d.ts.map +1 -1
- package/dist/api/unit/unit.js +31 -31
- package/dist/api/unit/unit.js.map +1 -1
- package/dist/api/user/user.cjs +21 -21
- package/dist/api/user/user.cjs.map +1 -1
- package/dist/api/user/user.d.cts +53 -107
- package/dist/api/user/user.d.cts.map +1 -1
- package/dist/api/user/user.d.ts +53 -107
- package/dist/api/user/user.d.ts.map +1 -1
- package/dist/api/user/user.js +21 -21
- package/dist/api/user/user.js.map +1 -1
- package/package.json +4 -7
- package/pnpm-workspace.yaml +1 -3
- package/src/api/actions/actions.ts +13 -105
- package/src/api/api.schemas.ts +1 -1
- package/src/api/asset/asset.ts +95 -305
- package/src/api/charges/charges.ts +55 -458
- package/src/api/event-stream/event-stream.ts +59 -264
- package/src/api/merchant/merchant.ts +29 -214
- package/src/api/organisation/organisation.ts +87 -383
- package/src/api/product/product.ts +131 -726
- package/src/api/state/state.ts +17 -107
- package/src/api/unit/unit.ts +147 -523
- package/src/api/user/user.ts +102 -403
|
@@ -5,7 +5,7 @@ let __tanstack_react_query = require("@tanstack/react-query");
|
|
|
5
5
|
|
|
6
6
|
//#region src/api/actions/actions.ts
|
|
7
7
|
/**
|
|
8
|
-
* Generated by orval v7.
|
|
8
|
+
* Generated by orval v7.17.0 🍺
|
|
9
9
|
* Do not edit manually.
|
|
10
10
|
* Account Server API
|
|
11
11
|
* The Informatics Matters Account Server API.
|
|
@@ -49,9 +49,9 @@ const useGetActionsQueryOptions = (params, options) => {
|
|
|
49
49
|
/**
|
|
50
50
|
* @summary Gets Actions held on the Account Server
|
|
51
51
|
*/
|
|
52
|
-
function useGetActions(params, options
|
|
52
|
+
function useGetActions(params, options) {
|
|
53
53
|
const queryOptions = useGetActionsQueryOptions(params, options);
|
|
54
|
-
const query = (0, __tanstack_react_query.useQuery)(queryOptions
|
|
54
|
+
const query = (0, __tanstack_react_query.useQuery)(queryOptions);
|
|
55
55
|
query.queryKey = queryOptions.queryKey;
|
|
56
56
|
return query;
|
|
57
57
|
}
|
|
@@ -68,9 +68,9 @@ const useGetActionsSuspenseQueryOptions = (params, options) => {
|
|
|
68
68
|
/**
|
|
69
69
|
* @summary Gets Actions held on the Account Server
|
|
70
70
|
*/
|
|
71
|
-
function useGetActionsSuspense(params, options
|
|
71
|
+
function useGetActionsSuspense(params, options) {
|
|
72
72
|
const queryOptions = useGetActionsSuspenseQueryOptions(params, options);
|
|
73
|
-
const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions
|
|
73
|
+
const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions);
|
|
74
74
|
query.queryKey = queryOptions.queryKey;
|
|
75
75
|
return query;
|
|
76
76
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actions.cjs","names":["customInstance","queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>>","queryMutator"],"sources":["../../../src/api/actions/actions.ts"],"sourcesContent":["/**\n * Generated by orval v7.16.1 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.\n\n * OpenAPI spec version: 4.4\n */\nimport { useQuery, useSuspenseQuery } from \"@tanstack/react-query\";\nimport type {\n DataTag,\n DefinedInitialDataOptions,\n DefinedUseQueryResult,\n QueryClient,\n QueryFunction,\n QueryKey,\n UndefinedInitialDataOptions,\n UseQueryOptions,\n UseQueryResult,\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from \"@tanstack/react-query\";\n\nimport type { ActionGetResponse, GetActionsParams } from \"../api.schemas\";\n\nimport { customInstance } from \"../../custom-instance\";\nimport type { ErrorType } from \"../../custom-instance\";\nimport { queryMutator } from \"../../options-mutator\";\n\ntype SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];\n\n/**\n * This endpoint delivers Action records (protocol buffers) that can be selected based on a date and time range and limited to merchants, organisations, Units, or Products. You can receive Action content as a `PROTOCOL_STRING` (the default), or `JSON_STRING`. If you do not provide a `format` `PROTOCOL_STRING` will be assumed.\n\nYou can provide a `m_id`, `org_id`, `unit_id`, `product_id`, but only one.\n\nYou can also provide `from` and `until` dates to limit the response to Actions that occur on the days you select. Actions are returned that are not before the `from` data but are before the `until` date. If neither `from` or `until` is provided `from` is assumed to be from _today_ until _tomorrow_.\n\nYou need admin privilege to use this endpoint.\n\n * @summary Gets Actions held on the Account Server\n */\nexport const getActions = (\n params?: GetActionsParams,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal,\n) => {\n return customInstance<ActionGetResponse>(\n { url: `/action`, method: \"GET\", params, signal },\n options,\n );\n};\n\nexport const getGetActionsQueryKey = (params?: GetActionsParams) => {\n return [`/action`, ...(params ? [params] : [])] as const;\n};\n\nexport const useGetActionsQueryOptions = <\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n) => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>\n getActions(params, requestOptions, signal);\n\n const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });\n\n return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {\n queryKey: DataTag<QueryKey, TData, TError>;\n };\n};\n\nexport type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;\nexport type GetActionsQueryError = ErrorType<void>;\n\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params: undefined | GetActionsParams,\n options: {\n query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &\n Pick<\n DefinedInitialDataOptions<\n Awaited<ReturnType<typeof getActions>>,\n TError,\n Awaited<ReturnType<typeof getActions>>\n >,\n \"initialData\"\n >;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &\n Pick<\n UndefinedInitialDataOptions<\n Awaited<ReturnType<typeof getActions>>,\n TError,\n Awaited<ReturnType<typeof getActions>>\n >,\n \"initialData\"\n >;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\n/**\n * @summary Gets Actions held on the Account Server\n */\n\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {\n const queryOptions = useGetActionsQueryOptions(params, options);\n\n const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {\n queryKey: DataTag<QueryKey, TData, TError>;\n };\n\n query.queryKey = queryOptions.queryKey;\n\n return query;\n}\n\nexport const useGetActionsSuspenseQueryOptions = <\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n) => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>\n getActions(params, requestOptions, signal);\n\n const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });\n\n return customOptions as UseSuspenseQueryOptions<\n Awaited<ReturnType<typeof getActions>>,\n TError,\n TData\n > & { queryKey: DataTag<QueryKey, TData, TError> };\n};\n\nexport type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;\nexport type GetActionsSuspenseQueryError = ErrorType<void>;\n\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params: undefined | GetActionsParams,\n options: {\n query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\n/**\n * @summary Gets Actions held on the Account Server\n */\n\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {\n const queryOptions = useGetActionsSuspenseQueryOptions(params, options);\n\n const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<\n TData,\n TError\n > & { queryKey: DataTag<QueryKey, TData, TError> };\n\n query.queryKey = queryOptions.queryKey;\n\n return query;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,MAAa,cACX,QACA,SACA,WACG;AACH,QAAOA,uCACL;EAAE,KAAK;EAAW,QAAQ;EAAO;EAAQ;EAAQ,EACjD,QACD;;AAGH,MAAa,yBAAyB,WAA8B;AAClE,QAAO,CAAC,WAAW,GAAI,SAAS,CAAC,OAAO,GAAG,EAAE,CAAE;;AAGjD,MAAa,6BAIX,QACA,YAIG;CACH,MAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,EAAE;CAEtE,MAAM,WAAW,cAAc,YAAY,sBAAsB,OAAO;CAExE,MAAMC,WAAkE,EAAE,aACxE,WAAW,QAAQ,gBAAgB,OAAO;AAI5C,QAFsBC,qCAAa;EAAE,GAAG;EAAc;EAAU;EAAS,CAAC;;;;;AA+D5E,SAAgB,cAId,QACA,SAIA,aACgF;CAChF,MAAM,eAAe,0BAA0B,QAAQ,QAAQ;CAE/D,MAAM,6CAAiB,cAAc,YAAY;AAIjD,OAAM,WAAW,aAAa;AAE9B,QAAO;;AAGT,MAAa,qCAIX,QACA,YAIG;CACH,MAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,EAAE;CAEtE,MAAM,WAAW,cAAc,YAAY,sBAAsB,OAAO;CAExE,MAAMD,WAAkE,EAAE,aACxE,WAAW,QAAQ,gBAAgB,OAAO;AAI5C,QAFsBC,qCAAa;EAAE,GAAG;EAAc;EAAU;EAAS,CAAC;;;;;AAiD5E,SAAgB,sBAId,QACA,SAIA,aACwF;CACxF,MAAM,eAAe,kCAAkC,QAAQ,QAAQ;CAEvE,MAAM,qDAAyB,cAAc,YAAY;AAKzD,OAAM,WAAW,aAAa;AAE9B,QAAO"}
|
|
1
|
+
{"version":3,"file":"actions.cjs","names":["customInstance","queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>>","queryMutator"],"sources":["../../../src/api/actions/actions.ts"],"sourcesContent":["/**\n * Generated by orval v7.17.0 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.\n\n * OpenAPI spec version: 4.4\n */\nimport { useQuery, useSuspenseQuery } from \"@tanstack/react-query\";\nimport type {\n QueryFunction,\n QueryKey,\n UseQueryOptions,\n UseQueryResult,\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from \"@tanstack/react-query\";\n\nimport type { ActionGetResponse, GetActionsParams } from \"../api.schemas\";\n\nimport { customInstance } from \"../../custom-instance\";\nimport type { ErrorType } from \"../../custom-instance\";\nimport { queryMutator } from \"../../options-mutator\";\n\ntype SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];\n\n/**\n * This endpoint delivers Action records (protocol buffers) that can be selected based on a date and time range and limited to merchants, organisations, Units, or Products. You can receive Action content as a `PROTOCOL_STRING` (the default), or `JSON_STRING`. If you do not provide a `format` `PROTOCOL_STRING` will be assumed.\n\nYou can provide a `m_id`, `org_id`, `unit_id`, `product_id`, but only one.\n\nYou can also provide `from` and `until` dates to limit the response to Actions that occur on the days you select. Actions are returned that are not before the `from` data but are before the `until` date. If neither `from` or `until` is provided `from` is assumed to be from _today_ until _tomorrow_.\n\nYou need admin privilege to use this endpoint.\n\n * @summary Gets Actions held on the Account Server\n */\nexport const getActions = (\n params?: GetActionsParams,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal,\n) => {\n return customInstance<ActionGetResponse>(\n { url: `/action`, method: \"GET\", params, signal },\n options,\n );\n};\n\nexport const getGetActionsQueryKey = (params?: GetActionsParams) => {\n return [`/action`, ...(params ? [params] : [])] as const;\n};\n\nexport const useGetActionsQueryOptions = <\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n },\n) => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>\n getActions(params, requestOptions, signal);\n\n const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });\n\n return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {\n queryKey: QueryKey;\n };\n};\n\nexport type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;\nexport type GetActionsQueryError = ErrorType<void>;\n\n/**\n * @summary Gets Actions held on the Account Server\n */\n\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n },\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } {\n const queryOptions = useGetActionsQueryOptions(params, options);\n\n const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n query.queryKey = queryOptions.queryKey;\n\n return query;\n}\n\nexport const useGetActionsSuspenseQueryOptions = <\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n },\n) => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>\n getActions(params, requestOptions, signal);\n\n const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });\n\n return customOptions as UseSuspenseQueryOptions<\n Awaited<ReturnType<typeof getActions>>,\n TError,\n TData\n > & { queryKey: QueryKey };\n};\n\nexport type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;\nexport type GetActionsSuspenseQueryError = ErrorType<void>;\n\n/**\n * @summary Gets Actions held on the Account Server\n */\n\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n },\n): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {\n const queryOptions = useGetActionsSuspenseQueryOptions(params, options);\n\n const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryOptions.queryKey;\n\n return query;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,MAAa,cACX,QACA,SACA,WACG;AACH,QAAOA,uCACL;EAAE,KAAK;EAAW,QAAQ;EAAO;EAAQ;EAAQ,EACjD,QACD;;AAGH,MAAa,yBAAyB,WAA8B;AAClE,QAAO,CAAC,WAAW,GAAI,SAAS,CAAC,OAAO,GAAG,EAAE,CAAE;;AAGjD,MAAa,6BAIX,QACA,YAIG;CACH,MAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,EAAE;CAEtE,MAAM,WAAW,cAAc,YAAY,sBAAsB,OAAO;CAExE,MAAMC,WAAkE,EAAE,aACxE,WAAW,QAAQ,gBAAgB,OAAO;AAI5C,QAFsBC,qCAAa;EAAE,GAAG;EAAc;EAAU;EAAS,CAAC;;;;;AAc5E,SAAgB,cAId,QACA,SAIwD;CACxD,MAAM,eAAe,0BAA0B,QAAQ,QAAQ;CAE/D,MAAM,6CAAiB,aAAa;AAEpC,OAAM,WAAW,aAAa;AAE9B,QAAO;;AAGT,MAAa,qCAIX,QACA,YAIG;CACH,MAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,EAAE;CAEtE,MAAM,WAAW,cAAc,YAAY,sBAAsB,OAAO;CAExE,MAAMD,WAAkE,EAAE,aACxE,WAAW,QAAQ,gBAAgB,OAAO;AAI5C,QAFsBC,qCAAa;EAAE,GAAG;EAAc;EAAU;EAAS,CAAC;;;;;AAgB5E,SAAgB,sBAId,QACA,SAIgE;CAChE,MAAM,eAAe,kCAAkC,QAAQ,QAAQ;CAEvE,MAAM,qDAAyB,aAAa;AAI5C,OAAM,WAAW,aAAa;AAE9B,QAAO"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ActionGetResponse, GetActionsParams } from "../api.schemas.cjs";
|
|
2
2
|
import { ErrorType, customInstance } from "../../custom-instance.cjs";
|
|
3
|
-
import {
|
|
3
|
+
import { QueryKey, UseQueryOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from "@tanstack/react-query";
|
|
4
4
|
|
|
5
5
|
//#region src/api/actions/actions.d.ts
|
|
6
6
|
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
@@ -18,56 +18,38 @@ You need admin privilege to use this endpoint.
|
|
|
18
18
|
declare const getActions: (params?: GetActionsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ActionGetResponse>;
|
|
19
19
|
declare const getGetActionsQueryKey: (params?: GetActionsParams) => readonly ["/action", ...GetActionsParams[]];
|
|
20
20
|
declare const useGetActionsQueryOptions: <TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
21
|
-
query?:
|
|
21
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
|
|
22
22
|
request?: SecondParameter<typeof customInstance>;
|
|
23
23
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {
|
|
24
|
-
queryKey:
|
|
24
|
+
queryKey: QueryKey;
|
|
25
25
|
};
|
|
26
26
|
type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
|
|
27
27
|
type GetActionsQueryError = ErrorType<void>;
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
32
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
33
|
-
};
|
|
34
|
-
declare function useGetActions<TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
35
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getActions>>, TError, Awaited<ReturnType<typeof getActions>>>, "initialData">;
|
|
36
|
-
request?: SecondParameter<typeof customInstance>;
|
|
37
|
-
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
38
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
39
|
-
};
|
|
28
|
+
/**
|
|
29
|
+
* @summary Gets Actions held on the Account Server
|
|
30
|
+
*/
|
|
40
31
|
declare function useGetActions<TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
41
|
-
query?:
|
|
32
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
|
|
42
33
|
request?: SecondParameter<typeof customInstance>;
|
|
43
|
-
}
|
|
44
|
-
queryKey:
|
|
34
|
+
}): UseQueryResult<TData, TError> & {
|
|
35
|
+
queryKey: QueryKey;
|
|
45
36
|
};
|
|
46
37
|
declare const useGetActionsSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
47
|
-
query?:
|
|
38
|
+
query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
|
|
48
39
|
request?: SecondParameter<typeof customInstance>;
|
|
49
40
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {
|
|
50
|
-
queryKey:
|
|
41
|
+
queryKey: QueryKey;
|
|
51
42
|
};
|
|
52
43
|
type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
|
|
53
44
|
type GetActionsSuspenseQueryError = ErrorType<void>;
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
58
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
59
|
-
};
|
|
60
|
-
declare function useGetActionsSuspense<TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
61
|
-
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
|
|
62
|
-
request?: SecondParameter<typeof customInstance>;
|
|
63
|
-
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
64
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
65
|
-
};
|
|
45
|
+
/**
|
|
46
|
+
* @summary Gets Actions held on the Account Server
|
|
47
|
+
*/
|
|
66
48
|
declare function useGetActionsSuspense<TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
67
|
-
query?:
|
|
49
|
+
query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
|
|
68
50
|
request?: SecondParameter<typeof customInstance>;
|
|
69
|
-
}
|
|
70
|
-
queryKey:
|
|
51
|
+
}): UseSuspenseQueryResult<TData, TError> & {
|
|
52
|
+
queryKey: QueryKey;
|
|
71
53
|
};
|
|
72
54
|
//#endregion
|
|
73
55
|
export { GetActionsQueryError, GetActionsQueryResult, GetActionsSuspenseQueryError, GetActionsSuspenseQueryResult, getActions, getGetActionsQueryKey, useGetActions, useGetActionsQueryOptions, useGetActionsSuspense, useGetActionsSuspenseQueryOptions };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actions.d.cts","names":[],"sources":["../../../src/api/actions/actions.ts"],"sourcesContent":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"actions.d.cts","names":[],"sources":["../../../src/api/actions/actions.ts"],"sourcesContent":[],"mappings":";;;;;KA0BK,yDAAyD,WAAW;AAHlB;AAgBvD;;;;;;;;AAWA;AAIA;AACoC,cAhBvB,UAgBuB,EAAA,CAAA,MAAA,CAAA,EAfzB,gBAeyB,EAAA,OAAA,CAAA,EAdxB,eAcwB,CAAA,OAdD,cAcC,CAAA,EAAA,MAAA,CAAA,EAbzB,WAayB,EAAA,GAbd,OAac,CAbd,iBAac,CAAA;AAAlB,cALL,qBAKK,EAAA,CAAA,MAAA,CAAA,EAL6B,gBAK7B,EAAA,GAAA,SAAA,CAAA,SAAA,EAAA,GAL6C,gBAK7C,EAAA,CAAA;AAAR,cADG,yBACH,EAAA,CAAA,QAAA,OAAA,CAAQ,UAAR,CAAA,OAA0B,UAA1B,CAAA,CAAA,EAAA,SACC,SADD,CAAA,IAAA,CAAA,CAAA,CAAA,MAAA,CAAA,EAGC,gBAHD,EAAA,OAK4C,CAL5C,EAAA;EACC,KAAA,CAAA,EAIC,eAJD,CAIiB,OAJjB,CAIyB,UAJzB,CAAA,OAI2C,UAJ3C,CAAA,CAAA,EAIyD,MAJzD,EAIiE,KAJjE,CAAA;EAEA,OAAA,CAAA,EAGG,eAHH,CAAA,OAG0B,cAH1B,CAAA;CAE2C,EAAA,GAa5B,eAb4B,CAaZ,OAbY,CAaJ,UAbI,CAAA,OAac,UAbd,CAAA,CAAA,EAa4B,MAb5B,EAaoC,KAbpC,CAAA,GAAA;EAAlB,QAAA,EActB,QAdsB;CAAR;AAAwC,KAkBxD,qBAAA,GAAwB,WAlBgC,CAkBpB,OAlBoB,CAkBZ,UAlBY,CAAA,OAkBM,UAlBN,CAAA,CAAA,CAAA;AAAQ,KAmBhE,oBAAA,GAAuB,SAnByC,CAAA,IAAA,CAAA;;;;AAaR,iBAYpD,aAZoD,CAAA,QAa1D,OAb0D,CAalD,UAbkD,CAAA,OAahC,UAbgC,CAAA,CAAA,EAAA,SAczD,SAdyD,CAAA,IAAA,CAAA,CAAA,CAAA,MAAA,CAAA,EAgBzD,gBAhByD,EAAA,OAAc,CAAd,EAAA;EAAlB,KAAA,CAAA,EAkBtC,eAlBsC,CAkBtB,OAlBsB,CAkBd,UAlBc,CAAA,OAkBI,UAlBJ,CAAA,CAAA,EAkBkB,MAlBlB,EAkB0B,KAlB1B,CAAA;EAAR,OAAA,CAAA,EAmB5B,eAnB4B,CAAA,OAmBL,cAnBK,CAAA;CAAwC,CAAA,EAqB/E,cArB+E,CAqBhE,KArBgE,EAqBzD,MArByD,CAAA,GAAA;EAAQ,QAAA,EAqB3C,QArB2C;CAAhE;AACZ,cA8BD,iCA9BC,EAAA,CAAA,QA+BJ,OA/BI,CA+BI,UA/BJ,CAAA,OA+BsB,UA/BtB,CAAA,CAAA,EAAA,SAgCH,SAhCG,CAAA,IAAA,CAAA,CAAA,CAAA,MAAA,CAAA,EAkCH,gBAlCG,EAAA,OAI4D,CAJ5D,EAAA;EAAQ,KAAA,CAAA,EAoCV,uBApCU,CAoCc,OApCd,CAoCsB,UApCtB,CAAA,OAoCwC,UApCxC,CAAA,CAAA,EAoCsD,MApCtD,EAoC8D,KApC9D,CAAA;EAIV,OAAA,CAAA,EAiCE,eAjCmB,CAAA,OAiCI,cAjCJ,CAAA;CAAyC,EAAA,GA6ChD,uBA7CgD,CA8CtE,OA9CsE,CA8C9D,UA9C8D,CAAA,OA8C5C,UA9C4C,CAAA,CAAA,EA+CtE,MA/CsE,EAgDtE,KAhDsE,CAAA,GAAA;EAAlB,QAAA,EAiDtC,QAjDsC;CAAR;AAAZ,KAoDxB,6BAAA,GAAgC,WApDR,CAoDoB,OApDpB,CAoD4B,UApD5B,CAAA,OAoD8C,UApD9C,CAAA,CAAA,CAAA;AAAW,KAqDnC,4BAAA,GAA+B,SArDI,CAAA,IAAA,CAAA;AAC/C;AAMA;;AACkB,iBAmDF,qBAnDE,CAAA,QAoDR,OApDQ,CAoDA,UApDA,CAAA,OAoDkB,UApDlB,CAAA,CAAA,EAAA,SAqDP,SArDO,CAAA,IAAA,CAAA,CAAA,CAAA,MAAA,CAAA,EAuDP,gBAvDO,EAAA,OAGP,CAHO,EAAA;EAAR,KAAA,CAAA,EAyDE,uBAzDF,CAyD0B,OAzD1B,CAyDkC,UAzDlC,CAAA,OAyDoD,UAzDpD,CAAA,CAAA,EAyDkE,MAzDlE,EAyD0E,KAzD1E,CAAA;EACC,OAAA,CAAA,EAyDG,eAzDH,CAAA,OAyD0B,cAzD1B,CAAA;CAEA,CAAA,EAyDR,sBAzDQ,CAyDe,KAzDf,EAyDsB,MAzDtB,CAAA,GAAA;EAE2C,QAAA,EAuDC,QAvDD;CAAlB"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ActionGetResponse, GetActionsParams } from "../api.schemas.js";
|
|
2
2
|
import { ErrorType, customInstance } from "../../custom-instance.js";
|
|
3
|
-
import {
|
|
3
|
+
import { QueryKey, UseQueryOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from "@tanstack/react-query";
|
|
4
4
|
|
|
5
5
|
//#region src/api/actions/actions.d.ts
|
|
6
6
|
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
@@ -18,56 +18,38 @@ You need admin privilege to use this endpoint.
|
|
|
18
18
|
declare const getActions: (params?: GetActionsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ActionGetResponse>;
|
|
19
19
|
declare const getGetActionsQueryKey: (params?: GetActionsParams) => readonly ["/action", ...GetActionsParams[]];
|
|
20
20
|
declare const useGetActionsQueryOptions: <TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
21
|
-
query?:
|
|
21
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
|
|
22
22
|
request?: SecondParameter<typeof customInstance>;
|
|
23
23
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {
|
|
24
|
-
queryKey:
|
|
24
|
+
queryKey: QueryKey;
|
|
25
25
|
};
|
|
26
26
|
type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
|
|
27
27
|
type GetActionsQueryError = ErrorType<void>;
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
32
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
33
|
-
};
|
|
34
|
-
declare function useGetActions<TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
35
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getActions>>, TError, Awaited<ReturnType<typeof getActions>>>, "initialData">;
|
|
36
|
-
request?: SecondParameter<typeof customInstance>;
|
|
37
|
-
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
38
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
39
|
-
};
|
|
28
|
+
/**
|
|
29
|
+
* @summary Gets Actions held on the Account Server
|
|
30
|
+
*/
|
|
40
31
|
declare function useGetActions<TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
41
|
-
query?:
|
|
32
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
|
|
42
33
|
request?: SecondParameter<typeof customInstance>;
|
|
43
|
-
}
|
|
44
|
-
queryKey:
|
|
34
|
+
}): UseQueryResult<TData, TError> & {
|
|
35
|
+
queryKey: QueryKey;
|
|
45
36
|
};
|
|
46
37
|
declare const useGetActionsSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
47
|
-
query?:
|
|
38
|
+
query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
|
|
48
39
|
request?: SecondParameter<typeof customInstance>;
|
|
49
40
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {
|
|
50
|
-
queryKey:
|
|
41
|
+
queryKey: QueryKey;
|
|
51
42
|
};
|
|
52
43
|
type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
|
|
53
44
|
type GetActionsSuspenseQueryError = ErrorType<void>;
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
58
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
59
|
-
};
|
|
60
|
-
declare function useGetActionsSuspense<TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
61
|
-
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
|
|
62
|
-
request?: SecondParameter<typeof customInstance>;
|
|
63
|
-
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
64
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
65
|
-
};
|
|
45
|
+
/**
|
|
46
|
+
* @summary Gets Actions held on the Account Server
|
|
47
|
+
*/
|
|
66
48
|
declare function useGetActionsSuspense<TData = Awaited<ReturnType<typeof getActions>>, TError = ErrorType<void>>(params?: GetActionsParams, options?: {
|
|
67
|
-
query?:
|
|
49
|
+
query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
|
|
68
50
|
request?: SecondParameter<typeof customInstance>;
|
|
69
|
-
}
|
|
70
|
-
queryKey:
|
|
51
|
+
}): UseSuspenseQueryResult<TData, TError> & {
|
|
52
|
+
queryKey: QueryKey;
|
|
71
53
|
};
|
|
72
54
|
//#endregion
|
|
73
55
|
export { GetActionsQueryError, GetActionsQueryResult, GetActionsSuspenseQueryError, GetActionsSuspenseQueryResult, getActions, getGetActionsQueryKey, useGetActions, useGetActionsQueryOptions, useGetActionsSuspense, useGetActionsSuspenseQueryOptions };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actions.d.ts","names":[],"sources":["../../../src/api/actions/actions.ts"],"sourcesContent":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"actions.d.ts","names":[],"sources":["../../../src/api/actions/actions.ts"],"sourcesContent":[],"mappings":";;;;;KA0BK,yDAAyD,WAAW;AAHlB;AAgBvD;;;;;;;;AAWA;AAIA;AACoC,cAhBvB,UAgBuB,EAAA,CAAA,MAAA,CAAA,EAfzB,gBAeyB,EAAA,OAAA,CAAA,EAdxB,eAcwB,CAAA,OAdD,cAcC,CAAA,EAAA,MAAA,CAAA,EAbzB,WAayB,EAAA,GAbd,OAac,CAbd,iBAac,CAAA;AAAlB,cALL,qBAKK,EAAA,CAAA,MAAA,CAAA,EAL6B,gBAK7B,EAAA,GAAA,SAAA,CAAA,SAAA,EAAA,GAL6C,gBAK7C,EAAA,CAAA;AAAR,cADG,yBACH,EAAA,CAAA,QAAA,OAAA,CAAQ,UAAR,CAAA,OAA0B,UAA1B,CAAA,CAAA,EAAA,SACC,SADD,CAAA,IAAA,CAAA,CAAA,CAAA,MAAA,CAAA,EAGC,gBAHD,EAAA,OAK4C,CAL5C,EAAA;EACC,KAAA,CAAA,EAIC,eAJD,CAIiB,OAJjB,CAIyB,UAJzB,CAAA,OAI2C,UAJ3C,CAAA,CAAA,EAIyD,MAJzD,EAIiE,KAJjE,CAAA;EAEA,OAAA,CAAA,EAGG,eAHH,CAAA,OAG0B,cAH1B,CAAA;CAE2C,EAAA,GAa5B,eAb4B,CAaZ,OAbY,CAaJ,UAbI,CAAA,OAac,UAbd,CAAA,CAAA,EAa4B,MAb5B,EAaoC,KAbpC,CAAA,GAAA;EAAlB,QAAA,EActB,QAdsB;CAAR;AAAwC,KAkBxD,qBAAA,GAAwB,WAlBgC,CAkBpB,OAlBoB,CAkBZ,UAlBY,CAAA,OAkBM,UAlBN,CAAA,CAAA,CAAA;AAAQ,KAmBhE,oBAAA,GAAuB,SAnByC,CAAA,IAAA,CAAA;;;;AAaR,iBAYpD,aAZoD,CAAA,QAa1D,OAb0D,CAalD,UAbkD,CAAA,OAahC,UAbgC,CAAA,CAAA,EAAA,SAczD,SAdyD,CAAA,IAAA,CAAA,CAAA,CAAA,MAAA,CAAA,EAgBzD,gBAhByD,EAAA,OAAc,CAAd,EAAA;EAAlB,KAAA,CAAA,EAkBtC,eAlBsC,CAkBtB,OAlBsB,CAkBd,UAlBc,CAAA,OAkBI,UAlBJ,CAAA,CAAA,EAkBkB,MAlBlB,EAkB0B,KAlB1B,CAAA;EAAR,OAAA,CAAA,EAmB5B,eAnB4B,CAAA,OAmBL,cAnBK,CAAA;CAAwC,CAAA,EAqB/E,cArB+E,CAqBhE,KArBgE,EAqBzD,MArByD,CAAA,GAAA;EAAQ,QAAA,EAqB3C,QArB2C;CAAhE;AACZ,cA8BD,iCA9BC,EAAA,CAAA,QA+BJ,OA/BI,CA+BI,UA/BJ,CAAA,OA+BsB,UA/BtB,CAAA,CAAA,EAAA,SAgCH,SAhCG,CAAA,IAAA,CAAA,CAAA,CAAA,MAAA,CAAA,EAkCH,gBAlCG,EAAA,OAI4D,CAJ5D,EAAA;EAAQ,KAAA,CAAA,EAoCV,uBApCU,CAoCc,OApCd,CAoCsB,UApCtB,CAAA,OAoCwC,UApCxC,CAAA,CAAA,EAoCsD,MApCtD,EAoC8D,KApC9D,CAAA;EAIV,OAAA,CAAA,EAiCE,eAjCmB,CAAA,OAiCI,cAjCJ,CAAA;CAAyC,EAAA,GA6ChD,uBA7CgD,CA8CtE,OA9CsE,CA8C9D,UA9C8D,CAAA,OA8C5C,UA9C4C,CAAA,CAAA,EA+CtE,MA/CsE,EAgDtE,KAhDsE,CAAA,GAAA;EAAlB,QAAA,EAiDtC,QAjDsC;CAAR;AAAZ,KAoDxB,6BAAA,GAAgC,WApDR,CAoDoB,OApDpB,CAoD4B,UApD5B,CAAA,OAoD8C,UApD9C,CAAA,CAAA,CAAA;AAAW,KAqDnC,4BAAA,GAA+B,SArDI,CAAA,IAAA,CAAA;AAC/C;AAMA;;AACkB,iBAmDF,qBAnDE,CAAA,QAoDR,OApDQ,CAoDA,UApDA,CAAA,OAoDkB,UApDlB,CAAA,CAAA,EAAA,SAqDP,SArDO,CAAA,IAAA,CAAA,CAAA,CAAA,MAAA,CAAA,EAuDP,gBAvDO,EAAA,OAGP,CAHO,EAAA;EAAR,KAAA,CAAA,EAyDE,uBAzDF,CAyD0B,OAzD1B,CAyDkC,UAzDlC,CAAA,OAyDoD,UAzDpD,CAAA,CAAA,EAyDkE,MAzDlE,EAyD0E,KAzD1E,CAAA;EACC,OAAA,CAAA,EAyDG,eAzDH,CAAA,OAyD0B,cAzD1B,CAAA;CAEA,CAAA,EAyDR,sBAzDQ,CAyDe,KAzDf,EAyDsB,MAzDtB,CAAA,GAAA;EAE2C,QAAA,EAuDC,QAvDD;CAAlB"}
|
|
@@ -4,7 +4,7 @@ import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
|
|
|
4
4
|
|
|
5
5
|
//#region src/api/actions/actions.ts
|
|
6
6
|
/**
|
|
7
|
-
* Generated by orval v7.
|
|
7
|
+
* Generated by orval v7.17.0 🍺
|
|
8
8
|
* Do not edit manually.
|
|
9
9
|
* Account Server API
|
|
10
10
|
* The Informatics Matters Account Server API.
|
|
@@ -48,9 +48,9 @@ const useGetActionsQueryOptions = (params, options) => {
|
|
|
48
48
|
/**
|
|
49
49
|
* @summary Gets Actions held on the Account Server
|
|
50
50
|
*/
|
|
51
|
-
function useGetActions(params, options
|
|
51
|
+
function useGetActions(params, options) {
|
|
52
52
|
const queryOptions = useGetActionsQueryOptions(params, options);
|
|
53
|
-
const query = useQuery(queryOptions
|
|
53
|
+
const query = useQuery(queryOptions);
|
|
54
54
|
query.queryKey = queryOptions.queryKey;
|
|
55
55
|
return query;
|
|
56
56
|
}
|
|
@@ -67,9 +67,9 @@ const useGetActionsSuspenseQueryOptions = (params, options) => {
|
|
|
67
67
|
/**
|
|
68
68
|
* @summary Gets Actions held on the Account Server
|
|
69
69
|
*/
|
|
70
|
-
function useGetActionsSuspense(params, options
|
|
70
|
+
function useGetActionsSuspense(params, options) {
|
|
71
71
|
const queryOptions = useGetActionsSuspenseQueryOptions(params, options);
|
|
72
|
-
const query = useSuspenseQuery(queryOptions
|
|
72
|
+
const query = useSuspenseQuery(queryOptions);
|
|
73
73
|
query.queryKey = queryOptions.queryKey;
|
|
74
74
|
return query;
|
|
75
75
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actions.js","names":["queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>>"],"sources":["../../../src/api/actions/actions.ts"],"sourcesContent":["/**\n * Generated by orval v7.16.1 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.\n\n * OpenAPI spec version: 4.4\n */\nimport { useQuery, useSuspenseQuery } from \"@tanstack/react-query\";\nimport type {\n DataTag,\n DefinedInitialDataOptions,\n DefinedUseQueryResult,\n QueryClient,\n QueryFunction,\n QueryKey,\n UndefinedInitialDataOptions,\n UseQueryOptions,\n UseQueryResult,\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from \"@tanstack/react-query\";\n\nimport type { ActionGetResponse, GetActionsParams } from \"../api.schemas\";\n\nimport { customInstance } from \"../../custom-instance\";\nimport type { ErrorType } from \"../../custom-instance\";\nimport { queryMutator } from \"../../options-mutator\";\n\ntype SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];\n\n/**\n * This endpoint delivers Action records (protocol buffers) that can be selected based on a date and time range and limited to merchants, organisations, Units, or Products. You can receive Action content as a `PROTOCOL_STRING` (the default), or `JSON_STRING`. If you do not provide a `format` `PROTOCOL_STRING` will be assumed.\n\nYou can provide a `m_id`, `org_id`, `unit_id`, `product_id`, but only one.\n\nYou can also provide `from` and `until` dates to limit the response to Actions that occur on the days you select. Actions are returned that are not before the `from` data but are before the `until` date. If neither `from` or `until` is provided `from` is assumed to be from _today_ until _tomorrow_.\n\nYou need admin privilege to use this endpoint.\n\n * @summary Gets Actions held on the Account Server\n */\nexport const getActions = (\n params?: GetActionsParams,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal,\n) => {\n return customInstance<ActionGetResponse>(\n { url: `/action`, method: \"GET\", params, signal },\n options,\n );\n};\n\nexport const getGetActionsQueryKey = (params?: GetActionsParams) => {\n return [`/action`, ...(params ? [params] : [])] as const;\n};\n\nexport const useGetActionsQueryOptions = <\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n) => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>\n getActions(params, requestOptions, signal);\n\n const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });\n\n return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {\n queryKey: DataTag<QueryKey, TData, TError>;\n };\n};\n\nexport type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;\nexport type GetActionsQueryError = ErrorType<void>;\n\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params: undefined | GetActionsParams,\n options: {\n query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &\n Pick<\n DefinedInitialDataOptions<\n Awaited<ReturnType<typeof getActions>>,\n TError,\n Awaited<ReturnType<typeof getActions>>\n >,\n \"initialData\"\n >;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &\n Pick<\n UndefinedInitialDataOptions<\n Awaited<ReturnType<typeof getActions>>,\n TError,\n Awaited<ReturnType<typeof getActions>>\n >,\n \"initialData\"\n >;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\n/**\n * @summary Gets Actions held on the Account Server\n */\n\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {\n const queryOptions = useGetActionsQueryOptions(params, options);\n\n const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {\n queryKey: DataTag<QueryKey, TData, TError>;\n };\n\n query.queryKey = queryOptions.queryKey;\n\n return query;\n}\n\nexport const useGetActionsSuspenseQueryOptions = <\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n) => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>\n getActions(params, requestOptions, signal);\n\n const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });\n\n return customOptions as UseSuspenseQueryOptions<\n Awaited<ReturnType<typeof getActions>>,\n TError,\n TData\n > & { queryKey: DataTag<QueryKey, TData, TError> };\n};\n\nexport type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;\nexport type GetActionsSuspenseQueryError = ErrorType<void>;\n\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params: undefined | GetActionsParams,\n options: {\n query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\n/**\n * @summary Gets Actions held on the Account Server\n */\n\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;\n request?: SecondParameter<typeof customInstance>;\n },\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {\n const queryOptions = useGetActionsSuspenseQueryOptions(params, options);\n\n const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<\n TData,\n TError\n > & { queryKey: DataTag<QueryKey, TData, TError> };\n\n query.queryKey = queryOptions.queryKey;\n\n return query;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,MAAa,cACX,QACA,SACA,WACG;AACH,QAAO,eACL;EAAE,KAAK;EAAW,QAAQ;EAAO;EAAQ;EAAQ,EACjD,QACD;;AAGH,MAAa,yBAAyB,WAA8B;AAClE,QAAO,CAAC,WAAW,GAAI,SAAS,CAAC,OAAO,GAAG,EAAE,CAAE;;AAGjD,MAAa,6BAIX,QACA,YAIG;CACH,MAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,EAAE;CAEtE,MAAM,WAAW,cAAc,YAAY,sBAAsB,OAAO;CAExE,MAAMA,WAAkE,EAAE,aACxE,WAAW,QAAQ,gBAAgB,OAAO;AAI5C,QAFsB,aAAa;EAAE,GAAG;EAAc;EAAU;EAAS,CAAC;;;;;AA+D5E,SAAgB,cAId,QACA,SAIA,aACgF;CAChF,MAAM,eAAe,0BAA0B,QAAQ,QAAQ;CAE/D,MAAM,QAAQ,SAAS,cAAc,YAAY;AAIjD,OAAM,WAAW,aAAa;AAE9B,QAAO;;AAGT,MAAa,qCAIX,QACA,YAIG;CACH,MAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,EAAE;CAEtE,MAAM,WAAW,cAAc,YAAY,sBAAsB,OAAO;CAExE,MAAMA,WAAkE,EAAE,aACxE,WAAW,QAAQ,gBAAgB,OAAO;AAI5C,QAFsB,aAAa;EAAE,GAAG;EAAc;EAAU;EAAS,CAAC;;;;;AAiD5E,SAAgB,sBAId,QACA,SAIA,aACwF;CACxF,MAAM,eAAe,kCAAkC,QAAQ,QAAQ;CAEvE,MAAM,QAAQ,iBAAiB,cAAc,YAAY;AAKzD,OAAM,WAAW,aAAa;AAE9B,QAAO"}
|
|
1
|
+
{"version":3,"file":"actions.js","names":["queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>>"],"sources":["../../../src/api/actions/actions.ts"],"sourcesContent":["/**\n * Generated by orval v7.17.0 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.\n\n * OpenAPI spec version: 4.4\n */\nimport { useQuery, useSuspenseQuery } from \"@tanstack/react-query\";\nimport type {\n QueryFunction,\n QueryKey,\n UseQueryOptions,\n UseQueryResult,\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from \"@tanstack/react-query\";\n\nimport type { ActionGetResponse, GetActionsParams } from \"../api.schemas\";\n\nimport { customInstance } from \"../../custom-instance\";\nimport type { ErrorType } from \"../../custom-instance\";\nimport { queryMutator } from \"../../options-mutator\";\n\ntype SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];\n\n/**\n * This endpoint delivers Action records (protocol buffers) that can be selected based on a date and time range and limited to merchants, organisations, Units, or Products. You can receive Action content as a `PROTOCOL_STRING` (the default), or `JSON_STRING`. If you do not provide a `format` `PROTOCOL_STRING` will be assumed.\n\nYou can provide a `m_id`, `org_id`, `unit_id`, `product_id`, but only one.\n\nYou can also provide `from` and `until` dates to limit the response to Actions that occur on the days you select. Actions are returned that are not before the `from` data but are before the `until` date. If neither `from` or `until` is provided `from` is assumed to be from _today_ until _tomorrow_.\n\nYou need admin privilege to use this endpoint.\n\n * @summary Gets Actions held on the Account Server\n */\nexport const getActions = (\n params?: GetActionsParams,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal,\n) => {\n return customInstance<ActionGetResponse>(\n { url: `/action`, method: \"GET\", params, signal },\n options,\n );\n};\n\nexport const getGetActionsQueryKey = (params?: GetActionsParams) => {\n return [`/action`, ...(params ? [params] : [])] as const;\n};\n\nexport const useGetActionsQueryOptions = <\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n },\n) => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>\n getActions(params, requestOptions, signal);\n\n const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });\n\n return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {\n queryKey: QueryKey;\n };\n};\n\nexport type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;\nexport type GetActionsQueryError = ErrorType<void>;\n\n/**\n * @summary Gets Actions held on the Account Server\n */\n\nexport function useGetActions<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n },\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } {\n const queryOptions = useGetActionsQueryOptions(params, options);\n\n const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n query.queryKey = queryOptions.queryKey;\n\n return query;\n}\n\nexport const useGetActionsSuspenseQueryOptions = <\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n },\n) => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>\n getActions(params, requestOptions, signal);\n\n const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });\n\n return customOptions as UseSuspenseQueryOptions<\n Awaited<ReturnType<typeof getActions>>,\n TError,\n TData\n > & { queryKey: QueryKey };\n};\n\nexport type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;\nexport type GetActionsSuspenseQueryError = ErrorType<void>;\n\n/**\n * @summary Gets Actions held on the Account Server\n */\n\nexport function useGetActionsSuspense<\n TData = Awaited<ReturnType<typeof getActions>>,\n TError = ErrorType<void>,\n>(\n params?: GetActionsParams,\n options?: {\n query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n },\n): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {\n const queryOptions = useGetActionsSuspenseQueryOptions(params, options);\n\n const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryOptions.queryKey;\n\n return query;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,MAAa,cACX,QACA,SACA,WACG;AACH,QAAO,eACL;EAAE,KAAK;EAAW,QAAQ;EAAO;EAAQ;EAAQ,EACjD,QACD;;AAGH,MAAa,yBAAyB,WAA8B;AAClE,QAAO,CAAC,WAAW,GAAI,SAAS,CAAC,OAAO,GAAG,EAAE,CAAE;;AAGjD,MAAa,6BAIX,QACA,YAIG;CACH,MAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,EAAE;CAEtE,MAAM,WAAW,cAAc,YAAY,sBAAsB,OAAO;CAExE,MAAMA,WAAkE,EAAE,aACxE,WAAW,QAAQ,gBAAgB,OAAO;AAI5C,QAFsB,aAAa;EAAE,GAAG;EAAc;EAAU;EAAS,CAAC;;;;;AAc5E,SAAgB,cAId,QACA,SAIwD;CACxD,MAAM,eAAe,0BAA0B,QAAQ,QAAQ;CAE/D,MAAM,QAAQ,SAAS,aAAa;AAEpC,OAAM,WAAW,aAAa;AAE9B,QAAO;;AAGT,MAAa,qCAIX,QACA,YAIG;CACH,MAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,EAAE;CAEtE,MAAM,WAAW,cAAc,YAAY,sBAAsB,OAAO;CAExE,MAAMA,WAAkE,EAAE,aACxE,WAAW,QAAQ,gBAAgB,OAAO;AAI5C,QAFsB,aAAa;EAAE,GAAG;EAAc;EAAU;EAAS,CAAC;;;;;AAgB5E,SAAgB,sBAId,QACA,SAIgE;CAChE,MAAM,eAAe,kCAAkC,QAAQ,QAAQ;CAEvE,MAAM,QAAQ,iBAAiB,aAAa;AAI5C,OAAM,WAAW,aAAa;AAE9B,QAAO"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.schemas.cjs","names":[],"sources":["../../src/api/api.schemas.ts"],"sourcesContent":["/**\n * Generated by orval v7.16.1 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.\n\n * OpenAPI spec version: 4.4\n */\nexport interface AsError {\n /** Brief error text that can be presented to the user */\n error: string;\n}\n\nexport interface ActionGetResponse {\n /** A list of Actions\n */\n actions: ActionDetail[];\n /** The number of Actions returned\n */\n count: number;\n}\n\nexport interface ActionDetail {\n id: number;\n action: string;\n content: string;\n timestamp: string;\n merchant?: MerchantSummary;\n product_id?: string;\n unit_id?: string;\n org_id?: string;\n}\n\nexport type AssetGetByIdResponse = AssetDetail;\n\nexport interface AssetGetResponse {\n /** A list of Assets\n */\n assets: AssetDetail[];\n /** The number of Assets returned\n */\n count: number;\n}\n\nexport interface AssetPostResponse {\n /** The Asset ID\n */\n id: string;\n}\n\nexport interface ChargesGetResponse {\n coins: string;\n count: number;\n summary: ChargeSummary[];\n organisation_charges: OrganisationChargeSummary[];\n}\n\nexport interface EventStreamGetPostResponse {\n /** The EventStream ID */\n id: number;\n /** A symbolic name, used internally to identify the stream */\n name: string;\n /** The Event Stream location. This will be a URL where events can be fetched. The protocol is typically a WebSocket, but the protocol is defined by the specific Event Stream Service that has been deployed. */\n location: string;\n /** The Event Stream format. */\n format: string;\n}\n\n/**\n * The Event Stream protocol, used to inform the client how to connect to given locations and handle events. At the moment the AS only supports web-sockets.\n */\nexport type EventStreamVersionGetResponseProtocol =\n (typeof EventStreamVersionGetResponseProtocol)[keyof typeof EventStreamVersionGetResponseProtocol];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const EventStreamVersionGetResponseProtocol = {\n ERROR_INTERNAL: \"ERROR_INTERNAL\",\n SERVICE_NOT_PRESENT: \"SERVICE_NOT_PRESENT\",\n WEBSOCKET: \"WEBSOCKET\",\n} as const;\n\nexport interface EventStreamVersionGetResponse {\n /** The EventStream implementation version */\n version: string;\n /** The Event Stream protocol, used to inform the client how to connect to given locations and handle events. At the moment the AS only supports web-sockets. */\n protocol: EventStreamVersionGetResponseProtocol;\n /** The name of the Event Stream implementation, often used to identify the service origin and implementation. */\n name: string;\n}\n\nexport interface StateGetVersionResponse {\n /** The Account Server version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined\n */\n version: string;\n}\n\nexport interface OrganisationPostResponse {\n /** The Organisation's unique ID */\n id: string;\n}\n\nexport interface UsersGetResponse {\n count: number;\n organisation?: OrganisationDetail;\n unit?: UnitDetail;\n /** The list of Organisation Users\n */\n users: UserDetail[];\n}\n\n/**\n * The Organisation's default product privacy setting\n */\nexport type OrganisationGetDefaultResponseDefaultProductPrivacy =\n (typeof OrganisationGetDefaultResponseDefaultProductPrivacy)[keyof typeof OrganisationGetDefaultResponseDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationGetDefaultResponseDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface OrganisationGetDefaultResponse {\n /** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */\n caller_is_member?: boolean;\n /** The Default Organisation ID\n */\n id?: string;\n /** The Default Organisation Name\n */\n name?: string;\n /** True if the Organisation is private. The Default organisation is always public, although it does not contain a membership (unless you're admin) and only houses Personal Units\n */\n private?: boolean;\n created?: string;\n /** The Organisation's default product privacy setting */\n default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;\n}\n\nexport interface OrganisationUnitPostResponse {\n /** The unit's unique ID */\n id: string;\n}\n\nexport interface PersonalUnitPutResponse {\n /** The unit's Organisation. Used to identify the Default organisation */\n organisation_id: string;\n /** The unit's unique ID */\n id: string;\n}\n\nexport interface OrganisationChargeSummary {\n organisation_id: string;\n name: string;\n summary: ChargeSummary[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n count?: number;\n organisation: OrganisationAllDetail;\n /** A list of Units\n */\n units: UnitAllDetail[];\n}\n\nexport interface OrganisationChargesGetResponse {\n organisation_id: string;\n name: string;\n coins: string;\n summary: ChargeSummary[];\n unit_charges: OrganisationUnitChargeSummary[];\n}\n\nexport interface OrganisationUnitChargeSummary {\n unit_id: string;\n name: string;\n /**\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n /** The start of the charge period */\n from: string;\n /** The date where of first day after the charge period */\n until: string;\n summary: ChargeSummary[];\n}\n\nexport interface OrganisationsGetResponse {\n count: number;\n /** A list of Organisations */\n organisations: OrganisationAllDetail[];\n}\n\nexport type OrganisationGetResponse = OrganisationAllDetail;\n\nexport type ProductChargesGetResponseProductType =\n (typeof ProductChargesGetResponseProductType)[keyof typeof ProductChargesGetResponseProductType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductChargesGetResponseProductType = {\n DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\nexport interface ProductChargesGetResponse {\n product_id: string;\n product_type: ProductChargesGetResponseProductType;\n /**\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n /** True if the product can be (needs to be) claimed. */\n claimable: boolean;\n claim?: ProductClaimDetail;\n count: number;\n /** The start of the charge period */\n from: string;\n /** The date where of first day after the charge period */\n until: string;\n /** The total number of coins consumed by this product for the invoice period */\n coins: string;\n processing_charges: ProcessingCharges[];\n storage_charges: StorageCharges;\n}\n\nexport type ProductsGetResponseProductsItem = ProductDmStorage | ProductDmProjectTier;\n\nexport interface ProductsGetResponse {\n count: number;\n /** All the Products you have access to */\n products: ProductsGetResponseProductsItem[];\n}\n\nexport type ProductsGetDefaultStorageCostDefaultStorageCost = {\n cost: string;\n units: string;\n description: string;\n};\n\nexport interface ProductsGetDefaultStorageCost {\n default_storage_cost: ProductsGetDefaultStorageCostDefaultStorageCost;\n}\n\nexport interface ProductsGetTypesResponse {\n /** The number of Product Types */\n count: number;\n /** All the Product Types you have access to */\n product_types: ProductType[];\n}\n\n/**\n * The Unit's Product\n */\nexport type ProductUnitGetResponseProduct = ProductDmStorage | ProductDmProjectTier;\n\nexport interface ProductUnitGetResponse {\n /** The Unit's Product */\n product: ProductUnitGetResponseProduct;\n}\n\nexport interface UnitChargesGetResponse {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n unit_id: string;\n name?: string;\n /** The Unit's owner (a username) */\n owner_id: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n coins: string;\n count: number;\n /**\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n /** The start of the charge period */\n from: string;\n /** The date where of first day after the charge period */\n until: string;\n summary: UnitChargeSummary;\n products: UnitProductChargeSummary[];\n}\n\nexport interface UnitChargeSummary {\n charges: ChargeSummary[];\n}\n\nexport interface UnitProductChargeSummary {\n product_id: string;\n product_type: string;\n charges: ChargeSummary[];\n}\n\n/**\n * The type of charge\n */\nexport type ChargeSummaryType = (typeof ChargeSummaryType)[keyof typeof ChargeSummaryType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ChargeSummaryType = { PROCESSING: \"PROCESSING\", STORAGE: \"STORAGE\" } as const;\n\nexport interface ChargeSummary {\n /** The type of charge */\n type: ChargeSummaryType;\n /** The cost, in coins of the charge */\n coins: string;\n}\n\nexport interface UnitProductPostResponse {\n /** The Product's unique ID */\n id: string;\n}\n\nexport type UnitGetResponse = UnitAllDetail;\n\nexport interface UnitsGetResponse {\n /** A list of Units\n */\n units: OrganisationUnitsGetResponse[];\n}\n\nexport type UserAccountGetResponse = UserAccountDetail;\n\nexport type AssetDetailScope = (typeof AssetDetailScope)[keyof typeof AssetDetailScope];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const AssetDetailScope = {\n USER: \"USER\",\n PRODUCT: \"PRODUCT\",\n UNIT: \"UNIT\",\n ORGANISATION: \"ORGANISATION\",\n GLOBAL: \"GLOBAL\",\n} as const;\n\nexport interface AssetDetail {\n creator: string;\n id: string;\n name: string;\n scope: AssetDetailScope;\n scope_id: string;\n secret: boolean;\n disabled: boolean;\n content: string;\n created: string;\n content_modified?: string;\n description?: string;\n merchants: MerchantDetail[];\n}\n\nexport type ProcessingChargesMerchantKind =\n (typeof ProcessingChargesMerchantKind)[keyof typeof ProcessingChargesMerchantKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProcessingChargesMerchantKind = { DATA_MANAGER: \"DATA_MANAGER\" } as const;\n\nexport interface ProcessingCharges {\n merchant_name: string;\n merchant_kind: ProcessingChargesMerchantKind;\n merchant_api_hostname: string;\n /** The date when the process stopped */\n closed?: string;\n /** True if no further change to the charges can occur. Typically True after the charge has been closed for a pre-configured period of time. */\n final: boolean;\n /** True if charges were received after the charge record was finalised */\n post_final_charges?: boolean;\n charge: ProcessingChargeItem;\n}\n\nexport interface ProcessingChargeItem {\n /** The charge record number */\n id: number;\n /** The most recent sequence number for this charge */\n sqn: number;\n name?: string;\n username: string;\n /** The date and time of the processing charge */\n timestamp: string;\n /** The coin-cost of the storage */\n coins: string;\n additional_data?: ChargeAdditionalData;\n}\n\nexport interface StorageCharges {\n num_items: number;\n items: StorageChargeItem[];\n}\n\nexport interface StorageChargeItem {\n item_number: number;\n /** The date and time of the processing charge */\n date: string;\n /** The coin-cost of the storage */\n coins: string;\n /** The current burn rate, the approximate amount of coins you are currently consuming each day */\n current_burn_rate?: string;\n /** The date when the charges concluded */\n closed?: string;\n additional_data?: ChargeAdditionalData;\n}\n\nexport interface ChargeAdditionalData {\n [key: string]: unknown;\n}\n\nexport interface ProductDmStorage {\n product: ProductDetail;\n organisation: OrganisationAllDetail;\n unit: UnitAllDetail;\n storage: ProductDmStorageDetail;\n coins: ProductCoinsDetail;\n /** True if the product can be (needs to be) claimed. */\n claimable: boolean;\n}\n\nexport interface ProductDmProjectTier {\n product: ProductDetail;\n organisation: OrganisationAllDetail;\n unit: UnitAllDetail;\n storage: ProductDmStorageDetail;\n coins: ProductCoinsDetail;\n instance: ProductInstanceDetail;\n /** True if the product can be (needs to be) claimed. */\n claimable: boolean;\n claim?: ProductClaimDetail;\n}\n\nexport type ProductDmStorageDetailSize = {\n /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */\n peak: string;\n /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */\n current: string;\n /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */\n unit_size: string;\n /** The peak number of storage units used today */\n units_used: number;\n};\n\nexport type ProductDmStorageDetailCoins = {\n /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */\n used: number;\n /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */\n unit_cost: number;\n};\n\nexport interface ProductDmStorageDetail {\n size: ProductDmStorageDetailSize;\n coins: ProductDmStorageDetailCoins;\n}\n\nexport interface ProductClaimDetail {\n /** The service-specific ID that is using this Subscription\n */\n id: string;\n /** A name for the service-specific ID\n */\n name?: string;\n}\n\nexport interface ProductCoinsDetail {\n /** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */\n allowance: number;\n /** The limit on your billing period spend. You can exceed the allowance but you cannot exceed the spend limit. Once reached the dependent may be restricted */\n limit: number;\n /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */\n used: number;\n /** True if the product is operating at or beyond its coin limit. When it is authority to perform actions using the product are severely limited. */\n at_limit: boolean;\n /** The current burn rate, the approximate amount of coins you are currently consuming each day */\n current_burn_rate: number;\n /** The predicted total billing period amount, if costs continue at the current burn rate until the end of the billing period. This is an estimate */\n billing_prediction: number;\n /** The predicted storage contribution to the billing period amount, if costs continue at the current burn rate until the end of the billing period. This is an estimate */\n billing_prediction_storage_contribution: number;\n /** The day of the month when the bill is due, and the end of the current billing period */\n billing_day: number;\n /** A multiplier applied to your coin usage within your allowance */\n allowance_multiplier: number;\n /** A multiplier that will be applied to coin used beyond your allowance */\n overspend_multiplier: number;\n /** The number of days remaining, in the current billing period */\n remaining_days: number;\n}\n\n/**\n * The Product Type\n\n */\nexport type ProductDetailType = (typeof ProductDetailType)[keyof typeof ProductDetailType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailType = {\n DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\n/**\n * The Product Type flavour. Not all products have flavours\n\n */\nexport type ProductDetailFlavour = (typeof ProductDetailFlavour)[keyof typeof ProductDetailFlavour];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailFlavour = {\n EVALUATION: \"EVALUATION\",\n BRONZE: \"BRONZE\",\n SILVER: \"SILVER\",\n GOLD: \"GOLD\",\n} as const;\n\nexport interface ProductDetail {\n /** The Product ID\n */\n id: string;\n created: string;\n /** The Product Type\n */\n type: ProductDetailType;\n /** The Product Type flavour. Not all products have flavours\n */\n flavour?: ProductDetailFlavour;\n /** The name of the Product\n */\n name?: string;\n}\n\nexport type ProductInstanceDetailCoins = {\n /** The number of coins used\n */\n used: number;\n};\n\nexport interface ProductInstanceDetail {\n coins: ProductInstanceDetailCoins;\n}\n\n/**\n * The kind of service that can use the Product\n */\nexport type ProductTypeServiceKind =\n (typeof ProductTypeServiceKind)[keyof typeof ProductTypeServiceKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductTypeServiceKind = { DATA_MANAGER: \"DATA_MANAGER\" } as const;\n\nexport interface ProductType {\n /** A product type, this is a unique string amongst all types known to the Account Server */\n type: string;\n /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */\n flavour?: string;\n /** The kind of service that can use the Product */\n service_kind?: ProductTypeServiceKind;\n}\n\n/**\n * The Organisation's default product privacy setting\n */\nexport type OrganisationAllDetailDefaultProductPrivacy =\n (typeof OrganisationAllDetailDefaultProductPrivacy)[keyof typeof OrganisationAllDetailDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationAllDetailDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface OrganisationAllDetail {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n /** The Organisation's unique ID */\n id: string;\n /** The Organisation's name */\n name: string;\n /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */\n owner_id?: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n /** The Organisation's default product privacy setting */\n default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;\n /** A list of users that are members of the Organisation */\n users: UserDetail[];\n}\n\n/**\n * The Organisation's default product privacy setting\n */\nexport type OrganisationDetailDefaultProductPrivacy =\n (typeof OrganisationDetailDefaultProductPrivacy)[keyof typeof OrganisationDetailDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationDetailDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface OrganisationDetail {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n /** The Organisation's unique ID */\n id: string;\n /** The Organisation's name */\n name: string;\n /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */\n owner_id?: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n /** The Organisation's default product privacy setting */\n default_product_privacy: OrganisationDetailDefaultProductPrivacy;\n}\n\nexport interface MerchantsGetResponse {\n count?: number;\n /** The list of known Merchants\n */\n merchants: MerchantDetail[];\n}\n\nexport type MerchantGetResponse = MerchantDetail;\n\n/**\n * The kind of Service\n */\nexport type MerchantDetailKind = (typeof MerchantDetailKind)[keyof typeof MerchantDetailKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const MerchantDetailKind = { DATA_MANAGER: \"DATA_MANAGER\" } as const;\n\nexport interface MerchantDetail {\n /** The unique ID of the Service */\n id: number;\n created: string;\n /** The kind of Service */\n kind: MerchantDetailKind;\n /** The name assigned to the Service */\n name: string;\n /** The hostname used by the Service */\n api_hostname: string;\n}\n\n/**\n * The kind of Service\n */\nexport type MerchantSummaryKind = (typeof MerchantSummaryKind)[keyof typeof MerchantSummaryKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const MerchantSummaryKind = { DATA_MANAGER: \"DATA_MANAGER\" } as const;\n\nexport interface MerchantSummary {\n /** The unique ID of the Merchant */\n id: number;\n /** The kind of Service */\n kind: MerchantSummaryKind;\n /** The name assigned to the Service */\n name: string;\n}\n\n/**\n * The Unit's default product privacy setting\n */\nexport type UnitAllDetailDefaultProductPrivacy =\n (typeof UnitAllDetailDefaultProductPrivacy)[keyof typeof UnitAllDetailDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitAllDetailDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface UnitAllDetail {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n /** The Unit's unique identity */\n id: string;\n /** The Unit's name */\n name: string;\n /** The Unit's owner (a username) */\n owner_id: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n /** The Unit's billing day */\n billing_day: number;\n /** The Unit's default product privacy setting */\n default_product_privacy: UnitAllDetailDefaultProductPrivacy;\n /** A list of users that are members of the Unit */\n users: UserDetail[];\n}\n\n/**\n * The Unit's default product privacy setting\n */\nexport type UnitDetailDefaultProductPrivacy =\n (typeof UnitDetailDefaultProductPrivacy)[keyof typeof UnitDetailDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitDetailDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface UnitDetail {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n /** The Unit's unique identity */\n id: string;\n /** The Unit's name */\n name: string;\n /** The Unit's owner (a username) */\n owner_id: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n /** The Unit's billing day */\n billing_day: number;\n /** The Unit's default product privacy setting */\n default_product_privacy: UnitDetailDefaultProductPrivacy;\n}\n\nexport interface UserAccountDetail {\n user: UserDetail;\n /** Whether the caller has admin privilege */\n caller_has_admin_privilege: boolean;\n /** The roles assigned to the user recognised by the Account Server */\n account_server_roles: string[];\n}\n\nexport interface UserDetail {\n /** The user identity (username) */\n id: string;\n}\n\nexport type AssetPatchBodyBody = {\n /** A file containing the content for the asset. You must provide a value here or in content_string */\n content_file?: Blob;\n /** The textual content of the asset. You must provide a value here or in content_file */\n content_string?: string;\n /** An optional description for the Asset */\n description?: string;\n};\n\n/**\n * An enumeration of the scope of the asset. This can be one of `USER`, `PRODUCT`, `UNIT`, `ORGANISATION`, or `GLOBAL`. Assets that are not `GLOBAL` need a scope ID.\n */\nexport type AssetPostBodyBodyScope =\n (typeof AssetPostBodyBodyScope)[keyof typeof AssetPostBodyBodyScope];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const AssetPostBodyBodyScope = {\n USER: \"USER\",\n PRODUCT: \"PRODUCT\",\n UNIT: \"UNIT\",\n ORGANISATION: \"ORGANISATION\",\n GLOBAL: \"GLOBAL\",\n} as const;\n\nexport type AssetPostBodyBody = {\n /**\n * The name of the asset. This must be unique within its scope. For example, only one asset can be called \"asset-1\" within a given `UNIT`. Asset names must be valid RFC 1123 Label Names\n * @maxLength 80\n * @pattern ^[a-z0-9-]{1,63}$\n */\n name: string;\n /** A file containing the content for the asset. You must provide a value here or in **content_string** but not both */\n content_file?: Blob;\n /** The textual content of the asset. You must provide a value here or in **content_file** but not both */\n content_string?: string;\n /** An enumeration of the scope of the asset. This can be one of `USER`, `PRODUCT`, `UNIT`, `ORGANISATION`, or `GLOBAL`. Assets that are not `GLOBAL` need a scope ID. */\n scope: AssetPostBodyBodyScope;\n /** The unique identity based on the Scope of the asset. For example, this will be the Unit ID if it's a UNIT. A scope_id is required if the scope is USER as it will be automatically set to your username. Global assets do not have a scope. */\n scope_id?: string;\n /** Is this a secret asset? Secret assets are not revealed in a subsequent **GET** but are revealed to merchants they are connected to. */\n secret: boolean;\n /** An optional description for the Asset */\n description?: string;\n};\n\nexport type EventStreamPostBodyBodyFormat =\n (typeof EventStreamPostBodyBodyFormat)[keyof typeof EventStreamPostBodyBodyFormat];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const EventStreamPostBodyBodyFormat = {\n PROTOCOL_STRING: \"PROTOCOL_STRING\",\n JSON_STRING: \"JSON_STRING\",\n} as const;\n\nexport type EventStreamPostBodyBody = { format?: EventStreamPostBodyBodyFormat };\n\n/**\n * The default product privacy setting for the Organisation\n */\nexport type OrganisationPostBodyBodyDefaultProductPrivacy =\n (typeof OrganisationPostBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationPostBodyBodyDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationPostBodyBodyDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport type OrganisationPostBodyBody = {\n /**\n * The name of the organisation\n * @maxLength 80\n */\n name: string;\n /** The name of the organisation owner. A user ID */\n owner: string;\n /** The default product privacy setting for the Organisation */\n default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;\n};\n\nexport type PersonalUnitPutBodyBody = {\n /**\n * The day you would like to be billed for the Unit's Products (a value from 1 and 28)\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n};\n\n/**\n * The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value\n */\nexport type OrganisationUnitPostBodyBodyDefaultProductPrivacy =\n (typeof OrganisationUnitPostBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationUnitPostBodyBodyDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationUnitPostBodyBodyDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport type OrganisationUnitPostBodyBody = {\n /**\n * The name of the unit\n * @maxLength 80\n */\n name: string;\n /**\n * The day you would like to be billed for the Unit's Products (a value from 1 and 28)\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n /** The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value */\n default_product_privacy?: OrganisationUnitPostBodyBodyDefaultProductPrivacy;\n};\n\n/**\n * The new default **Product** privacy applied to all products that belong to this Organisation. Privacy is also controlled at the **Unit** level. As an example the Organisation level privacy can be `DEFAULT_PRIVATE`, but the unit can declare its Products to be `ALWAYS_PRIVATE`.\n\nWhether the privacy can be honoured will depend on the value in any of the organisation's existing units\n */\nexport type OrganisationPatchBodyBodyDefaultProductPrivacy =\n (typeof OrganisationPatchBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationPatchBodyBodyDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationPatchBodyBodyDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport type OrganisationPatchBodyBody = {\n /** The new name for the Organisational */\n name?: string;\n /** The new default **Product** privacy applied to all products that belong to this Organisation. Privacy is also controlled at the **Unit** level. As an example the Organisation level privacy can be `DEFAULT_PRIVATE`, but the unit can declare its Products to be `ALWAYS_PRIVATE`.\n\nWhether the privacy can be honoured will depend on the value in any of the organisation's existing units */\n default_product_privacy?: OrganisationPatchBodyBodyDefaultProductPrivacy;\n};\n\n/**\n * The new default **Product** privacy applied to all products that belong to this Unit. Privacy is also controlled at the **Organisation** level. As an example, the Unit can declare its Products to be `DEFAULT_PRIVATE`, but the Organisation can declare its value to be `DEFAULT_PUBLIC`.\n\nWhether the privacy can be honoured will depend on the organisation's value\n */\nexport type UnitPatchBodyBodyDefaultProductPrivacy =\n (typeof UnitPatchBodyBodyDefaultProductPrivacy)[keyof typeof UnitPatchBodyBodyDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitPatchBodyBodyDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport type UnitPatchBodyBody = {\n /** The new name for the Unit */\n name?: string;\n /** The new default **Product** privacy applied to all products that belong to this Unit. Privacy is also controlled at the **Organisation** level. As an example, the Unit can declare its Products to be `DEFAULT_PRIVATE`, but the Organisation can declare its value to be `DEFAULT_PUBLIC`.\n\nWhether the privacy can be honoured will depend on the organisation's value */\n default_product_privacy?: UnitPatchBodyBodyDefaultProductPrivacy;\n};\n\n/**\n * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products\n */\nexport type UnitProductPostBodyBodyType =\n (typeof UnitProductPostBodyBodyType)[keyof typeof UnitProductPostBodyBodyType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyType = {\n DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products\n */\nexport type UnitProductPostBodyBodyFlavour =\n (typeof UnitProductPostBodyBodyFlavour)[keyof typeof UnitProductPostBodyBodyFlavour];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyFlavour = {\n EVALUATION: \"EVALUATION\",\n BRONZE: \"BRONZE\",\n SILVER: \"SILVER\",\n GOLD: \"GOLD\",\n} as const;\n\nexport type UnitProductPostBodyBody = {\n /**\n * The name you want to give the Product\n * @maxLength 80\n */\n name: string;\n /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */\n type: UnitProductPostBodyBodyType;\n /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */\n flavour?: UnitProductPostBodyBodyFlavour;\n /**\n * The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products\n * @minimum 1\n */\n allowance?: number;\n /**\n * The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. You can provide this for Storage products but you must not provide a value for Project Tier Products\n * @minimum 1\n */\n limit?: number;\n};\n\nexport type ProductPatchBodyBody = {\n /**\n * The name you want to give the Product\n * @maxLength 80\n */\n name?: string;\n /**\n * The Product's built-in coin allowance. Product allowances cannot be reduced\n * @minimum 1\n */\n allowance?: number;\n /**\n * The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. The existing product limit cannot be reduced\n * @minimum 1\n */\n limit?: number;\n};\n\n/**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n */\nexport type QPbpParameter = number;\n\n/**\n * An Organisation Identity\n */\nexport type QOrgIdParameter = string;\n\n/**\n * A Merchant Identity\n */\nexport type QMIdParameter = number;\n\n/**\n * An object name\n */\nexport type QNameParameter = string;\n\n/**\n * A Unit Identity\n */\nexport type QUnitIdParameter = string;\n\n/**\n * A Product Identity\n */\nexport type QProductIdParameter = string;\n\n/**\n * A User Identity\n */\nexport type QUserIdParameter = string;\n\nexport type QFormatParameter = (typeof QFormatParameter)[keyof typeof QFormatParameter];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const QFormatParameter = {\n PROTOCOL_STRING: \"PROTOCOL_STRING\",\n JSON_STRING: \"JSON_STRING\",\n} as const;\n\n/**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\nexport type QFromParameter = string;\n\n/**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\nexport type QUntilParameter = string;\n\nexport type GetChargesParams = {\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n * @minimum -23\n * @maximum 0\n */\n pbp?: QPbpParameter;\n};\n\nexport type GetOrganisationChargesParams = {\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n * @minimum -23\n * @maximum 0\n */\n pbp?: QPbpParameter;\n};\n\nexport type GetProductChargesParams = {\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n * @minimum -23\n * @maximum 0\n */\n pbp?: QPbpParameter;\n};\n\nexport type GetUnitChargesParams = {\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n * @minimum -23\n * @maximum 0\n */\n pbp?: QPbpParameter;\n};\n\nexport type GetOrganisationsParams = {\n /**\n * An object name\n */\n name?: QNameParameter;\n};\n\nexport type GetUnitsParams = {\n /**\n * An object name\n */\n name?: QNameParameter;\n};\n\nexport type GetAssetParams = {\n /**\n * A User Identity\n * @minLength 3\n * @maxLength 80\n * @pattern ^\\w(?:\\w*(?:[@.-]\\w+)?)*$\n */\n user_id?: QUserIdParameter;\n /**\n * A Product Identity\n * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n product_id?: QProductIdParameter;\n /**\n * A Unit Identity\n * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n unit_id?: QUnitIdParameter;\n /**\n * An Organisation Identity\n * @pattern ^org-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n org_id?: QOrgIdParameter;\n};\n\nexport type AttachAssetParams = {\n /**\n * A Merchant Identity\n * @minimum 1\n */\n m_id?: QMIdParameter;\n};\n\nexport type DetachAssetParams = {\n /**\n * A Merchant Identity\n * @minimum 1\n */\n m_id?: QMIdParameter;\n};\n\nexport type GetActionsParams = {\n /**\n * The required format for delivered content.\n */\n format?: QFormatParameter;\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A Merchant Identity\n * @minimum 1\n */\n m_id?: QMIdParameter;\n /**\n * An Organisation Identity\n * @pattern ^org-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n org_id?: QOrgIdParameter;\n /**\n * A Product Identity\n * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n product_id?: QProductIdParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A Unit Identity\n * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n unit_id?: QUnitIdParameter;\n};\n"],"mappings":";;AA6EA,MAAa,wCAAwC;CACnD,gBAAgB;CAChB,qBAAqB;CACrB,WAAW;CACZ;AAsCD,MAAa,sDAAsD;CACjE,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAgFD,MAAa,uCAAuC;CAClD,wCAAwC;CACxC,mCAAmC;CACpC;AAoGD,MAAa,oBAAoB;CAAE,YAAY;CAAc,SAAS;CAAW;AA2BjF,MAAa,mBAAmB;CAC9B,MAAM;CACN,SAAS;CACT,MAAM;CACN,cAAc;CACd,QAAQ;CACT;AAqBD,MAAa,gCAAgC,EAAE,cAAc,gBAAgB;AAyI7E,MAAa,oBAAoB;CAC/B,wCAAwC;CACxC,mCAAmC;CACpC;AASD,MAAa,uBAAuB;CAClC,YAAY;CACZ,QAAQ;CACR,QAAQ;CACR,MAAM;CACP;AAmCD,MAAa,yBAAyB,EAAE,cAAc,gBAAgB;AAkBtE,MAAa,6CAA6C;CACxD,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AA2BD,MAAa,0CAA0C;CACrD,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAiCD,MAAa,qBAAqB,EAAE,cAAc,gBAAgB;AAoBlE,MAAa,sBAAsB,EAAE,cAAc,gBAAgB;AAkBnE,MAAa,qCAAqC;CAChD,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AA6BD,MAAa,kCAAkC;CAC7C,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAiDD,MAAa,yBAAyB;CACpC,MAAM;CACN,SAAS;CACT,MAAM;CACN,cAAc;CACd,QAAQ;CACT;AA2BD,MAAa,gCAAgC;CAC3C,iBAAiB;CACjB,aAAa;CACd;AAWD,MAAa,gDAAgD;CAC3D,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AA8BD,MAAa,oDAAoD;CAC/D,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AA2BD,MAAa,iDAAiD;CAC5D,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAoBD,MAAa,yCAAyC;CACpD,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAoBD,MAAa,8BAA8B;CACzC,wCAAwC;CACxC,mCAAmC;CACpC;AASD,MAAa,iCAAiC;CAC5C,YAAY;CACZ,QAAQ;CACR,QAAQ;CACR,MAAM;CACP;AAkFD,MAAa,mBAAmB;CAC9B,iBAAiB;CACjB,aAAa;CACd"}
|
|
1
|
+
{"version":3,"file":"api.schemas.cjs","names":[],"sources":["../../src/api/api.schemas.ts"],"sourcesContent":["/**\n * Generated by orval v7.17.0 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.\n\n * OpenAPI spec version: 4.4\n */\nexport interface AsError {\n /** Brief error text that can be presented to the user */\n error: string;\n}\n\nexport interface ActionGetResponse {\n /** A list of Actions\n */\n actions: ActionDetail[];\n /** The number of Actions returned\n */\n count: number;\n}\n\nexport interface ActionDetail {\n id: number;\n action: string;\n content: string;\n timestamp: string;\n merchant?: MerchantSummary;\n product_id?: string;\n unit_id?: string;\n org_id?: string;\n}\n\nexport type AssetGetByIdResponse = AssetDetail;\n\nexport interface AssetGetResponse {\n /** A list of Assets\n */\n assets: AssetDetail[];\n /** The number of Assets returned\n */\n count: number;\n}\n\nexport interface AssetPostResponse {\n /** The Asset ID\n */\n id: string;\n}\n\nexport interface ChargesGetResponse {\n coins: string;\n count: number;\n summary: ChargeSummary[];\n organisation_charges: OrganisationChargeSummary[];\n}\n\nexport interface EventStreamGetPostResponse {\n /** The EventStream ID */\n id: number;\n /** A symbolic name, used internally to identify the stream */\n name: string;\n /** The Event Stream location. This will be a URL where events can be fetched. The protocol is typically a WebSocket, but the protocol is defined by the specific Event Stream Service that has been deployed. */\n location: string;\n /** The Event Stream format. */\n format: string;\n}\n\n/**\n * The Event Stream protocol, used to inform the client how to connect to given locations and handle events. At the moment the AS only supports web-sockets.\n */\nexport type EventStreamVersionGetResponseProtocol =\n (typeof EventStreamVersionGetResponseProtocol)[keyof typeof EventStreamVersionGetResponseProtocol];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const EventStreamVersionGetResponseProtocol = {\n ERROR_INTERNAL: \"ERROR_INTERNAL\",\n SERVICE_NOT_PRESENT: \"SERVICE_NOT_PRESENT\",\n WEBSOCKET: \"WEBSOCKET\",\n} as const;\n\nexport interface EventStreamVersionGetResponse {\n /** The EventStream implementation version */\n version: string;\n /** The Event Stream protocol, used to inform the client how to connect to given locations and handle events. At the moment the AS only supports web-sockets. */\n protocol: EventStreamVersionGetResponseProtocol;\n /** The name of the Event Stream implementation, often used to identify the service origin and implementation. */\n name: string;\n}\n\nexport interface StateGetVersionResponse {\n /** The Account Server version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined\n */\n version: string;\n}\n\nexport interface OrganisationPostResponse {\n /** The Organisation's unique ID */\n id: string;\n}\n\nexport interface UsersGetResponse {\n count: number;\n organisation?: OrganisationDetail;\n unit?: UnitDetail;\n /** The list of Organisation Users\n */\n users: UserDetail[];\n}\n\n/**\n * The Organisation's default product privacy setting\n */\nexport type OrganisationGetDefaultResponseDefaultProductPrivacy =\n (typeof OrganisationGetDefaultResponseDefaultProductPrivacy)[keyof typeof OrganisationGetDefaultResponseDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationGetDefaultResponseDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface OrganisationGetDefaultResponse {\n /** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */\n caller_is_member?: boolean;\n /** The Default Organisation ID\n */\n id?: string;\n /** The Default Organisation Name\n */\n name?: string;\n /** True if the Organisation is private. The Default organisation is always public, although it does not contain a membership (unless you're admin) and only houses Personal Units\n */\n private?: boolean;\n created?: string;\n /** The Organisation's default product privacy setting */\n default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;\n}\n\nexport interface OrganisationUnitPostResponse {\n /** The unit's unique ID */\n id: string;\n}\n\nexport interface PersonalUnitPutResponse {\n /** The unit's Organisation. Used to identify the Default organisation */\n organisation_id: string;\n /** The unit's unique ID */\n id: string;\n}\n\nexport interface OrganisationChargeSummary {\n organisation_id: string;\n name: string;\n summary: ChargeSummary[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n count?: number;\n organisation: OrganisationAllDetail;\n /** A list of Units\n */\n units: UnitAllDetail[];\n}\n\nexport interface OrganisationChargesGetResponse {\n organisation_id: string;\n name: string;\n coins: string;\n summary: ChargeSummary[];\n unit_charges: OrganisationUnitChargeSummary[];\n}\n\nexport interface OrganisationUnitChargeSummary {\n unit_id: string;\n name: string;\n /**\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n /** The start of the charge period */\n from: string;\n /** The date where of first day after the charge period */\n until: string;\n summary: ChargeSummary[];\n}\n\nexport interface OrganisationsGetResponse {\n count: number;\n /** A list of Organisations */\n organisations: OrganisationAllDetail[];\n}\n\nexport type OrganisationGetResponse = OrganisationAllDetail;\n\nexport type ProductChargesGetResponseProductType =\n (typeof ProductChargesGetResponseProductType)[keyof typeof ProductChargesGetResponseProductType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductChargesGetResponseProductType = {\n DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\nexport interface ProductChargesGetResponse {\n product_id: string;\n product_type: ProductChargesGetResponseProductType;\n /**\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n /** True if the product can be (needs to be) claimed. */\n claimable: boolean;\n claim?: ProductClaimDetail;\n count: number;\n /** The start of the charge period */\n from: string;\n /** The date where of first day after the charge period */\n until: string;\n /** The total number of coins consumed by this product for the invoice period */\n coins: string;\n processing_charges: ProcessingCharges[];\n storage_charges: StorageCharges;\n}\n\nexport type ProductsGetResponseProductsItem = ProductDmStorage | ProductDmProjectTier;\n\nexport interface ProductsGetResponse {\n count: number;\n /** All the Products you have access to */\n products: ProductsGetResponseProductsItem[];\n}\n\nexport type ProductsGetDefaultStorageCostDefaultStorageCost = {\n cost: string;\n units: string;\n description: string;\n};\n\nexport interface ProductsGetDefaultStorageCost {\n default_storage_cost: ProductsGetDefaultStorageCostDefaultStorageCost;\n}\n\nexport interface ProductsGetTypesResponse {\n /** The number of Product Types */\n count: number;\n /** All the Product Types you have access to */\n product_types: ProductType[];\n}\n\n/**\n * The Unit's Product\n */\nexport type ProductUnitGetResponseProduct = ProductDmStorage | ProductDmProjectTier;\n\nexport interface ProductUnitGetResponse {\n /** The Unit's Product */\n product: ProductUnitGetResponseProduct;\n}\n\nexport interface UnitChargesGetResponse {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n unit_id: string;\n name?: string;\n /** The Unit's owner (a username) */\n owner_id: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n coins: string;\n count: number;\n /**\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n /** The start of the charge period */\n from: string;\n /** The date where of first day after the charge period */\n until: string;\n summary: UnitChargeSummary;\n products: UnitProductChargeSummary[];\n}\n\nexport interface UnitChargeSummary {\n charges: ChargeSummary[];\n}\n\nexport interface UnitProductChargeSummary {\n product_id: string;\n product_type: string;\n charges: ChargeSummary[];\n}\n\n/**\n * The type of charge\n */\nexport type ChargeSummaryType = (typeof ChargeSummaryType)[keyof typeof ChargeSummaryType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ChargeSummaryType = { PROCESSING: \"PROCESSING\", STORAGE: \"STORAGE\" } as const;\n\nexport interface ChargeSummary {\n /** The type of charge */\n type: ChargeSummaryType;\n /** The cost, in coins of the charge */\n coins: string;\n}\n\nexport interface UnitProductPostResponse {\n /** The Product's unique ID */\n id: string;\n}\n\nexport type UnitGetResponse = UnitAllDetail;\n\nexport interface UnitsGetResponse {\n /** A list of Units\n */\n units: OrganisationUnitsGetResponse[];\n}\n\nexport type UserAccountGetResponse = UserAccountDetail;\n\nexport type AssetDetailScope = (typeof AssetDetailScope)[keyof typeof AssetDetailScope];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const AssetDetailScope = {\n USER: \"USER\",\n PRODUCT: \"PRODUCT\",\n UNIT: \"UNIT\",\n ORGANISATION: \"ORGANISATION\",\n GLOBAL: \"GLOBAL\",\n} as const;\n\nexport interface AssetDetail {\n creator: string;\n id: string;\n name: string;\n scope: AssetDetailScope;\n scope_id: string;\n secret: boolean;\n disabled: boolean;\n content: string;\n created: string;\n content_modified?: string;\n description?: string;\n merchants: MerchantDetail[];\n}\n\nexport type ProcessingChargesMerchantKind =\n (typeof ProcessingChargesMerchantKind)[keyof typeof ProcessingChargesMerchantKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProcessingChargesMerchantKind = { DATA_MANAGER: \"DATA_MANAGER\" } as const;\n\nexport interface ProcessingCharges {\n merchant_name: string;\n merchant_kind: ProcessingChargesMerchantKind;\n merchant_api_hostname: string;\n /** The date when the process stopped */\n closed?: string;\n /** True if no further change to the charges can occur. Typically True after the charge has been closed for a pre-configured period of time. */\n final: boolean;\n /** True if charges were received after the charge record was finalised */\n post_final_charges?: boolean;\n charge: ProcessingChargeItem;\n}\n\nexport interface ProcessingChargeItem {\n /** The charge record number */\n id: number;\n /** The most recent sequence number for this charge */\n sqn: number;\n name?: string;\n username: string;\n /** The date and time of the processing charge */\n timestamp: string;\n /** The coin-cost of the storage */\n coins: string;\n additional_data?: ChargeAdditionalData;\n}\n\nexport interface StorageCharges {\n num_items: number;\n items: StorageChargeItem[];\n}\n\nexport interface StorageChargeItem {\n item_number: number;\n /** The date and time of the processing charge */\n date: string;\n /** The coin-cost of the storage */\n coins: string;\n /** The current burn rate, the approximate amount of coins you are currently consuming each day */\n current_burn_rate?: string;\n /** The date when the charges concluded */\n closed?: string;\n additional_data?: ChargeAdditionalData;\n}\n\nexport interface ChargeAdditionalData {\n [key: string]: unknown;\n}\n\nexport interface ProductDmStorage {\n product: ProductDetail;\n organisation: OrganisationAllDetail;\n unit: UnitAllDetail;\n storage: ProductDmStorageDetail;\n coins: ProductCoinsDetail;\n /** True if the product can be (needs to be) claimed. */\n claimable: boolean;\n}\n\nexport interface ProductDmProjectTier {\n product: ProductDetail;\n organisation: OrganisationAllDetail;\n unit: UnitAllDetail;\n storage: ProductDmStorageDetail;\n coins: ProductCoinsDetail;\n instance: ProductInstanceDetail;\n /** True if the product can be (needs to be) claimed. */\n claimable: boolean;\n claim?: ProductClaimDetail;\n}\n\nexport type ProductDmStorageDetailSize = {\n /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */\n peak: string;\n /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */\n current: string;\n /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */\n unit_size: string;\n /** The peak number of storage units used today */\n units_used: number;\n};\n\nexport type ProductDmStorageDetailCoins = {\n /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */\n used: number;\n /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */\n unit_cost: number;\n};\n\nexport interface ProductDmStorageDetail {\n size: ProductDmStorageDetailSize;\n coins: ProductDmStorageDetailCoins;\n}\n\nexport interface ProductClaimDetail {\n /** The service-specific ID that is using this Subscription\n */\n id: string;\n /** A name for the service-specific ID\n */\n name?: string;\n}\n\nexport interface ProductCoinsDetail {\n /** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */\n allowance: number;\n /** The limit on your billing period spend. You can exceed the allowance but you cannot exceed the spend limit. Once reached the dependent may be restricted */\n limit: number;\n /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */\n used: number;\n /** True if the product is operating at or beyond its coin limit. When it is authority to perform actions using the product are severely limited. */\n at_limit: boolean;\n /** The current burn rate, the approximate amount of coins you are currently consuming each day */\n current_burn_rate: number;\n /** The predicted total billing period amount, if costs continue at the current burn rate until the end of the billing period. This is an estimate */\n billing_prediction: number;\n /** The predicted storage contribution to the billing period amount, if costs continue at the current burn rate until the end of the billing period. This is an estimate */\n billing_prediction_storage_contribution: number;\n /** The day of the month when the bill is due, and the end of the current billing period */\n billing_day: number;\n /** A multiplier applied to your coin usage within your allowance */\n allowance_multiplier: number;\n /** A multiplier that will be applied to coin used beyond your allowance */\n overspend_multiplier: number;\n /** The number of days remaining, in the current billing period */\n remaining_days: number;\n}\n\n/**\n * The Product Type\n\n */\nexport type ProductDetailType = (typeof ProductDetailType)[keyof typeof ProductDetailType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailType = {\n DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\n/**\n * The Product Type flavour. Not all products have flavours\n\n */\nexport type ProductDetailFlavour = (typeof ProductDetailFlavour)[keyof typeof ProductDetailFlavour];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailFlavour = {\n EVALUATION: \"EVALUATION\",\n BRONZE: \"BRONZE\",\n SILVER: \"SILVER\",\n GOLD: \"GOLD\",\n} as const;\n\nexport interface ProductDetail {\n /** The Product ID\n */\n id: string;\n created: string;\n /** The Product Type\n */\n type: ProductDetailType;\n /** The Product Type flavour. Not all products have flavours\n */\n flavour?: ProductDetailFlavour;\n /** The name of the Product\n */\n name?: string;\n}\n\nexport type ProductInstanceDetailCoins = {\n /** The number of coins used\n */\n used: number;\n};\n\nexport interface ProductInstanceDetail {\n coins: ProductInstanceDetailCoins;\n}\n\n/**\n * The kind of service that can use the Product\n */\nexport type ProductTypeServiceKind =\n (typeof ProductTypeServiceKind)[keyof typeof ProductTypeServiceKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductTypeServiceKind = { DATA_MANAGER: \"DATA_MANAGER\" } as const;\n\nexport interface ProductType {\n /** A product type, this is a unique string amongst all types known to the Account Server */\n type: string;\n /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */\n flavour?: string;\n /** The kind of service that can use the Product */\n service_kind?: ProductTypeServiceKind;\n}\n\n/**\n * The Organisation's default product privacy setting\n */\nexport type OrganisationAllDetailDefaultProductPrivacy =\n (typeof OrganisationAllDetailDefaultProductPrivacy)[keyof typeof OrganisationAllDetailDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationAllDetailDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface OrganisationAllDetail {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n /** The Organisation's unique ID */\n id: string;\n /** The Organisation's name */\n name: string;\n /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */\n owner_id?: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n /** The Organisation's default product privacy setting */\n default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;\n /** A list of users that are members of the Organisation */\n users: UserDetail[];\n}\n\n/**\n * The Organisation's default product privacy setting\n */\nexport type OrganisationDetailDefaultProductPrivacy =\n (typeof OrganisationDetailDefaultProductPrivacy)[keyof typeof OrganisationDetailDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationDetailDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface OrganisationDetail {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n /** The Organisation's unique ID */\n id: string;\n /** The Organisation's name */\n name: string;\n /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */\n owner_id?: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n /** The Organisation's default product privacy setting */\n default_product_privacy: OrganisationDetailDefaultProductPrivacy;\n}\n\nexport interface MerchantsGetResponse {\n count?: number;\n /** The list of known Merchants\n */\n merchants: MerchantDetail[];\n}\n\nexport type MerchantGetResponse = MerchantDetail;\n\n/**\n * The kind of Service\n */\nexport type MerchantDetailKind = (typeof MerchantDetailKind)[keyof typeof MerchantDetailKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const MerchantDetailKind = { DATA_MANAGER: \"DATA_MANAGER\" } as const;\n\nexport interface MerchantDetail {\n /** The unique ID of the Service */\n id: number;\n created: string;\n /** The kind of Service */\n kind: MerchantDetailKind;\n /** The name assigned to the Service */\n name: string;\n /** The hostname used by the Service */\n api_hostname: string;\n}\n\n/**\n * The kind of Service\n */\nexport type MerchantSummaryKind = (typeof MerchantSummaryKind)[keyof typeof MerchantSummaryKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const MerchantSummaryKind = { DATA_MANAGER: \"DATA_MANAGER\" } as const;\n\nexport interface MerchantSummary {\n /** The unique ID of the Merchant */\n id: number;\n /** The kind of Service */\n kind: MerchantSummaryKind;\n /** The name assigned to the Service */\n name: string;\n}\n\n/**\n * The Unit's default product privacy setting\n */\nexport type UnitAllDetailDefaultProductPrivacy =\n (typeof UnitAllDetailDefaultProductPrivacy)[keyof typeof UnitAllDetailDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitAllDetailDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface UnitAllDetail {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n /** The Unit's unique identity */\n id: string;\n /** The Unit's name */\n name: string;\n /** The Unit's owner (a username) */\n owner_id: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n /** The Unit's billing day */\n billing_day: number;\n /** The Unit's default product privacy setting */\n default_product_privacy: UnitAllDetailDefaultProductPrivacy;\n /** A list of users that are members of the Unit */\n users: UserDetail[];\n}\n\n/**\n * The Unit's default product privacy setting\n */\nexport type UnitDetailDefaultProductPrivacy =\n (typeof UnitDetailDefaultProductPrivacy)[keyof typeof UnitDetailDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitDetailDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport interface UnitDetail {\n /** Whether the user making the API call is a member of the Unit */\n caller_is_member: boolean;\n /** The Unit's unique identity */\n id: string;\n /** The Unit's name */\n name: string;\n /** The Unit's owner (a username) */\n owner_id: string;\n /** True if the Unit is private */\n private: boolean;\n created: string;\n /** The Unit's billing day */\n billing_day: number;\n /** The Unit's default product privacy setting */\n default_product_privacy: UnitDetailDefaultProductPrivacy;\n}\n\nexport interface UserAccountDetail {\n user: UserDetail;\n /** Whether the caller has admin privilege */\n caller_has_admin_privilege: boolean;\n /** The roles assigned to the user recognised by the Account Server */\n account_server_roles: string[];\n}\n\nexport interface UserDetail {\n /** The user identity (username) */\n id: string;\n}\n\nexport type AssetPatchBodyBody = {\n /** A file containing the content for the asset. You must provide a value here or in content_string */\n content_file?: Blob;\n /** The textual content of the asset. You must provide a value here or in content_file */\n content_string?: string;\n /** An optional description for the Asset */\n description?: string;\n};\n\n/**\n * An enumeration of the scope of the asset. This can be one of `USER`, `PRODUCT`, `UNIT`, `ORGANISATION`, or `GLOBAL`. Assets that are not `GLOBAL` need a scope ID.\n */\nexport type AssetPostBodyBodyScope =\n (typeof AssetPostBodyBodyScope)[keyof typeof AssetPostBodyBodyScope];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const AssetPostBodyBodyScope = {\n USER: \"USER\",\n PRODUCT: \"PRODUCT\",\n UNIT: \"UNIT\",\n ORGANISATION: \"ORGANISATION\",\n GLOBAL: \"GLOBAL\",\n} as const;\n\nexport type AssetPostBodyBody = {\n /**\n * The name of the asset. This must be unique within its scope. For example, only one asset can be called \"asset-1\" within a given `UNIT`. Asset names must be valid RFC 1123 Label Names\n * @maxLength 80\n * @pattern ^[a-z0-9-]{1,63}$\n */\n name: string;\n /** A file containing the content for the asset. You must provide a value here or in **content_string** but not both */\n content_file?: Blob;\n /** The textual content of the asset. You must provide a value here or in **content_file** but not both */\n content_string?: string;\n /** An enumeration of the scope of the asset. This can be one of `USER`, `PRODUCT`, `UNIT`, `ORGANISATION`, or `GLOBAL`. Assets that are not `GLOBAL` need a scope ID. */\n scope: AssetPostBodyBodyScope;\n /** The unique identity based on the Scope of the asset. For example, this will be the Unit ID if it's a UNIT. A scope_id is required if the scope is USER as it will be automatically set to your username. Global assets do not have a scope. */\n scope_id?: string;\n /** Is this a secret asset? Secret assets are not revealed in a subsequent **GET** but are revealed to merchants they are connected to. */\n secret: boolean;\n /** An optional description for the Asset */\n description?: string;\n};\n\nexport type EventStreamPostBodyBodyFormat =\n (typeof EventStreamPostBodyBodyFormat)[keyof typeof EventStreamPostBodyBodyFormat];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const EventStreamPostBodyBodyFormat = {\n PROTOCOL_STRING: \"PROTOCOL_STRING\",\n JSON_STRING: \"JSON_STRING\",\n} as const;\n\nexport type EventStreamPostBodyBody = { format?: EventStreamPostBodyBodyFormat };\n\n/**\n * The default product privacy setting for the Organisation\n */\nexport type OrganisationPostBodyBodyDefaultProductPrivacy =\n (typeof OrganisationPostBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationPostBodyBodyDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationPostBodyBodyDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport type OrganisationPostBodyBody = {\n /**\n * The name of the organisation\n * @maxLength 80\n */\n name: string;\n /** The name of the organisation owner. A user ID */\n owner: string;\n /** The default product privacy setting for the Organisation */\n default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;\n};\n\nexport type PersonalUnitPutBodyBody = {\n /**\n * The day you would like to be billed for the Unit's Products (a value from 1 and 28)\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n};\n\n/**\n * The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value\n */\nexport type OrganisationUnitPostBodyBodyDefaultProductPrivacy =\n (typeof OrganisationUnitPostBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationUnitPostBodyBodyDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationUnitPostBodyBodyDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport type OrganisationUnitPostBodyBody = {\n /**\n * The name of the unit\n * @maxLength 80\n */\n name: string;\n /**\n * The day you would like to be billed for the Unit's Products (a value from 1 and 28)\n * @minimum 1\n * @maximum 28\n */\n billing_day: number;\n /** The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value */\n default_product_privacy?: OrganisationUnitPostBodyBodyDefaultProductPrivacy;\n};\n\n/**\n * The new default **Product** privacy applied to all products that belong to this Organisation. Privacy is also controlled at the **Unit** level. As an example the Organisation level privacy can be `DEFAULT_PRIVATE`, but the unit can declare its Products to be `ALWAYS_PRIVATE`.\n\nWhether the privacy can be honoured will depend on the value in any of the organisation's existing units\n */\nexport type OrganisationPatchBodyBodyDefaultProductPrivacy =\n (typeof OrganisationPatchBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationPatchBodyBodyDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const OrganisationPatchBodyBodyDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport type OrganisationPatchBodyBody = {\n /** The new name for the Organisational */\n name?: string;\n /** The new default **Product** privacy applied to all products that belong to this Organisation. Privacy is also controlled at the **Unit** level. As an example the Organisation level privacy can be `DEFAULT_PRIVATE`, but the unit can declare its Products to be `ALWAYS_PRIVATE`.\n\nWhether the privacy can be honoured will depend on the value in any of the organisation's existing units */\n default_product_privacy?: OrganisationPatchBodyBodyDefaultProductPrivacy;\n};\n\n/**\n * The new default **Product** privacy applied to all products that belong to this Unit. Privacy is also controlled at the **Organisation** level. As an example, the Unit can declare its Products to be `DEFAULT_PRIVATE`, but the Organisation can declare its value to be `DEFAULT_PUBLIC`.\n\nWhether the privacy can be honoured will depend on the organisation's value\n */\nexport type UnitPatchBodyBodyDefaultProductPrivacy =\n (typeof UnitPatchBodyBodyDefaultProductPrivacy)[keyof typeof UnitPatchBodyBodyDefaultProductPrivacy];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitPatchBodyBodyDefaultProductPrivacy = {\n ALWAYS_PUBLIC: \"ALWAYS_PUBLIC\",\n ALWAYS_PRIVATE: \"ALWAYS_PRIVATE\",\n DEFAULT_PUBLIC: \"DEFAULT_PUBLIC\",\n DEFAULT_PRIVATE: \"DEFAULT_PRIVATE\",\n} as const;\n\nexport type UnitPatchBodyBody = {\n /** The new name for the Unit */\n name?: string;\n /** The new default **Product** privacy applied to all products that belong to this Unit. Privacy is also controlled at the **Organisation** level. As an example, the Unit can declare its Products to be `DEFAULT_PRIVATE`, but the Organisation can declare its value to be `DEFAULT_PUBLIC`.\n\nWhether the privacy can be honoured will depend on the organisation's value */\n default_product_privacy?: UnitPatchBodyBodyDefaultProductPrivacy;\n};\n\n/**\n * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products\n */\nexport type UnitProductPostBodyBodyType =\n (typeof UnitProductPostBodyBodyType)[keyof typeof UnitProductPostBodyBodyType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyType = {\n DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products\n */\nexport type UnitProductPostBodyBodyFlavour =\n (typeof UnitProductPostBodyBodyFlavour)[keyof typeof UnitProductPostBodyBodyFlavour];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyFlavour = {\n EVALUATION: \"EVALUATION\",\n BRONZE: \"BRONZE\",\n SILVER: \"SILVER\",\n GOLD: \"GOLD\",\n} as const;\n\nexport type UnitProductPostBodyBody = {\n /**\n * The name you want to give the Product\n * @maxLength 80\n */\n name: string;\n /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */\n type: UnitProductPostBodyBodyType;\n /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */\n flavour?: UnitProductPostBodyBodyFlavour;\n /**\n * The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products\n * @minimum 1\n */\n allowance?: number;\n /**\n * The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. You can provide this for Storage products but you must not provide a value for Project Tier Products\n * @minimum 1\n */\n limit?: number;\n};\n\nexport type ProductPatchBodyBody = {\n /**\n * The name you want to give the Product\n * @maxLength 80\n */\n name?: string;\n /**\n * The Product's built-in coin allowance. Product allowances cannot be reduced\n * @minimum 1\n */\n allowance?: number;\n /**\n * The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. The existing product limit cannot be reduced\n * @minimum 1\n */\n limit?: number;\n};\n\n/**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n */\nexport type QPbpParameter = number;\n\n/**\n * An Organisation Identity\n */\nexport type QOrgIdParameter = string;\n\n/**\n * A Merchant Identity\n */\nexport type QMIdParameter = number;\n\n/**\n * An object name\n */\nexport type QNameParameter = string;\n\n/**\n * A Unit Identity\n */\nexport type QUnitIdParameter = string;\n\n/**\n * A Product Identity\n */\nexport type QProductIdParameter = string;\n\n/**\n * A User Identity\n */\nexport type QUserIdParameter = string;\n\nexport type QFormatParameter = (typeof QFormatParameter)[keyof typeof QFormatParameter];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const QFormatParameter = {\n PROTOCOL_STRING: \"PROTOCOL_STRING\",\n JSON_STRING: \"JSON_STRING\",\n} as const;\n\n/**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\nexport type QFromParameter = string;\n\n/**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\nexport type QUntilParameter = string;\n\nexport type GetChargesParams = {\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n * @minimum -23\n * @maximum 0\n */\n pbp?: QPbpParameter;\n};\n\nexport type GetOrganisationChargesParams = {\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n * @minimum -23\n * @maximum 0\n */\n pbp?: QPbpParameter;\n};\n\nexport type GetProductChargesParams = {\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n * @minimum -23\n * @maximum 0\n */\n pbp?: QPbpParameter;\n};\n\nexport type GetUnitChargesParams = {\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A charge Prior Billing Period, 0 implies \"current\" and -23 is for the period 23 months ago.\n * @minimum -23\n * @maximum 0\n */\n pbp?: QPbpParameter;\n};\n\nexport type GetOrganisationsParams = {\n /**\n * An object name\n */\n name?: QNameParameter;\n};\n\nexport type GetUnitsParams = {\n /**\n * An object name\n */\n name?: QNameParameter;\n};\n\nexport type GetAssetParams = {\n /**\n * A User Identity\n * @minLength 3\n * @maxLength 80\n * @pattern ^\\w(?:\\w*(?:[@.-]\\w+)?)*$\n */\n user_id?: QUserIdParameter;\n /**\n * A Product Identity\n * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n product_id?: QProductIdParameter;\n /**\n * A Unit Identity\n * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n unit_id?: QUnitIdParameter;\n /**\n * An Organisation Identity\n * @pattern ^org-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n org_id?: QOrgIdParameter;\n};\n\nexport type AttachAssetParams = {\n /**\n * A Merchant Identity\n * @minimum 1\n */\n m_id?: QMIdParameter;\n};\n\nexport type DetachAssetParams = {\n /**\n * A Merchant Identity\n * @minimum 1\n */\n m_id?: QMIdParameter;\n};\n\nexport type GetActionsParams = {\n /**\n * The required format for delivered content.\n */\n format?: QFormatParameter;\n /**\n * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided\n */\n from?: QFromParameter;\n /**\n * A Merchant Identity\n * @minimum 1\n */\n m_id?: QMIdParameter;\n /**\n * An Organisation Identity\n * @pattern ^org-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n org_id?: QOrgIdParameter;\n /**\n * A Product Identity\n * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n product_id?: QProductIdParameter;\n /**\n * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided\n */\n until?: QUntilParameter;\n /**\n * A Unit Identity\n * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n */\n unit_id?: QUnitIdParameter;\n};\n"],"mappings":";;AA6EA,MAAa,wCAAwC;CACnD,gBAAgB;CAChB,qBAAqB;CACrB,WAAW;CACZ;AAsCD,MAAa,sDAAsD;CACjE,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAgFD,MAAa,uCAAuC;CAClD,wCAAwC;CACxC,mCAAmC;CACpC;AAoGD,MAAa,oBAAoB;CAAE,YAAY;CAAc,SAAS;CAAW;AA2BjF,MAAa,mBAAmB;CAC9B,MAAM;CACN,SAAS;CACT,MAAM;CACN,cAAc;CACd,QAAQ;CACT;AAqBD,MAAa,gCAAgC,EAAE,cAAc,gBAAgB;AAyI7E,MAAa,oBAAoB;CAC/B,wCAAwC;CACxC,mCAAmC;CACpC;AASD,MAAa,uBAAuB;CAClC,YAAY;CACZ,QAAQ;CACR,QAAQ;CACR,MAAM;CACP;AAmCD,MAAa,yBAAyB,EAAE,cAAc,gBAAgB;AAkBtE,MAAa,6CAA6C;CACxD,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AA2BD,MAAa,0CAA0C;CACrD,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAiCD,MAAa,qBAAqB,EAAE,cAAc,gBAAgB;AAoBlE,MAAa,sBAAsB,EAAE,cAAc,gBAAgB;AAkBnE,MAAa,qCAAqC;CAChD,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AA6BD,MAAa,kCAAkC;CAC7C,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAiDD,MAAa,yBAAyB;CACpC,MAAM;CACN,SAAS;CACT,MAAM;CACN,cAAc;CACd,QAAQ;CACT;AA2BD,MAAa,gCAAgC;CAC3C,iBAAiB;CACjB,aAAa;CACd;AAWD,MAAa,gDAAgD;CAC3D,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AA8BD,MAAa,oDAAoD;CAC/D,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AA2BD,MAAa,iDAAiD;CAC5D,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAoBD,MAAa,yCAAyC;CACpD,eAAe;CACf,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CAClB;AAoBD,MAAa,8BAA8B;CACzC,wCAAwC;CACxC,mCAAmC;CACpC;AASD,MAAa,iCAAiC;CAC5C,YAAY;CACZ,QAAQ;CACR,QAAQ;CACR,MAAM;CACP;AAkFD,MAAa,mBAAmB;CAC9B,iBAAiB;CACjB,aAAa;CACd"}
|