@equinor/fusion-framework-module-services 3.1.5 → 3.2.1

package/dist/types/people/api-models.d.ts

@@ -0,0 +1,34 @@
+import { ApiPerson_v2 } from './api-models.v2';
+import { ApiPerson_v4 } from './api-models.v4';
+import { ApiVersion } from './static';
+export type ApiProjectMaster = {
+    id: string;
+    name?: string;
+};
+export type ApiManager = {
+    azureUniqueId: string;
+    name?: string;
+    mail?: string;
+    department?: string;
+    fullDepartment?: string;
+    upn?: string;
+    jobTitle?: string;
+    accountType: ApiProfileAccountType;
+    accountClassification: ApiAccountClassification;
+};
+export type ApiInvitationStatus = 'Accepted' | 'Pending' | 'NotSent';
+export type ApiProfileAccountType = 'Employee' | 'Consultant' | 'Enterprise' | 'External' | 'External Hire';
+export type ApiAccountClassification = 'Unclassified' | 'Internal' | 'External';
+export type ApiProfileAccountLink = {
+    azureUniqueId: string;
+    mail?: string;
+    isPrimaryAccount?: boolean;
+    preferredContactMail?: string;
+    isExpired?: boolean;
+    upn?: string;
+};
+export type ApiPersonMap = {
+    [ApiVersion.v2]: ApiPerson_v2;
+    [ApiVersion.v4]: ApiPerson_v4;
+};
+export type ApiPerson<T extends keyof typeof ApiVersion | ApiVersion> = T extends ApiVersion ? ApiPersonMap[T] : T extends keyof typeof ApiVersion ? ApiPersonMap[(typeof ApiVersion)[T]] : unknown;

package/dist/types/people/api-models.v2.d.ts

@@ -0,0 +1,25 @@
+import { ApiAccountClassification, ApiInvitationStatus, ApiProfileAccountLink, ApiProfileAccountType } from './api-models';
+export type ApiPerson_v2 = {
+    fusionPersonId?: string;
+    azureUniqueId: string;
+    mail?: string;
+    name?: string;
+    jobTitle?: string;
+    department?: string;
+    fullDepartment?: string;
+    mobilePhone?: string;
+    officeLocation?: string;
+    sapId?: string;
+    employeeId?: string;
+    isResourceOwner?: boolean;
+    isExpired?: boolean;
+    expiredDate?: string;
+    upn?: string;
+    accountType: ApiProfileAccountType;
+    invitationStatus: ApiInvitationStatus;
+    accountClassification: ApiAccountClassification;
+    managerAzureUniqueId: string;
+    linkedAccounts?: Array<ApiProfileAccountLink>;
+    isPrimaryAccount?: boolean;
+    preferredContactMail?: string;
+};

package/dist/types/people/api-models.v4.d.ts

@@ -0,0 +1,81 @@
+import { ApiAccountClassification, ApiInvitationStatus, ApiProfileAccountLink, ApiProfileAccountType, ApiProjectMaster } from './api-models';
+export type ApiPerson_v4 = {
+    azureUniqueId: string;
+    mail?: string;
+    name?: string;
+    jobTitle?: string;
+    department?: string;
+    fullDepartment?: string;
+    mobilePhone?: string;
+    officeLocation?: string;
+    upn?: string;
+    isResourceOwner?: boolean;
+    isExpired?: boolean;
+    expiredDate?: string;
+    isPrimaryAccount?: boolean;
+    preferredContactMail?: string;
+    accountType?: ApiProfileAccountType;
+    invitationStatus?: ApiInvitationStatus;
+    accountClassification?: ApiAccountClassification;
+    managerAzureUniqueId?: string;
+    linkedAccounts?: Array<ApiProfileAccountLink>;
+};
+export type ApiCompanyInfo_v4 = {
+    id: string;
+    name?: string;
+};
+export type ApiPersonRole_v4 = {
+    name?: string;
+    displayName?: string;
+    sourceSystem?: string;
+    type?: string;
+    isActive?: boolean;
+    activeToUtc?: string;
+    onDemandSupport?: boolean;
+    scopes?: Array<ApiPersonRoleScope_v4>;
+};
+export type ApiPersonRoleScope_v4 = {
+    type?: string;
+    values?: string[];
+    valueType?: string;
+};
+export type ApiPersonPosition_v4 = {
+    positionId: string;
+    positionExternalId?: string;
+    id: string;
+    parentPositionId?: string;
+    taskOwnerIds?: string[];
+    name?: string;
+    obs?: string;
+    basePosition: ApiPersonBasePosition_v4;
+    project: ApiPersonProject_v4;
+    appliesFrom: string;
+    appliesTo: string;
+    workload?: number;
+};
+export type ApiPersonBasePosition_v4 = {
+    id: string;
+    name?: string;
+    type?: string;
+    discipline?: string;
+};
+export type ApiPersonProject_v4 = {
+    id: string;
+    name?: string;
+    domainId?: string;
+    type?: string;
+};
+export type ApiPersonContract_v4 = {
+    id: string;
+    name?: string;
+    contractNumber?: string;
+    companyId?: string;
+    companyName?: string;
+    project: ApiPersonProject_v4;
+    projectMaster: ApiProjectMaster;
+    positions: Array<ApiPersonPosition_v4>;
+};
+export type ApiCompanyInfoV4 = {
+    id: string;
+    name?: string;
+};

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

