@equinor/fusion-services 0.2.0

package/dist/types/roles/endpoints/claimable-roles.get.d.ts

@@ -0,0 +1,199 @@
+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 `listClaimableRoles` accepts for `GET /claimable-roles`.
+ *
+ * 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 ListClaimableRolesArg} and {@link ListClaimableRolesResponse}.
+ */
+type ListClaimableRolesVersion = FilterAllowedApiVersions<AvailableVersions>;
+/**
+ * Version contract for `listClaimableRoles`, implementing `GET /claimable-roles`.
+ *
+ * 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<{
+            top: z.ZodOptional<z.ZodNumber>;
+            skip: z.ZodOptional<z.ZodNumber>;
+            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;
+                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;
+            } & {
+                createdBy?: {
+                    azureUniqueId?: string | null | undefined;
+                    mail?: string | null | undefined;
+                    displayName?: string | undefined;
+                    upn?: string | null | undefined;
+                    accountType?: string | undefined;
+                    accountClassification?: string | null | undefined;
+                } | undefined;
+                createdDate?: string | undefined;
+                updatedBy?: {
+                    azureUniqueId?: string | null | undefined;
+                    mail?: string | null | undefined;
+                    displayName?: string | undefined;
+                    upn?: string | null | undefined;
+                    accountType?: string | undefined;
+                    accountClassification?: string | null | undefined;
+                } | null | undefined;
+                updatedDate?: string | null | undefined;
+            }, unknown, z.core.$ZodTypeInternals<{
+                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;
+            } & {
+                createdBy?: {
+                    azureUniqueId?: string | null | undefined;
+                    mail?: string | null | undefined;
+                    displayName?: string | undefined;
+                    upn?: string | null | undefined;
+                    accountType?: string | undefined;
+                    accountClassification?: string | null | undefined;
+                } | undefined;
+                createdDate?: string | undefined;
+                updatedBy?: {
+                    azureUniqueId?: string | null | undefined;
+                    mail?: string | null | undefined;
+                    displayName?: string | undefined;
+                    upn?: string | null | undefined;
+                    accountType?: string | undefined;
+                    accountClassification?: string | null | undefined;
+                } | null | undefined;
+                updatedDate?: string | null | undefined;
+            }, unknown>>>>;
+        }, z.core.$strip>;
+    };
+};
+/**
+ * Response body `listClaimableRoles` resolves for the selected API version.
+ *
+ * Version 1.0 resolves to `ApiPagedCollectionV1<ApiClaimableRoleV1>`, inferred from
+ * `apiPagedCollectionSchemaV1(ApiClaimableRoleSchemaV1)` — the very schema that validates the
+ * `200 OK` body at runtime.
+ */
+type ListClaimableRolesResponse<TVersion extends ListClaimableRolesVersion> = VersionedResponse<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * Arguments `listClaimableRoles` accepts, resolved from the selected API version.
+ *
+ * Version 1.0 accepts the optional query options `top`, `skip`, `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 ListClaimableRolesArg<TVersion extends ListClaimableRolesVersion> = VersionedArgs<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * What `listClaimableRoles` hands back once the request runs, for the selected API version and
+ * client method.
+ *
+ * `'json'` gives `Promise<ListClaimableRolesResponse<TVersion>>` and `'json$'` gives
+ * `StreamResponse<ListClaimableRolesResponse<TVersion>>`, so promise and observable callers
+ * share one response type.
+ */
+type ListClaimableRolesResult<TVersion extends ListClaimableRolesVersion, TMethod extends ClientMethodType = 'json'> = ClientMethod<ListClaimableRolesResponse<TVersion>>[TMethod];
+/**
+ * Lists the claimable roles published by the Roles service.
+ *
+ * Roles V2 operation: `GET /claimable-roles` — "Get all claimable roles."
+ *
+ * Curried in two stages: `listClaimableRoles(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 ListClaimableRolesArg} plus an optional `ClientRequestInit`, and gives back
+ * {@link ListClaimableRolesResult}.
+ *
+ * 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(ApiClaimableRoleSchemaV1)`, 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); and `expand` is sent as `$expand` to inline related resources.
+ *
+ * Roles V2 answers `200 OK`; the body is typed `ApiPagedCollectionV1<ApiClaimableRoleV1>`.
+ *
+ * Related: `getClaimableRole` fetches a single entry, and `assignClaimableRole` makes one
+ * claimable by a user or application account.
+ *
+ * @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 ListClaimableRolesArg} and an optional
+ * `ClientRequestInit`, returning {@link ListClaimableRolesResult}.
+ * @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 { listClaimableRoles } from '@equinor/fusion-services/roles';
+ *
+ * const page = await listClaimableRoles('v1', httpClient)({ top: 25 });
+ * ```
+ *
+ * @example
+ * Observable form: pass `json$` to receive a `StreamResponse` instead of a promise.
+ * ```ts
+ * listClaimableRoles('v1', httpClient, 'json$')({ top: 25 }).subscribe(console.log);
+ * ```
+ */
+declare const listClaimableRoles: <TVersion extends ListClaimableRolesVersion, TMethod extends ClientMethodType = 'json'>(version: TVersion, client: IHttpClient, method?: TMethod) => (input?: ListClaimableRolesArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, ListClaimableRolesResponse<ExtractApiVersion<TVersion>>>) => ListClaimableRolesResult<ExtractApiVersion<TVersion>, TMethod>;
+export { type ListClaimableRolesArg, type ListClaimableRolesResponse, type ListClaimableRolesResult, type ListClaimableRolesVersion, listClaimableRoles, };

