@alicloud/cloudauth20190307 3.9.5 → 3.11.0

package/src/models/DescribeCloudauthstSceneListResponseBody.ts

@@ -0,0 +1,136 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * Creation time.
+   * 
+   * @example
+   * 2023-01-04 19:56:04
+   */
+  gmtCreate?: string;
+  /**
+   * @remarks
+   * Modification time.
+   * 
+   * @example
+   * 2023-01-04 19:56:04
+   */
+  gmtModified?: string;
+  /**
+   * @remarks
+   * Cloud marketplace product code.
+   * 
+   * @example
+   * SMART_VERIFY
+   */
+  productCode?: string;
+  /**
+   * @remarks
+   * Product name
+   * 
+   * @example
+   * -
+   */
+  productName?: string;
+  /**
+   * @remarks
+   * Scene ID.
+   * 
+   * @example
+   * 20**40
+   */
+  sceneId?: string;
+  /**
+   * @remarks
+   * Scene name.
+   * 
+   * @example
+   * 测试场景
+   */
+  sceneName?: string;
+  /**
+   * @remarks
+   * Whether to deliver the files generated by the authentication to the customer\\"s OSS:
+   * - **Y**: Enabled
+   * - **N**: Disabled
+   * 
+   * @example
+   * N
+   */
+  storeImage?: string;
+  static names(): { [key: string]: string } {
+    return {
+      gmtCreate: 'GmtCreate',
+      gmtModified: 'GmtModified',
+      productCode: 'ProductCode',
+      productName: 'ProductName',
+      sceneId: 'SceneId',
+      sceneName: 'SceneName',
+      storeImage: 'StoreImage',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      gmtCreate: 'string',
+      gmtModified: 'string',
+      productCode: 'string',
+      productName: 'string',
+      sceneId: 'string',
+      sceneName: 'string',
+      storeImage: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeCloudauthstSceneListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Scene list
+   */
+  items?: DescribeCloudauthstSceneListResponseBodyItems[];
+  /**
+   * @remarks
+   * The ID of this request.
+   * 
+   * @example
+   * CEC88747-2F3E-539E-91A6-84E321CAA12B
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'Items',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: { 'type': 'array', 'itemType': DescribeCloudauthstSceneListResponseBodyItems },
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDeviceInfoRequest.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDeviceInfoRequest extends $dara.Model {
   /**
+   * @remarks
+   * Business type. No more than 64 characters.
+   * 
    * @example
    * FACE_TEST
    */
   bizType?: string;
   /**
+   * @remarks
+   * The current page number being queried.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
   /**
+   * @remarks
+   * A unique ID generated by the real-person authentication server for the access party\\"s device. This ID is only generated after the device has been successfully activated and can be obtained through the getLicenseExtraInfo function in the offline facial recognition SDK.
+   * 
    * @example
    * wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
    */
   deviceId?: string;
   /**
+   * @remarks
+   * The end time of the query, i.e., querying authorizations that will expire between ExpiredStartDay and ExpiredEndDay.
+   * 
    * @example
    * 20200330
    */
   expiredEndDay?: string;
   /**
+   * @remarks
+   * The start time of the query, i.e., querying authorizations that will expire between ExpiredStartDay and ExpiredEndDay.
+   * 
    * @example
    * 20190401
    */
   expiredStartDay?: string;
   /**
+   * @remarks
+   * Number of items per page in the query.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * No more than 64 characters, defined by the access party, which can be used to identify a specific device.
+   * 
    * @example
    * 3iJ1AY$oHcu7mC69
    */

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/DescribeInfoCheckExportRecordRequest.ts

@@ -0,0 +1,59 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeInfoCheckExportRecordRequest extends $dara.Model {
+  /**
+   * @example
+   * 1
+   */
+  currentPage?: number;
+  /**
+   * @example
+   * 2025-10-11 21:24:48
+   */
+  endDate?: string;
+  /**
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  /**
+   * @example
+   * ID_CARD_2_META
+   */
+  productType?: string;
+  /**
+   * @example
+   * 2025-10-11 21:24:48
+   */
+  startDate?: string;
+  static names(): { [key: string]: string } {
+    return {
+      currentPage: 'CurrentPage',
+      endDate: 'EndDate',
+      pageSize: 'PageSize',
+      productType: 'ProductType',
+      startDate: 'StartDate',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      currentPage: 'number',
+      endDate: 'string',
+      pageSize: 'number',
+      productType: 'string',
+      startDate: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeInfoCheckExportRecordResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeInfoCheckExportRecordResponseBody } from "./DescribeInfoCheckExportRecordResponseBody";
+
+
+export class DescribeInfoCheckExportRecordResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeInfoCheckExportRecordResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeInfoCheckExportRecordResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+