@@ -0,0 +1,15 @@
+import { IHttpClient, ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
+import type { ClientDataMethod, ClientMethod } from '../types';
+import { ApiVersion } from './static';
+import { ApiResponse as PersonDetailApiResponse, ApiResult as PersonDetailResult, SupportedApiVersion as PersonDetailSupportedApiVersion, ApiRequestArgs as PersonDetailApiRequestArgs } from './person-details';
+import { ApiResponse as PersonQueryApiResponse, ApiResult as PersonQueryResult, SupportedApiVersion as PersonQuerySupportedApiVersion, ApiRequestArgs as PersonQueryApiRequestArgs } from './query';
+import { ApiResponse as PersonPhotoApiResponse, ApiResult as PersonPhotoResult, SupportedApiVersion as PersonPhotoSupportedApiVersion, ApiRequestArgs as PersonPhotoApiRequestArgs } from './person-photo';
+export declare class PeopleApiClient<TClient extends IHttpClient = IHttpClient> {
+    protected _client: TClient;
+    get Version(): typeof ApiVersion;
+    constructor(_client: TClient);
+    get<TVersion extends PersonDetailSupportedApiVersion, TArgs extends PersonDetailApiRequestArgs<TVersion>, TResult extends PersonDetailApiResponse<TVersion, TArgs>, TMethod extends keyof ClientMethod<TResult>>(version: TVersion, method: TMethod, args: TArgs, init?: ClientRequestInit<TClient, TResult>): PersonDetailResult<TVersion, TArgs, TMethod, TResult>;
+    query<TVersion extends PersonQuerySupportedApiVersion, TArgs extends PersonQueryApiRequestArgs<TVersion>, TResult = PersonQueryApiResponse<TVersion>, TMethod extends keyof ClientMethod<TResult> = keyof ClientMethod<TResult>>(version: TVersion, method: TMethod, args: TArgs, init?: ClientRequestInit<TClient, TResult>): PersonQueryResult<TVersion, TMethod, TResult>;
+    photo<TVersion extends PersonPhotoSupportedApiVersion, TArgs extends PersonPhotoApiRequestArgs<TVersion>, TResult extends Blob = PersonPhotoApiResponse<TVersion>, TMethod extends keyof ClientDataMethod = keyof ClientDataMethod>(version: TVersion, method: TMethod, args: TArgs, init?: ClientRequestInit<TClient, TResult>): PersonPhotoResult<TMethod>;
+}
+export default PeopleApiClient;

package/dist/types/people/index.d.ts

@@ -0,0 +1,3 @@
+export { PeopleApiClient, default } from './client';
+export { ApiVersion } from './static';
+export * from './api-models';

package/dist/types/people/person-details/client.d.ts

@@ -0,0 +1,5 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod } from '../../types';
+import type { ApiResponse, ApiResult, ApiRequestArgs } from './types';
+export declare const client: <TVersion extends "v4", TMethod extends keyof ClientMethod = keyof ClientMethod, TClient extends IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response> = IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response>, TArgs extends ApiRequestArgs<TVersion> = ApiRequestArgs<TVersion>>(client: TClient, version: TVersion, method?: TMethod) => <T = ApiResponse<TVersion, TArgs>>(args: TArgs, init?: ClientRequestInit<TClient, T> | undefined) => ApiResult<TVersion, TArgs, TMethod, T>;
+export default client;