package/dist/types/roles/endpoints/claimable-roles.post.d.ts

@@ -0,0 +1,150 @@
+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 `createClaimableRole` accepts for `POST /claimable-roles`.
+ *
+ * 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 CreateClaimableRoleArg} and {@link CreateClaimableRoleResponse}.
+ */
+type CreateClaimableRoleVersion = FilterAllowedApiVersions<AvailableVersions>;
+/**
+ * Version contract for `createClaimableRole`, implementing `POST /claimable-roles`.
+ *
+ * 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<{
+            name: z.ZodOptional<z.ZodString>;
+            displayName: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            systemIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            accessRoleMappings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                accessRoleIdentifier: z.ZodOptional<z.ZodString>;
+                reason: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>;
+        /** Response published by version 1.0 of this operation. */
+        readonly response: z.ZodIntersection<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.ZodObject<{
+            createdBy: 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>>;
+            createdDate: z.ZodOptional<z.ZodString>;
+            updatedBy: z.ZodOptional<z.ZodNullable<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>>>;
+            updatedDate: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strip>>;
+    };
+};
+/**
+ * Response body `createClaimableRole` resolves for the selected API version.
+ *
+ * Version 1.0 resolves to `ApiClaimableRoleV1`, inferred from `ApiClaimableRoleSchemaV1` — the
+ * very schema that validates the `201 Created` body at runtime.
+ */
+type CreateClaimableRoleResponse<TVersion extends CreateClaimableRoleVersion> = VersionedResponse<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * Arguments `createClaimableRole` accepts, resolved from the selected API version.
+ *
+ * Version 1.0 accepts the request body fields of `CreateClaimableRoleRequestV1`.
+ *
+ * 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 CreateClaimableRoleArg<TVersion extends CreateClaimableRoleVersion> = VersionedArgs<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * What `createClaimableRole` hands back once the request runs, for the selected API version and
+ * client method.
+ *
+ * `'json'` gives `Promise<CreateClaimableRoleResponse<TVersion>>` and `'json$'` gives
+ * `StreamResponse<CreateClaimableRoleResponse<TVersion>>`, so promise and observable callers
+ * share one response type.
+ */
+type CreateClaimableRoleResult<TVersion extends CreateClaimableRoleVersion, TMethod extends ClientMethodType = 'json'> = ClientMethod<CreateClaimableRoleResponse<TVersion>>[TMethod];
+/**
+ * Creates a claimable role: a role an account can be granted and then claim on demand for a
+ * limited period.
+ *
+ * Roles V2 operation: `POST /claimable-roles` — "Create a new claimable role."
+ *
+ * Curried in two stages: `createClaimableRole(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 CreateClaimableRoleArg} plus an optional `ClientRequestInit`, and gives back
+ * {@link CreateClaimableRoleResult}.
+ *
+ * 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
+ * `ApiClaimableRoleSchemaV1`, and sends `api-version=1.0` on the request.
+ *
+ * Roles V2 answers `201 Created`; the body is typed `ApiClaimableRoleV1`. 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 CreateClaimableRoleArg} and an optional
+ * `ClientRequestInit`, returning {@link CreateClaimableRoleResult}.
+ * @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 { createClaimableRole } from '@equinor/fusion-services/roles';
+ *
+ * const claimableRole = await createClaimableRole('v1', httpClient)({
+ *   name: 'on-call-approver',
+ *   displayName: 'On-call approver',
+ *   systemIdentifier: 'fusion-core',
+ * });
+ * ```
+ */
+declare const createClaimableRole: <TVersion extends CreateClaimableRoleVersion, TMethod extends ClientMethodType = 'json'>(version: TVersion, client: IHttpClient, method?: TMethod) => (input?: CreateClaimableRoleArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, CreateClaimableRoleResponse<ExtractApiVersion<TVersion>>>) => CreateClaimableRoleResult<ExtractApiVersion<TVersion>, TMethod>;
+export { type CreateClaimableRoleArg, type CreateClaimableRoleResponse, type CreateClaimableRoleResult, type CreateClaimableRoleVersion, createClaimableRole, };

