@equinor/fusion-services 0.2.0

package/dist/types/roles/endpoints/system-access-role-assignment.patch.d.ts

@@ -0,0 +1,186 @@
+import { z } from 'zod';
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod, ClientMethodType, ExtractApiVersion, FilterAllowedApiVersions, VersionedArgs, VersionedResponse } from '../types';
+import { ApiVersion } from '../static';
+/** Concrete API versions this operation publishes. */
+type AvailableVersions = ApiVersion.v1;
+/**
+ * API version identifiers `updateSystemAccessRoleAssignment` accepts for
+ * `PATCH /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments/{accessRoleAssignmentId}`.
+ *
+ * Roles V2 publishes version 1.0 of this operation, nameable as `'v1'`, `'1.0'`, or
+ * `ApiVersion.v1`. All three resolve to the same contract entry, so all three infer the same
+ * {@link UpdateSystemAccessRoleAssignmentArg} and
+ * {@link UpdateSystemAccessRoleAssignmentResponse}.
+ */
+type UpdateSystemAccessRoleAssignmentVersion = FilterAllowedApiVersions<AvailableVersions>;
+/**
+ * Version contract for `updateSystemAccessRoleAssignment`, implementing
+ * `PATCH /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments/{accessRoleAssignmentId}`.
+ *
+ * Each concrete {@link ApiVersion} maps to the argument and response schemas that
+ * version publishes, so the version a caller passes is the single discriminator
+ * for the request shape, the request path, and the response shape.
+ */
+declare const VersionContract: {
+    readonly "1.0": {
+        /** Arguments accepted by version 1.0 of this operation. */
+        readonly args: z.ZodObject<{
+            validTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            systemIdentifier: z.ZodString;
+            accessRoleIdentifier: z.ZodString;
+            accessRoleAssignmentId: z.ZodString;
+        }, z.core.$strip>;
+        /** Response published by version 1.0 of this operation. */
+        readonly response: z.ZodObject<{
+            id: z.ZodOptional<z.ZodString>;
+            assignedTo: z.ZodOptional<z.ZodObject<{
+                azureUniqueId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                mail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                displayName: z.ZodOptional<z.ZodString>;
+                upn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                accountType: z.ZodOptional<z.ZodString>;
+                accountClassification: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            }, z.core.$strip>>;
+            reason: z.ZodOptional<z.ZodString>;
+            source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            externalIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            type: z.ZodOptional<z.ZodString>;
+            scope: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                isGlobal: z.ZodBoolean;
+                value: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>>;
+            validFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            validTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            isActive: z.ZodOptional<z.ZodBoolean>;
+            tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            accessRole: z.ZodOptional<z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                name: z.ZodOptional<z.ZodString>;
+                description: z.ZodOptional<z.ZodString>;
+                scopeType: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    name: z.ZodOptional<z.ZodString>;
+                    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                }, z.core.$strip>>>;
+            }, z.core.$strip>>;
+            roleAssignment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                role: z.ZodOptional<z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    name: z.ZodOptional<z.ZodString>;
+                    displayName: z.ZodOptional<z.ZodString>;
+                    description: z.ZodOptional<z.ZodString>;
+                    system: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                        id: z.ZodOptional<z.ZodString>;
+                        name: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strip>>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>>;
+            claimableRoleAssignment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                claimableRole: z.ZodOptional<z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    name: z.ZodOptional<z.ZodString>;
+                    displayName: z.ZodOptional<z.ZodString>;
+                    description: z.ZodOptional<z.ZodString>;
+                    accessRoleMappings: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+                        accessRole: z.ZodOptional<z.ZodObject<{
+                            id: z.ZodOptional<z.ZodString>;
+                            name: z.ZodOptional<z.ZodString>;
+                            description: z.ZodOptional<z.ZodString>;
+                            scopeType: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                                id: z.ZodOptional<z.ZodString>;
+                                name: z.ZodOptional<z.ZodString>;
+                                description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                            }, z.core.$strip>>>;
+                        }, z.core.$strip>>;
+                        reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    }, z.core.$strip>>>>;
+                    system: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                        id: z.ZodOptional<z.ZodString>;
+                        name: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strip>>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>;
+    };
+};
+/**
+ * Response body `updateSystemAccessRoleAssignment` resolves for the selected API version.
+ *
+ * Version 1.0 resolves to `ApiAccessRoleAssignmentV1`, inferred from
+ * `ApiAccessRoleAssignmentSchemaV1` — the very schema that validates the `200 OK` body at
+ * runtime.
+ */
+type UpdateSystemAccessRoleAssignmentResponse<TVersion extends UpdateSystemAccessRoleAssignmentVersion> = VersionedResponse<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * Arguments `updateSystemAccessRoleAssignment` accepts, resolved from the selected API version.
+ *
+ * Version 1.0 accepts the path identifiers `systemIdentifier`, `accessRoleIdentifier`,
+ * `accessRoleAssignmentId`, and the request body fields of
+ * `UpdateAccessRoleAssignmentRequestV1`.
+ *
+ * Path identifiers and body fields share one flat object; the endpoint separates them when it
+ * builds the request. The value is parsed by the version's Zod argument schema before anything
+ * is sent.
+ */
+type UpdateSystemAccessRoleAssignmentArg<TVersion extends UpdateSystemAccessRoleAssignmentVersion> = VersionedArgs<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * What `updateSystemAccessRoleAssignment` hands back once the request runs, for the selected
+ * API version and client method.
+ *
+ * `'json'` gives `Promise<UpdateSystemAccessRoleAssignmentResponse<TVersion>>` and `'json$'`
+ * gives `StreamResponse<UpdateSystemAccessRoleAssignmentResponse<TVersion>>`, so promise and
+ * observable callers share one response type.
+ */
+type UpdateSystemAccessRoleAssignmentResult<TVersion extends UpdateSystemAccessRoleAssignmentVersion, TMethod extends ClientMethodType = 'json'> = ClientMethod<UpdateSystemAccessRoleAssignmentResponse<TVersion>>[TMethod];
+/**
+ * Extends or shortens a system access role assignment by updating its `validTo` date.
+ *
+ * Roles V2 operation:
+ * `PATCH /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments/{accessRoleAssignmentId}`
+ * — "Update an access role assignment's valid to date."
+ *
+ * Curried in two stages: `updateSystemAccessRoleAssignment(version, client, method)` binds the
+ * API version, the `IHttpClient` that reaches the Roles service, and the execution method —
+ * `'json'` for a promise, `'json$'` for an observable stream. The returned function takes
+ * {@link UpdateSystemAccessRoleAssignmentArg} plus an optional `ClientRequestInit`, and gives
+ * back {@link UpdateSystemAccessRoleAssignmentResult}.
+ *
+ * The version argument is the single discriminator: `'v1'` — equivalently `'1.0'` or
+ * `ApiVersion.v1` — selects the version-1.0 argument schema, validates the response with
+ * `ApiAccessRoleAssignmentSchemaV1`, and sends `api-version=1.0` on the request.
+ *
+ * Roles V2 answers `200 OK`; the body is typed `ApiAccessRoleAssignmentV1`. Fields left out of
+ * the arguments are not sent, so they keep their stored values. The contract declares `403
+ * Forbidden` for callers the Roles service does not authorise for this operation.
+ *
+ * @template TVersion - Roles API version identifier: `'v1'`, `'1.0'`, or `ApiVersion.v1`.
+ * @template TMethod - Execution method: `'json'` for a promise, `'json$'` for an observable.
+ * @param version - API version selecting the request path, the argument schema, and the
+ * response schema.
+ * @param client - HTTP client that executes the request against the Roles service.
+ * @param method - Execution method, defaulting to `'json'`.
+ * @returns A request function taking {@link UpdateSystemAccessRoleAssignmentArg} and an
+ * optional `ClientRequestInit`, returning {@link UpdateSystemAccessRoleAssignmentResult}.
+ * @throws {Error} When `version` names an API version this operation does not publish. The
+ * check runs while binding, before the HTTP client is used.
+ * @throws {z.ZodError} From the returned function, when the arguments fail this version's
+ * argument schema or the response body fails its response schema.
+ *
+ * @example
+ * ```ts
+ * import { updateSystemAccessRoleAssignment } from '@equinor/fusion-services/roles';
+ *
+ * const assignment = await updateSystemAccessRoleAssignment('v1', httpClient)({
+ *   systemIdentifier: 'fusion-core',
+ *   accessRoleIdentifier: 'writer',
+ *   accessRoleAssignmentId: '4d2c9a71-5e6f-4b80-9c12-3a4b5c6d7e8f',
+ *   validTo: '2026-06-30T23:59:59Z',
+ * });
+ * ```
+ */
+declare const updateSystemAccessRoleAssignment: <TVersion extends UpdateSystemAccessRoleAssignmentVersion, TMethod extends ClientMethodType = 'json'>(version: TVersion, client: IHttpClient, method?: TMethod) => (input: UpdateSystemAccessRoleAssignmentArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, UpdateSystemAccessRoleAssignmentResponse<ExtractApiVersion<TVersion>>>) => UpdateSystemAccessRoleAssignmentResult<ExtractApiVersion<TVersion>, TMethod>;
+export { type UpdateSystemAccessRoleAssignmentArg, type UpdateSystemAccessRoleAssignmentResponse, type UpdateSystemAccessRoleAssignmentResult, type UpdateSystemAccessRoleAssignmentVersion, updateSystemAccessRoleAssignment, };

