@equinor/fusion-framework-module-services 5.0.0-next-663bed8344cc2ca0111705b05045173328b3104d → 5.0.1

package/dist/types/bookmarks/api-version.d.ts

@@ -0,0 +1,4 @@
+export declare enum ApiVersion {
+    'v1' = "1.0",
+    'v2' = "2.0"
+}

package/dist/types/bookmarks/client.d.ts

@@ -1,58 +1,156 @@
-import { IHttpClient } from '@equinor/fusion-framework-module-http';
-import { ClientMethod } from '..';
-import { DeleteBookmarkResult, DeleteBookmarksFn, DeleteBookmarksResult } from './delete/types';
-import { ApiVersions, GetBookmarkResult, GetBookmarksFn, GetBookmarksResult } from './get/types';
-import { PostBookmarkResult, PostBookmarkFn, PostBookmarksResult } from './post/types';
-import { PatchBookmarkFn, PatchBookmarkResult, PatchBookmarksResult } from './patch';
-import { GetAllBookmarkResult, GetAllBookmarksResult } from './getAll';
-import { PostBookmarkFavoriteFn, PostBookmarksFavoriteResult } from './favorites/post';
-import { DeleteBookmarksFavoriteFn, DeleteBookmarksFavoriteResult } from './favorites/delete';
-import { HeadBookmarkFavoriteFn, HeadBookmarksFavoriteResult } from './favorites/head';
-export declare class BookmarksApiClient<TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TClient extends IHttpClient = IHttpClient, TPayload = unknown> {
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod } from '../types';
+import { GetBookmarksArgs, GetBookmarksResponse, GetBookmarksResult, GetBookmarksVersion } from './endpoints/user-bookmarks.get';
+import { GetBookmarkArg, GetBookmarkResponse, GetBookmarkResult, GetBookmarkVersion } from './endpoints/bookmark.get';
+import { CreateBookmarkArg, CreateBookmarkResponse, CreateBookmarkVersion, CreateBookmarksResult } from './endpoints/bookmark.post';
+import { type PatchBookmarkArg, type PatchBookmarkResponse, type PatchBookmarkVersion, type PatchBookmarksResult } from './endpoints/bookmark.patch';
+import { BookmarkApplyArgs, BookmarkApplyResponse, BookmarkApplyResult, BookmarkApplyVersion } from './endpoints/bookmark-apply.get';
+import { AddBookmarkFavouriteArgs, AddBookmarkFavouriteResponse, AddBookmarkFavouriteResult, AddBookmarkFavouriteVersion } from './endpoints/user-bookmark-favourite.post';
+import { DeleteBookmarkArg, DeleteBookmarkResponse, DeleteBookmarkVersion } from './endpoints/bookmark.delete';
+import { IsFavoriteBookmarkArgs, IsFavoriteBookmarkResponse, IsFavoriteBookmarkResult, IsFavoriteBookmarkVersion } from './endpoints/user-bookmark-favourite.head';
+import { RemoveBookmarkFavouriteArgs, RemoveBookmarkFavouriteResponse, RemoveBookmarkFavouriteResult, RemoveBookmarkFavouriteVersion } from './endpoints/user-bookmark-favourite.delete';
+/**
+ * Provides a client interface for interacting with the bookmarks API.
+ * This class abstracts the details of making API requests and handling responses.
+ * It provides methods for fetching, creating, updating, and deleting bookmarks,
+ * as well as managing bookmark favorites.
+ *
+ * @example
+ * ```typescript
+ * import { BookmarksApiClient } from '@equinor/fusion';
+ * import { HttpClient } from '@equinor/fusion-framework-module-http';
+ *
+ * const httpClient = new HttpClient({ baseUri: 'https://my-bookmarks-api.com/' });
+ *
+ * // create a bookmarks API client using a custom HTTP client
+ * const client = new BookmarksApiClient(httpClient, 'json');
+ *
+ * // fetch a bookmark by its ID
+ * const bookmark = await client.getBookmark('my-bookmark-id');
+ *
+ * // fetch all bookmarks for the current user
+ * const bookmarks = await client.query();
+ *
+ * // update a bookmark by its ID
+ * await client.patch({
+ *  bookmarkId: 'my-bookmark-id',
+ *  data: {
+ *     name: 'new-name'
+ *     payload: { foo: 'bar' }
+ *  }
+ * });
+ *
+ * // delete a bookmark by its ID
+ * await client.deleteBookmark('my-bookmark-id');
+ *
+ * // add or remove a bookmark to the current user's favorites
+ * await client.addFavorite({ bookmarkId:'my-bookmark-id' });
+ * await client.removeFavorite({ bookmarkId:'my-bookmark-id' });
+ * ```
+ *
+ * @template TMethod - The client method to use for the request, defaults to 'json'.
+ * @template TClient - The HTTP client to use for executing the request.
+ */
+export declare class BookmarksApiClient<TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TClient extends IHttpClient = IHttpClient> {
     protected _client: TClient;
     protected _method: TMethod;
+    /**
+     * Constructs a new instance of the BookmarksClient class.
+     *
+     * @param _client - The client instance to use for making API requests.
+     * @param _method - The client method to use for API requests.
+     */
     constructor(_client: TClient, _method: TMethod);
     /**
-     * Fetch bookmark by id
-     * @see {@link get/client}
+     * Fetch a single bookmark
+     *
+     * @template TVersion - The version of the API to call
+     * @template TResponse - The type of the result of the `getBookmark` function
+     * @param version - The API version to use
+     * @param args - Additional parameters to pass to the `getBookmark` function
+     * @returns The result of the `getBookmark` function
      */
-    get<TVersion extends ApiVersions, TResult = GetBookmarkResult<TVersion, TPayload>>(version: TVersion, ...args: Parameters<GetBookmarksFn<TVersion, TMethod, TClient, TPayload, TResult>>): GetBookmarksResult<TVersion, TMethod, TPayload, TResult>;
+    get<TVersion extends GetBookmarkVersion, TResponse = GetBookmarkResponse<TVersion>>(version: TVersion, args: GetBookmarkArg<TVersion>, init?: ClientRequestInit<TClient, TResponse>): GetBookmarkResult<TVersion, TMethod, TResponse>;
     /**
-     * Fetch all bookmarks
-     * @see {@link get/client}
+     * Retrieves the payload for a bookmark using the specified API version.
+     *
+     * @template TVersion - The version of the API to call.
+     * @template TResult - The type of the result of the `getBookmarkPayload` function.
+     * @param version - The API version to use for the bookmark payload.
+     * @param args - The arguments to pass to the `getBookmarkPayload` function.
+     * @returns The result of the `getBookmarkPayload` function.
      */
-    getAll<TVersion extends ApiVersions, TResult = GetAllBookmarkResult<TVersion, TPayload>>(version: TVersion): GetAllBookmarksResult<TVersion, TMethod, TPayload, TResult>;
+    getPayload<TVersion extends BookmarkApplyVersion, TResponse = BookmarkApplyResponse<TVersion>>(version: TVersion, args: BookmarkApplyArgs<TVersion>, init?: ClientRequestInit<TClient, TResponse>): BookmarkApplyResult<TVersion, TMethod, TResponse>;
     /**
-     * Create a new bookmark
-     * @see {@link get/client}
+     * Query a person's bookmarks.
+     *
+     * @template TVersion - The version of the API to call.
+     * @template TResponse - The type of the result of the `getBookmarks` function.
+     * @param version - The API version to use.
+     * @param args - Additional arguments to pass to the `getBookmarks` function.
+     * @param init - Optional request initialization options.
+     * @returns The result of calling the `getBookmarks` function.
      */
-    post<TVersion extends ApiVersions, TResult = PostBookmarkResult<TVersion, TPayload>>(version: TVersion, ...args: Parameters<PostBookmarkFn<TVersion, TMethod, TClient, TPayload, TResult>>): PostBookmarksResult<TVersion, TMethod, TPayload, TResult>;
+    query<TVersion extends GetBookmarksVersion, TResponse = GetBookmarksResponse<TVersion>>(version: TVersion, args?: GetBookmarksArgs<TVersion>, init?: ClientRequestInit<TClient, TResponse>): GetBookmarksResult<TVersion, TMethod, TResponse>;
     /**
      * Update a bookmark
-     * @see {@link get/client}
+     *
+     * @template TVersion - The version of the API to call
+     * @template TResponse - The type of the result of the `patchBookmark` function
+     * @param version - The API version to use
+     * @param args - The parameters to pass to the `patchBookmark` function
+     * @returns The result of the `patchBookmark` function
      */
-    patch<TVersion extends ApiVersions, TResult = PatchBookmarkResult<TVersion, TPayload>>(version: TVersion, ...args: Parameters<PatchBookmarkFn<TVersion, TMethod, TClient, TPayload, TResult>>): PatchBookmarksResult<TVersion, TMethod, TPayload, TResult>;
+    patch<TVersion extends PatchBookmarkVersion, TResponse = PatchBookmarkResponse<TVersion>>(version: TVersion, args: PatchBookmarkArg<TVersion>, init?: ClientRequestInit<TClient, TResponse>): PatchBookmarksResult<TVersion, TMethod, TResponse>;
     /**
-     * Delete a bookmark
-     * @see {@link delete/client}
+     * Create a new bookmark
+     *
+     * @template TVersion - The version of the API to call
+     * @template TResult - The type of the result of the `postBookmark` function
+     * @param version - The API version to use
+     * @param request - The parameters to pass to the `postBookmark` function
+     * @returns The result of creating the bookmark
      */
-    delete<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(version: TVersion, ...args: Parameters<DeleteBookmarksFn<TVersion, TMethod, TClient, TResult>>): DeleteBookmarksResult<TVersion, TMethod, TResult>;
+    create<TVersion extends CreateBookmarkVersion, TResponse = CreateBookmarkResponse<TVersion>>(version: TVersion, request: CreateBookmarkArg<TVersion>, init?: ClientRequestInit<TClient, TResponse>): CreateBookmarksResult<TVersion, TMethod, TResponse>;
     /**
-     * Add bookmark to favorites by bookmark id
-     * @see {@link addFavorite/client}
+     * Deletes a bookmark.
+     *
+     * @template TVersion - The version of the API to call.
+     * @template TResponse - The type of the result of the `deleteBookmark` function.
+     * @param version - The version of the delete bookmark API to use.
+     * @param args - The arguments to pass to the `deleteBookmark` function.
+     * @returns The result of the delete bookmark operation.
+     */
+    delete<TVersion extends DeleteBookmarkVersion, TResponse = DeleteBookmarkResponse<TVersion>>(version: TVersion, args: DeleteBookmarkArg<TVersion>, init?: ClientRequestInit<TClient, TResponse>): GetBookmarkResult<TVersion, TMethod, TResponse>;
+    /**
+     * Check if a bookmark is a favorite.
+     *
+     * @template TVersion - The version of the API to call.
+     * @template TResult - The type of the result of the `verifyBookmarkFavorite` function.
+     * @param version - The API version to use.
+     * @param args - The arguments to pass to the `HeadBookmarkFavoriteFn` function.
+     * @returns The result of the `HeadBookmarksFavoriteResult` function.
      */
-    addFavorite<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(version: TVersion, ...args: Parameters<PostBookmarkFavoriteFn<TVersion, TMethod, TClient, TResult>>): PostBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+    isFavorite<TVersion extends IsFavoriteBookmarkVersion, TResponse = IsFavoriteBookmarkResponse<TVersion>>(version: TVersion, args: IsFavoriteBookmarkArgs<TVersion>, init?: ClientRequestInit<TClient, TResponse>): IsFavoriteBookmarkResult<TVersion, TMethod, TResponse>;
     /**
+     * Add the provided bookmark to the user's favorites.
      *
-     * Remove bookmark from favorites by bookmark id
-     * @see {@link removeFavorite/client}
+     * @template TVersion - The version of the API to call.
+     * @template TResponse - The type of the result of the `addBookmarkFavorite` function.
+     * @param version - The API version to use.
+     * @param args - The parameters to pass to the `PostBookmarkFavoriteFn` function.
+     * @returns The result of adding the bookmark to the user's favorites.
      */
-    removeFavorite<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(version: TVersion, ...args: Parameters<DeleteBookmarksFavoriteFn<TVersion, TMethod, TClient, TResult>>): DeleteBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+    addFavourite<TVersion extends AddBookmarkFavouriteVersion, TResponse = AddBookmarkFavouriteResponse<TVersion>>(version: TVersion, args: AddBookmarkFavouriteArgs<TVersion>, init?: ClientRequestInit<TClient, TResponse>): AddBookmarkFavouriteResult<TVersion, TMethod, TResponse>;
     /**
+     * Removes the provided bookmark from the user's collection of bookmarks.
      *
-     * Verify that the current bookmark is present in the users collection of bookmarks.
-     * @see {@link verifyFavorite/client}
+     * @template TVersion - The version of the API to call.
+     * @template TResult - The type of the result of the `deleteBookmarkFavorite` function.
+     * @param version - The API version to use for the request.
+     * @param request - The parameters to pass to the `deleteBookmarkFavorite` function.
+     * @returns The result of the `deleteBookmarkFavorite` function.
      */
-    verifyFavorite<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(version: TVersion, ...args: Parameters<HeadBookmarkFavoriteFn<TVersion, TMethod, TClient, TResult>>): HeadBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+    removeFavourite<TVersion extends RemoveBookmarkFavouriteVersion, TResponse = RemoveBookmarkFavouriteResponse<TVersion>>(version: TVersion, request: RemoveBookmarkFavouriteArgs<TVersion>, init?: ClientRequestInit<TClient, TResponse>): RemoveBookmarkFavouriteResult<TVersion, TMethod, TResponse>;
 }
 export default BookmarksApiClient;