package/dist/types/roles/endpoints/public-schema.get.d.ts

@@ -0,0 +1,98 @@
+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 `getPublicSchema` accepts for `GET /public/schemas/{type}`.
+ *
+ * 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 GetPublicSchemaArg} and {@link GetPublicSchemaResponse}.
+ */
+type GetPublicSchemaVersion = FilterAllowedApiVersions<AvailableVersions>;
+/**
+ * Version contract for `getPublicSchema`, implementing `GET /public/schemas/{type}`.
+ *
+ * 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<{
+            type: z.ZodString;
+        }, z.core.$strip>;
+        /** Response published by version 1.0. The upstream spec does not publish a response schema. */
+        readonly response: z.ZodUnknown;
+    };
+};
+/**
+ * Response body `getPublicSchema` resolves for the selected API version.
+ *
+ * Version 1.0 publishes no response schema in the OpenAPI contract, so the type resolves to
+ * `unknown`.
+ */
+type GetPublicSchemaResponse<TVersion extends GetPublicSchemaVersion> = VersionedResponse<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * Arguments `getPublicSchema` accepts, resolved from the selected API version.
+ *
+ * Version 1.0 accepts the path identifier `type`.
+ *
+ * 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 GetPublicSchemaArg<TVersion extends GetPublicSchemaVersion> = VersionedArgs<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * What `getPublicSchema` hands back once the request runs, for the selected API version and
+ * client method.
+ *
+ * `'json'` gives `Promise<GetPublicSchemaResponse<TVersion>>` and `'json$'` gives
+ * `StreamResponse<GetPublicSchemaResponse<TVersion>>`, so promise and observable callers share
+ * one response type.
+ */
+type GetPublicSchemaResult<TVersion extends GetPublicSchemaVersion, TMethod extends ClientMethodType = 'json'> = ClientMethod<GetPublicSchemaResponse<TVersion>>[TMethod];
+/**
+ * Fetches a published JSON Schema document from the Roles service's public schema catalogue.
+ *
+ * Roles V2 operation: `GET /public/schemas/{type}` — "Returns a JSON schema for the specified
+ * type."
+ *
+ * Curried in two stages: `getPublicSchema(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 GetPublicSchemaArg} plus an optional `ClientRequestInit`, and gives back
+ * {@link GetPublicSchemaResult}.
+ *
+ * The version argument is the single discriminator: `'v1'` — equivalently `'1.0'` or
+ * `ApiVersion.v1` — selects the version-1.0 argument schema, passes the response body through
+ * unvalidated (the contract publishes no response schema), and sends `api-version=1.0` on the
+ * request.
+ *
+ * Roles V2 answers `200 OK`; the contract publishes no response schema, so the body is typed
+ * `unknown`.
+ *
+ * @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 GetPublicSchemaArg} and an optional
+ * `ClientRequestInit`, returning {@link GetPublicSchemaResult}.
+ * @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 { getPublicSchema } from '@equinor/fusion-services/roles';
+ *
+ * const schema = await getPublicSchema('v1', httpClient)({ type: 'role-config.schema.json' });
+ * ```
+ */
+declare const getPublicSchema: <TVersion extends GetPublicSchemaVersion, TMethod extends ClientMethodType = 'json'>(version: TVersion, client: IHttpClient, method?: TMethod) => (input: GetPublicSchemaArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, GetPublicSchemaResponse<ExtractApiVersion<TVersion>>>) => GetPublicSchemaResult<ExtractApiVersion<TVersion>, TMethod>;
+export { type GetPublicSchemaArg, type GetPublicSchemaResponse, type GetPublicSchemaResult, type GetPublicSchemaVersion, getPublicSchema, };

