@alicloud/cloudauth20190307 3.9.5 → 3.10.0

package/src/models/DescribeDeviceInfoResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDeviceInfoResponseBodyDeviceInfoListDeviceInfo extends $dara.Model {
   /**
+   * @remarks
+   * Authorization start date.
+   * 
    * @example
    * 20180101
    */
   beginDay?: string;
   /**
+   * @remarks
+   * Corresponds to the BizType in the request.
+   * 
    * @example
    * FACE_TEST
    */
   bizType?: string;
   /**
+   * @remarks
+   * Corresponds to the DeviceId in the request.
+   * 
    * @example
    * wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
    */
   deviceId?: string;
   /**
+   * @remarks
+   * Authorization expiration date.
+   * 
    * @example
    * 20180101
    */
   expiredDay?: string;
   /**
+   * @remarks
+   * Corresponds to the UserDeviceId in the request.
+   * 
    * @example
    * 3iJ1AY$oHcu7mC69
    */
@@ -85,22 +100,38 @@ export class DescribeDeviceInfoResponseBodyDeviceInfoList extends $dara.Model {
 
 export class DescribeDeviceInfoResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The current page number being queried.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
+  /**
+   * @remarks
+   * Array of device information.
+   */
   deviceInfoList?: DescribeDeviceInfoResponseBodyDeviceInfoList;
   /**
+   * @remarks
+   * Number of items per page.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The ID of this request.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */
   requestId?: string;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 1
    */

package/src/models/DescribeFaceGuardRiskRequest.ts

@@ -4,21 +4,35 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeFaceGuardRiskRequest extends $dara.Model {
   /**
+   * @remarks
+   * Authentication ID
+   * 
    * @example
    * aba9830f471a4335af4612c8adaa91b0
    */
   bizId?: string;
   /**
+   * @remarks
+   * Risk identification - device token.
+   * 
    * @example
    * McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx
    */
   deviceToken?: string;
   /**
+   * @remarks
+   * This identifier is used for subsequent troubleshooting, and you need to ensure that this value is unique in your business.
+   * 
+   * Supports the use of English letters (including uppercase and lowercase) and numbers, with a maximum length of 32 characters.
+   * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c35xxxx
    */
   outerOrderNo?: string;
   /**
+   * @remarks
+   * Product code, fixed value: FACE_GUARD
+   * 
    * @example
    * FACE_GUARD
    */

package/src/models/DescribeFaceGuardRiskResponseBody.ts

@@ -3,8 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Unique real-person authentication identifier.
+   * 
+   * @example
+   * sha43d9cabd52d370d9f4cca9468f71e
+   */
   certifyId?: string;
   /**
+   * @remarks
+   * Extended information, in JSON format. (Customized return based on tenant requirements)
+   * 
    * @example
    * {
    *   "code": 200
@@ -18,6 +28,17 @@ export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
    * }
    */
   riskExtends?: string;
+  /**
+   * @remarks
+   * Device risk tags.
+   * 
+   * - Multiple device risk tags are separated by commas (,). For example, “ROOT,VPN,HOOK”,
+   * 
+   * - For more information about device risk tags and their meanings, please refer to the official documentation on Face Guard Tag Descriptions.
+   * 
+   * @example
+   * ROOT,VPN,HOOK
+   */
   riskTags?: string;
   static names(): { [key: string]: string } {
     return {
@@ -46,23 +67,33 @@ export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
 
 export class DescribeFaceGuardRiskResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code, **200** indicates successful response from the interface.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * D6163397-15C5-419C-9ACC-B7C83E0B4C10
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result information.
+   */
   resultObject?: DescribeFaceGuardRiskResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeFaceVerifyRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeFaceVerifyRequest extends $dara.Model {
   /**
+   * @remarks
+   * Unique identifier for real-person authentication.
+   * 
    * @example
    * 91707dc296d469ad38e4c5efa6a0f24b
    */
   certifyId?: string;
   /**
+   * @remarks
+   * Image return type.
+   * 
    * @example
    * JPG
    */
   pictureReturnType?: string;
   /**
+   * @remarks
+   * Authentication scene ID.
+   * 
    * @example
    * 1000000006
    */

package/src/models/DescribeFaceVerifyResponseBody.ts

@@ -3,33 +3,79 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Device risk label.
+   * 
+   * @example
+   * ROOT,VPN,HOOK
+   */
   deviceRisk?: string;
   /**
+   * @remarks
+   * Device token.
+   * 
    * @example
    * McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx
    */
   deviceToken?: string;
   /**
+   * @remarks
+   * Information about the authenticated subject, usually empty in general authentication scenarios.
+   * 
    * @example
    * null
    */
   identityInfo?: string;
   /**
+   * @remarks
+   * Attachment information of the authenticated subject, mainly image materials. JSON format, see example below.
+   * 
    * @example
    * {"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"pictureUrl": "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg","ossBucketName": "cn-shanghai-aliyun-cloudauth-1260051251634779","ossObjectName": "verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg"}}
    */
   materialInfo?: string;
   /**
+   * @remarks
+   * Whether it passed, T for pass, F for fail.
+   * 
    * @example
    * T
    */
   passed?: string;
   /**
+   * @remarks
+   * Description of the authentication result. For details, see the SubCode explanation below.
+   * 
    * @example
    * 200
    */
   subCode?: string;
+  /**
+   * @remarks
+   * Whether the response was successful.
+   * 
+   * @example
+   * True
+   */
   success?: string;
+  /**
+   * @remarks
+   * Records the identity information and corresponding encoding entered by the user under the rare character mode. The returned data is a JSON formatted string, which will be an empty string if there are no rare characters in the name.
+   * 
+   * - name: Refers to the name entered by the user.
+   * 
+   * - verifyName: Refers to the final name encoding after verification. For example, if a rare character is verified through transcoding: “Mr. Wang”, the actual verified name is “Wang Xiansheng”.
+   * 
+   * - number: Refers to the identification number entered by the user.
+   * 
+   * @example
+   * {
+   *   "number": "610***********1110",
+   *   "name": "王先生",
+   *   "verifyName": "王先"
+   * }
+   */
   userInfo?: string;
   static names(): { [key: string]: string } {
     return {
@@ -68,20 +114,33 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
 
 export class DescribeFaceVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 indicates success, other values indicate failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Error message
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF039795
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result information
+   */
   resultObject?: DescribeFaceVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeOssUploadTokenResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Model {
   /**
+   * @remarks
+   * OSS bucket for file storage.
+   * 
    * @example
    * cloudauth-zhangjiakou-external
    */
   bucket?: string;
   /**
+   * @remarks
+   * Access endpoint.
+   * 
    * @example
    * https://oss-cn-zhangjiakou.aliyuncs.com
    */
   endPoint?: string;
   /**
+   * @remarks
+   * Expiration time.
+   * 
    * @example
    * 1582636610000
    */
   expired?: number;
   /**
+   * @remarks
+   * The Key required for file upload.
+   * 
    * @example
    * STS.NU8rUBj****
    */
   key?: string;
   /**
+   * @remarks
+   * File storage path.
+   * 
    * @example
    * prod/RdNLC@Ox2n-1s7NMt
    */
   path?: string;
   /**
+   * @remarks
+   * The Secret required for file upload.
+   * 
    * @example
    * FwmnyoqT8dHj7nJLuM67T****
    */
   secret?: string;
   /**
+   * @remarks
+   * The Token required for file upload.
+   * 
    * @example
    * uWia500nTS5knZaDzq4/KqpvhcLnO****
    */
@@ -72,8 +93,15 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
 }
 
 export class DescribeOssUploadTokenResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Information about the OSS upload Token.
+   */
   ossUploadToken?: DescribeOssUploadTokenResponseBodyOssUploadToken;
   /**
+   * @remarks
+   * The ID of this request.
+   * 
    * @example
    * 2FA2C773-47DB-4156-B1EE-5B047321A939
    */

package/src/models/DescribePageFaceVerifyDataRequest.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribePageFaceVerifyDataRequest extends $dara.Model {
   /**
+   * @remarks
+   * Current page number, default is 1.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
   /**
+   * @remarks
+   * Required, end time, format is yyyy-MM-dd, default is yyyy-MM-dd 00:00:00, the query interval cannot exceed 90 days.
+   * 
    * @example
    * 2023-04-30
    */
   endDate?: string;
   /**
+   * @remarks
+   * Number of items per page, default is 10.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Product code.
+   * 
    * @example
    * ID_PLUS
    */
   productCode?: string;
   /**
+   * @remarks
+   * Scene ID.
+   * 
    * @example
    * 36**01
    */
   sceneId?: number;
   /**
+   * @remarks
+   * Required, start time, format is yyyy-MM-dd, default is yyyy-MM-dd 00:00:00, the query interval cannot exceed 90 days.
+   * 
    * @example
    * 2023-04-10
    */

package/src/models/DescribePageFaceVerifyDataResponseBody.ts

@@ -4,27 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribePageFaceVerifyDataResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * Date.
+   * 
    * @example
    * 2024-03-24T00:00:00.000Z
    */
   date?: string;
   /**
+   * @remarks
+   * Product scheme code, please refer to the financial-grade real-person help documentation.
+   * 
    * @example
    * ID_PLUS
    */
   productCode?: string;
   /**
+   * @remarks
+   * Scene ID.
+   * 
    * @example
    * 20**40
    */
   sceneId?: string;
+  /**
+   * @remarks
+   * Scene name.
+   * 
+   * @example
+   * ****实名认证
+   */
   sceneName?: string;
   /**
+   * @remarks
+   * Number of successful calls.
+   * 
    * @example
    * 1
    */
   successCount?: string;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 19
    */
@@ -62,42 +84,70 @@ export class DescribePageFaceVerifyDataResponseBodyItems extends $dara.Model {
 
 export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Current page number.
+   * 
    * @example
    * 1
    */
   currentPage?: string;
+  /**
+   * @remarks
+   * List of returned data.
+   */
   items?: DescribePageFaceVerifyDataResponseBodyItems[];
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * Number of items per page.
+   * 
    * @example
    * 10
    */
   pageSize?: string;
   /**
+   * @remarks
+   * ID of this request.
+   * 
    * @example
    * 473469C7-A***B-A3DC0DE3C83E
    */
   requestId?: string;
   /**
+   * @remarks
+   * Whether the response was successful.
+   * 
    * @example
    * true
    */
   success?: string;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 100
    */
   totalCount?: string;
   /**
+   * @remarks
+   * Total number of pages.
+   * 
    * @example
    * 5
    */

package/src/models/DescribeSmartStatisticsPageListRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSmartStatisticsPageListRequest extends $dara.Model {
   /**
    * @remarks
+   * Current page number.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeSmartStatisticsPageListRequest extends $dara.Model {
   currentPage?: string;
   /**
    * @remarks
+   * End time, using UTC format, in the form of yyyy-MM-ddTHH:mm:ssZ.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class DescribeSmartStatisticsPageListRequest extends $dara.Model {
   endDate?: string;
   /**
    * @remarks
+   * Number of items per page.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,8 @@ export class DescribeSmartStatisticsPageListRequest extends $dara.Model {
   pageSize?: string;
   /**
    * @remarks
+   * Scene ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -36,12 +44,17 @@ export class DescribeSmartStatisticsPageListRequest extends $dara.Model {
    */
   sceneId?: string;
   /**
+   * @remarks
+   * ServiceCode for the real person cloud product, only value: **cloudauthst**.
+   * 
    * @example
    * cloudauthst
    */
   serviceCode?: string;
   /**
    * @remarks
+   * Start time, using UTC format, in the form of yyyy-MM-ddTHH:mm:ssZ.
+   * 
    * This parameter is required.
    * 
    * @example