package/dist/types/people/person-details/generate-endpoint.d.ts

@@ -0,0 +1,2 @@
+import type { ApiRequestArgs } from './types';
+export declare const generateEndpoint: <TVersion extends "v4">(version: TVersion, args: ApiRequestArgs<TVersion>) => string;

package/dist/types/people/person-details/generate-parameters.d.ts

@@ -0,0 +1,5 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ApiClientArguments } from '../../types';
+import type { ApiRequestArgs } from './types';
+export declare const generateParameters: <TResult, TVersion extends "v4", TClient extends IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response> = IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response>>(version: TVersion, args: ApiRequestArgs<TVersion>, init?: ClientRequestInit<TClient, TResult> | undefined) => ApiClientArguments<TClient, TResult>;
+export default generateParameters;

package/dist/types/people/person-details/index.d.ts

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

package/dist/types/people/person-details/types.d.ts

@@ -0,0 +1,30 @@
+import { ApiVersion } from '../static';
+import type { ApiManager } from '../api-models';
+import type { ApiCompanyInfo_v4, ApiPersonContract_v4, ApiPerson_v4, ApiPersonPosition_v4, ApiPersonRole_v4 } from '../api-models.v4';
+import { ClientMethod } from '../../types';
+export type SupportedApiVersion = Extract<keyof typeof ApiVersion, 'v4'>;
+type ApiRequestArgsMap = {
+    [ApiVersion.v4]: {
+        azureId: string;
+        expand?: Array<keyof ExpandMap[ApiVersion.v4]>;
+    };
+};
+export type AllowedArgs = ApiRequestArgsMap[keyof ApiRequestArgsMap];
+type ExpandMap = {
+    [ApiVersion.v4]: {
+        roles: Array<ApiPersonRole_v4>;
+        positions: Array<ApiPersonPosition_v4>;
+        contracts: Array<ApiPersonContract_v4>;
+        manager: ApiManager;
+        companies: Array<ApiCompanyInfo_v4>;
+    };
+};
+export type ApiRequestArgs<T extends SupportedApiVersion> = ApiRequestArgsMap[(typeof ApiVersion)[T]];
+type ApiResponseTypes<TArgs extends AllowedArgs> = {
+    [ApiVersion.v4]: TArgs['expand'] extends Array<keyof ExpandMap[ApiVersion.v4]> ? ApiPerson_v4 & {
+        [K in TArgs['expand'][number]]: ExpandMap[ApiVersion.v4][K];
+    } : ApiPerson_v4;
+};
+export type ApiResponse<T extends SupportedApiVersion, TArgs extends AllowedArgs> = ApiResponseTypes<TArgs>[(typeof ApiVersion)[T]];
+export type ApiResult<TVersion extends SupportedApiVersion, TArgs extends ApiRequestArgs<TVersion>, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = ApiResponse<TVersion, TArgs>> = ClientMethod<TResult>[TMethod];
+export {};

package/dist/types/people/person-photo/client.d.ts

@@ -0,0 +1,5 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientDataMethod } from '../../types';
+import type { ApiResponse, ApiRequestArgs } from './types';
+export declare const client: <TVersion extends "v2", TMethod extends keyof ClientDataMethod = keyof ClientDataMethod, TClient extends IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response> = IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response>, TArgs extends ApiRequestArgs<TVersion> = ApiRequestArgs<TVersion>>(client: TClient, version: TVersion, method?: TMethod) => <T extends Blob = ApiResponse<TVersion>>(args: TArgs, init?: ClientRequestInit<TClient, T> | undefined) => ClientDataMethod[TMethod];
+export default client;

package/dist/types/people/person-photo/generate-endpoint.d.ts

@@ -0,0 +1,2 @@
+import type { ApiRequestArgs } from './types';
+export declare const generateEndpoint: <TVersion extends "v2">(version: TVersion, args: ApiRequestArgs<TVersion>) => string;

package/dist/types/people/person-photo/generate-parameters.d.ts

