umbraco-management-api-client/dist/apis/MemberApi.d.ts

TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)

/**
 * 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 { CreateMemberRequestModel, DirectionModel, GetItemMember200ResponseInner, MemberResponseModel, PagedIReferenceResponseModel, PagedMemberResponseModel, PagedModelMemberItemResponseModel, PagedReferenceByIdModel, UpdateMemberRequestModel } from '../models/index';
export interface DeleteMemberByIdRequest {
    id: string;
}
export interface GetFilterMemberRequest {
    memberTypeId?: string;
    memberGroupName?: string;
    isApproved?: boolean;
    isLockedOut?: boolean;
    orderBy?: string;
    orderDirection?: DirectionModel;
    filter?: string;
    skip?: number;
    take?: number;
}
export interface GetItemMemberRequest {
    id?: Set<string>;
}
export interface GetItemMemberSearchRequest {
    query?: string;
    skip?: number;
    take?: number;
    allowedMemberTypes?: Array<string>;
}
export interface GetMemberAreReferencedRequest {
    id?: Set<string>;
    skip?: number;
    take?: number;
}
export interface GetMemberByIdRequest {
    id: string;
}
export interface GetMemberByIdReferencedByRequest {
    id: string;
    skip?: number;
    take?: number;
}
export interface GetMemberByIdReferencedDescendantsRequest {
    id: string;
    skip?: number;
    take?: number;
}
export interface PostMemberRequest {
    createMemberRequestModel?: CreateMemberRequestModel;
}
export interface PostMemberValidateRequest {
    createMemberRequestModel?: CreateMemberRequestModel;
}
export interface PutMemberByIdRequest {
    id: string;
    updateMemberRequestModel?: UpdateMemberRequestModel;
}
export interface PutMemberByIdValidateRequest {
    id: string;
    updateMemberRequestModel?: UpdateMemberRequestModel;
}
/**
 *
 */
export declare class MemberApi extends runtime.BaseAPI {
    /**
     */
    deleteMemberByIdRaw(requestParameters: DeleteMemberByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    deleteMemberById(requestParameters: DeleteMemberByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    getFilterMemberRaw(requestParameters: GetFilterMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedMemberResponseModel>>;
    /**
     */
    getFilterMember(requestParameters?: GetFilterMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedMemberResponseModel>;
    /**
     */
    getItemMemberRaw(requestParameters: GetItemMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetItemMember200ResponseInner>>>;
    /**
     */
    getItemMember(requestParameters?: GetItemMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetItemMember200ResponseInner>>;
    /**
     */
    getItemMemberSearchRaw(requestParameters: GetItemMemberSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedModelMemberItemResponseModel>>;
    /**
     */
    getItemMemberSearch(requestParameters?: GetItemMemberSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelMemberItemResponseModel>;
    /**
     */
    getMemberAreReferencedRaw(requestParameters: GetMemberAreReferencedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedReferenceByIdModel>>;
    /**
     */
    getMemberAreReferenced(requestParameters?: GetMemberAreReferencedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedReferenceByIdModel>;
    /**
     */
    getMemberByIdRaw(requestParameters: GetMemberByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MemberResponseModel>>;
    /**
     */
    getMemberById(requestParameters: GetMemberByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MemberResponseModel>;
    /**
     */
    getMemberByIdReferencedByRaw(requestParameters: GetMemberByIdReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedIReferenceResponseModel>>;
    /**
     */
    getMemberByIdReferencedBy(requestParameters: GetMemberByIdReferencedByRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedIReferenceResponseModel>;
    /**
     */
    getMemberByIdReferencedDescendantsRaw(requestParameters: GetMemberByIdReferencedDescendantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedReferenceByIdModel>>;
    /**
     */
    getMemberByIdReferencedDescendants(requestParameters: GetMemberByIdReferencedDescendantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedReferenceByIdModel>;
    /**
     */
    getMemberConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     */
    getMemberConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     */
    postMemberRaw(requestParameters: PostMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postMember(requestParameters?: PostMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    postMemberValidateRaw(requestParameters: PostMemberValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    postMemberValidate(requestParameters?: PostMemberValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putMemberByIdRaw(requestParameters: PutMemberByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putMemberById(requestParameters: PutMemberByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     */
    putMemberByIdValidateRaw(requestParameters: PutMemberByIdValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     */
    putMemberByIdValidate(requestParameters: PutMemberByIdValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}