@squonk/account-server-client 4.1.0 → 4.1.1-rc.1

package/asset/asset.d.cts

@@ -1,4 +1,4 @@
-import { UseQueryOptions, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
+import { UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
 import { GetAssetParams, customInstance, AssetGetResponse, ErrorType, AsError, AssetPostBodyBody, AssetPostResponse, AssetDetail, AssetPatchBodyBody, AttachAssetParams, DetachAssetParams } from '../index.cjs';
 import 'axios';
 
@@ -14,7 +14,7 @@ declare const getGetAssetQueryOptions: <TData = AssetGetResponse, TError = Error
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }) => UseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 type GetAssetQueryResult = NonNullable<Awaited<ReturnType<typeof getAsset>>>;
 type GetAssetQueryError = ErrorType<AsError | void>;
@@ -22,25 +22,25 @@ declare function useGetAsset<TData = Awaited<ReturnType<typeof getAsset>>, TErro
     query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>, 'initialData'>;
     request?: SecondParameter<typeof customInstance>;
 }): DefinedUseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetAsset<TData = Awaited<ReturnType<typeof getAsset>>, TError = ErrorType<AsError | void>>(params?: GetAssetParams, options?: {
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>, 'initialData'>;
     request?: SecondParameter<typeof customInstance>;
 }): UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetAsset<TData = Awaited<ReturnType<typeof getAsset>>, TError = ErrorType<AsError | void>>(params?: GetAssetParams, options?: {
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }): UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare const getGetAssetSuspenseQueryOptions: <TData = AssetGetResponse, TError = ErrorType<void | AsError>>(params?: GetAssetParams, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 type GetAssetSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getAsset>>>;
 type GetAssetSuspenseQueryError = ErrorType<AsError | void>;
@@ -48,19 +48,19 @@ declare function useGetAssetSuspense<TData = Awaited<ReturnType<typeof getAsset>
     query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }): UseSuspenseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetAssetSuspense<TData = Awaited<ReturnType<typeof getAsset>>, TError = ErrorType<AsError | void>>(params?: GetAssetParams, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }): UseSuspenseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetAssetSuspense<TData = Awaited<ReturnType<typeof getAsset>>, TError = ErrorType<AsError | void>>(params?: GetAssetParams, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }): UseSuspenseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 /**
  * Creates an Asset, which can be attached to a **User** account, a **Product**, **Unit**, **Organisation** or can be made **Global**
@@ -73,13 +73,13 @@ They must also be *attached* to a **Merchant** before the **Merchant** can ue th
 
  * @summary Create an Asset
  */
