@paciolan/cybersource-sdk/dist/apis/user-management-api.d.ts

CyberSource REST API Typescript SDK

/**
 * CyberSource Merged Spec
 * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
 *
 * OpenAPI spec version: 0.0.1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { UmsV1UsersGet200Response } from '../models';
/**
 * UserManagementApi - axios parameter creator
 * @export
 */
export declare const UserManagementApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * This endpoint is deprecated. Please use the search end point.
     * @summary Get User Information - Deprecated
     * @param {string} [organizationId] This is the orgId of the organization which the user belongs to.
     * @param {string} [userName] User ID of the user you want to get details on.
     * @param {string} [permissionId] permission that you are trying to search user on.
     * @param {string} [roleId] role of the user you are trying to search on.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUsers: (organizationId?: string, userName?: string, permissionId?: string, roleId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
 * UserManagementApi - functional programming interface
 * @export
 */
export declare const UserManagementApiFp: (configuration?: Configuration) => {
    /**
     * This endpoint is deprecated. Please use the search end point.
     * @summary Get User Information - Deprecated
     * @param {string} [organizationId] This is the orgId of the organization which the user belongs to.
     * @param {string} [userName] User ID of the user you want to get details on.
     * @param {string} [permissionId] permission that you are trying to search user on.
     * @param {string} [roleId] role of the user you are trying to search on.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUsers(organizationId?: string, userName?: string, permissionId?: string, roleId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UmsV1UsersGet200Response>>>;
};
/**
 * UserManagementApi - factory interface
 * @export
 */
export declare const UserManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * This endpoint is deprecated. Please use the search end point.
     * @summary Get User Information - Deprecated
     * @param {string} [organizationId] This is the orgId of the organization which the user belongs to.
     * @param {string} [userName] User ID of the user you want to get details on.
     * @param {string} [permissionId] permission that you are trying to search user on.
     * @param {string} [roleId] role of the user you are trying to search on.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUsers(organizationId?: string, userName?: string, permissionId?: string, roleId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<UmsV1UsersGet200Response>>;
};
/**
 * UserManagementApi - object-oriented interface
 * @export
 * @class UserManagementApi
 * @extends {BaseAPI}
 */
export declare class UserManagementApi extends BaseAPI {
    /**
     * This endpoint is deprecated. Please use the search end point.
     * @summary Get User Information - Deprecated
     * @param {string} [organizationId] This is the orgId of the organization which the user belongs to.
     * @param {string} [userName] User ID of the user you want to get details on.
     * @param {string} [permissionId] permission that you are trying to search user on.
     * @param {string} [roleId] role of the user you are trying to search on.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserManagementApi
     */
    getUsers(organizationId?: string, userName?: string, permissionId?: string, roleId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<UmsV1UsersGet200Response>>;
}