@equinor/fusion-framework-module-services 2.1.0 → 2.3.0

package/dist/types/notification/settings/put/index.d.ts

@@ -0,0 +1,5 @@
+export { ApiVersion } from '@equinor/fusion-framework-module-services/notification';
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';
+export * from './types';
+export { updateUserNotificationSettings, default } from './client';

package/dist/types/notification/settings/put/types.d.ts

@@ -0,0 +1,17 @@
+import { IHttpClient, ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../../../types';
+import { ApiNotificationSettingsEntity } from '../../api-models';
+import { ApiVersion } from '../../static';
+type PutUserNotificationSettingsArgsTypes = {
+    [ApiVersion.v1]: ApiNotificationSettingsEntity<ApiVersion.v1>;
+    [ApiVersion.v2]: ApiNotificationSettingsEntity<ApiVersion.v2>;
+};
+export type PutUserNotificationSettingsArgs<T extends string> = T extends keyof typeof ApiVersion ? PutUserNotificationSettingsArgsTypes[(typeof ApiVersion)[T]] : unknown;
+type GetUserNotificationSettingsResponseTypes = {
+    [ApiVersion.v2]: ApiNotificationSettingsEntity<ApiVersion.v2>;
+    [ApiVersion.v1]: ApiNotificationSettingsEntity<ApiVersion.v1>;
+};
+export type PutUserNotificationSettingsResponse<T> = T extends keyof typeof ApiVersion ? GetUserNotificationSettingsResponseTypes[(typeof ApiVersion)[T]] : unknown;
+export type PutUserNotificationSettingsFn<TVersion extends string = keyof typeof ApiVersion, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TClient extends IHttpClient = IHttpClient, TResult = PutUserNotificationSettingsResponse<TVersion>> = (args: PutUserNotificationSettingsArgs<TVersion>, init?: ClientRequestInit<TClient, TResult>) => PutUserNotificationSettingsResult<TVersion, TMethod, TResult>;
+export type PutUserNotificationSettingsResult<TVersion extends string = keyof typeof ApiVersion, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = PutUserNotificationSettingsResponse<TVersion>> = ClientMethod<TResult>[TMethod];
+export {};

package/dist/types/notification/static.d.ts

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

package/dist/types/notification/types.d.ts

@@ -0,0 +1 @@
+export { ClientMethodType, ClientMethod, ApiClientArguments, } from '@equinor/fusion-framework-module-services';

package/dist/types/provider.d.ts

@@ -3,6 +3,7 @@ import { ClientMethod } from './types';
 import { ApiClientFactory } from './types';
 import { ContextApiClient } from './context';
 import BookmarksApiClient from './bookmarks/client';
+import { NotificationApiClient } from './notification';
 export interface IApiProvider<TClient extends IHttpClient = IHttpClient> {
     createBookmarksClient<TMethod extends keyof ClientMethod, TPayload = unknown>(method: TMethod): Promise<BookmarksApiClient<TMethod, TClient, TPayload>>;
     createContextClient<TMethod extends keyof ClientMethod>(method: TMethod): Promise<ContextApiClient<TMethod, TClient>>;
@@ -13,6 +14,7 @@ type ApiProviderCtorArgs<TClient extends IHttpClient = IHttpClient> = {
 export declare class ApiProvider<TClient extends IHttpClient = IHttpClient> implements IApiProvider<TClient> {
     protected _createClientFn: ApiClientFactory<TClient>;
     constructor({ createClient }: ApiProviderCtorArgs<TClient>);
+    createNotificationClient<TMethod extends keyof ClientMethod>(method: TMethod): Promise<NotificationApiClient<TMethod, TClient>>;
     createBookmarksClient<TMethod extends keyof ClientMethod, TPayload = unknown>(method: TMethod): Promise<BookmarksApiClient<TMethod, TClient, TPayload>>;
     createContextClient<TMethod extends keyof ClientMethod>(method: TMethod): Promise<ContextApiClient<TMethod, TClient>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/fusion-framework-module-services",
-    "version": "2.1.0",
+    "version": "2.3.0",
     "description": "",
     "sideEffects": false,
     "main": "dist/esm/index.js",
@@ -10,6 +10,9 @@
             "*": [
                 "dist/types/*"
             ],
+            "notification": [
+                "dist/types/notification/index"
+            ],
             "context": [
                 "dist/types/context/index"
             ],
@@ -28,6 +31,7 @@
         ".": "./dist/esm/index.js",
         "./context": "./dist/esm/context/index.js",
         "./bookmark": "./dist/esm/bookmarks/index.js",
+        "./notification": "./dist/esm/notification/index.js",
         "./context/get": "./dist/esm/context/get-context/index.js",
         "./errors": "./dist/esm/errors.js",
         "./package.json": "./package.json"
@@ -59,5 +63,5 @@
         "@equinor/fusion-framework-module": ">=1.2.2",
         "odata-query": "^7.0.3"
     },
-    "gitHead": "d177e1925ca7b8692435b1fdefbcc0c8418d7625"
+    "gitHead": "2cec998dee5e0781c2cc2b327e2e119d12cd0046"
 }

package/src/bookmarks/client.ts

@@ -13,6 +13,18 @@ import patchBookmark, {
     PutBookmarksResult as PatchBookmarksResult,
 } from './patch';
 import getAllBookmarks, { GetAllBookmarkResult, GetAllBookmarksResult } from './getAll';
+import addBookmarkFavorite, {
+    PostBookmarkFavoriteFn,
+    PostBookmarksFavoriteResult,
+} from './favorites/post';
+import deleteBookmarkFavorite, {
+    DeleteBookmarksFavoriteFn,
+    DeleteBookmarksFavoriteResult,
+} from './favorites/delete';
+import verifyBookmarkFavorite, {
+    HeadBookmarkFavoriteFn,
+    HeadBookmarksFavoriteResult,
+} from './favorites/head';
 
 export class BookmarksApiClient<
     TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
@@ -67,6 +79,10 @@ export class BookmarksApiClient<
         return fn<TResult>(...args);
     }
 
+    /**
+     * Delete a bookmark
+     * @see {@link delete/client}
+     */
     public delete<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(
         version: TVersion,
         ...args: Parameters<DeleteBookmarksFn<TVersion, TMethod, TClient, TResult>>
@@ -74,6 +90,44 @@ export class BookmarksApiClient<
         const fn = deleteBookmark(this._client, version, this._method);
         return fn<TResult>(...args);
     }
+
+    /**
+     * Add bookmark to favorites by bookmark id
+     * @see {@link addFavorite/client}
+     */
+    public addFavorite<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(
+        version: TVersion,
+        ...args: Parameters<PostBookmarkFavoriteFn<TVersion, TMethod, TClient, TResult>>
+    ): PostBookmarksFavoriteResult<TVersion, TMethod, TResult> {
+        const fn = addBookmarkFavorite(this._client, version, this._method);
+        return fn<TResult>(...args);
+    }
+
+    /**
+     *
+     * Remove bookmark from favorites by bookmark id
+     * @see {@link removeFavorite/client}
+     */
+    public removeFavorite<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(
+        version: TVersion,
+        ...args: Parameters<DeleteBookmarksFavoriteFn<TVersion, TMethod, TClient, TResult>>
+    ): DeleteBookmarksFavoriteResult<TVersion, TMethod, TResult> {
+        const fn = deleteBookmarkFavorite(this._client, version, this._method);
+        return fn<TResult>(...args);
+    }
+
+    /**
+     *
+     * Verify that the current bookmark is present in the users collection of bookmarks.
+     * @see {@link verifyFavorite/client}
+     */
+    public verifyFavorite<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(
+        version: TVersion,
+        ...args: Parameters<HeadBookmarkFavoriteFn<TVersion, TMethod, TClient, TResult>>
+    ): HeadBookmarksFavoriteResult<TVersion, TMethod, TResult> {
+        const fn = verifyBookmarkFavorite(this._client, version, this._method);
+        return fn<TResult>(...args);
+    }
 }
 
 export default BookmarksApiClient;