-declare const createAsset: (assetPostBodyBody: AssetPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<AssetPostResponse>;
-declare const getCreateAssetMutationOptions: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createAsset>>, TError, {
+declare const createAsset: (assetPostBodyBody: AssetPostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<AssetPostResponse>;
+declare const getCreateAssetMutationOptions: <TData = AssetPostResponse, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         data: AssetPostBodyBody;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<Awaited<ReturnType<typeof createAsset>>, TError, {
+}) => UseMutationOptions<TData, TError, {
     data: AssetPostBodyBody;
 }, TContext>;
 type CreateAssetMutationResult = NonNullable<Awaited<ReturnType<typeof createAsset>>>;
@@ -88,12 +88,12 @@ type CreateAssetMutationError = ErrorType<AsError | void>;
 /**
 * @summary Create an Asset
 */
-declare const useCreateAsset: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createAsset>>, TError, {
+declare const useCreateAsset: <TData = AssetPostResponse, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         data: AssetPostBodyBody;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<Awaited<ReturnType<typeof createAsset>>, TError, {
+}) => UseMutationResult<TData, TError, {
     data: AssetPostBodyBody;
 }, TContext>;
 /**
@@ -107,7 +107,7 @@ declare const getGetSpecificAssetQueryOptions: <TData = AssetDetail, TError = Er
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }) => UseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 type GetSpecificAssetQueryResult = NonNullable<Awaited<ReturnType<typeof getSpecificAsset>>>;
 type GetSpecificAssetQueryError = ErrorType<AsError | void>;
@@ -115,25 +115,25 @@ declare function useGetSpecificAsset<TData = Awaited<ReturnType<typeof getSpecif
     query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>, 'initialData'>;
     request?: SecondParameter<typeof customInstance>;
 }): DefinedUseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetSpecificAsset<TData = Awaited<ReturnType<typeof getSpecificAsset>>, TError = ErrorType<AsError | void>>(assetId: string, options?: {
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>, 'initialData'>;
     request?: SecondParameter<typeof customInstance>;
 }): UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetSpecificAsset<TData = Awaited<ReturnType<typeof getSpecificAsset>>, TError = ErrorType<AsError | void>>(assetId: string, options?: {
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }): UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare const getGetSpecificAssetSuspenseQueryOptions: <TData = AssetDetail, TError = ErrorType<void | AsError>>(assetId: string, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 type GetSpecificAssetSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getSpecificAsset>>>;
 type GetSpecificAssetSuspenseQueryError = ErrorType<AsError | void>;
@@ -141,19 +141,19 @@ declare function useGetSpecificAssetSuspense<TData = Awaited<ReturnType<typeof g
     query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }): UseSuspenseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetSpecificAssetSuspense<TData = Awaited<ReturnType<typeof getSpecificAsset>>, TError = ErrorType<AsError | void>>(assetId: string, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }): UseSuspenseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetSpecificAssetSuspense<TData = Awaited<ReturnType<typeof getSpecificAsset>>, TError = ErrorType<AsError | void>>(assetId: string, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSpecificAsset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }): UseSuspenseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
+    queryKey: DataTag<QueryKey, TData, TError>;
 };
 /**
  * Used to update or replace Asset *Content* or *Description*.
@@ -165,13 +165,13 @@ Anyone can alter a `GLOBAL` asset. For other *scopes* you will need to be the us
  * @summary Adjust an existing Asset
  */
 declare const patchAsset: (assetId: string, assetPatchBodyBody: AssetPatchBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getPatchAssetMutationOptions: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchAsset>>, TError, {
+declare const getPatchAssetMutationOptions: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
         data: AssetPatchBodyBody;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<Awaited<ReturnType<typeof patchAsset>>, TError, {
+}) => UseMutationOptions<TData, TError, {
     assetId: string;
     data: AssetPatchBodyBody;
 }, TContext>;
@@ -181,13 +181,13 @@ type PatchAssetMutationError = ErrorType<void | AsError>;
 /**
 * @summary Adjust an existing Asset
 */
-declare const usePatchAsset: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchAsset>>, TError, {
+declare const usePatchAsset: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
         data: AssetPatchBodyBody;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<Awaited<ReturnType<typeof patchAsset>>, TError, {
+}) => UseMutationResult<TData, TError, {
     assetId: string;
     data: AssetPatchBodyBody;
 }, TContext>;
@@ -199,12 +199,12 @@ Anyone can alter a `GLOBAL` asset. For other *scopes* you will need to be the us
 * @summary Deletes an Asset
 */
 declare const deleteAsset: (assetId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDeleteAssetMutationOptions: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteAsset>>, TError, {
+declare const getDeleteAssetMutationOptions: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<Awaited<ReturnType<typeof deleteAsset>>, TError, {
+}) => UseMutationOptions<TData, TError, {
     assetId: string;
 }, TContext>;
 type DeleteAssetMutationResult = NonNullable<Awaited<ReturnType<typeof deleteAsset>>>;
@@ -212,12 +212,12 @@ type DeleteAssetMutationError = ErrorType<AsError | void>;
 /**
 * @summary Deletes an Asset
 */
-declare const useDeleteAsset: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteAsset>>, TError, {
+declare const useDeleteAsset: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<Awaited<ReturnType<typeof deleteAsset>>, TError, {
+}) => UseMutationResult<TData, TError, {
     assetId: string;
 }, TContext>;
 /**
@@ -228,12 +228,12 @@ Anyone can alter a `GLOBAL` asset. For other *scopes* you will need to be the us
 * @summary Disables an Asset
 */
 declare const disableAsset: (assetId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDisableAssetMutationOptions: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof disableAsset>>, TError, {
+declare const getDisableAssetMutationOptions: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<Awaited<ReturnType<typeof disableAsset>>, TError, {
+}) => UseMutationOptions<TData, TError, {
     assetId: string;
 }, TContext>;
 type DisableAssetMutationResult = NonNullable<Awaited<ReturnType<typeof disableAsset>>>;
@@ -241,12 +241,12 @@ type DisableAssetMutationError = ErrorType<AsError | void>;
 /**
 * @summary Disables an Asset
 */
-declare const useDisableAsset: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof disableAsset>>, TError, {
+declare const useDisableAsset: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<Awaited<ReturnType<typeof disableAsset>>, TError, {
+}) => UseMutationResult<TData, TError, {
     assetId: string;
 }, TContext>;
 /**
@@ -257,12 +257,12 @@ Anyone can alter a `GLOBAL` asset. For other *scopes* you will need to be the us
 * @summary Enables an Asset
 */
 declare const enableAsset: (assetId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getEnableAssetMutationOptions: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof enableAsset>>, TError, {
+declare const getEnableAssetMutationOptions: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<Awaited<ReturnType<typeof enableAsset>>, TError, {
+}) => UseMutationOptions<TData, TError, {
     assetId: string;
 }, TContext>;
 type EnableAssetMutationResult = NonNullable<Awaited<ReturnType<typeof enableAsset>>>;
@@ -270,12 +270,12 @@ type EnableAssetMutationError = ErrorType<AsError | void>;
 /**
 * @summary Enables an Asset
 */
-declare const useEnableAsset: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof enableAsset>>, TError, {
+declare const useEnableAsset: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<Awaited<ReturnType<typeof enableAsset>>, TError, {
+}) => UseMutationResult<TData, TError, {
     assetId: string;
 }, TContext>;
 /**
@@ -286,13 +286,13 @@ Anyone can alter a `GLOBAL` asset. For other *scopes* you will need to be the us
 * @summary Attaches an Asset to a Merchant
 */
 declare const attachAsset: (assetId: string, params?: AttachAssetParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getAttachAssetMutationOptions: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof attachAsset>>, TError, {
+declare const getAttachAssetMutationOptions: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
         params?: AttachAssetParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<Awaited<ReturnType<typeof attachAsset>>, TError, {
+}) => UseMutationOptions<TData, TError, {
     assetId: string;
     params?: AttachAssetParams;
 }, TContext>;
@@ -301,13 +301,13 @@ type AttachAssetMutationError = ErrorType<AsError | void>;
 /**
 * @summary Attaches an Asset to a Merchant
 */
-declare const useAttachAsset: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof attachAsset>>, TError, {
+declare const useAttachAsset: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
         params?: AttachAssetParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<Awaited<ReturnType<typeof attachAsset>>, TError, {
+}) => UseMutationResult<TData, TError, {
     assetId: string;
     params?: AttachAssetParams;
 }, TContext>;
@@ -319,13 +319,13 @@ Anyone can alter a `GLOBAL` asset. For other *scopes* you will need to be the us
 * @summary Detaches an Asset from a Merchant
 */
 declare const detachAsset: (assetId: string, params?: DetachAssetParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDetachAssetMutationOptions: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof detachAsset>>, TError, {
+declare const getDetachAssetMutationOptions: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
         params?: DetachAssetParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<Awaited<ReturnType<typeof detachAsset>>, TError, {
+}) => UseMutationOptions<TData, TError, {
     assetId: string;
     params?: DetachAssetParams;
 }, TContext>;
@@ -334,13 +334,13 @@ type DetachAssetMutationError = ErrorType<AsError | void>;
 /**
 * @summary Detaches an Asset from a Merchant
 */
-declare const useDetachAsset: <TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<Awaited<ReturnType<typeof detachAsset>>, TError, {
+declare const useDetachAsset: <TData = void, TError = ErrorType<void | AsError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
         assetId: string;
         params?: DetachAssetParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<Awaited<ReturnType<typeof detachAsset>>, TError, {
+}) => UseMutationResult<TData, TError, {
     assetId: string;
     params?: DetachAssetParams;
 }, TContext>;