@alicloud/cloudauth20190307 3.9.5 → 3.11.0

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

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

package/src/models/DescribePageSettingResponseBody.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribePageSettingResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Failure reasons.
+   * 
+   * @example
+   * {
+   *             "11": "认证不通过，可能原因：1、公安网照片缺失；2、公安网照片格式错误；3、公安网照片找不到人脸等可能",
+   *             "1": "认证通过",
+   *             "12": "认证不通过，可能原因：公安网系统异常，无法比对等可能",
+   *             "2": "认证不通过，原因：实名校验不通过",
+   *             "3": "认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证姓名不一致；3、提交的照片为非身份证照片等可能",
+   *             "4": "认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证号码不一致；3、提交的照片为非身份证照片等可能",
+   *             "5": "认证不通过，可能原因：身份证照片有效期已过期（或即将过期）等可能",
+   *             "6": "认证不通过，可能原因：人脸与身份证头像不一致等可能",
+   *             "7": "认证不通过，可能原因：人脸与公安网照片不一致等可能",
+   *             "8": "认证不通过，可能原因：1、提交的身份证照片非身份证原照片；2、未提交有效身份证照片等可能",
+   *             "9": "认证不通过，可能原因：非账号本人操作等可能",
+   *             "10": "认证不通过，可能原因：非同人操作等可能"
+   *         }
+   */
+  failReasons?: { [key: string]: any };
+  /**
+   * @remarks
+   * The ID of this request.
+   * 
+   * @example
+   * C58A8581-6A5B-55F1-B2EF-1CEAC97DA181
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      failReasons: 'FailReasons',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      failReasons: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.failReasons) {
+      $dara.Model.validateMap(this.failReasons);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeProductCodeResponse.ts

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

package/src/models/DescribeProductCodeResponseBody.ts

@@ -0,0 +1,124 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeProductCodeResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * Product code.
+   * 
+   * @example
+   * ID_PRO
+   */
+  productCode?: string;
+  /**
+   * @remarks
+   * Name corresponding to the product code.
+   * 
+   * @example
+   * APP认证
+   */
+  productName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      productCode: 'ProductCode',
+      productName: 'ProductName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      productCode: 'string',
+      productName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeProductCodeResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Current query page number.
+   * 
+   * @example
+   * 1
+   */
+  currentPage?: number;
+  /**
+   * @remarks
+   * List of product code information.
+   */
+  items?: DescribeProductCodeResponseBodyItems[];
+  /**
+   * @remarks
+   * Number of products per page.
+   * 
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * ID of this request.
+   * 
+   * @example
+   * 7FBBADA3-9A66-5759-8AF8-2F99F5BE13F7
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Total number of returned results.
+   * 
+   * @example
+   * 1
+   */
+  totalCount?: number;
+  /**
+   * @remarks
+   * Total number of pages.
+   * 
+   * @example
+   * 3
+   */
+  totalPage?: number;
+  static names(): { [key: string]: string } {
+    return {
+      currentPage: 'CurrentPage',
+      items: 'Items',
+      pageSize: 'PageSize',
+      requestId: 'RequestId',
+      totalCount: 'TotalCount',
+      totalPage: 'TotalPage',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      currentPage: 'number',
+      items: { 'type': 'array', 'itemType': DescribeProductCodeResponseBodyItems },
+      pageSize: 'number',
+      requestId: 'string',
+      totalCount: 'number',
+      totalPage: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

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

package/src/models/DescribeSmartStatisticsPageListResponseBody.ts

@@ -4,32 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSmartStatisticsPageListResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * Date. Format: <i>month/day</i>
+   * 
    * @example
    * 11/8
    */
   date?: string;
   /**
+   * @remarks
+   * Pass rate.
+   * 
    * @example
    * 25
    */
   passRate?: string;
   /**
+   * @remarks
+   * Product solution Code, please refer to the Enhanced Real Person Help Documentation.
+   * 
    * @example
    * SMART_VERIFY
    */
   productCode?: string;
   /**
+   * @remarks
+   * Scene ID.
+   * 
    * @example
    * 20**40
    */
   sceneId?: number;
+  /**
+   * @remarks
+   * Scene name.
+   * 
+   * @example
+   * ****实名认证
+   */
   sceneName?: string;
   /**
+   * @remarks
+   * Number of successful calls.
+   * 
    * @example
    * 1
    */
   successCount?: number;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 4
    */
@@ -69,27 +94,46 @@ export class DescribeSmartStatisticsPageListResponseBodyItems extends $dara.Mode
 
 export class DescribeSmartStatisticsPageListResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Current page number.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
+  /**
+   * @remarks
+   * Returned data list.
+   */
   items?: DescribeSmartStatisticsPageListResponseBodyItems[];
   /**
+   * @remarks
+   * Number of items displayed per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * ID of this request.
+   * 
    * @example
    * 96943***4E39F805
    */
   requestId?: string;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 29
    */
   totalCount?: number;
   /**
+   * @remarks
+   * Total number of pages.
+   * 
    * @example
    * 3
    */