package/dist/types/roles/endpoints/role-access-role.delete.d.ts

@@ -0,0 +1,104 @@
+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 `deleteRoleAccessRole` accepts for
+ * `DELETE /roles/{roleIdentifier}/access-roles/{accessRoleIdentifier}`.
+ *
+ * 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 DeleteRoleAccessRoleArg} and {@link DeleteRoleAccessRoleResponse}.
+ */
+type DeleteRoleAccessRoleVersion = FilterAllowedApiVersions<AvailableVersions>;
+/**
+ * Version contract for `deleteRoleAccessRole`, implementing
+ * `DELETE /roles/{roleIdentifier}/access-roles/{accessRoleIdentifier}`.
+ *
+ * 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<{
+            roleIdentifier: z.ZodString;
+            accessRoleIdentifier: z.ZodString;
+        }, z.core.$strip>;
+        /** Response published by version 1.0. The operation answers `204 No Content`. */
+        readonly response: z.ZodVoid;
+    };
+};
+/**
+ * Response body `deleteRoleAccessRole` resolves for the selected API version.
+ *
+ * Version 1.0 answers `204 No Content` without a body, so the type resolves to `void`.
+ */
+type DeleteRoleAccessRoleResponse<TVersion extends DeleteRoleAccessRoleVersion> = VersionedResponse<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * Arguments `deleteRoleAccessRole` accepts, resolved from the selected API version.
+ *
+ * Version 1.0 accepts the path identifiers `roleIdentifier`, `accessRoleIdentifier`.
+ *
+ * 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 DeleteRoleAccessRoleArg<TVersion extends DeleteRoleAccessRoleVersion> = VersionedArgs<typeof VersionContract, ExtractApiVersion<TVersion>>;
+/**
+ * What `deleteRoleAccessRole` hands back once the request runs, for the selected API version
+ * and client method.
+ *
+ * `'json'` gives `Promise<DeleteRoleAccessRoleResponse<TVersion>>` and `'json$'` gives
+ * `StreamResponse<DeleteRoleAccessRoleResponse<TVersion>>`, so promise and observable callers
+ * share one response type.
+ */
+type DeleteRoleAccessRoleResult<TVersion extends DeleteRoleAccessRoleVersion, TMethod extends ClientMethodType = 'json'> = ClientMethod<DeleteRoleAccessRoleResponse<TVersion>>[TMethod];
+/**
+ * Removes one access role mapping from a role.
+ *
+ * Roles V2 operation: `DELETE /roles/{roleIdentifier}/access-roles/{accessRoleIdentifier}` —
+ * "Delete an access role from a role"
+ *
+ * Curried in two stages: `deleteRoleAccessRole(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 DeleteRoleAccessRoleArg} plus an optional `ClientRequestInit`, and gives back
+ * {@link DeleteRoleAccessRoleResult}.
+ *
+ * The version argument is the single discriminator: `'v1'` — equivalently `'1.0'` or
+ * `ApiVersion.v1` — selects the version-1.0 argument schema, expects the empty success body,
+ * and sends `api-version=1.0` on the request.
+ *
+ * Destructive: it removes the access role mapping permanently, and the deletion cannot be
+ * undone through this API. Roles V2 answers `204 No Content` with no body, so the resolved
+ * value is `void`. 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 DeleteRoleAccessRoleArg} and an optional
+ * `ClientRequestInit`, returning {@link DeleteRoleAccessRoleResult}.
+ * @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 { deleteRoleAccessRole } from '@equinor/fusion-services/roles';
+ *
+ * await deleteRoleAccessRole('v1', httpClient)({
+ *   roleIdentifier: 'reader',
+ *   accessRoleIdentifier: 'writer',
+ * });
+ * ```
+ */
+declare const deleteRoleAccessRole: <TVersion extends DeleteRoleAccessRoleVersion, TMethod extends ClientMethodType = 'json'>(version: TVersion, client: IHttpClient, method?: TMethod) => (input: DeleteRoleAccessRoleArg<ExtractApiVersion<TVersion>>, init?: ClientRequestInit<IHttpClient, DeleteRoleAccessRoleResponse<ExtractApiVersion<TVersion>>>) => DeleteRoleAccessRoleResult<ExtractApiVersion<TVersion>, TMethod>;
+export { type DeleteRoleAccessRoleArg, type DeleteRoleAccessRoleResponse, type DeleteRoleAccessRoleResult, type DeleteRoleAccessRoleVersion, deleteRoleAccessRole, };