xverse-components-utils/types/apis/csa/api.d.ts

xverse components utils

/**
 * csa/csa.proto
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: version not set
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Configuration } from './configuration';
import type { AxiosInstance, AxiosRequestConfig } from 'axios';
type AxiosPromise<T> = Promise<T extends {
    data?: any;
} ? T['data'] : void>;
import type { RequestArgs } from './base';
import { BaseAPI } from './base';
/**
 *
 * @export
 * @interface CsaCSARequestHeader
 */
export interface CsaCSARequestHeader {
    /**
     *
     * @type {string}
     * @memberof CsaCSARequestHeader
     */
    'appID'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaCSARequestHeader
     */
    'token'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaCSARequestHeader
     */
    'from'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaCSARequestHeader
     */
    'to'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaCSARequestHeader
     */
    'sessionID'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaCSARequestHeader
     */
    'traceID'?: string;
}
/**
 *
 * @export
 * @interface CsaCheckRequest
 */
export interface CsaCheckRequest {
    /**
     *
     * @type {CsaCSARequestHeader}
     * @memberof CsaCheckRequest
     */
    'csaRequestHeader'?: CsaCSARequestHeader;
    /**
     *
     * @type {CsaRuleType}
     * @memberof CsaCheckRequest
     */
    'ruleType'?: CsaRuleType;
    /**
     *
     * @type {string}
     * @memberof CsaCheckRequest
     */
    'ruleName'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaCheckRequest
     */
    'ruleOptions'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaCheckRequest
     */
    'data'?: string;
}
/**
 *
 * @export
 * @interface CsaCheckResponse
 */
export interface CsaCheckResponse {
    /**
     *
     * @type {number}
     * @memberof CsaCheckResponse
     */
    'code'?: number;
    /**
     *
     * @type {string}
     * @memberof CsaCheckResponse
     */
    'errMsg'?: string;
}
/**
 *
 * @export
 * @interface CsaImgCheckRequest
 */
export interface CsaImgCheckRequest {
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckRequest
     */
    'traceId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckRequest
     */
    'appId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckRequest
     */
    'worldId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckRequest
     */
    'roomId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckRequest
     */
    'skinId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckRequest
     */
    'releaseId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckRequest
     */
    'content'?: string;
}
/**
 *
 * @export
 * @interface CsaImgCheckResponse
 */
export interface CsaImgCheckResponse {
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckResponse
     */
    'traceId'?: string;
    /**
     *
     * @type {number}
     * @memberof CsaImgCheckResponse
     */
    'code'?: number;
    /**
     *
     * @type {string}
     * @memberof CsaImgCheckResponse
     */
    'msg'?: string;
}
/**
 *
 * @export
 * @enum {string}
 */
export declare enum CsaRuleType {
    DefaultRule1 = "DefaultRule1",
    CustomRules = "CustomRules"
}
/**
 *
 * @export
 * @interface CsaTextCheckRequest
 */
export interface CsaTextCheckRequest {
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'traceId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'appId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'worldId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'roomId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'skinId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'releaseId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'fromId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'toId'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckRequest
     */
    'content'?: string;
}
/**
 *
 * @export
 * @interface CsaTextCheckResponse
 */
export interface CsaTextCheckResponse {
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckResponse
     */
    'traceId'?: string;
    /**
     *
     * @type {number}
     * @memberof CsaTextCheckResponse
     */
    'code'?: number;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckResponse
     */
    'msg'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckResponse
     */
    'suggestion'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckResponse
     */
    'label'?: string;
    /**
     *
     * @type {Array<string>}
     * @memberof CsaTextCheckResponse
     */
    'keywords'?: Array<string>;
}
/**
 *
 * @export
 * @interface CsaTextCheckResponseData
 */
export interface CsaTextCheckResponseData {
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckResponseData
     */
    'suggestion'?: string;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckResponseData
     */
    'label'?: string;
    /**
     *
     * @type {Array<string>}
     * @memberof CsaTextCheckResponseData
     */
    'keywords'?: Array<string>;
}
/**
 *
 * @export
 * @interface CsaTextCheckResponseV2
 */
export interface CsaTextCheckResponseV2 {
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckResponseV2
     */
    'traceId'?: string;
    /**
     *
     * @type {number}
     * @memberof CsaTextCheckResponseV2
     */
    'code'?: number;
    /**
     *
     * @type {string}
     * @memberof CsaTextCheckResponseV2
     */
    'msg'?: string;
    /**
     *
     * @type {CsaTextCheckResponseData}
     * @memberof CsaTextCheckResponseV2
     */
    'data'?: CsaTextCheckResponseData;
}
/**
 *
 * @export
 * @interface ProtobufAny
 */
export interface ProtobufAny {
    /**
     *
     * @type {string}
     * @memberof ProtobufAny
     */
    'type_url'?: string;
    /**
     *
     * @type {string}
     * @memberof ProtobufAny
     */
    'value'?: string;
}
/**
 *
 * @export
 * @interface RuntimeError
 */