@@ -0,0 +1,5 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ApiClientArguments } from '../../types';
+import type { ApiRequestArgs } from './types';
+export declare const generateParameters: <TResult, TVersion extends "v2", TClient extends IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response> = IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response>>(version: TVersion, args: ApiRequestArgs<TVersion>, init?: ClientRequestInit<TClient, TResult> | undefined) => ApiClientArguments<TClient, TResult>;
+export default generateParameters;

package/dist/types/people/person-photo/index.d.ts

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

package/dist/types/people/person-photo/types.d.ts

@@ -0,0 +1,16 @@
+import { ApiVersion } from '../static';
+import { ClientDataMethod } from '../../types';
+export type SupportedApiVersion = Extract<keyof typeof ApiVersion, 'v2'>;
+type ApiRequestArgsMap = {
+    [ApiVersion.v2]: {
+        azureId: string;
+    };
+};
+export type AllowedArgs = ApiRequestArgsMap[keyof ApiRequestArgsMap];
+export type ApiRequestArgs<T extends SupportedApiVersion> = ApiRequestArgsMap[(typeof ApiVersion)[T]];
+type ApiResponseTypes = {
+    [ApiVersion.v2]: Blob;
+};
+export type ApiResponse<T extends SupportedApiVersion> = ApiResponseTypes[(typeof ApiVersion)[T]];
+export type ApiResult<TMethod extends keyof ClientDataMethod = keyof ClientDataMethod> = ClientDataMethod[TMethod];
+export {};

package/dist/types/people/query/client.d.ts

@@ -0,0 +1,5 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod } from '../../types';
+import type { ApiResponse, ApiResult, ApiRequestArgs } from './types';
+export declare const client: <TVersion extends "v2", TMethod extends keyof ClientMethod = keyof ClientMethod, TClient extends IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response> = IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response>, TArgs extends ApiRequestArgs<TVersion> = ApiRequestArgs<TVersion>>(client: TClient, version: TVersion, method?: TMethod) => <T = ApiResponse<TVersion>>(args: TArgs, init?: ClientRequestInit<TClient, T> | undefined) => ApiResult<TVersion, TMethod, T>;
+export default client;

package/dist/types/people/query/generate-endpoint.d.ts

@@ -0,0 +1,2 @@
+import type { ApiRequestArgs } from './types';
+export declare const generateEndpoint: <TVersion extends "v2">(version: TVersion, args: ApiRequestArgs<TVersion>) => string;

package/dist/types/people/query/generate-parameters.d.ts

@@ -0,0 +1,5 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ApiClientArguments } from '../../types';
+import type { ApiRequestArgs } from './types';
+export declare const generateParameters: <TResult, TVersion extends "v2", TClient extends IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response> = IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response>>(version: TVersion, args: ApiRequestArgs<TVersion>, init?: ClientRequestInit<TClient, TResult> | undefined) => ApiClientArguments<TClient, TResult>;
+export default generateParameters;

package/dist/types/people/query/index.d.ts

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

package/dist/types/people/query/types.d.ts

@@ -0,0 +1,17 @@
+import { ApiVersion } from '../static';
+import { ApiPerson_v2 } from '../api-models.v2';
+import { ClientMethod } from '../../types';
+export type SupportedApiVersion = Extract<keyof typeof ApiVersion, 'v2'>;
+type ApiRequestArgsMap = {
+    [ApiVersion.v2]: {
+        search: string;
+    };
+};
+export type AllowedArgs = ApiRequestArgsMap[keyof ApiRequestArgsMap];
+export type ApiRequestArgs<T extends SupportedApiVersion> = ApiRequestArgsMap[(typeof ApiVersion)[T]];
+type ApiResponseTypes = {
+    [ApiVersion.v2]: Array<ApiPerson_v2>;
+};
+export type ApiResponse<T extends SupportedApiVersion> = ApiResponseTypes[(typeof ApiVersion)[T]];
+export type ApiResult<TVersion extends SupportedApiVersion, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = ApiResponse<TVersion>> = ClientMethod<TResult>[TMethod];
+export {};

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

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

package/dist/types/provider.d.ts

@@ -4,10 +4,12 @@ import { ApiClientFactory } from './types';
 import { ContextApiClient } from './context';
 import BookmarksApiClient from './bookmarks/client';
 import { NotificationApiClient } from './notification';
+import { PeopleApiClient } from './people/client';
 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>>;
     createNotificationClient<TMethod extends keyof ClientMethod>(method: TMethod): Promise<NotificationApiClient<TMethod, TClient>>;