package/dist/types/bookmarks/endpoints/bookmark-apply.get.d.ts

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod, ExtractApiVersion, FilterAllowedApiVersions } from '../types';
+import { ApiVersion } from '../api-version';
+/** API version which this operation uses. */
+type AvailableVersions = ApiVersion.v1;
+/** Defines the allowed versions for this operation. (key of enum as string or enum value) */
+type AllowedVersions = FilterAllowedApiVersions<AvailableVersions>;
+/** Schema for the input arguments to this operation. */
+declare const ArgSchema: {
+    "1.0": z.ZodObject<{
+        bookmarkId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        bookmarkId: string;
+    }, {
+        bookmarkId: string;
+    }>;
+};
+/** Schema for the response from the API. */
+declare const ApiResponseSchema: {
+    "1.0": z.ZodObject<{
+        id: z.ZodString;
+        payload: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodString]>>>, any, string | Record<string, unknown> | undefined>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        payload?: any;
+    }, {
+        id: string;
+        payload?: string | Record<string, unknown> | undefined;
+    }>;
+};
+/** Defines the expected output from the api. */
+type ApiResponse<TVersion extends AllowedVersions> = z.infer<(typeof ApiResponseSchema)[ExtractApiVersion<TVersion>]>;
+/** Defines the input arguments to this operation. */
+type MethodArg<TVersion extends AllowedVersions> = z.input<(typeof ArgSchema)[ExtractApiVersion<TVersion>]>;
+/** Defines the expected output of this operation. */
+type MethodResult<TVersion extends AllowedVersions, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = ApiResponse<TVersion>> = ClientMethod<TResult>[TMethod];
+/** executes the api call */
+declare const executeApiCall: <TVersion extends AllowedVersions, TMethod extends keyof ClientMethod>(version: TVersion, client: IHttpClient, method?: TMethod) => <TResponse = ApiResponse<ExtractApiVersion<TVersion>>, TResult = MethodResult<ExtractApiVersion<TVersion>, TMethod, TResponse>>(input: MethodArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, TResponse>) => TResult;
+export { AllowedVersions as BookmarkApplyVersion, MethodArg as BookmarkApplyArgs, ApiResponse as BookmarkApplyResponse, MethodResult as BookmarkApplyResult, executeApiCall as getBookmarkApply, };