package/dist/types/roles/endpoints/system-access-role-assignments.get.d.ts

@@ -0,0 +1,267 @@
+import { z } from 'zod';
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod, ClientMethodType, ExtractApiVersion, FilterAllowedApiVersions, VersionedArgs, VersionedResponse } from '../types';
+import { ApiVersion } from '../static';
+/** Concrete API versions this operation publishes. */
+type AvailableVersions = ApiVersion.v1;
+/**
+ * API version identifiers `listSystemAccessRoleAssignments` accepts for
+ * `GET /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments`.
+ *
+ * Roles V2 publishes version 1.0 of this operation, nameable as `'v1'`, `'1.0'`, or
+ * `ApiVersion.v1`. All three resolve to the same contract entry, so all three infer the same
+ * {@link ListSystemAccessRoleAssignmentsArg} and
+ * {@link ListSystemAccessRoleAssignmentsResponse}.
+ */
+type ListSystemAccessRoleAssignmentsVersion = FilterAllowedApiVersions<AvailableVersions>;
+/**
+ * Version contract for `listSystemAccessRoleAssignments`, implementing
+ * `GET /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments`.
+ *
+ * Each concrete {@link ApiVersion} maps to the argument and response schemas that
+ * version publishes, so the version a caller passes is the single discriminator
+ * for the request shape, the request path, and the response shape.
+ */
+declare const VersionContract: {
+    readonly "1.0": {
+        /** Arguments accepted by version 1.0 of this operation. */
+        readonly args: z.ZodObject<{
+            systemIdentifier: z.ZodString;
+            accessRoleIdentifier: z.ZodString;
+            top: z.ZodOptional<z.ZodNumber>;
+            skip: z.ZodOptional<z.ZodNumber>;
+            filter: z.ZodOptional<z.ZodString>;
+            expand: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        /** Response published by version 1.0 of this operation. */
+        readonly response: z.ZodObject<{
+            totalCount: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+            count: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+            nextPage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            prevPage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            value: z.ZodOptional<z.ZodArray<z.ZodType<{
+                id?: string | undefined;
+                assignedTo?: {
+                    azureUniqueId?: string | null | undefined;
+                    mail?: string | null | undefined;
+                    displayName?: string | undefined;
+                    upn?: string | null | undefined;
+                    accountType?: string | undefined;
+                    accountClassification?: string | null | undefined;
+                } | undefined;
+                reason?: string | undefined;
+                source?: string | null | undefined;
+                externalIdentifier?: string | null | undefined;
+                type?: string | undefined;
+                scope?: {
+                    type?: string | null | undefined;
+                    isGlobal: boolean;
+                    value: string | null;
+                } | null | undefined;
+                validFrom?: string | null | undefined;
+                validTo?: string | null | undefined;
+                isActive?: boolean | undefined;
+                tags?: string[] | undefined;
+                accessRole?: {
+                    id?: string | undefined;
+                    name?: string | undefined;
+                    description?: string | undefined;
+                    scopeType?: {
+                        id?: string | undefined;
+                        name?: string | undefined;
+                        description?: string | null | undefined;
+                    } | null | undefined;
+                } | undefined;
+                roleAssignment?: {
+                    id?: string | undefined;
+                    role?: {
+                        id?: string | undefined;
+                        name?: string | undefined;
+                        displayName?: string | undefined;
+                        description?: string | undefined;
+                        system?: {
+                            id?: string | undefined;
+                            name?: string | undefined;
+                        } | null | undefined;
+                    } | undefined;
+                } | null | undefined;
+                claimableRoleAssignment?: {
+                    id?: string | undefined;
+                    claimableRole?: {
+                        id?: string | undefined;
+                        name?: string | undefined;
+                        displayName?: string | undefined;
+                        description?: string | undefined;
+                        accessRoleMappings?: {
+                            accessRole?: {
+                                id?: string | undefined;
+                                name?: string | undefined;
+                                description?: string | undefined;
+                                scopeType?: {
+                                    id?: string | undefined;
+                                    name?: string | undefined;
+                                    description?: string | null | undefined;
+                                } | null | undefined;
+                            } | undefined;
+                            reason?: string | null | undefined;
+                        }[] | null | undefined;
+                        system?: {
+                            id?: string | undefined;
+                            name?: string | undefined;
+                        } | null | undefined;
+                    } | undefined;
+                } | null | undefined;
+            }, unknown, z.core.$ZodTypeInternals<{
+                id?: string | undefined;
+                assignedTo?: {
+                    azureUniqueId?: string | null | undefined;
+                    mail?: string | null | undefined;
+                    displayName?: string | undefined;
+                    upn?: string | null | undefined;
+                    accountType?: string | undefined;
+                    accountClassification?: string | null | undefined;
+                } | undefined;
+                reason?: string | undefined;
+                source?: string | null | undefined;
+                externalIdentifier?: string | null | undefined;
+                type?: string | undefined;
+                scope?: {
+                    type?: string | null | undefined;
+                    isGlobal: boolean;
+                    value: string | null;
+                } | null | undefined;
+                validFrom?: string | null | undefined;
+                validTo?: string | null | undefined;
+                isActive?: boolean | undefined;
+                tags?: string[] | undefined;
+                accessRole?: {
+                    id?: string | undefined;
+                    name?: string | undefined;
+                    description?: string | undefined;
+                    scopeType?: {
+                        id?: string | undefined;
+                        name?: string | undefined;
+                        description?: string | null | undefined;
+                    } | null | undefined;
+                } | undefined;
+                roleAssignment?: {
+                    id?: string | undefined;
+                    role?: {
+                        id?: string | undefined;
+                        name?: string | undefined;
+                        displayName?: string | undefined;
+                        description?: string | undefined;
+                        system?: {
+                            id?: string | undefined;
+                            name?: string | undefined;
+                        } | null | undefined;
+                    } | undefined;
+                } | null | undefined;
+                claimableRoleAssignment?: {
+                    id?: string | undefined;
+                    claimableRole?: {
+                        id?: string | undefined;
+                        name?: string | undefined;
+                        displayName?: string | undefined;
+                        description?: string | undefined;
+                        accessRoleMappings?: {
+                            accessRole?: {
+                                id?: string | undefined;
+                                name?: string | undefined;
+                                description?: string | undefined;
+                                scopeType?: {
+                                    id?: string | undefined;
+                                    name?: string | undefined;
+                                    description?: string | null | undefined;
+                                } | null | undefined;
+                            } | undefined;
+                            reason?: string | null | undefined;
+                        }[] | null | undefined;
+                        system?: {
+                            id?: string | undefined;
+                            name?: string | undefined;
+                        } | null | undefined;
+                    } | undefined;
+                } | null | undefined;
+            }, unknown>>>>;
+        }, z.core.$strip>;
+    };
+};
+/**
+ * Response body `listSystemAccessRoleAssignments` resolves for the selected API version.
+ *
+ * Version 1.0 resolves to `ApiPagedCollectionV1<ApiAccessRoleAssignmentV1>`, inferred from
+ * `apiPagedCollectionSchemaV1(ApiAccessRoleAssignmentSchemaV1)` — the very schema that
+ * validates the `200 OK` body at runtime.
+ */
+type ListSystemAccessRoleAssignmentsResponse<TVersion extends ListSystemAccessRoleAssignmentsVersion> = VersionedResponse<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * Arguments `listSystemAccessRoleAssignments` accepts, resolved from the selected API version.
+ *
+ * Version 1.0 accepts the path identifiers `systemIdentifier`, `accessRoleIdentifier`, and the
+ * optional query options `top`, `skip`, `filter`, `expand`.
+ *
+ * The value is parsed by the version's Zod argument schema before the request path is built, so
+ * defaults and range checks apply up front.
+ */
+type ListSystemAccessRoleAssignmentsArg<TVersion extends ListSystemAccessRoleAssignmentsVersion> = VersionedArgs<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * What `listSystemAccessRoleAssignments` hands back once the request runs, for the selected API
+ * version and client method.
+ *
+ * `'json'` gives `Promise<ListSystemAccessRoleAssignmentsResponse<TVersion>>` and `'json$'`
+ * gives `StreamResponse<ListSystemAccessRoleAssignmentsResponse<TVersion>>`, so promise and
+ * observable callers share one response type.
+ */
+type ListSystemAccessRoleAssignmentsResult<TVersion extends ListSystemAccessRoleAssignmentsVersion, TMethod extends ClientMethodType = 'json'> = ClientMethod<ListSystemAccessRoleAssignmentsResponse<TVersion>>[TMethod];
+/**
+ * Lists the assignments of one system access role.
+ *
+ * Roles V2 operation:
+ * `GET /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments` — "Get all
+ * access role assignments for an access role."
+ *
+ * Curried in two stages: `listSystemAccessRoleAssignments(version, client, method)` binds the
+ * API version, the `IHttpClient` that reaches the Roles service, and the execution method —
+ * `'json'` for a promise, `'json$'` for an observable stream. The returned function takes
+ * {@link ListSystemAccessRoleAssignmentsArg} plus an optional `ClientRequestInit`, and gives
+ * back {@link ListSystemAccessRoleAssignmentsResult}.
+ *
+ * The version argument is the single discriminator: `'v1'` — equivalently `'1.0'` or
+ * `ApiVersion.v1` — selects the version-1.0 argument schema, validates the response with
+ * `apiPagedCollectionSchemaV1(ApiAccessRoleAssignmentSchemaV1)`, and sends `api-version=1.0` on
+ * the request.
+ *
+ * Query options: `top` and `skip` page the collection as `$top` and `$skip` (`top` accepts
+ * 0–100); `filter` is sent as an OData `$filter` expression; and `expand` is sent as `$expand`
+ * to inline related resources.
+ *
+ * Roles V2 answers `200 OK`; the body is typed
+ * `ApiPagedCollectionV1<ApiAccessRoleAssignmentV1>`.
+ *
+ * @template TVersion - Roles API version identifier: `'v1'`, `'1.0'`, or `ApiVersion.v1`.
+ * @template TMethod - Execution method: `'json'` for a promise, `'json$'` for an observable.
+ * @param version - API version selecting the request path, the argument schema, and the
+ * response schema.
+ * @param client - HTTP client that executes the request against the Roles service.
+ * @param method - Execution method, defaulting to `'json'`.
+ * @returns A request function taking {@link ListSystemAccessRoleAssignmentsArg} and an optional
+ * `ClientRequestInit`, returning {@link ListSystemAccessRoleAssignmentsResult}.
+ * @throws {Error} When `version` names an API version this operation does not publish. The
+ * check runs while binding, before the HTTP client is used.
+ * @throws {z.ZodError} From the returned function, when the arguments fail this version's
+ * argument schema or the response body fails its response schema.
+ *
+ * @example
+ * ```ts
+ * import { listSystemAccessRoleAssignments } from '@equinor/fusion-services/roles';
+ *
+ * const page = await listSystemAccessRoleAssignments('v1', httpClient)({
+ *   systemIdentifier: 'fusion-core',
+ *   accessRoleIdentifier: 'writer',
+ *   top: 25,
+ * });
+ * ```
+ */
+declare const listSystemAccessRoleAssignments: <TVersion extends ListSystemAccessRoleAssignmentsVersion, TMethod extends ClientMethodType = 'json'>(version: TVersion, client: IHttpClient, method?: TMethod) => (input: ListSystemAccessRoleAssignmentsArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, ListSystemAccessRoleAssignmentsResponse<ExtractApiVersion<TVersion>>>) => ListSystemAccessRoleAssignmentsResult<ExtractApiVersion<TVersion>, TMethod>;
+export { type ListSystemAccessRoleAssignmentsArg, type ListSystemAccessRoleAssignmentsResponse, type ListSystemAccessRoleAssignmentsResult, type ListSystemAccessRoleAssignmentsVersion, listSystemAccessRoleAssignments, };

package/dist/types/roles/endpoints/system-access-role-assignments.post.d.ts

@@ -0,0 +1,194 @@
+import { z } from 'zod';
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod, ClientMethodType, ExtractApiVersion, FilterAllowedApiVersions, VersionedArgs, VersionedResponse } from '../types';
+import { ApiVersion } from '../static';
+/** Concrete API versions this operation publishes. */
+type AvailableVersions = ApiVersion.v1;
+/**
+ * API version identifiers `assignSystemAccessRole` accepts for
+ * `POST /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments`.
+ *
+ * Roles V2 publishes version 1.0 of this operation, nameable as `'v1'`, `'1.0'`, or
+ * `ApiVersion.v1`. All three resolve to the same contract entry, so all three infer the same
+ * {@link AssignSystemAccessRoleArg} and {@link AssignSystemAccessRoleResponse}.
+ */
+type AssignSystemAccessRoleVersion = FilterAllowedApiVersions<AvailableVersions>;
+/**
+ * Version contract for `assignSystemAccessRole`, implementing
+ * `POST /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments`.
+ *
+ * Each concrete {@link ApiVersion} maps to the argument and response schemas that
+ * version publishes, so the version a caller passes is the single discriminator
+ * for the request shape, the request path, and the response shape.
+ */
+declare const VersionContract: {
+    readonly "1.0": {
+        /** Arguments accepted by version 1.0 of this operation. */
+        readonly args: z.ZodObject<{
+            accountIdentifier: z.ZodOptional<z.ZodString>;
+            reason: z.ZodOptional<z.ZodString>;
+            source: z.ZodOptional<z.ZodString>;
+            externalIdentifier: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            scope: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                isGlobal: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+                value: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            }, z.core.$strip>>>;
+            validFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            validTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            tags: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+            systemIdentifier: z.ZodString;
+            accessRoleIdentifier: z.ZodString;
+        }, z.core.$strip>;
+        /** Response published by version 1.0 of this operation. */
+        readonly response: z.ZodObject<{
+            id: z.ZodOptional<z.ZodString>;
+            assignedTo: z.ZodOptional<z.ZodObject<{
+                azureUniqueId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                mail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                displayName: z.ZodOptional<z.ZodString>;
+                upn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                accountType: z.ZodOptional<z.ZodString>;
+                accountClassification: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            }, z.core.$strip>>;
+            reason: z.ZodOptional<z.ZodString>;
+            source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            externalIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            type: z.ZodOptional<z.ZodString>;
+            scope: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                isGlobal: z.ZodBoolean;
+                value: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>>;
+            validFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            validTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            isActive: z.ZodOptional<z.ZodBoolean>;
+            tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            accessRole: z.ZodOptional<z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                name: z.ZodOptional<z.ZodString>;
+                description: z.ZodOptional<z.ZodString>;
+                scopeType: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    name: z.ZodOptional<z.ZodString>;
+                    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                }, z.core.$strip>>>;
+            }, z.core.$strip>>;
+            roleAssignment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                role: z.ZodOptional<z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    name: z.ZodOptional<z.ZodString>;
+                    displayName: z.ZodOptional<z.ZodString>;
+                    description: z.ZodOptional<z.ZodString>;
+                    system: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                        id: z.ZodOptional<z.ZodString>;
+                        name: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strip>>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>>;
+            claimableRoleAssignment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                claimableRole: z.ZodOptional<z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    name: z.ZodOptional<z.ZodString>;
+                    displayName: z.ZodOptional<z.ZodString>;
+                    description: z.ZodOptional<z.ZodString>;
+                    accessRoleMappings: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+                        accessRole: z.ZodOptional<z.ZodObject<{
+                            id: z.ZodOptional<z.ZodString>;
+                            name: z.ZodOptional<z.ZodString>;
+                            description: z.ZodOptional<z.ZodString>;
+                            scopeType: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                                id: z.ZodOptional<z.ZodString>;
+                                name: z.ZodOptional<z.ZodString>;
+                                description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                            }, z.core.$strip>>>;
+                        }, z.core.$strip>>;
+                        reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    }, z.core.$strip>>>>;
+                    system: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                        id: z.ZodOptional<z.ZodString>;
+                        name: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strip>>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>;
+    };
+};
+/**
+ * Response body `assignSystemAccessRole` resolves for the selected API version.
+ *
+ * Version 1.0 resolves to `ApiAccessRoleAssignmentV1`, inferred from
+ * `ApiAccessRoleAssignmentSchemaV1` — the very schema that validates the `201 Created` body at
+ * runtime.
+ */
+type AssignSystemAccessRoleResponse<TVersion extends AssignSystemAccessRoleVersion> = VersionedResponse<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * Arguments `assignSystemAccessRole` accepts, resolved from the selected API version.
+ *
+ * Version 1.0 accepts the path identifiers `systemIdentifier`, `accessRoleIdentifier`, and the
+ * request body fields of `AssignAccessRoleRequestV1`.
+ *
+ * Path identifiers and body fields share one flat object; the endpoint separates them when it
+ * builds the request. The value is parsed by the version's Zod argument schema before anything
+ * is sent.
+ */
+type AssignSystemAccessRoleArg<TVersion extends AssignSystemAccessRoleVersion> = VersionedArgs<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * What `assignSystemAccessRole` hands back once the request runs, for the selected API version
+ * and client method.
+ *
+ * `'json'` gives `Promise<AssignSystemAccessRoleResponse<TVersion>>` and `'json$'` gives
+ * `StreamResponse<AssignSystemAccessRoleResponse<TVersion>>`, so promise and observable callers
+ * share one response type.
+ */
+type AssignSystemAccessRoleResult<TVersion extends AssignSystemAccessRoleVersion, TMethod extends ClientMethodType = 'json'> = ClientMethod<AssignSystemAccessRoleResponse<TVersion>>[TMethod];
+/**
+ * Assigns a system access role directly to a user or application, without routing through a
+ * role.
+ *
+ * Roles V2 operation:
+ * `POST /systems/{systemIdentifier}/access-roles/{accessRoleIdentifier}/assignments` — "Assign
+ * an access role to a user or application."
+ *
+ * Curried in two stages: `assignSystemAccessRole(version, client, method)` binds the API
+ * version, the `IHttpClient` that reaches the Roles service, and the execution method —
+ * `'json'` for a promise, `'json$'` for an observable stream. The returned function takes
+ * {@link AssignSystemAccessRoleArg} plus an optional `ClientRequestInit`, and gives back
+ * {@link AssignSystemAccessRoleResult}.
+ *
+ * The version argument is the single discriminator: `'v1'` — equivalently `'1.0'` or
+ * `ApiVersion.v1` — selects the version-1.0 argument schema, validates the response with
+ * `ApiAccessRoleAssignmentSchemaV1`, and sends `api-version=1.0` on the request.
+ *
+ * Roles V2 answers `201 Created`; the body is typed `ApiAccessRoleAssignmentV1`. The contract
+ * declares `403 Forbidden` for callers the Roles service does not authorise for this operation.
+ *
+ * @template TVersion - Roles API version identifier: `'v1'`, `'1.0'`, or `ApiVersion.v1`.
+ * @template TMethod - Execution method: `'json'` for a promise, `'json$'` for an observable.
+ * @param version - API version selecting the request path, the argument schema, and the
+ * response schema.
+ * @param client - HTTP client that executes the request against the Roles service.
+ * @param method - Execution method, defaulting to `'json'`.
+ * @returns A request function taking {@link AssignSystemAccessRoleArg} and an optional
+ * `ClientRequestInit`, returning {@link AssignSystemAccessRoleResult}.
+ * @throws {Error} When `version` names an API version this operation does not publish. The
+ * check runs while binding, before the HTTP client is used.
+ * @throws {z.ZodError} From the returned function, when the arguments fail this version's
+ * argument schema or the response body fails its response schema.
+ *
+ * @example
+ * ```ts
+ * import { assignSystemAccessRole } from '@equinor/fusion-services/roles';
+ *
+ * const assignment = await assignSystemAccessRole('v1', httpClient)({
+ *   systemIdentifier: 'fusion-core',
+ *   accessRoleIdentifier: 'writer',
+ *   accountIdentifier: 'user@equinor.com',
+ * });
+ * ```
+ */
+declare const assignSystemAccessRole: <TVersion extends AssignSystemAccessRoleVersion, TMethod extends ClientMethodType = 'json'>(version: TVersion, client: IHttpClient, method?: TMethod) => (input: AssignSystemAccessRoleArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, AssignSystemAccessRoleResponse<ExtractApiVersion<TVersion>>>) => AssignSystemAccessRoleResult<ExtractApiVersion<TVersion>, TMethod>;
+export { type AssignSystemAccessRoleArg, type AssignSystemAccessRoleResponse, type AssignSystemAccessRoleResult, type AssignSystemAccessRoleVersion, assignSystemAccessRole, };