package/src/bookmarks/favorites/delete/client.ts

@@ -0,0 +1,35 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+import { generateParameters } from './generate-parameters';
+import {
+    ApiVersions,
+    DeleteBookmarkFavoriteArgs,
+    DeleteBookmarkFavoriteResult,
+    DeleteBookmarksFavoriteResult,
+} from './types';
+
+/**
+ * Method for fetching bookmark by it`s id from bookmark service
+ * @param client - client for execution of request
+ * @param version - version of API to call
+ * @param method - client method to call
+ */
+export const deleteBookmarkFavorite =
+    <
+        TVersion extends ApiVersions = ApiVersions,
+        TMethod extends keyof ClientMethod = keyof ClientMethod,
+        TClient extends IHttpClient = IHttpClient
+    >(
+        client: TClient,
+        version: TVersion,
+        method: TMethod = 'fetch' as TMethod
+    ) =>
+    <TResult = DeleteBookmarkFavoriteResult<TVersion>>(
+        args: DeleteBookmarkFavoriteArgs<TVersion>,
+        init?: ClientRequestInit<TClient, TResult>
+    ): DeleteBookmarksFavoriteResult<TVersion, TMethod, TResult> =>
+        client[method](
+            ...generateParameters<TResult, TVersion, TClient>(version, args, init)
+        ) as DeleteBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+
+export default deleteBookmarkFavorite;