package/dist/types/bookmarks/endpoints/bookmark.delete.d.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod, ExtractApiVersion, FilterAllowedApiVersions } from '../types';
+import { ApiVersion } from '../api-version';
+/** API version which this operation uses. */
+type AvailableVersions = ApiVersion.v1;
+/** Defines the allowed versions for this operation. (key of enum as string or enum value) */
+type AllowedVersions = FilterAllowedApiVersions<AvailableVersions>;
+/** Schema for the input arguments to this operation. */
+declare const ArgSchema: {
+    "1.0": z.ZodObject<{
+        bookmarkId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        bookmarkId: string;
+    }, {
+        bookmarkId: string;
+    }>;
+};
+/** Schema for the response from the API. */
+declare const ApiResponseSchema: {
+    "1.0": z.ZodBoolean;
+};
+/** Defines the expected output from the api. */
+type ApiResponse<TVersion extends AllowedVersions> = z.infer<(typeof ApiResponseSchema)[ExtractApiVersion<TVersion>]>;
+/** Defines the input arguments to this operation. */
+type MethodArg<TVersion extends AllowedVersions> = z.input<(typeof ArgSchema)[ExtractApiVersion<TVersion>]>;
+/** Defines the expected output of this operation. */
+type MethodResult<TVersion extends AllowedVersions, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = ApiResponse<TVersion>> = ClientMethod<TResult>[TMethod];
+/** executes the api call */
+declare const executeApiCall: <TVersion extends AllowedVersions, TMethod extends keyof ClientMethod>(version: TVersion, client: IHttpClient, method?: TMethod) => <TResponse = ApiResponse<ExtractApiVersion<TVersion>>, TResult = MethodResult<ExtractApiVersion<TVersion>, TMethod, TResponse>>(input: MethodArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, TResponse>) => TResult;
+export { AllowedVersions as DeleteBookmarkVersion, MethodArg as DeleteBookmarkArg, ApiResponse as DeleteBookmarkResponse, MethodResult as DeleteBookmarksResult, executeApiCall as deleteBookmark, };

