@alicloud/cloudauth20190307 3.9.5 → 3.11.0

package/src/models/DescribeVerifyStatisticsResponseBody.ts

@@ -0,0 +1,294 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeVerifyStatisticsResponseBodyResultObjectItems extends $dara.Model {
+  /**
+   * @remarks
+   * Date.
+   * 
+   * @example
+   * 2025-10-11
+   */
+  date?: string;
+  /**
+   * @remarks
+   * Client initialization pass rate.
+   * 
+   * @example
+   * 60
+   */
+  initDevicePassRate?: string;
+  /**
+   * @remarks
+   * Number of server initializations.
+   * 
+   * @example
+   * 15
+   */
+  initService?: number;
+  /**
+   * @remarks
+   * Server initialization conversion rate.
+   * 
+   * @example
+   * 26.67
+   */
+  initServiceConversionRate?: string;
+  /**
+   * @remarks
+   * Server initialization pass rate.
+   * 
+   * @example
+   * 20
+   */
+  initServicePassRate?: string;
+  /**
+   * @remarks
+   * Pass rate.
+   * 
+   * @example
+   * 75
+   */
+  passRate?: string;
+  static names(): { [key: string]: string } {
+    return {
+      date: 'Date',
+      initDevicePassRate: 'InitDevicePassRate',
+      initService: 'InitService',
+      initServiceConversionRate: 'InitServiceConversionRate',
+      initServicePassRate: 'InitServicePassRate',
+      passRate: 'PassRate',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      date: 'string',
+      initDevicePassRate: 'string',
+      initService: 'number',
+      initServiceConversionRate: 'string',
+      initServicePassRate: 'string',
+      passRate: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeVerifyStatisticsResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Number of client initializations.
+   * 
+   * @example
+   * 73
+   */
+  initDevice?: number;
+  /**
+   * @remarks
+   * Number of identity deduplication client initializations.
+   * 
+   * @example
+   * 9
+   */
+  initDeviceId?: number;
+  /**
+   * @remarks
+   * Number of successful identity deduplication client initializations.
+   * 
+   * @example
+   * 9
+   */
+  initDeviceIdSuccess?: number;
+  /**
+   * @remarks
+   * Number of client initialization calls.
+   * 
+   * @example
+   * 73
+   */
+  initDeviceSuccess?: number;
+  /**
+   * @remarks
+   * Number of service-side initializations.
+   * 
+   * @example
+   * 73
+   */
+  initService?: number;
+  /**
+   * @remarks
+   * Total number of identity deduplication server initialization requests.
+   * 
+   * @example
+   * 9
+   */
+  initServiceId?: number;
+  /**
+   * @remarks
+   * Number of successful identity deduplication server initializations.
+   * 
+   * @example
+   * 9
+   */
+  initServiceIdSuccess?: number;
+  /**
+   * @remarks
+   * Number of successful service-side initialization authentications.
+   * 
+   * @example
+   * 134
+   */
+  initServiceSuccess?: number;
+  /**
+   * @remarks
+   * Daily pass/conversion rate (PV).
+   */
+  items?: DescribeVerifyStatisticsResponseBodyResultObjectItems[];
+  /**
+   * @remarks
+   * Number of client verifications.
+   * 
+   * @example
+   * 15
+   */
+  verifyDevice?: number;
+  /**
+   * @remarks
+   * Number of identity deduplication client authentications.
+   * 
+   * @example
+   * 9
+   */
+  verifyDeviceId?: number;
+  /**
+   * @remarks
+   * Number of successful identity deduplication client verifications.
+   * 
+   * @example
+   * 6
+   */
+  verifyDeviceIdSuccess?: number;
+  /**
+   * @remarks
+   * Number of successful identity deduplication client authentications.
+   * 
+   * @example
+   * 3
+   */
+  verifyDeviceIdSuccessPassed?: number;
+  /**
+   * @remarks
+   * Number of successful client authentications.
+   * 
+   * @example
+   * 15
+   */
+  verifyDeviceSuccess?: number;
+  /**
+   * @remarks
+   * Number of successful client authentications.
+   * 
+   * @example
+   * 6
+   */
+  verifyDeviceSuccessPassed?: number;
+  static names(): { [key: string]: string } {
+    return {
+      initDevice: 'InitDevice',
+      initDeviceId: 'InitDeviceId',
+      initDeviceIdSuccess: 'InitDeviceIdSuccess',
+      initDeviceSuccess: 'InitDeviceSuccess',
+      initService: 'InitService',
+      initServiceId: 'InitServiceId',
+      initServiceIdSuccess: 'InitServiceIdSuccess',
+      initServiceSuccess: 'InitServiceSuccess',
+      items: 'Items',
+      verifyDevice: 'VerifyDevice',
+      verifyDeviceId: 'VerifyDeviceId',
+      verifyDeviceIdSuccess: 'VerifyDeviceIdSuccess',
+      verifyDeviceIdSuccessPassed: 'VerifyDeviceIdSuccessPassed',
+      verifyDeviceSuccess: 'VerifyDeviceSuccess',
+      verifyDeviceSuccessPassed: 'VerifyDeviceSuccessPassed',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      initDevice: 'number',
+      initDeviceId: 'number',
+      initDeviceIdSuccess: 'number',
+      initDeviceSuccess: 'number',
+      initService: 'number',
+      initServiceId: 'number',
+      initServiceIdSuccess: 'number',
+      initServiceSuccess: 'number',
+      items: { 'type': 'array', 'itemType': DescribeVerifyStatisticsResponseBodyResultObjectItems },
+      verifyDevice: 'number',
+      verifyDeviceId: 'number',
+      verifyDeviceIdSuccess: 'number',
+      verifyDeviceIdSuccessPassed: 'number',
+      verifyDeviceSuccess: 'number',
+      verifyDeviceSuccessPassed: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeVerifyStatisticsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * ID of this request.
+   * 
+   * @example
+   * 4E27D502-1287-526A-910C-881A3F023914
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Statistical results
+   */
+  resultObject?: DescribeVerifyStatisticsResponseBodyResultObject;
+  static names(): { [key: string]: string } {
+    return {
+      requestId: 'RequestId',
+      resultObject: 'ResultObject',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      requestId: 'string',
+      resultObject: DescribeVerifyStatisticsResponseBodyResultObject,
+    };
+  }
+
+  validate() {
+    if(this.resultObject && typeof (this.resultObject as any).validate === 'function') {
+      (this.resultObject as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeVerifyTokenRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeVerifyTokenRequest extends $dara.Model {
   /**
    * @remarks
+   * Verification ID. A unique ID that identifies a verification task, not exceeding 64 characters. For a single verification task, the system supports unlimited submissions until the final verification is passed and the task is completed.
+   * 
+   * > Different BizIds are required for different verification tasks.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,8 @@ export class DescribeVerifyTokenRequest extends $dara.Model {
   bizId?: string;
   /**
    * @remarks
+   * Identifier for the business scenario using the real person authentication service. Please refer to [Business Settings](https://help.aliyun.com/document_detail/127885.html) and complete the creation in the console first.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,62 +26,105 @@ export class DescribeVerifyTokenRequest extends $dara.Model {
    */
   bizType?: string;
   /**
+   * @remarks
+   * Callback seed.
+   * 
    * @example
    * -
    */
   callbackSeed?: string;
   /**
+   * @remarks
+   * Callback URL.
+   * 
    * @example
    * -
    */
   callbackUrl?: string;
   /**
+   * @remarks
+   * HTTP or HTTPS link to the retained portrait photo.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   faceRetainedImageUrl?: string;
   /**
+   * @remarks
+   * Redirect URL for failed verification.
+   * 
    * @example
    * -
    */
   failedRedirectUrl?: string;
   /**
+   * @remarks
+   * HTTP or HTTPS link to the national emblem side of the ID card image.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   idCardBackImageUrl?: string;
   /**
+   * @remarks
+   * HTTP or HTTPS link to the portrait side of the ID card image.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   idCardFrontImageUrl?: string;
   /**
+   * @remarks
+   * ID card number.
+   * 
    * @example
    * 330100xxxxxxxxxxxx
    */
   idCardNumber?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * 张三
+   */
   name?: string;
   /**
+   * @remarks
+   * Redirect URL upon successful verification.
+   * 
    * @example
    * -
    */
   passedRedirectUrl?: string;
   /**
+   * @remarks
+   * ID of the end user, such as the account ID of the end user.
+   * 
    * @example
    * user111
    */
   userId?: string;
   /**
+   * @remarks
+   * User IP.
+   * 
    * @example
    * 192.168.***.***
    */
   userIp?: string;
   /**
+   * @remarks
+   * User phone number.
+   * 
    * @example
    * 187********
    */
   userPhoneNumber?: string;
   /**
+   * @remarks
+   * User registration time. Expressed in timestamp format, unit: milliseconds.
+   * 
    * @example
    * 1577808000000
    */

package/src/models/DescribeVerifyTokenResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeVerifyTokenResponseBodyOssUploadToken extends $dara.Model {
   /**
+   * @remarks
+   * OSS file storage bucket.
+   * 
    * @example
    * cloudauth-zhangjiakou-external
    */
   bucket?: string;
   /**
+   * @remarks
+   * Access endpoint.
+   * 
    * @example
    * https://oss-cn-zhangjiakou.aliyuncs.com
    */
   endPoint?: string;
   /**
+   * @remarks
+   * Expiration time. Expressed in timestamp format, unit: milliseconds.
+   * 
    * @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,18 +93,31 @@ export class DescribeVerifyTokenResponseBodyOssUploadToken extends $dara.Model {
 }
 
 export class DescribeVerifyTokenResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * OSS upload token information.
+   */
   ossUploadToken?: DescribeVerifyTokenResponseBodyOssUploadToken;
   /**
+   * @remarks
+   * The ID of this request.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
   /**
+   * @remarks
+   * The entry link for the original H5 verification scheme, which has been discontinued and no longer supports new integrations. If you need to integrate an H5 verification scheme, it is recommended to use the [PC or mobile H5 web integration solution](https://help.aliyun.com/document_detail/173779.html) of financial-grade real-person authentication.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   verifyPageUrl?: string;
   /**
+   * @remarks
+   * The token for this verification, used to link various interfaces in the verification request, valid for 30 minutes.
+   * 
    * @example
    * c302c0797679457685410ee51a5ba375
    */

package/src/models/DescribeWhitelistSettingRequest.ts

@@ -0,0 +1,147 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeWhitelistSettingRequest extends $dara.Model {
+  /**
+   * @remarks
+   * ID Number
+   * 
+   * @example
+   * 320321XXXXXXXX701X
+   */
+  certNo?: string;
+  /**
+   * @remarks
+   * Certification ID
+   * 
+   * @example
+   * shsf57a4e0d9981c3bd66dc754f3d3cd
+   */
+  certifyId?: string;
+  /**
+   * @remarks
+   * Pagination parameter: current page number, default value is 1.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1
+   */
+  currentPage?: number;
+  /**
+   * @remarks
+   * Specify the language to query. Values:
+   * - **zh**: Chinese
+   * - **en**: English
+   * 
+   * @example
+   * zh
+   */
+  lang?: string;
+  /**
+   * @remarks
+   * Number of items per page for pagination.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * Scene ID.
+   * 
+   * @example
+   * 1000004530
+   */
+  sceneId?: number;
+  /**
+   * @remarks
+   * Service Code:
+   * - **Enhanced Financial Grade**: cloudauthst
+   * - **Financial Grade**: antcloudauth
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * antcloudauth
+   */
+  serviceCode?: string;
+  /**
+   * @remarks
+   * Visitor\\"s source IP address.
+   * 
+   * @example
+   * 113.140.85.74
+   */
+  sourceIp?: string;
+  /**
+   * @remarks
+   * Whitelist status:
+   * - **VALID**: Valid
+   * - **INVALID**: Invalid
+   * - **DELETED**: Deleted
+   * 
+   * @example
+   * VALID
+   */
+  status?: string;
+  /**
+   * @remarks
+   * Expiration date.
+   * 
+   * @example
+   * 1730304000000
+   */
+  validEndDate?: number;
+  /**
+   * @remarks
+   * Effective start time (in seconds timestamp).
+   * 
+   * @example
+   * 1759939200000
+   */
+  validStartDate?: number;
+  static names(): { [key: string]: string } {
+    return {
+      certNo: 'CertNo',
+      certifyId: 'CertifyId',
+      currentPage: 'CurrentPage',
+      lang: 'Lang',
+      pageSize: 'PageSize',
+      sceneId: 'SceneId',
+      serviceCode: 'ServiceCode',
+      sourceIp: 'SourceIp',
+      status: 'Status',
+      validEndDate: 'ValidEndDate',
+      validStartDate: 'ValidStartDate',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      certNo: 'string',
+      certifyId: 'string',
+      currentPage: 'number',
+      lang: 'string',
+      pageSize: 'number',
+      sceneId: 'number',
+      serviceCode: 'string',
+      sourceIp: 'string',
+      status: 'string',
+      validEndDate: 'number',
+      validStartDate: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeWhitelistSettingResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeWhitelistSettingResponseBody } from "./DescribeWhitelistSettingResponseBody";
+
+
+export class DescribeWhitelistSettingResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeWhitelistSettingResponseBody;
+  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: DescribeWhitelistSettingResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+