import { HcClient } from "@huaweicloud/huaweicloud-sdk-core/HcClient"; import { ClientBuilder } from "@huaweicloud/huaweicloud-sdk-core/ClientBuilder"; import { CreateAppRequest } from './model/CreateAppRequest'; import { CreateAppResponse } from './model/CreateAppResponse'; import { CreateSignatureRequest } from './model/CreateSignatureRequest'; import { CreateSignatureResponse } from './model/CreateSignatureResponse'; import { CreateTemplateRequest } from './model/CreateTemplateRequest'; import { CreateTemplateResponse } from './model/CreateTemplateResponse'; import { DeleteSignatureRequest } from './model/DeleteSignatureRequest'; import { DeleteSignatureResponse } from './model/DeleteSignatureResponse'; import { DeleteTemplateRequest } from './model/DeleteTemplateRequest'; import { DeleteTemplateResponse } from './model/DeleteTemplateResponse'; import { EnableSignatureRequest } from './model/EnableSignatureRequest'; import { EnableSignatureResponse } from './model/EnableSignatureResponse'; import { ListAppDetailsRequest } from './model/ListAppDetailsRequest'; import { ListAppDetailsResponse } from './model/ListAppDetailsResponse'; import { ListSendCountryDetailsRequest } from './model/ListSendCountryDetailsRequest'; import { ListSendCountryDetailsResponse } from './model/ListSendCountryDetailsResponse'; import { ListSignatureDetailsRequest } from './model/ListSignatureDetailsRequest'; import { ListSignatureDetailsResponse } from './model/ListSignatureDetailsResponse'; import { ListTemplateDetailsRequest } from './model/ListTemplateDetailsRequest'; import { ListTemplateDetailsResponse } from './model/ListTemplateDetailsResponse'; import { ListTemplateVarilableDetailsRequest } from './model/ListTemplateVarilableDetailsRequest'; import { ListTemplateVarilableDetailsResponse } from './model/ListTemplateVarilableDetailsResponse'; import { ShowAppCountRequest } from './model/ShowAppCountRequest'; import { ShowAppCountResponse } from './model/ShowAppCountResponse'; import { ShowAppRequest } from './model/ShowAppRequest'; import { ShowAppResponse } from './model/ShowAppResponse'; import { ShowSignatureFileRequest } from './model/ShowSignatureFileRequest'; import { ShowSignatureFileResponse } from './model/ShowSignatureFileResponse'; import { ShowSignatureRequest } from './model/ShowSignatureRequest'; import { ShowSignatureResponse } from './model/ShowSignatureResponse'; import { ShowTemplateRequest } from './model/ShowTemplateRequest'; import { ShowTemplateResponse } from './model/ShowTemplateResponse'; import { UpdateAppRequest } from './model/UpdateAppRequest'; import { UpdateAppResponse } from './model/UpdateAppResponse'; import { UpdateSignatureRequest } from './model/UpdateSignatureRequest'; import { UpdateSignatureResponse } from './model/UpdateSignatureResponse'; import { UpdateTemplateRequest } from './model/UpdateTemplateRequest'; import { UpdateTemplateResponse } from './model/UpdateTemplateResponse'; import { UploadSignatureFileRequest } from './model/UploadSignatureFileRequest'; import { UploadSignatureFileResponse } from './model/UploadSignatureFileResponse'; export declare class MsgsmsClient { static newBuilder(): ClientBuilder; private hcClient; constructor(client: HcClient); getPath(): string; /** * 该接口用于用户创建应用信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 创建短信应用 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {SmsAppAddReq} createAppRequestBody 请求Body参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApp(createAppRequest?: CreateAppRequest): Promise; /** * 该接口用于用户查询已创建的应用信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 查询短信应用 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} [appName] 应用名称 * @param {string} [startTime] 开始时间 * @param {string} [endTime] 结束时间 * @param {number} [limit] 数量 * @param {number} [offset] 偏移量 * @param {string} [region] 地域 1. cn：国内 2. intl：国际 * @param {string} [sortDir] 排序方式 1. desc：降序 2. asc：升序 * @param {string} [sortKey] 排序字段 * @param {string} [status] 应用状态 1. CREATED：待上线。应用暂未创建成功，请稍候。 2. SUSPENDED：暂停。无法发起业务请求。当客户所发短信内容触发业务违规，或客户申请退订短信业务时，运营经理会将客户短信应用暂停。 3. LAUNCHED：正常。应用添加成功，可以正常使用。 4. PROCESSING：资源待分配。请联系客户经理或通过工单系统申请配置资源。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAppDetails(listAppDetailsRequest?: ListAppDetailsRequest): Promise; /** * 该接口用于用户查询应用详情信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 获取应用详情 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 应用ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ showApp(showAppRequest?: ShowAppRequest): Promise; /** * 该接口用于用户查询应用使用的数量信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 查询应用数量 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} region 地域 1. cn：国内 2. intl：国际 * @param {*} [options] Override http request option. * @throws {RequiredError} */ showAppCount(showAppCountRequest?: ShowAppCountRequest): Promise; /** * 该接口用于用户修改应用信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 修改短信应用 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 应用主键ID * @param {SmsAppUpdateReq} updateAppRequestBody 请求Body参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateApp(updateAppRequest?: UpdateAppRequest): Promise; /** * 该接口用于用户创建签名。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 创建短信签名 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {SmsSignatureReq} createSignatureRequestBody 请求Body参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSignature(createSignatureRequest?: CreateSignatureRequest): Promise; /** * 该接口用于用户删除已创建的签名信息息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 删除短信签名 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 签名ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSignature(deleteSignatureRequest?: DeleteSignatureRequest): Promise; /** * 该接口用于用户申请激活签名信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 申请激活签名 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 签名ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ enableSignature(enableSignatureRequest?: EnableSignatureRequest): Promise; /** * 该接口用于用户查询已创建的短信签名信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 查询签名信息 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} [appName] 应用名称 * @param {string} [startTime] 开始时间 * @param {string} [endTime] 结束时间 * @param {number} [limit] 数量 * @param {number} [offset] 偏移量 * @param {string} [signatureId] 签名ID * @param {string} [signatureName] 签名名称 * @param {string} [signatureType] 签名类型。支持枚举值： 1. VERIFY_CODE_TYPE: 验证码类 2. PROMOTION_TYPE: 推广类 3. NOTIFY_TYPE: 通知类 * @param {string} [site] 地域 * @param {string} [sortDir] 排序方式 1. desc：降序 2. asc：升序 * @param {string} [sortKey] 排序字段 * @param {string} [status] 状态 1. PENDING_REVIEW：待签名审核 2. PROCESSING：内容审核通过，签名处理中 3. REVIEW_PASSED：处理完毕(待补充资质)，该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 4. REVIEW_NOT_PASS：审核不通过 5. TO_BE_ACTIVATED：待激活 6. PENDING_ACTIVATE：激活审核中 7. PENDING_QUALIFICATION_REVIEW：待资质审核，该状态下，用户不可发送短信 8. REAL_NAME_REGISTRATING：实名报备中，该状态下，用户不可发送短信 9. REVIEW_PASSED_QUALIFICATION_PROCESSING：处理完毕(资质审核中)，该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 10. REVIEW_PASSED_REAL_NAME_REGISTRATING：处理完毕(实名报备中)，该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 11. REVIEW_PASSED_REAL_NAME_REGISTRATE_FAIL：处理完毕(实名报备失败)，该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 12. REVIEW_PROCESSING_COMPLETED：处理完毕 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSignatureDetails(listSignatureDetailsRequest?: ListSignatureDetailsRequest): Promise; /** * 该接口用于用户查询签名详情信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 获取签名详情 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 签名ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ showSignature(showSignatureRequest?: ShowSignatureRequest): Promise; /** * 该接口用于用户查询上传的文件信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 查询申请文件 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} fileId 营业执照ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ showSignatureFile(showSignatureFileRequest?: ShowSignatureFileRequest): Promise; /** * 该接口用于用户更新签名信息，目前仅支持审核不通过的短信签名重新修改。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 修改短信签名 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 签名ID * @param {SmsSignatureReq} updateSignatureRequestBody 请求Body参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSignature(updateSignatureRequest?: UpdateSignatureRequest): Promise; /** * 该接口用于用户上传文件信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 上传申请文件 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {any} file 营业执照文件 * @param {string} [fileDesc] 描述 * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadSignatureFile(uploadSignatureFileRequest?: UploadSignatureFileRequest): Promise; /** * 该接口用于用户创建模板。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 创建短信模板 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {SmsTemplateReq} createTemplateRequestBody 请求Body参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTemplate(createTemplateRequest?: CreateTemplateRequest): Promise; /** * 该接口用于用户删除已创建的模板信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 删除短信模板 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 模板ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTemplate(deleteTemplateRequest?: DeleteTemplateRequest): Promise; /** * 该接口用于用户查询短信发送的国家信息 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 查询发送国家 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} [countryNameEn] 国家(英文) * @param {string} [countryNameZh] 国家(中文) * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSendCountryDetails(listSendCountryDetailsRequest?: ListSendCountryDetailsRequest): Promise; /** * 该接口用于用户查询已创建的模板信息。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 查询短信模板 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} [appKey] 应用key * @param {string} [appName] 应用名称 * @param {string} [startTime] 开始时间 * @param {string} [endTime] 结束时间 * @param {number} [limit] 数量 * @param {number} [offset] 偏移量 * @param {string} [flowStatus] 流程状态 1. Adopted: 通过 2. Reviewing: 审核中 3. Reject: 拒绝 * @param {string} [hasVariable] 是否存在变量 * @param {string} [region] 地域 1. cn：国内 2. intl：国际 * @param {string} [signName] 签名名称 * @param {string} [sortDir] 排序方式 1. desc：降序 2. asc：升序 * @param {string} [sortKey] 排序字段 * @param {string} [templateId] 模板ID * @param {string} [templateName] 模板名称 * @param {string} [templateType] 模板类型 1. VERIFY_CODE_TYPE: 验证码类 2. PROMOTION_TYPE: 推广类 3. NOTIFY_TYPE: 通知类 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTemplateDetails(listTemplateDetailsRequest?: ListTemplateDetailsRequest): Promise; /** * 该接口用于用户查询模板参数。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 查询模板变量 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 模板ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTemplateVarilableDetails(listTemplateVarilableDetailsRequest?: ListTemplateVarilableDetailsRequest): Promise; /** * 该接口用于用户查询已创建的模板详情。 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 获取模板详情 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 模板ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ showTemplate(showTemplateRequest?: ShowTemplateRequest): Promise; /** * 该接口用于用户修改模板信息，目前仅支持审核不通过的短信模板重新修改 * * Please refer to HUAWEI cloud API Explorer for details. * * @summary 修改短信模板 * @param {string} contentType 请求体参数类型，该字段必须设置为：application/json;charset=utf8 * @param {string} id 模板ID * @param {SmsTemplateReq} updateTemplateRequestBody 请求Body参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTemplate(updateTemplateRequest?: UpdateTemplateRequest): Promise; } export declare const ParamCreater: () => { /** * 该接口用于用户创建应用信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ createApp(createAppRequest?: CreateAppRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; data: {}; }; /** * 该接口用于用户查询已创建的应用信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ listAppDetails(listAppDetailsRequest?: ListAppDetailsRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询应用详情信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ showApp(showAppRequest?: ShowAppRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询应用使用的数量信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ showAppCount(showAppCountRequest?: ShowAppCountRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户修改应用信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ updateApp(updateAppRequest?: UpdateAppRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; data: {}; }; /** * 该接口用于用户创建签名。 * * Please refer to HUAWEI cloud API Explorer for details. */ createSignature(createSignatureRequest?: CreateSignatureRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; data: {}; }; /** * 该接口用于用户删除已创建的签名信息息。 * * Please refer to HUAWEI cloud API Explorer for details. */ deleteSignature(deleteSignatureRequest?: DeleteSignatureRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户申请激活签名信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ enableSignature(enableSignatureRequest?: EnableSignatureRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询已创建的短信签名信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ listSignatureDetails(listSignatureDetailsRequest?: ListSignatureDetailsRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询签名详情信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ showSignature(showSignatureRequest?: ShowSignatureRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询上传的文件信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ showSignatureFile(showSignatureFileRequest?: ShowSignatureFileRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户更新签名信息，目前仅支持审核不通过的短信签名重新修改。 * * Please refer to HUAWEI cloud API Explorer for details. */ updateSignature(updateSignatureRequest?: UpdateSignatureRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; data: {}; }; /** * 该接口用于用户上传文件信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ uploadSignatureFile(uploadSignatureFileRequest?: UploadSignatureFileRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; data: {}; }; /** * 该接口用于用户创建模板。 * * Please refer to HUAWEI cloud API Explorer for details. */ createTemplate(createTemplateRequest?: CreateTemplateRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; data: {}; }; /** * 该接口用于用户删除已创建的模板信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ deleteTemplate(deleteTemplateRequest?: DeleteTemplateRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询短信发送的国家信息 * * Please refer to HUAWEI cloud API Explorer for details. */ listSendCountryDetails(listSendCountryDetailsRequest?: ListSendCountryDetailsRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询已创建的模板信息。 * * Please refer to HUAWEI cloud API Explorer for details. */ listTemplateDetails(listTemplateDetailsRequest?: ListTemplateDetailsRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询模板参数。 * * Please refer to HUAWEI cloud API Explorer for details. */ listTemplateVarilableDetails(listTemplateVarilableDetailsRequest?: ListTemplateVarilableDetailsRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户查询已创建的模板详情。 * * Please refer to HUAWEI cloud API Explorer for details. */ showTemplate(showTemplateRequest?: ShowTemplateRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; }; /** * 该接口用于用户修改模板信息，目前仅支持审核不通过的短信模板重新修改 * * Please refer to HUAWEI cloud API Explorer for details. */ updateTemplate(updateTemplateRequest?: UpdateTemplateRequest): { method: string; url: string; contentType: string; queryParams: {}; pathParams: {}; headers: {}; data: {}; }; }; /** * * @export * @class RequiredError * @extends {Error} */ export declare class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } //# sourceMappingURL=MsgsmsClient.d.ts.map