export interface RuntimeError {
    /**
     *
     * @type {string}
     * @memberof RuntimeError
     */
    'error'?: string;
    /**
     *
     * @type {number}
     * @memberof RuntimeError
     */
    'code'?: number;
    /**
     *
     * @type {string}
     * @memberof RuntimeError
     */
    'message'?: string;
    /**
     *
     * @type {Array<ProtobufAny>}
     * @memberof RuntimeError
     */
    'details'?: Array<ProtobufAny>;
}
/**
 * CSAApi - axios parameter creator
 * @export
 */
export declare const CSAApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary 文本内容检查
     * @param {CsaCheckRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSACheck: (body: CsaCheckRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {CsaImgCheckRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSAImgCheck: (body: CsaImgCheckRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {CsaTextCheckRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSATextCheck: (body: CsaTextCheckRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary v2版本的文本检查，给前端用
     * @param {CsaTextCheckRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSATextCheckV2: (body: CsaTextCheckRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * CSAApi - functional programming interface
 * @export
 */
export declare const CSAApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary 文本内容检查
     * @param {CsaCheckRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSACheck(body: CsaCheckRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CsaCheckResponse>>;
    /**
     *
     * @param {CsaImgCheckRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSAImgCheck(body: CsaImgCheckRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CsaImgCheckResponse>>;
    /**
     *
     * @param {CsaTextCheckRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSATextCheck(body: CsaTextCheckRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CsaTextCheckResponse>>;
    /**
     *
     * @summary v2版本的文本检查，给前端用
     * @param {CsaTextCheckRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSATextCheckV2(body: CsaTextCheckRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CsaTextCheckResponseV2>>;
};
/**
 * CSAApi - factory interface
 * @export
 */
export declare const CSAApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary 文本内容检查
     * @param {CSAApiCSACheckRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSACheck(requestParameters: CSAApiCSACheckRequest, options?: AxiosRequestConfig): AxiosPromise<CsaCheckResponse>;
    /**
     *
     * @param {CSAApiCSAImgCheckRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSAImgCheck(requestParameters: CSAApiCSAImgCheckRequest, options?: AxiosRequestConfig): AxiosPromise<CsaImgCheckResponse>;
    /**
     *
     * @param {CSAApiCSATextCheckRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSATextCheck(requestParameters: CSAApiCSATextCheckRequest, options?: AxiosRequestConfig): AxiosPromise<CsaTextCheckResponse>;
    /**
     *
     * @summary v2版本的文本检查，给前端用
     * @param {CSAApiCSATextCheckV2Request} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cSATextCheckV2(requestParameters: CSAApiCSATextCheckV2Request, options?: AxiosRequestConfig): AxiosPromise<CsaTextCheckResponseV2>;
};
/**
 * Request parameters for cSACheck operation in CSAApi.
 * @export
 * @interface CSAApiCSACheckRequest
 */
export interface CSAApiCSACheckRequest {
    /**
     *
     * @type {CsaCheckRequest}
     * @memberof CSAApiCSACheck
     */
    readonly body: CsaCheckRequest;
}
/**
 * Request parameters for cSAImgCheck operation in CSAApi.
 * @export
 * @interface CSAApiCSAImgCheckRequest
 */
export interface CSAApiCSAImgCheckRequest {
    /**
     *
     * @type {CsaImgCheckRequest}
     * @memberof CSAApiCSAImgCheck
     */
    readonly body: CsaImgCheckRequest;
}
/**
 * Request parameters for cSATextCheck operation in CSAApi.
 * @export
 * @interface CSAApiCSATextCheckRequest
 */
export interface CSAApiCSATextCheckRequest {
    /**
     *
     * @type {CsaTextCheckRequest}
     * @memberof CSAApiCSATextCheck
     */
    readonly body: CsaTextCheckRequest;
}
/**
 * Request parameters for cSATextCheckV2 operation in CSAApi.
 * @export
 * @interface CSAApiCSATextCheckV2Request
 */
export interface CSAApiCSATextCheckV2Request {
    /**
     *
     * @type {CsaTextCheckRequest}
     * @memberof CSAApiCSATextCheckV2
     */
    readonly body: CsaTextCheckRequest;
}
/**
 * CSAApi - object-oriented interface
 * @export
 * @class CSAApi
 * @extends {BaseAPI}
 */
export declare class CSAApi extends BaseAPI {
    /**
     *
     * @summary 文本内容检查
     * @param {CSAApiCSACheckRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CSAApi
     */
    cSACheck(requestParameters: CSAApiCSACheckRequest, options?: AxiosRequestConfig): Promise<void>;
    /**
     *
     * @param {CSAApiCSAImgCheckRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CSAApi
     */
    cSAImgCheck(requestParameters: CSAApiCSAImgCheckRequest, options?: AxiosRequestConfig): Promise<void>;
    /**
     *
     * @param {CSAApiCSATextCheckRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CSAApi
     */
    cSATextCheck(requestParameters: CSAApiCSATextCheckRequest, options?: AxiosRequestConfig): Promise<void>;
    /**
     *
     * @summary v2版本的文本检查，给前端用
     * @param {CSAApiCSATextCheckV2Request} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CSAApi
     */
    cSATextCheckV2(requestParameters: CSAApiCSATextCheckV2Request, options?: AxiosRequestConfig): Promise<CsaTextCheckResponseData>;
}
export {};