package/src/bookmarks/favorites/delete/generate-endpoint.ts

@@ -0,0 +1,19 @@
+import { ApiVersions, DeleteBookmarkFavoriteArgs } from './types';
+
+/**
+ * Method for generating endpoint for deleting a bookmark.
+ */
+export const generateEndpoint = <TVersion extends ApiVersions>(
+    version: TVersion,
+    args: DeleteBookmarkFavoriteArgs<TVersion>
+) => {
+    switch (version) {
+        case 'v1':
+        default: {
+            const { bookmarkId } = args as { bookmarkId: string };
+            const params = new URLSearchParams();
+            params.append('api-version', '1.0');
+            return `/persons/me/bookmarks/favorites/${bookmarkId}/?${String(params)}`;
+        }
+    }
+};

package/src/bookmarks/favorites/delete/generate-parameters.ts

@@ -0,0 +1,25 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ApiClientArguments } from '../..';
+import { generateEndpoint } from './generate-endpoint';
+import { ApiVersions, DeleteBookmarkFavoriteArgs } from './types';
+
+/** function for creating http client arguments  */
+export const generateParameters = <
+    TResult,
+    TVersion extends ApiVersions,
+    TClient extends IHttpClient = IHttpClient
+>(
+    version: TVersion,
+    args: DeleteBookmarkFavoriteArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+): ApiClientArguments<TClient, TResult> => {
+    const path = generateEndpoint(version, args);
+
+    const requestParams: ClientRequestInit<TClient, TResult> = Object.assign(
+        {},
+        { method: 'Delete' },
+        init
+    );
+
+    return [path, requestParams];
+};

package/src/bookmarks/favorites/delete/index.ts

@@ -0,0 +1,6 @@
+export * from './types';
+
+export { deleteBookmarkFavorite as deleteBookmark, default } from './client';
+
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';

package/src/bookmarks/favorites/delete/types-v1.ts

@@ -0,0 +1,2 @@
+/** arguments for v1 delete bookmark favorite */
+export type DeleteBookmarksFavoriteArgsV1 = { bookmarkId: string };

package/src/bookmarks/favorites/delete/types.ts