+    createPeopleClient(): Promise<PeopleApiClient<TClient>>;
 }
 type ApiProviderCtorArgs<TClient extends IHttpClient = IHttpClient> = {
     createClient: ApiClientFactory<TClient>;
@@ -30,5 +32,6 @@ export declare class ApiProvider<TClient extends IHttpClient = IHttpClient> impl
     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>>;
+    createPeopleClient(): Promise<PeopleApiClient<TClient>>;
 }
 export {};

package/dist/types/types.d.ts

@@ -10,4 +10,8 @@ export type ClientMethod<T = unknown> = {
     fetch$: StreamResponse<FetchResponse<T>>;
     json$: StreamResponse<T>;
 };
+export type ClientDataMethod = {
+    blob: Blob;
+    blob$: StreamResponse<Blob>;
+};
 export type ClientMethodType = keyof ClientMethod;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "3.1.5";
+export declare const version = "3.2.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-services",
-  "version": "3.1.5",
+  "version": "3.2.1",
   "description": "",
   "sideEffects": false,
   "main": "dist/esm/index.js",
@@ -25,6 +25,18 @@
       "context/related": [
         "dist/types/context/related/index"
       ],
+      "people": [
+        "dist/types/people/index"
+      ],
+      "people/get": [
+        "dist/types/people/person-details/index"
+      ],
+      "people/query": [
+        "dist/types/people/query/index"
+      ],
+      "people/photo": [
+        "dist/types/people/person-photo/index"
+      ],
       "bookmarks": [
         "dist/types/bookmarks/index"
       ]
@@ -36,6 +48,10 @@
     "./bookmark": "./dist/esm/bookmarks/index.js",
     "./notification": "./dist/esm/notification/index.js",
     "./context/get": "./dist/esm/context/get-context/index.js",
+    "./people": "./dist/esm/people/index.js",
+    "./people/get": "./dist/esm/people/person-details/index.js",
+    "./people/query": "./dist/esm/people/query/index.js",
+    "./people/photo": "./dist/esm/people/person-photo/index.js",
     "./errors": "./dist/esm/errors.js",
     "./package.json": "./package.json"
   },
