wallee/dist/services/RolesService.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 { Role, RoleCreate, RoleListResponse, RoleSearchResponse, RoleUpdate, SortingOrder } from '../models/index';
export interface DeleteRolesIdRequest {
    id: number;
}
export interface GetRolesRequest {
    after?: number;
    before?: number;
    expand?: Set<string>;
    limit?: number;
    order?: SortingOrder;
}
export interface GetRolesIdRequest {
    id: number;
    expand?: Set<string>;
}
export interface GetRolesSearchRequest {
    expand?: Set<string>;
    limit?: number;
    offset?: number;
    order?: string;
    query?: string;
}
export interface PatchRolesIdRequest {
    id: number;
    roleUpdate: RoleUpdate;
    expand?: Set<string>;
}
export interface PostRolesRequest {
    roleCreate: RoleCreate;
    expand?: Set<string>;
}
/**
 *
 */
export declare class RolesService extends runtime.BaseAPI {
    constructor(configuration: runtime.Configuration);
    /**
     * Permanently deletes a role. It cannot be undone.
     * Delete a role
     
     */
    deleteRolesIdRaw(requestParameters: DeleteRolesIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Permanently deletes a role. It cannot be undone.
     * Delete a role
     
     */
    deleteRolesId(requestParameters: DeleteRolesIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * List all roles
     
     */
    getRolesRaw(requestParameters: GetRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RoleListResponse>>;
    /**
     * List all roles
     
     */
    getRoles(requestParameters?: GetRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RoleListResponse>;
    /**
     * Retrieve a role
     
     */
    getRolesIdRaw(requestParameters: GetRolesIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Role>>;
    /**
     * Retrieve a role
     
     */
    getRolesId(requestParameters: GetRolesIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Role>;
    /**
     * Search roles
     
     */
    getRolesSearchRaw(requestParameters: GetRolesSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RoleSearchResponse>>;
    /**
     * Search roles
     
     */
    getRolesSearch(requestParameters?: GetRolesSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RoleSearchResponse>;
    /**
     * Update a role
     
     */
    patchRolesIdRaw(requestParameters: PatchRolesIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Role>>;
    /**
     * Update a role
     
     */
    patchRolesId(requestParameters: PatchRolesIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Role>;
    /**
     * Create a role
     
     */
    postRolesRaw(requestParameters: PostRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Role>>;
    /**
     * Create a role
     
     */
    postRoles(requestParameters: PostRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Role>;
}