@@ -0,0 +1,33 @@
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+import { DeleteBookmarksFavoriteArgsV1 } from './types-v1';
+
+export type DeleteBookmarkFavoriteResult<TVersion extends ApiVersions> =
+    DeleteBookmarksFavoriteVersions[TVersion]['result'];
+
+export type DeleteBookmarkFavoriteArgs<TVersion extends ApiVersions> =
+    DeleteBookmarksFavoriteVersions[TVersion]['args'];
+
+export type DeleteBookmarksFavoriteResult<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TResult = DeleteBookmarkFavoriteResult<TVersion>
+> = ClientMethod<TResult>[TMethod];
+
+export type DeleteBookmarksFavoriteFn<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TClient extends IHttpClient = IHttpClient,
+    TResult = DeleteBookmarkFavoriteResult<TVersion>
+> = (
+    args: DeleteBookmarkFavoriteArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+) => DeleteBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+
+export type DeleteBookmarksFavoriteVersions = {
+    ['v1']: { args: DeleteBookmarksFavoriteArgsV1; result: undefined };
+};
+
+/**Api versions for bookmarks service */
+export type ApiVersions = keyof DeleteBookmarksFavoriteVersions;

package/src/bookmarks/favorites/head/client.ts

@@ -0,0 +1,35 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+import { generateParameters } from './generate-parameters';
+import {
+    ApiVersions,
+    HeadBookmarkFavoriteArgs,
+    HeadBookmarkFavoriteResult,
+    HeadBookmarksFavoriteResult,
+} from './types';
+
+/**
+ * Verify that the bookmark is owned by the current user.
+ * @param client - client for execution of request
+ * @param version - version of API to call
+ * @param method - client method to call
+ */
+export const verifyBookmarkFavorite =
+    <
+        TVersion extends ApiVersions = ApiVersions,
+        TMethod extends keyof ClientMethod = keyof ClientMethod,
+        TClient extends IHttpClient = IHttpClient
+    >(
+        client: TClient,
+        version: TVersion,
+        method: TMethod = 'json' as TMethod
+    ) =>
+    <TResult = HeadBookmarkFavoriteResult<TVersion>>(
+        args: HeadBookmarkFavoriteArgs<TVersion>,
+        init?: ClientRequestInit<TClient, TResult>
+    ): HeadBookmarksFavoriteResult<TVersion, TMethod, TResult> =>
+        client[method](
+            ...generateParameters<TResult, TVersion, TClient>(version, args, init)
+        ) as HeadBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+
+export default verifyBookmarkFavorite;

package/src/bookmarks/favorites/head/generate-endpoint.ts

@@ -0,0 +1,19 @@
+import { ApiVersions, HeadBookmarkFavoriteArgs } from './types';
+
+/**
+ * Method for generating endpoint for getting bookmark by id
+ */
+export const generateEndpoint = <TVersion extends ApiVersions>(
+    version: TVersion,
+    args: HeadBookmarkFavoriteArgs<TVersion>
+) => {
+    switch (version) {
+        case 'v1':
+        default: {
+            const { bookmarkId } = args as { bookmarkId: string };
+            const params = new URLSearchParams();
+            params.append('api-version', version);
+            return `/persons/me/bookmarks/favorites/${bookmarkId}?${String(params)}`;
+        }
+    }
+};

package/src/bookmarks/favorites/head/generate-parameters.ts

@@ -0,0 +1,28 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ApiClientArguments } from '../..';
+import { generateEndpoint } from './generate-endpoint';
+import { ApiVersions, HeadBookmarkFavoriteArgs } from './types';
+
+/** function for creating http client arguments  */
+export const generateParameters = <
+    TResult,
+    TVersion extends ApiVersions,
+    TClient extends IHttpClient = IHttpClient
+>(
+    version: TVersion,
+    args: HeadBookmarkFavoriteArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+): ApiClientArguments<TClient, TResult> => {
+    const path = generateEndpoint(version, args);
+
+    const headers = new Headers();
+    headers.append('content-type', 'application/json');
+
+    const requestParams: ClientRequestInit<TClient, TResult> = Object.assign(
+        {},
+        { method: 'head', headers: headers },
+        init
+    );
+
+    return [path, requestParams];
+};

