umbraco-management-api-client
Version:
TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)
370 lines (369 loc) • 19.4 kB
TypeScript
/**
* Umbraco Management API
* This shows all APIs available in this version of Umbraco - including all the legacy apis that are available for backward compatibility
*
* The version of the OpenAPI document: Latest
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type { CalculatedUserStartNodesResponseModel, ChangePasswordCurrentUserRequestModel, ChangePasswordUserRequestModel, CreateInitialPasswordUserRequestModel, CreateUserClientCredentialsRequestModel, CreateUserRequestModel, CurrentUserConfigurationResponseModel, CurrentUserResponseModel, DeleteUsersRequestModel, DirectionModel, DisableUserRequestModel, EnableTwoFactorRequestModel, EnableUserRequestModel, GetItemUser200ResponseInner, GetUserById2fa200ResponseInner, GetUserCurrentLoginProviders200ResponseInner, GetUserCurrentPermissionsDocument200ResponseInner, InviteUserRequestModel, PagedUserResponseModel, ResendInviteUserRequestModel, ResetPasswordUserResponseModel, SetAvatarRequestModel, UnlockUsersRequestModel, UpdateUserGroupsOnUserRequestModel, UpdateUserRequestModel, UserConfigurationResponseModel, UserOrderModel, UserPermissionsResponseModel, UserResponseModel, UserStateModel, VerifyInviteUserRequestModel, VerifyInviteUserResponseModel } from '../models/index';
export interface DeleteUserRequest {
deleteUsersRequestModel?: DeleteUsersRequestModel;
}
export interface DeleteUserAvatarByIdRequest {
id: string;
}
export interface DeleteUserByIdRequest {
id: string;
}
export interface DeleteUserById2faByProviderNameRequest {
id: string;
providerName: string;
}
export interface DeleteUserByIdClientCredentialsByClientIdRequest {
id: string;
clientId: string;
}
export interface DeleteUserCurrent2faByProviderNameRequest {
providerName: string;
code?: string;
}
export interface GetFilterUserRequest {
skip?: number;
take?: number;
orderBy?: UserOrderModel;
orderDirection?: DirectionModel;
userGroupIds?: Set<string>;
userStates?: Set<UserStateModel>;
filter?: string;
}
export interface GetItemUserRequest {
id?: Set<string>;
}
export interface GetUserRequest {
skip?: number;
take?: number;
}
export interface GetUserByIdRequest {
id: string;
}
export interface GetUserById2faRequest {
id: string;
}
export interface GetUserByIdCalculateStartNodesRequest {
id: string;
}
export interface GetUserByIdClientCredentialsRequest {
id: string;
}
export interface GetUserCurrent2faByProviderNameRequest {
providerName: string;
}
export interface GetUserCurrentPermissionsRequest {
id?: Set<string>;
}
export interface GetUserCurrentPermissionsDocumentRequest {
id?: Set<string>;
}
export interface GetUserCurrentPermissionsMediaRequest {
id?: Set<string>;
}
export interface PostUserRequest {
createUserRequestModel?: CreateUserRequestModel;
}
export interface PostUserAvatarByIdRequest {
id: string;
setAvatarRequestModel?: SetAvatarRequestModel;
}
export interface PostUserByIdChangePasswordRequest {
id: string;
changePasswordUserRequestModel?: ChangePasswordUserRequestModel;
}
export interface PostUserByIdClientCredentialsRequest {
id: string;
createUserClientCredentialsRequestModel?: CreateUserClientCredentialsRequestModel;
}
export interface PostUserByIdResetPasswordRequest {
id: string;
}
export interface PostUserCurrent2faByProviderNameRequest {
providerName: string;
enableTwoFactorRequestModel?: EnableTwoFactorRequestModel;
}
export interface PostUserCurrentAvatarRequest {
setAvatarRequestModel?: SetAvatarRequestModel;
}
export interface PostUserCurrentChangePasswordRequest {
changePasswordCurrentUserRequestModel?: ChangePasswordCurrentUserRequestModel;
}
export interface PostUserDisableRequest {
disableUserRequestModel?: DisableUserRequestModel;
}
export interface PostUserEnableRequest {
enableUserRequestModel?: EnableUserRequestModel;
}
export interface PostUserInviteRequest {
inviteUserRequestModel?: InviteUserRequestModel;
}
export interface PostUserInviteCreatePasswordRequest {
createInitialPasswordUserRequestModel?: CreateInitialPasswordUserRequestModel;
}
export interface PostUserInviteResendRequest {
resendInviteUserRequestModel?: ResendInviteUserRequestModel;
}
export interface PostUserInviteVerifyRequest {
verifyInviteUserRequestModel?: VerifyInviteUserRequestModel;
}
export interface PostUserSetUserGroupsRequest {
updateUserGroupsOnUserRequestModel?: UpdateUserGroupsOnUserRequestModel;
}
export interface PostUserUnlockRequest {
unlockUsersRequestModel?: UnlockUsersRequestModel;
}
export interface PutUserByIdRequest {
id: string;
updateUserRequestModel?: UpdateUserRequestModel;
}
/**
*
*/
export declare class UserApi extends runtime.BaseAPI {
/**
*/
deleteUserRaw(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteUser(requestParameters?: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
deleteUserAvatarByIdRaw(requestParameters: DeleteUserAvatarByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteUserAvatarById(requestParameters: DeleteUserAvatarByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
deleteUserByIdRaw(requestParameters: DeleteUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteUserById(requestParameters: DeleteUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
deleteUserById2faByProviderNameRaw(requestParameters: DeleteUserById2faByProviderNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteUserById2faByProviderName(requestParameters: DeleteUserById2faByProviderNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
deleteUserByIdClientCredentialsByClientIdRaw(requestParameters: DeleteUserByIdClientCredentialsByClientIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteUserByIdClientCredentialsByClientId(requestParameters: DeleteUserByIdClientCredentialsByClientIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
deleteUserCurrent2faByProviderNameRaw(requestParameters: DeleteUserCurrent2faByProviderNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
deleteUserCurrent2faByProviderName(requestParameters: DeleteUserCurrent2faByProviderNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
getFilterUserRaw(requestParameters: GetFilterUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedUserResponseModel>>;
/**
*/
getFilterUser(requestParameters?: GetFilterUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedUserResponseModel>;
/**
*/
getItemUserRaw(requestParameters: GetItemUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemUser200ResponseInner>>>;
/**
*/
getItemUser(requestParameters?: GetItemUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemUser200ResponseInner>>;
/**
*/
getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedUserResponseModel>>;
/**
*/
getUser(requestParameters?: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedUserResponseModel>;
/**
*/
getUserByIdRaw(requestParameters: GetUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponseModel>>;
/**
*/
getUserById(requestParameters: GetUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponseModel>;
/**
*/
getUserById2faRaw(requestParameters: GetUserById2faRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetUserById2fa200ResponseInner>>>;
/**
*/
getUserById2fa(requestParameters: GetUserById2faRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetUserById2fa200ResponseInner>>;
/**
*/
getUserByIdCalculateStartNodesRaw(requestParameters: GetUserByIdCalculateStartNodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalculatedUserStartNodesResponseModel>>;
/**
*/
getUserByIdCalculateStartNodes(requestParameters: GetUserByIdCalculateStartNodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalculatedUserStartNodesResponseModel>;
/**
*/
getUserByIdClientCredentialsRaw(requestParameters: GetUserByIdClientCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
/**
*/
getUserByIdClientCredentials(requestParameters: GetUserByIdClientCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
/**
*/
getUserConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserConfigurationResponseModel>>;
/**
*/
getUserConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserConfigurationResponseModel>;
/**
*/
getUserCurrentRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CurrentUserResponseModel>>;
/**
*/
getUserCurrent(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CurrentUserResponseModel>;
/**
*/
getUserCurrent2faRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetUserById2fa200ResponseInner>>>;
/**
*/
getUserCurrent2fa(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetUserById2fa200ResponseInner>>;
/**
*/
getUserCurrent2faByProviderNameRaw(requestParameters: GetUserCurrent2faByProviderNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
/**
*/
getUserCurrent2faByProviderName(requestParameters: GetUserCurrent2faByProviderNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
/**
*/
getUserCurrentConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CurrentUserConfigurationResponseModel>>;
/**
*/
getUserCurrentConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CurrentUserConfigurationResponseModel>;
/**
*/
getUserCurrentLoginProvidersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetUserCurrentLoginProviders200ResponseInner>>>;
/**
*/
getUserCurrentLoginProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetUserCurrentLoginProviders200ResponseInner>>;
/**
*/
getUserCurrentPermissionsRaw(requestParameters: GetUserCurrentPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserPermissionsResponseModel>>;
/**
*/
getUserCurrentPermissions(requestParameters?: GetUserCurrentPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserPermissionsResponseModel>;
/**
*/
getUserCurrentPermissionsDocumentRaw(requestParameters: GetUserCurrentPermissionsDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetUserCurrentPermissionsDocument200ResponseInner>>>;
/**
*/
getUserCurrentPermissionsDocument(requestParameters?: GetUserCurrentPermissionsDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetUserCurrentPermissionsDocument200ResponseInner>>;
/**
*/
getUserCurrentPermissionsMediaRaw(requestParameters: GetUserCurrentPermissionsMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserPermissionsResponseModel>>;
/**
*/
getUserCurrentPermissionsMedia(requestParameters?: GetUserCurrentPermissionsMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserPermissionsResponseModel>;
/**
*/
postUserRaw(requestParameters: PostUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUser(requestParameters?: PostUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserAvatarByIdRaw(requestParameters: PostUserAvatarByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserAvatarById(requestParameters: PostUserAvatarByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserByIdChangePasswordRaw(requestParameters: PostUserByIdChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserByIdChangePassword(requestParameters: PostUserByIdChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserByIdClientCredentialsRaw(requestParameters: PostUserByIdClientCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserByIdClientCredentials(requestParameters: PostUserByIdClientCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserByIdResetPasswordRaw(requestParameters: PostUserByIdResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResetPasswordUserResponseModel>>;
/**
*/
postUserByIdResetPassword(requestParameters: PostUserByIdResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResetPasswordUserResponseModel>;
/**
*/
postUserCurrent2faByProviderNameRaw(requestParameters: PostUserCurrent2faByProviderNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
/**
*/
postUserCurrent2faByProviderName(requestParameters: PostUserCurrent2faByProviderNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
/**
*/
postUserCurrentAvatarRaw(requestParameters: PostUserCurrentAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserCurrentAvatar(requestParameters?: PostUserCurrentAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserCurrentChangePasswordRaw(requestParameters: PostUserCurrentChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserCurrentChangePassword(requestParameters?: PostUserCurrentChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserDisableRaw(requestParameters: PostUserDisableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserDisable(requestParameters?: PostUserDisableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserEnableRaw(requestParameters: PostUserEnableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserEnable(requestParameters?: PostUserEnableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserInviteRaw(requestParameters: PostUserInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserInvite(requestParameters?: PostUserInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserInviteCreatePasswordRaw(requestParameters: PostUserInviteCreatePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserInviteCreatePassword(requestParameters?: PostUserInviteCreatePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserInviteResendRaw(requestParameters: PostUserInviteResendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserInviteResend(requestParameters?: PostUserInviteResendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserInviteVerifyRaw(requestParameters: PostUserInviteVerifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VerifyInviteUserResponseModel>>;
/**
*/
postUserInviteVerify(requestParameters?: PostUserInviteVerifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerifyInviteUserResponseModel>;
/**
*/
postUserSetUserGroupsRaw(requestParameters: PostUserSetUserGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserSetUserGroups(requestParameters?: PostUserSetUserGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
postUserUnlockRaw(requestParameters: PostUserUnlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
postUserUnlock(requestParameters?: PostUserUnlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
*/
putUserByIdRaw(requestParameters: PutUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
*/
putUserById(requestParameters: PutUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}