liferay-headless-rest-client/dist/clients/scim-v1.0/sdk.gen.d.ts

A collection of Headless Clients used in Liferay Portal

import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeleteV2GroupData, DeleteV2GroupResponses, GetV2GroupByIdData, GetV2GroupByIdResponses, PatchV2GroupData, PatchV2GroupResponses, PutV2GroupData, PutV2GroupResponses, GetV2GroupsData, GetV2GroupsResponses, PostV2GroupData, PostV2GroupResponses, PostV2GroupSearchData, PostV2GroupSearchResponses, GetV2ResourceTypeByIdData, GetV2ResourceTypeByIdResponses, GetV2ResourceTypesData, GetV2ResourceTypesResponses, GetV2SchemaByIdData, GetV2SchemaByIdResponses, GetV2SchemasData, GetV2SchemasResponses, GetV2ServiceProviderConfigData, GetV2ServiceProviderConfigResponses, DeleteV2UserData, DeleteV2UserResponses, GetV2UserByIdData, GetV2UserByIdResponses, PatchV2UserData, PatchV2UserResponses, PutV2UserData, PutV2UserResponses, GetV2UsersData, GetV2UsersResponses, PostV2UserData, PostV2UserResponses, PostV2UserSearchData, PostV2UserSearchResponses } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
    /**
     * You can provide a client instance returned by `createClient()` instead of
     * individual options. This might be also useful if you want to implement a
     * custom client.
     */
    client?: Client;
    /**
     * You can pass arbitrary values through the `meta` object. This can be
     * used to access values that aren't defined as part of the SDK function.
     */
    meta?: Record<string, unknown>;
};
/**
 * Deletes a group.
 */
export declare const deleteV2Group: <ThrowOnError extends boolean = false>(options: Options<DeleteV2GroupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteV2GroupResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves a group.
 */
export declare const getV2GroupById: <ThrowOnError extends boolean = false>(options: Options<GetV2GroupByIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2GroupByIdResponses, unknown, ThrowOnError, "fields">;
/**
 * Updates a group.
 */
export declare const patchV2Group: <ThrowOnError extends boolean = false>(options: Options<PatchV2GroupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchV2GroupResponses, unknown, ThrowOnError, "fields">;
/**
 * Updates a group.
 */
export declare const putV2Group: <ThrowOnError extends boolean = false>(options: Options<PutV2GroupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutV2GroupResponses, unknown, ThrowOnError, "fields">;
/**
 * Lists groups.
 */
export declare const getV2Groups: <ThrowOnError extends boolean = false>(options?: Options<GetV2GroupsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2GroupsResponses, unknown, ThrowOnError, "fields">;
/**
 * Creates a group.
 */
export declare const postV2Group: <ThrowOnError extends boolean = false>(options?: Options<PostV2GroupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostV2GroupResponses, unknown, ThrowOnError, "fields">;
/**
 * Query groups.
 */
export declare const postV2GroupSearch: <ThrowOnError extends boolean = false>(options?: Options<PostV2GroupSearchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostV2GroupSearchResponses, unknown, ThrowOnError, "fields">;
export declare const getV2ResourceTypeById: <ThrowOnError extends boolean = false>(options: Options<GetV2ResourceTypeByIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2ResourceTypeByIdResponses, unknown, ThrowOnError, "fields">;
/**
 * To discover the types of resources available on a SCIM service provider.
 */
export declare const getV2ResourceTypes: <ThrowOnError extends boolean = false>(options?: Options<GetV2ResourceTypesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2ResourceTypesResponses, unknown, ThrowOnError, "fields">;
export declare const getV2SchemaById: <ThrowOnError extends boolean = false>(options: Options<GetV2SchemaByIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2SchemaByIdResponses, unknown, ThrowOnError, "fields">;
/**
 * Lists schemas.
 */
export declare const getV2Schemas: <ThrowOnError extends boolean = false>(options?: Options<GetV2SchemasData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2SchemasResponses, unknown, ThrowOnError, "fields">;
/**
 * Gives serviceProviderConfig info.
 */
export declare const getV2ServiceProviderConfig: <ThrowOnError extends boolean = false>(options?: Options<GetV2ServiceProviderConfigData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2ServiceProviderConfigResponses, unknown, ThrowOnError, "fields">;
/**
 * Deletes a user.
 */
export declare const deleteV2User: <ThrowOnError extends boolean = false>(options: Options<DeleteV2UserData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteV2UserResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves a user.
 */
export declare const getV2UserById: <ThrowOnError extends boolean = false>(options: Options<GetV2UserByIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2UserByIdResponses, unknown, ThrowOnError, "fields">;
/**
 * Updates a user.
 */
export declare const patchV2User: <ThrowOnError extends boolean = false>(options: Options<PatchV2UserData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchV2UserResponses, unknown, ThrowOnError, "fields">;
/**
 * Updates a user.
 */
export declare const putV2User: <ThrowOnError extends boolean = false>(options: Options<PutV2UserData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutV2UserResponses, unknown, ThrowOnError, "fields">;
/**
 * Lists users.
 */
export declare const getV2Users: <ThrowOnError extends boolean = false>(options?: Options<GetV2UsersData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetV2UsersResponses, unknown, ThrowOnError, "fields">;
/**
 * Creates a user.
 */
export declare const postV2User: <ThrowOnError extends boolean = false>(options?: Options<PostV2UserData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostV2UserResponses, unknown, ThrowOnError, "fields">;
/**
 * Query users.
 */
export declare const postV2UserSearch: <ThrowOnError extends boolean = false>(options?: Options<PostV2UserSearchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostV2UserSearchResponses, unknown, ThrowOnError, "fields">;