package/dist/types/bookmarks/endpoints/bookmark.get.d.ts

@@ -0,0 +1,351 @@
+import { z } from 'zod';
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod, ExtractApiVersion, FilterAllowedApiVersions } from '../types';
+import { ApiVersion } from '../api-version';
+/** API version which this operation uses. */
+type AvailableVersions = ApiVersion.v1 | ApiVersion.v2;
+/** Defines the allowed versions for this operation. (key of enum as string or enum value) */
+type AllowedVersions = FilterAllowedApiVersions<AvailableVersions>;
+/** Schema for the input arguments to this operation. */
+declare const ArgSchema: {
+    "1.0": z.ZodObject<{
+        bookmarkId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        bookmarkId: string;
+    }, {
+        bookmarkId: string;
+    }>;
+    "2.0": z.ZodObject<{
+        bookmarkId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        bookmarkId: string;
+    }, {
+        bookmarkId: string;
+    }>;
+};
+/** Schema for the response from the API. */
+declare const ApiResponseSchema: {
+    "1.0": z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        appKey: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        isShared: z.ZodOptional<z.ZodBoolean>;
+        context: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            type?: string | null | undefined;
+            name?: string | null | undefined;
+        }, {
+            id: string;
+            type?: string | null | undefined;
+            name?: string | null | undefined;
+        }>>;
+        createdBy: z.ZodObject<{
+            azureUniqueId: z.ZodString;
+            name: z.ZodString;
+            mail: z.ZodOptional<z.ZodString>;
+            phoneNumber: z.ZodOptional<z.ZodString>;
+            jobTitle: z.ZodOptional<z.ZodString>;
+            accountType: z.ZodOptional<z.ZodEnum<["Employee", "Consultant", "External", "Application", "Local"]>>;
+            accountClassification: z.ZodOptional<z.ZodEnum<["Unclassified", "Internal", "External"]>>;
+        }, "strip", z.ZodTypeAny, {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        }, {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        }>;
+        updatedBy: z.ZodOptional<z.ZodObject<{
+            azureUniqueId: z.ZodString;
+            name: z.ZodString;
+            mail: z.ZodOptional<z.ZodString>;
+            phoneNumber: z.ZodOptional<z.ZodString>;
+            jobTitle: z.ZodOptional<z.ZodString>;
+            accountType: z.ZodOptional<z.ZodEnum<["Employee", "Consultant", "External", "Application", "Local"]>>;
+            accountClassification: z.ZodOptional<z.ZodEnum<["Unclassified", "Internal", "External"]>>;
+        }, "strip", z.ZodTypeAny, {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        }, {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        }>>;
+        created: z.ZodEffects<z.ZodString, Date, string>;
+        updated: z.ZodOptional<z.ZodEffects<z.ZodString, Date, string>>;
+        sourceSystem: z.ZodOptional<z.ZodObject<{
+            identifier: z.ZodString;
+            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            subSystem: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            identifier: string;
+            name?: string | null | undefined;
+            subSystem?: string | null | undefined;
+        }, {
+            identifier: string;
+            name?: string | null | undefined;
+            subSystem?: string | null | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        appKey: string;
+        createdBy: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        };
+        created: Date;
+        description?: string | undefined;
+        isShared?: boolean | undefined;
+        context?: {
+            id: string;
+            type?: string | null | undefined;
+            name?: string | null | undefined;
+        } | undefined;
+        updatedBy?: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        } | undefined;
+        updated?: Date | undefined;
+        sourceSystem?: {
+            identifier: string;
+            name?: string | null | undefined;
+            subSystem?: string | null | undefined;
+        } | undefined;
+    }, {
+        id: string;
+        name: string;
+        appKey: string;
+        createdBy: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        };
+        created: string;
+        description?: string | undefined;
+        isShared?: boolean | undefined;
+        context?: {
+            id: string;
+            type?: string | null | undefined;
+            name?: string | null | undefined;
+        } | undefined;
+        updatedBy?: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        } | undefined;
+        updated?: string | undefined;
+        sourceSystem?: {
+            identifier: string;
+            name?: string | null | undefined;
+            subSystem?: string | null | undefined;
+        } | undefined;
+    }>;
+    "2.0": z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        appKey: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        isShared: z.ZodOptional<z.ZodBoolean>;
+        context: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            type?: string | null | undefined;
+            name?: string | null | undefined;
+        }, {
+            id: string;
+            type?: string | null | undefined;
+            name?: string | null | undefined;
+        }>>;
+        createdBy: z.ZodObject<{
+            azureUniqueId: z.ZodString;
+            name: z.ZodString;
+            mail: z.ZodOptional<z.ZodString>;
+            phoneNumber: z.ZodOptional<z.ZodString>;
+            jobTitle: z.ZodOptional<z.ZodString>;
+            accountType: z.ZodOptional<z.ZodEnum<["Employee", "Consultant", "External", "Application", "Local"]>>;
+            accountClassification: z.ZodOptional<z.ZodEnum<["Unclassified", "Internal", "External"]>>;
+        }, "strip", z.ZodTypeAny, {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        }, {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        }>;
+        updatedBy: z.ZodOptional<z.ZodObject<{
+            azureUniqueId: z.ZodString;
+            name: z.ZodString;
+            mail: z.ZodOptional<z.ZodString>;
+            phoneNumber: z.ZodOptional<z.ZodString>;
+            jobTitle: z.ZodOptional<z.ZodString>;
+            accountType: z.ZodOptional<z.ZodEnum<["Employee", "Consultant", "External", "Application", "Local"]>>;
+            accountClassification: z.ZodOptional<z.ZodEnum<["Unclassified", "Internal", "External"]>>;
+        }, "strip", z.ZodTypeAny, {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        }, {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        }>>;
+        created: z.ZodEffects<z.ZodString, Date, string>;
+        updated: z.ZodOptional<z.ZodEffects<z.ZodString, Date, string>>;
+        sourceSystem: z.ZodOptional<z.ZodObject<{
+            identifier: z.ZodString;
+            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            subSystem: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            identifier: string;
+            name?: string | null | undefined;
+            subSystem?: string | null | undefined;
+        }, {
+            identifier: string;
+            name?: string | null | undefined;
+            subSystem?: string | null | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        appKey: string;
+        createdBy: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        };
+        created: Date;
+        description?: string | undefined;
+        isShared?: boolean | undefined;
+        context?: {
+            id: string;
+            type?: string | null | undefined;
+            name?: string | null | undefined;
+        } | undefined;
+        updatedBy?: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        } | undefined;
+        updated?: Date | undefined;
+        sourceSystem?: {
+            identifier: string;
+            name?: string | null | undefined;
+            subSystem?: string | null | undefined;
+        } | undefined;
+    }, {
+        id: string;
+        name: string;
+        appKey: string;
+        createdBy: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        };
+        created: string;
+        description?: string | undefined;
+        isShared?: boolean | undefined;
+        context?: {
+            id: string;
+            type?: string | null | undefined;
+            name?: string | null | undefined;
+        } | undefined;
+        updatedBy?: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        } | undefined;
+        updated?: string | undefined;
+        sourceSystem?: {
+            identifier: string;
+            name?: string | null | undefined;
+            subSystem?: string | null | undefined;
+        } | undefined;
+    }>;
+};
+/** Defines the expected output from the api. */
+type ApiResponse<TVersion extends AllowedVersions> = z.infer<(typeof ApiResponseSchema)[ExtractApiVersion<TVersion>]>;
+/** Defines the input arguments to this operation. */
+type MethodArg<TVersion extends AllowedVersions> = z.input<(typeof ArgSchema)[ExtractApiVersion<TVersion>]>;
+/** Defines the expected output of this operation. */
+type MethodResult<TVersion extends AllowedVersions, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = ApiResponse<TVersion>> = ClientMethod<TResult>[TMethod];
+/** executes the api call */
+declare const executeApiCall: <TVersion extends AllowedVersions, TMethod extends keyof ClientMethod>(version: TVersion, client: IHttpClient, method?: TMethod) => <TResponse = ApiResponse<ExtractApiVersion<TVersion>>, TResult = MethodResult<ExtractApiVersion<TVersion>, TMethod, TResponse>>(input: MethodArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, TResponse>) => TResult;
+export { AllowedVersions as GetBookmarkVersion, MethodArg as GetBookmarkArg, ApiResponse as GetBookmarkResponse, MethodResult as GetBookmarkResult, executeApiCall as getBookmark, };