package/src/bookmarks/favorites/head/index.ts

@@ -0,0 +1,6 @@
+export * from './types';
+
+export { verifyBookmarkFavorite, default } from './client';
+
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';

package/src/bookmarks/favorites/head/types.ts

@@ -0,0 +1,35 @@
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+
+export type HeadBookmarkFavoriteResult<TVersion extends ApiVersions> =
+    HeadBookmarksFavoriteVersions[TVersion]['result'];
+
+export type HeadBookmarkFavoriteArgs<TVersion extends ApiVersions> =
+    HeadBookmarksFavoriteVersions[TVersion]['args'];
+
+export type HeadBookmarksFavoriteResult<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TResult = HeadBookmarkFavoriteResult<TVersion>
+> = ClientMethod<TResult>[TMethod];
+
+export type HeadBookmarkFavoriteFn<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TClient extends IHttpClient = IHttpClient,
+    TResult = HeadBookmarkFavoriteResult<TVersion>
+> = (
+    args: HeadBookmarkFavoriteArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+) => HeadBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+
+export interface HeadBookmarksFavoriteArgsV1 {
+    bookmarkId: string;
+}
+
+export type HeadBookmarksFavoriteVersions = {
+    ['v1']: { args: HeadBookmarksFavoriteArgsV1; result: Response };
+};
+
+export type ApiVersions = keyof HeadBookmarksFavoriteVersions;

package/src/bookmarks/favorites/post/client.ts

@@ -0,0 +1,35 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+import { generateParameters } from './generate-parameters';
+import {
+    ApiVersions,
+    PostBookmarkFavoriteArgs,
+    PostBookmarkFavoriteResult,
+    PostBookmarksFavoriteResult,
+} from './types';
+
+/**
+ * Method for adding other users bookmark to your favorites.
+ * @param client - client for execution of request
+ * @param version - version of API to call
+ * @param method - client method to call
+ */
+export const addBookmarkFavorite =
+    <
+        TVersion extends ApiVersions = ApiVersions,
+        TMethod extends keyof ClientMethod = keyof ClientMethod,
+        TClient extends IHttpClient = IHttpClient
+    >(
+        client: TClient,
+        version: TVersion,
+        method: TMethod = 'json' as TMethod
+    ) =>
+    <TResult = PostBookmarkFavoriteResult<TVersion>>(
+        args: PostBookmarkFavoriteArgs<TVersion>,
+        init?: ClientRequestInit<TClient, TResult>
+    ): PostBookmarksFavoriteResult<TVersion, TMethod, TResult> =>
+        client[method](
+            ...generateParameters<TResult, TVersion, TClient>(version, args, init)
+        ) as PostBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+
+export default addBookmarkFavorite;

package/src/bookmarks/favorites/post/generate-endpoint.ts

@@ -0,0 +1,18 @@
+import { ApiVersions, PostBookmarkFavoriteArgs } from './types';
+
+/**
+ * Method for generating endpoint for getting bookmark by id
+ */
+export const generateEndpoint = <TVersion extends ApiVersions>(
+    version: TVersion,
+    _args: PostBookmarkFavoriteArgs<TVersion>
+) => {
+    switch (version) {
+        case 'v1':
+        default: {
+            const params = new URLSearchParams();
+            params.append('api-version', version);
+            return `/persons/me/bookmarks/favorites?${String(params)}`;
+        }
+    }
+};

package/src/bookmarks/favorites/post/generate-parameters.ts

