keycloak-api 0.2.5 → 1.0.0

package/dist/account/components.d.mts

@@ -0,0 +1,796 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @type object
+*/
+type OrganizationRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    id?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    name?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    alias?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    description?: string | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    enabled?: boolean | undefined;
+    /**
+     * @type array | undefined
+    */
+    domains?: string[] | undefined;
+};
+/**
+ * @type object
+*/
+type GroupRepresentation = {
+    /**
+     * @type object | undefined
+    */
+    access?: {
+        [key: string]: unknown;
+    } | undefined;
+    /**
+     * @type object | undefined
+    */
+    attributes?: {
+        [key: string]: unknown;
+    } | undefined;
+    /**
+     * @type object | undefined
+    */
+    clientRoles?: {
+        [key: string]: unknown;
+    } | undefined;
+    /**
+     * @type string | undefined
+    */
+    id?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    name?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    path?: string | undefined;
+    /**
+     * @type array | undefined
+    */
+    realmRoles?: string[] | undefined;
+    /**
+     * @type array | undefined
+    */
+    subGroups?: GroupRepresentation[] | undefined;
+};
+/**
+ * @type object
+*/
+type ConsentScopeRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    id?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    name?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    displayText?: string | undefined;
+};
+/**
+ * @type object
+*/
+type ConsentRepresentation = {
+    /**
+     * @type number | undefined
+    */
+    createdDate?: number | undefined;
+    /**
+     * @type number | undefined
+    */
+    lastUpdatedDate?: number | undefined;
+    /**
+     * @type array | undefined
+    */
+    grantedScopes?: ConsentScopeRepresentation[] | undefined;
+};
+/**
+ * @type object
+*/
+type ClientRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    clientId?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    clientName?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    description?: string | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    userConsentRequired?: boolean | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    inUse?: boolean | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    offlineAccess?: boolean | undefined;
+    /**
+     * @type string | undefined
+    */
+    rootUrl?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    baseUrl?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    effectiveUrl?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    logoUri?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    policyUri?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    tosUri?: string | undefined;
+    /**
+     * @type object | undefined
+    */
+    consent?: ConsentRepresentation | undefined;
+};
+/**
+ * @type object
+*/
+type LinkedAccountRepresentation = {
+    /**
+     * @type boolean | undefined
+    */
+    connected?: boolean | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    social?: boolean | undefined;
+    /**
+     * @type string | undefined
+    */
+    providerAlias?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    providerName?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    displayName?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    linkedUsername?: string | undefined;
+};
+/**
+ * @type object
+*/
+type AccountLinkUriRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    accountLinkUri?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    nonce?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    hash?: string | undefined;
+};
+/**
+ * @type object
+*/
+type UserProfileMetadataAttributeRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    name?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    displayName?: string | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    required?: boolean | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    readOnly?: boolean | undefined;
+    /**
+     * @type object | undefined
+    */
+    validators?: object | undefined;
+};
+/**
+ * @type object
+*/
+type UserProfileMetadataRepresentation = {
+    /**
+     * @type array | undefined
+    */
+    attributes?: UserProfileMetadataAttributeRepresentation[] | undefined;
+};
+/**
+ * @type object
+*/
+type UserProfileAttributesRepresentation = {
+    /**
+     * @type array | undefined
+    */
+    locale?: string[] | undefined;
+};
+/**
+ * @type object
+*/
+type AccountRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    id?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    username?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    firstName?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    lastName?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    email?: string | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    emailVerified?: boolean | undefined;
+    /**
+     * @type object | undefined
+    */
+    userProfileMetadata?: UserProfileMetadataRepresentation | undefined;
+    /**
+     * @type object | undefined
+    */
+    attributes?: UserProfileAttributesRepresentation | undefined;
+};
+/**
+ * @type object
+*/
+type CredentialMetadataRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    id?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    type?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    userLabel?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    createdDate?: string | undefined;
+    /**
+     * @type object | undefined
+    */
+    credentialData?: object | undefined;
+};
+/**
+ * @type object
+*/
+type UserCredentialMetadataRepresentation = {
+    /**
+     * @type object | undefined
+    */
+    credential?: CredentialMetadataRepresentation | undefined;
+};
+/**
+ * @type object
+*/
+type CredentialRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    type?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    category?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    displayName?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    helpText?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    iconCssClass?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    updateAction?: string | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    removeable?: boolean | undefined;
+    /**
+     * @type array | undefined
+    */
+    userCredentialMetadatas?: UserCredentialMetadataRepresentation[] | undefined;
+};
+/**
+ * @type object
+*/
+type SessionRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    id?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    ipAddress?: string | undefined;
+    /**
+     * @type number | undefined
+    */
+    started?: number | undefined;
+    /**
+     * @type number | undefined
+    */
+    lastAccess?: number | undefined;
+    /**
+     * @type number | undefined
+    */
+    expires?: number | undefined;
+    /**
+     * @type string | undefined
+    */
+    browser?: string | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    current?: boolean | undefined;
+    /**
+     * @type array | undefined
+    */
+    clients?: ClientRepresentation[] | undefined;
+};
+/**
+ * @type object
+*/
+type DeviceRepresentation = {
+    /**
+     * @type string | undefined
+    */
+    id?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    ipAddress?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    os?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    osVersion?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    browser?: string | undefined;
+    /**
+     * @type string | undefined
+    */
+    device?: string | undefined;
+    /**
+     * @type number | undefined
+    */
+    lastAccess?: number | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    current?: boolean | undefined;
+    /**
+     * @type boolean | undefined
+    */
+    mobile?: boolean | undefined;
+    /**
+     * @type array | undefined
+    */
+    sessions?: SessionRepresentation[] | undefined;
+};
+/**
+ * @type object
+*/
+type UpdateAccountData = AccountRepresentation;
+/**
+ * @type array
+*/
+type GetApplicationsStatus200 = ClientRepresentation[];
+/**
+ * @type array
+*/
+type GetCredentialsStatus200 = CredentialRepresentation[];
+/**
+ * @type string | undefined
+*/
+type UpdateCredentialLabelData = string | undefined;
+/**
+ * @type array
+*/
+type GetSessionsStatus200 = SessionRepresentation[];
+/**
+ * @type array
+*/
+type GetDevicesStatus200 = DeviceRepresentation[];
+/**
+ * @type array
+*/
+type GetLinkedAccountsStatus200 = LinkedAccountRepresentation[];
+/**
+ * @type array
+*/
+type GetGroupsStatus200 = GroupRepresentation[];
+/**
+ * @type array
+*/
+type GetOrganizationsStatus200 = OrganizationRepresentation[];
+
+type RequestInit = {
+    body?: string | FormData | undefined;
+    headers?: Record<string, string> | undefined;
+    method?: string | undefined;
+    signal?: any | undefined;
+};
+type Response = {
+    ok: boolean;
+    status: number;
+    url: string;
+    json(): Promise<any>;
+    text(): Promise<string>;
+    headers?: {
+        get(name: string): string | null;
+    } | undefined;
+};
+type FetchImpl = (url: string, init?: RequestInit | undefined) => Promise<Response>;
+
+type FetcherConfig = {
+    baseUrl?: string;
+    token?: string | null;
+    fetchImpl?: FetchImpl;
+    headers?: Record<string, any>;
+};
+type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> = {
+    url: string;
+    method: string;
+    body?: TBody | undefined;
+    headers?: THeaders | undefined;
+    queryParams?: TQueryParams | undefined;
+    pathParams?: TPathParams | undefined;
+    signal?: AbortSignal | undefined;
+} & FetcherConfig;
+declare function client<TData, TError, TBody, THeaders, TQueryParams, TPathParams>({ url, method, body, headers, pathParams, queryParams, signal, baseUrl, token, fetchImpl, }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams>): Promise<TData>;
+
+/**
+ * @summary Get account
+ * @description Get user details for currently logged in user
+ * @link /account/
+ */
+declare function getAccount({ queryParams, config }?: {
+    queryParams?: {
+        "userProfileMetadata"?: boolean;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<AccountRepresentation>;
+/**
+ * @summary Update account
+ * @link /account/
+ */
+declare function updateAccount({ body, config }?: {
+    body: UpdateAccountData;
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<unknown>;
+/**
+ * @summary Get applications
+ * @link /account/applications
+ */
+declare function getApplications({ queryParams, config }?: {
+    queryParams?: {
+        "name"?: string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<GetApplicationsStatus200>;
+/**
+ * @summary Get consent
+ * @link /account/applications/{clientId}/consent
+ */
+declare function getConsent({ pathParams, config }?: {
+    pathParams: {
+        "clientId": string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<ConsentRepresentation>;
+/**
+ * @summary Create consent
+ * @link /account/applications/{clientId}/consent
+ */
+declare function createConsent({ pathParams, config }?: {
+    pathParams: {
+        "clientId": string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<ConsentRepresentation>;
+/**
+ * @summary Update consent
+ * @link /account/applications/{clientId}/consent
+ */
+declare function updateConsent({ pathParams, config }?: {
+    pathParams: {
+        "clientId": string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<ConsentRepresentation>;
+/**
+ * @summary Delete consent
+ * @link /account/applications/{clientId}/consent
+ */
+declare function deleteConsent({ pathParams, config }?: {
+    pathParams: {
+        "clientId": string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<unknown>;
+/**
+ * @summary Get credentials
+ * @description Get credentials for currently logged in user
+ * @link /account/credentials
+ */
+declare function getCredentials({ queryParams, config }?: {
+    queryParams?: {
+        "type"?: string;
+        "user-credentials"?: boolean;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<GetCredentialsStatus200>;
+/**
+ * @summary Delete the credential
+ * @link /account/credentials/{credentialId}
+ */
+declare function deleteCredential({ pathParams, config }?: {
+    pathParams: {
+        "credentialId": string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<unknown>;
+/**
+ * @summary Update a user label of specified credential of current user
+ * @link /account/credentials/{credentialId}/label
+ */
+declare function updateCredentialLabel({ pathParams, body, config }?: {
+    pathParams: {
+        "credentialId": string;
+    };
+    body?: UpdateCredentialLabelData;
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<unknown>;
+/**
+ * @summary Get sessions
+ * @description Get sessions for currently logged in user
+ * @link /account/sessions
+ */
+declare function getSessions({ config }?: {
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<GetSessionsStatus200>;
+/**
+ * @summary Delete current session
+ * @link /account/sessions
+ */
+declare function deleteCurrentSession({ config }?: {
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<unknown>;
+/**
+ * @summary Get devices
+ * @description Get devices for currently logged in user
+ * @link /account/sessions/devices
+ */
+declare function getDevices({ config }?: {
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<GetDevicesStatus200>;
+/**
+ * @summary Delete the session
+ * @link /account/sessions/{sessionId}
+ */
+declare function deleteSession({ pathParams, config }?: {
+    pathParams: {
+        "sessionId": string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<unknown>;
+/**
+ * @summary Get linked accounts
+ * @description Get linked accounts for currently logged in user
+ * @link /account/linked-accounts
+ */
+declare function getLinkedAccounts({ config }?: {
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<GetLinkedAccountsStatus200>;
+/**
+ * @summary Build account linking URI
+ * @description Build account linking URI
+ * @link /account/linked-accounts/{providerId}
+ */
+declare function buildLinkingUri({ pathParams, queryParams, config }?: {
+    pathParams: {
+        "providerId": string;
+    };
+    queryParams?: {
+        "redirectUri"?: string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<AccountLinkUriRepresentation>;
+/**
+ * @summary Delete the linked provider
+ * @link /account/linked-accounts/{providerId}
+ */
+declare function deleteLinkedProvider({ pathParams, config }?: {
+    pathParams: {
+        "providerId": string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<unknown>;
+/**
+ * @summary Get groups that this user is a member of
+ * @link /account/groups
+ */
+declare function getGroups({ queryParams, config }?: {
+    queryParams?: {
+        "briefRepresentation"?: boolean;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<GetGroupsStatus200>;
+/**
+ * @summary Get organizations
+ * @description Get organizations for currently logged in user
+ * @link /account/organizations
+ */
+declare function getOrganizations({ config }?: {
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<GetOrganizationsStatus200>;
+declare const operationsByPath: {
+    "GET /account/": typeof getAccount;
+    "POST /account/": typeof updateAccount;
+    "GET /account/applications": typeof getApplications;
+    "GET /account/applications/{clientId}/consent": typeof getConsent;
+    "POST /account/applications/{clientId}/consent": typeof createConsent;
+    "PUT /account/applications/{clientId}/consent": typeof updateConsent;
+    "DELETE /account/applications/{clientId}/consent": typeof deleteConsent;
+    "GET /account/credentials": typeof getCredentials;
+    "DELETE /account/credentials/{credentialId}": typeof deleteCredential;
+    "PUT /account/credentials/{credentialId}/label": typeof updateCredentialLabel;
+    "GET /account/sessions": typeof getSessions;
+    "DELETE /account/sessions": typeof deleteCurrentSession;
+    "GET /account/sessions/devices": typeof getDevices;
+    "DELETE /account/sessions/{sessionId}": typeof deleteSession;
+    "GET /account/linked-accounts": typeof getLinkedAccounts;
+    "GET /account/linked-accounts/{providerId}": typeof buildLinkingUri;
+    "DELETE /account/linked-accounts/{providerId}": typeof deleteLinkedProvider;
+    "GET /account/groups": typeof getGroups;
+    "GET /account/organizations": typeof getOrganizations;
+};
+declare const operationsByTag: {
+    account: {
+        getAccount: typeof getAccount;
+        updateAccount: typeof updateAccount;
+        getApplications: typeof getApplications;
+        getConsent: typeof getConsent;
+        createConsent: typeof createConsent;
+        updateConsent: typeof updateConsent;
+        deleteConsent: typeof deleteConsent;
+        getCredentials: typeof getCredentials;
+        deleteCredential: typeof deleteCredential;
+        updateCredentialLabel: typeof updateCredentialLabel;
+        getSessions: typeof getSessions;
+        deleteCurrentSession: typeof deleteCurrentSession;
+        getDevices: typeof getDevices;
+        deleteSession: typeof deleteSession;
+        getLinkedAccounts: typeof getLinkedAccounts;
+        buildLinkingUri: typeof buildLinkingUri;
+        deleteLinkedProvider: typeof deleteLinkedProvider;
+        getGroups: typeof getGroups;
+        getOrganizations: typeof getOrganizations;
+    };
+};
+declare const tagDictionary: {
+    readonly account: {
+        readonly GET: readonly ["getAccount", "getApplications", "getConsent", "getCredentials", "getSessions", "getDevices", "getLinkedAccounts", "buildLinkingUri", "getGroups", "getOrganizations"];
+        readonly POST: readonly ["updateAccount", "createConsent"];
+        readonly PUT: readonly ["updateConsent", "updateCredentialLabel"];
+        readonly DELETE: readonly ["deleteConsent", "deleteCredential", "deleteCurrentSession", "deleteSession", "deleteLinkedProvider"];
+    };
+};
+
+export { buildLinkingUri, createConsent, deleteConsent, deleteCredential, deleteCurrentSession, deleteLinkedProvider, deleteSession, getAccount, getApplications, getConsent, getCredentials, getDevices, getGroups, getLinkedAccounts, getOrganizations, getSessions, operationsByPath, operationsByTag, tagDictionary, updateAccount, updateConsent, updateCredentialLabel };
+//# sourceMappingURL=components.d.mts.map