@@ -55,13 +71,13 @@
   },
   "devDependencies": {
     "typescript": "^5.1.3",
-    "@equinor/fusion-framework-module": "^4.2.4",
-    "@equinor/fusion-framework-module-http": "^5.0.6",
-    "@equinor/fusion-framework-module-service-discovery": "^7.0.8"
+    "@equinor/fusion-framework-module": "^4.2.5",
+    "@equinor/fusion-framework-module-http": "^5.1.1",
+    "@equinor/fusion-framework-module-service-discovery": "^7.0.11"
   },
   "peerDependencies": {
     "odata-query": "^7.0.4",
-    "@equinor/fusion-framework-module": "^4.2.4"
+    "@equinor/fusion-framework-module": "^4.2.5"
   },
   "scripts": {
     "build": "tsc -b"

package/src/people/api-models.ts

@@ -0,0 +1,52 @@
+import { ApiPerson_v2 } from './api-models.v2';
+import { ApiPerson_v4 } from './api-models.v4';
+import { ApiVersion } from './static';
+
+export type ApiProjectMaster = {
+    id: string;
+    name?: string;
+};
+
+export type ApiManager = {
+    azureUniqueId: string;
+    name?: string;
+    mail?: string;
+    department?: string;
+    fullDepartment?: string;
+    upn?: string;
+    jobTitle?: string;
+    accountType: ApiProfileAccountType;
+    accountClassification: ApiAccountClassification;
+};
+
+export type ApiInvitationStatus = 'Accepted' | 'Pending' | 'NotSent';
+
+export type ApiProfileAccountType =
+    | 'Employee'
+    | 'Consultant'
+    | 'Enterprise'
+    | 'External'
+    | 'External Hire';
+
+// TODO what are these?
+export type ApiAccountClassification = 'Unclassified' | 'Internal' | 'External';
+
+export type ApiProfileAccountLink = {
+    azureUniqueId: string;
+    mail?: string;
+    isPrimaryAccount?: boolean;
+    preferredContactMail?: string;
+    isExpired?: boolean;
+    upn?: string;
+};
+
+export type ApiPersonMap = {
+    [ApiVersion.v2]: ApiPerson_v2;
+    [ApiVersion.v4]: ApiPerson_v4;
+};
+
+export type ApiPerson<T extends keyof typeof ApiVersion | ApiVersion> = T extends ApiVersion
+    ? ApiPersonMap[T]
+    : T extends keyof typeof ApiVersion
+    ? ApiPersonMap[(typeof ApiVersion)[T]]
+    : unknown;

package/src/people/api-models.v2.ts

@@ -0,0 +1,31 @@
+import {
+    ApiAccountClassification,
+    ApiInvitationStatus,
+    ApiProfileAccountLink,
+    ApiProfileAccountType,
+} from './api-models';
+
+export type ApiPerson_v2 = {
+    fusionPersonId?: string;
+    azureUniqueId: string;
+    mail?: string;
+    name?: string;
+    jobTitle?: string;
+    department?: string;
+    fullDepartment?: string;
+    mobilePhone?: string;
+    officeLocation?: string;
+    sapId?: string;
+    employeeId?: string;
+    isResourceOwner?: boolean;
+    isExpired?: boolean;
+    expiredDate?: string;
+    upn?: string;
+    accountType: ApiProfileAccountType;
+    invitationStatus: ApiInvitationStatus;
+    accountClassification: ApiAccountClassification;
+    managerAzureUniqueId: string;
+    linkedAccounts?: Array<ApiProfileAccountLink>;
+    isPrimaryAccount?: boolean;
+    preferredContactMail?: string;
+};

package/src/people/api-models.v4.ts

@@ -0,0 +1,100 @@
+import {
+    ApiAccountClassification,
+    ApiInvitationStatus,
+    ApiProfileAccountLink,
+    ApiProfileAccountType,
+    ApiProjectMaster,
+} from './api-models';
+
+export type ApiPerson_v4 = {
+    azureUniqueId: string;
+    mail?: string;
+    name?: string;
+    jobTitle?: string;
+    department?: string;
+    fullDepartment?: string;
+    mobilePhone?: string;
+    officeLocation?: string;
+    upn?: string;
+    isResourceOwner?: boolean;
+    isExpired?: boolean;
+    expiredDate?: string;
+    isPrimaryAccount?: boolean;
+    preferredContactMail?: string;
+    accountType?: ApiProfileAccountType;
+
+    // TODO is this default
+    invitationStatus?: ApiInvitationStatus;
+    accountClassification?: ApiAccountClassification;
+    managerAzureUniqueId?: string;
+
+    // TODO is this default
+    linkedAccounts?: Array<ApiProfileAccountLink>;
+};
+
+export type ApiCompanyInfo_v4 = {
+    id: string;
+    name?: string;
+};
+
+export type ApiPersonRole_v4 = {
+    name?: string;
+    displayName?: string;
+    sourceSystem?: string;
+    type?: string;
+    isActive?: boolean;
+    activeToUtc?: string;
+    onDemandSupport?: boolean;
+    scopes?: Array<ApiPersonRoleScope_v4>;
+};
+
+export type ApiPersonRoleScope_v4 = {
+    type?: string;
+    values?: string[];
+    valueType?: string;
+};
+
+export type ApiPersonPosition_v4 = {
+    positionId: string;
+    positionExternalId?: string;
+    id: string;
+    parentPositionId?: string;
+    taskOwnerIds?: string[];
+    name?: string;
+    obs?: string;
+    basePosition: ApiPersonBasePosition_v4;
+    project: ApiPersonProject_v4;
+    appliesFrom: string;
+    appliesTo: string;
+    workload?: number;
+};
+
+export type ApiPersonBasePosition_v4 = {
+    id: string;
+    name?: string;
+    type?: string;
+    discipline?: string;
+};
+
+export type ApiPersonProject_v4 = {
+    id: string;
+    name?: string;
+    domainId?: string;
+    type?: string;
+};
+
+export type ApiPersonContract_v4 = {
+    id: string;
+    name?: string;
+    contractNumber?: string;
+    companyId?: string;
+    companyName?: string;
+    project: ApiPersonProject_v4;
+    projectMaster: ApiProjectMaster;
+    positions: Array<ApiPersonPosition_v4>;
+};
+
+export type ApiCompanyInfoV4 = {
+    id: string;
+    name?: string;
+};