@@ -0,0 +1,28 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ApiClientArguments } from '../..';
+import { generateEndpoint } from './generate-endpoint';
+import { ApiVersions, PostBookmarkFavoriteArgs } from './types';
+
+/** function for creating http client arguments  */
+export const generateParameters = <
+    TResult,
+    TVersion extends ApiVersions,
+    TClient extends IHttpClient = IHttpClient
+>(
+    version: TVersion,
+    args: PostBookmarkFavoriteArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+): ApiClientArguments<TClient, TResult> => {
+    const path = generateEndpoint(version, args);
+
+    const headers = new Headers();
+    headers.append('content-type', 'application/json');
+
+    const requestParams: ClientRequestInit<TClient, TResult> = Object.assign(
+        {},
+        { method: 'post', body: JSON.stringify(args), headers: headers },
+        init
+    );
+
+    return [path, requestParams];
+};

package/src/bookmarks/favorites/post/index.ts

@@ -0,0 +1,6 @@
+export * from './types';
+
+export { addBookmarkFavorite, default } from './client';
+
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';

package/src/bookmarks/favorites/post/types.ts

@@ -0,0 +1,35 @@
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+
+export type PostBookmarkFavoriteResult<TVersion extends ApiVersions> =
+    PostBookmarksFavoriteVersions[TVersion]['result'];
+
+export type PostBookmarkFavoriteArgs<TVersion extends ApiVersions> =
+    PostBookmarksFavoriteVersions[TVersion]['args'];
+
+export type PostBookmarksFavoriteResult<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TResult = PostBookmarkFavoriteResult<TVersion>
+> = ClientMethod<TResult>[TMethod];
+
+export type PostBookmarkFavoriteFn<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TClient extends IHttpClient = IHttpClient,
+    TResult = PostBookmarkFavoriteResult<TVersion>
+> = (
+    args: PostBookmarkFavoriteArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+) => PostBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+
+export interface PostBookmarksFavoriteArgsV1 {
+    bookmarkId: string;
+}
+
+export type PostBookmarksFavoriteVersions = {
+    ['v1']: { args: PostBookmarksFavoriteArgsV1; result: Response };
+};
+
+export type ApiVersions = keyof PostBookmarksFavoriteVersions;

package/src/notification/api-models.ts

@@ -0,0 +1,70 @@
+import { ApiVersion } from './static';
+
+type ApiNotificationEntity_v1 = {
+    id: string;
+    appKey: string;
+    emailPriority: number;
+    fallbackHtml: string;
+    targetAzureUniqueId: string;
+    title: string;
+    card: string;
+    created: string;
+    createdBy: CreatedBy_v1;
+    createdByApplication: CreatedByApplication_v1;
+    seenByUser: boolean;
+    seen: string;
+    sourceSystem: SourceSystem_v1;
+};
+
+type SourceSystem_v1 = {
+    name: string;
+    subSystem: string;
+    identifier: string;
+};
+
+type CreatedByApplication_v1 = {
+    id: string;
+    title: string;
+};
+
+type CreatedBy_v1 = {
+    id: string;
+    name: string;
+    jobTitle: string;
+    mail: string;
+    accountType: string;
+};
+
+type ApiNotificationEntity_v2 = unknown;
+
+type ApiNotificationEntityTypes = {
+    [ApiVersion.v1]: ApiNotificationEntity_v1;
+    [ApiVersion.v2]: ApiNotificationEntity_v2;
+};
+
+export type ApiNotificationEntity<T extends string = ApiVersion> = T extends ApiVersion
+    ? ApiNotificationEntityTypes[T]
+    : unknown;
+
+/**User notification Settings */
+type ApiNotificationSettingsEntity_v1 = {
+    email: boolean;
+    delayInMinutes: number;
+    appConfig: AppConfig_v1[];
+};
+
+type AppConfig_v1 = {
+    appKey: string;
+    enabled: boolean;
+};
+
+type ApiNotificationSettingsEntity_v2 = unknown;
+
+type ApiNotificationSettingEntityTypes = {
+    [ApiVersion.v1]: ApiNotificationSettingsEntity_v1;
+    [ApiVersion.v2]: ApiNotificationSettingsEntity_v2;
+};
+
+export type ApiNotificationSettingsEntity<T extends string = ApiVersion> = T extends ApiVersion
+    ? ApiNotificationSettingEntityTypes[T]
+    : unknown;