wallee/dist/services/HumanUsersService.d.ts

TypeScript/JavaScript client for wallee

/**
 * Wallee AG TypeScript SDK
 *
 * This library allows to interact with the Wallee AG payment service.
 *
 * Copyright owner: Wallee AG
 * Website: https://en.wallee.com
 * Developer email: ecosystem-team@wallee.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import * as runtime from '../runtime';
import type { HumanUser, HumanUserCreate, HumanUserListResponse, HumanUserSearchResponse, HumanUserUpdate, SortingOrder } from '../models/index';
export interface DeleteHumanUsersIdRequest {
    id: number;
}
export interface GetHumanUsersRequest {
    after?: number;
    before?: number;
    expand?: Set<string>;
    limit?: number;
    order?: SortingOrder;
}
export interface GetHumanUsersExportRequest {
    fields?: Set<string>;
    limit?: number;
    offset?: number;
    order?: string;
    query?: string;
}
export interface GetHumanUsersIdRequest {
    id: number;
    expand?: Set<string>;
}
export interface GetHumanUsersSearchRequest {
    expand?: Set<string>;
    limit?: number;
    offset?: number;
    order?: string;
    query?: string;
}
export interface PatchHumanUsersIdRequest {
    id: number;
    humanUserUpdate: HumanUserUpdate;
    expand?: Set<string>;
}
export interface PostHumanUsersRequest {
    humanUserCreate: HumanUserCreate;
    expand?: Set<string>;
}
/**
 *
 */
export declare class HumanUsersService extends runtime.BaseAPI {
    constructor(configuration: runtime.Configuration);
    /**
     * Permanently deletes a human user. It cannot be undone.
     * Delete a human user
     
     */
    deleteHumanUsersIdRaw(requestParameters: DeleteHumanUsersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Permanently deletes a human user. It cannot be undone.
     * Delete a human user
     
     */
    deleteHumanUsersId(requestParameters: DeleteHumanUsersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * List all human users
     
     */
    getHumanUsersRaw(requestParameters: GetHumanUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HumanUserListResponse>>;
    /**
     * List all human users
     
     */
    getHumanUsers(requestParameters?: GetHumanUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HumanUserListResponse>;
    /**
     * Export human users into a CSV file.
     * Export human users
     
     * (The read time out for this request is 60 seconds)
     */
    getHumanUsersExportRaw(requestParameters: GetHumanUsersExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
    /**
     * Export human users into a CSV file.
     * Export human users
     
     * (The read time out for this request is 60 seconds)
     */
    getHumanUsersExport(requestParameters?: GetHumanUsersExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
    /**
     * Retrieve a human user
     
     */
    getHumanUsersIdRaw(requestParameters: GetHumanUsersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HumanUser>>;
    /**
     * Retrieve a human user
     
     */
    getHumanUsersId(requestParameters: GetHumanUsersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HumanUser>;
    /**
     * Search human users
     
     */
    getHumanUsersSearchRaw(requestParameters: GetHumanUsersSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HumanUserSearchResponse>>;
    /**
     * Search human users
     
     */
    getHumanUsersSearch(requestParameters?: GetHumanUsersSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HumanUserSearchResponse>;
    /**
     * Update a human user
     
     */
    patchHumanUsersIdRaw(requestParameters: PatchHumanUsersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HumanUser>>;
    /**
     * Update a human user
     
     */
    patchHumanUsersId(requestParameters: PatchHumanUsersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HumanUser>;
    /**
     * Create a human user
     
     */
    postHumanUsersRaw(requestParameters: PostHumanUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HumanUser>>;
    /**
     * Create a human user
     
     */
    postHumanUsers(requestParameters: PostHumanUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HumanUser>;
}