@alicloud/cloudauth20190307 3.9.2 → 3.9.4

package/src/models/ModifyDeviceInfoRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDeviceInfoRequest extends $dara.Model {
   /**
+   * @remarks
+   * The updated business type. It should not exceed 64 characters and is defined by the connected party. It can be used to annotate specific businesses, for example, different face usage scenarios or the customer identifiers to be delivered.
+   * 
    * @example
    * FACE_TEST
    */
   bizType?: string;
   /**
    * @remarks
+   * A unique ID generated by the real-person authentication server for the connected device, which is only generated after the device is successfully activated. This ID can be obtained through the getLicenseExtraInfo function in the offline facial recognition SDK.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,16 +22,26 @@ export class ModifyDeviceInfoRequest extends $dara.Model {
    */
   deviceId?: string;
   /**
+   * @remarks
+   * The extended duration of the device expiration. Unit: years, with a range of [1,100]. A value of 100 indicates permanent use. One year is calculated as 365 days.
+   * 
    * @example
    * 1
    */
   duration?: string;
   /**
+   * @remarks
+   * The current expiration time of the device. If the expiration date is incorrect (differing from the real-person authentication server\\"s recorded expiration time by more than one week), an error will be reported.
+   * > The expiration time can be queried through the DescribeDeviceInfo interface. An incorrect expiration date will result in an error. This check ensures that the business party does not accidentally re-activate a device due to some misoperation, thus consuming the authorization unnecessarily.
+   * 
    * @example
    * 20190401
    */
   expiredDay?: string;
   /**
+   * @remarks
+   * The updated user device ID. It should not exceed 64 characters and is defined by the connected party. It can be used to identify specific devices, and it is recommended to use the physical number of the device.
+   * 
    * @example
    * 3iJ1AY$oHcu7mC69
    */

package/src/models/ModifyDeviceInfoResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDeviceInfoResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * If the Duration in the request parameters is not empty, this field represents the start time of the authorization after the device validity period has been extended. One year of Duration is calculated as 365 days. Example: 20180101.
+   * 
    * @example
    * 20190401
    */
   beginDay?: string;
   /**
+   * @remarks
+   * Corresponds to the BizType in the request parameters.
+   * 
    * @example
    * FACE_TEST
    */
   bizType?: string;
   /**
+   * @remarks
+   * Corresponds to the DeviceId in the request parameters.
+   * 
    * @example
    * wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
    */
   deviceId?: string;
   /**
+   * @remarks
+   * If the Duration in the request parameters is not empty, this field represents the expiration time of the authorization after the device validity period has been extended. One year of Duration is calculated as 365 days. Example: 20180101.
+   * 
    * @example
    * 20200330
    */
   expiredDay?: string;
   /**
+   * @remarks
+   * The ID of this request.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */
   requestId?: string;
   /**
+   * @remarks
+   * Corresponds to the UserDeviceId in the request parameters.
+   * 
    * @example
    * 3iJ1AY$oHcu7mC69
    */

package/src/models/PageQueryWhiteListSettingRequest.ts

@@ -4,46 +4,77 @@ import * as $dara from '@darabonba/typescript';
 
 export class PageQueryWhiteListSettingRequest extends $dara.Model {
   /**
+   * @remarks
+   * ID number.
+   * 
    * @example
    * 330103xxxxxxxxxxxx
    */
   certNo?: string;
   /**
+   * @remarks
+   * Unique identifier for real person authentication.
+   * 
    * @example
    * sha75b4e19a1ddda059b920757b0e12b
    */
   certifyId?: string;
   /**
+   * @remarks
+   * Current page number, default is 1.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
   /**
+   * @remarks
+   * Number of items per page, default is 10
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Authentication scene ID. This ID is automatically generated after creating an authentication scene in the console. For how to create an authentication scene, see Adding an Authentication Scene.
+   * 
    * @example
    * 1000000xxx
    */
   sceneId?: number;
   /**
+   * @remarks
+   * ServiceCode of the real person cloud product, value: **antcloudauth**.
+   * 
    * @example
    * antcloudauth
    */
   serviceCode?: string;
   /**
+   * @remarks
+   * Status:
+   * 
+   * - DELETE: Deleted
+   * - VALID: Not deleted and within the validity period, valid
+   * - INVALID: Not deleted but outside the validity period, invalid
+   * 
    * @example
    * VALID
    */
   status?: string;
   /**
+   * @remarks
+   * End date of validity (timestamp in milliseconds)
+   * 
    * @example
    * 1725379200000
    */
   validEndDate?: string;
   /**
+   * @remarks
+   * Start date of validity (timestamp in milliseconds)
+   * 
    * @example
    * 1725120000000
    */

package/src/models/PageQueryWhiteListSettingResponseBody.ts

@@ -1,49 +1,207 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { PageQueryWhiteListSettingResponseBodyResultObject } from "./PageQueryWhiteListSettingResponseBodyResultObject";
 
 
+export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * ID number.
+   * 
+   * @example
+   * 330103xxxxxxxxxxxx
+   */
+  certNo?: string;
+  /**
+   * @remarks
+   * Unique identifier for real person authentication.
+   * 
+   * @example
+   * sha43d9cabd52d370d9f4cca9468f71e
+   */
+  certifyId?: string;
+  /**
+   * @remarks
+   * Creation time.
+   * 
+   * @example
+   * 2024-08-30 14:00:00
+   */
+  gmtCreate?: string;
+  /**
+   * @remarks
+   * Modification time.
+   * 
+   * @example
+   * 2024-08-30 14:00:00
+   */
+  gmtModified?: string;
+  /**
+   * @remarks
+   * Whitelist ID.
+   * 
+   * @example
+   * 234822
+   */
+  id?: number;
+  /**
+   * @remarks
+   * Remark information.
+   * 
+   * @example
+   * test
+   */
+  remark?: string;
+  /**
+   * @remarks
+   * Authentication scene ID.
+   * 
+   * @example
+   * 1000000332
+   */
+  sceneId?: number;
+  /**
+   * @remarks
+   * ServiceCode of the real person cloud product
+   * 
+   * @example
+   * antcloudauth
+   */
+  serviceCode?: string;
+  /**
+   * @remarks
+   * Status:
+   * 
+   * - DELETE: Deleted
+   * - VALID: Not deleted and within the validity period, valid
+   * - INVALID: Not deleted but outside the validity period, invalid
+   * 
+   * @example
+   * VALID
+   */
+  status?: string;
+  /**
+   * @remarks
+   * End date of validity
+   * 
+   * @example
+   * 2024-09-02 13:57:51
+   */
+  validEndDate?: string;
+  /**
+   * @remarks
+   * Start date of validity
+   * 
+   * @example
+   * 2024-08-30 13:57:51
+   */
+  validStartDate?: string;
+  static names(): { [key: string]: string } {
+    return {
+      certNo: 'CertNo',
+      certifyId: 'CertifyId',
+      gmtCreate: 'GmtCreate',
+      gmtModified: 'GmtModified',
+      id: 'Id',
+      remark: 'Remark',
+      sceneId: 'SceneId',
+      serviceCode: 'ServiceCode',
+      status: 'Status',
+      validEndDate: 'ValidEndDate',
+      validStartDate: 'ValidStartDate',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      certNo: 'string',
+      certifyId: 'string',
+      gmtCreate: 'string',
+      gmtModified: 'string',
+      id: 'number',
+      remark: 'string',
+      sceneId: 'number',
+      serviceCode: 'string',
+      status: 'string',
+      validEndDate: 'string',
+      validStartDate: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code, **200** indicates a successful API response.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Current page number.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Number of items per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 5A6229C0-E156-48E4-B6EC-0F528BDF60D2
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Request result
+   */
   resultObject?: PageQueryWhiteListSettingResponseBodyResultObject[];
   /**
+   * @remarks
+   * Whether the response was successful.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * Total number of items.
+   * 
    * @example
    * 28
    */
   totalItem?: number;
   /**
+   * @remarks
+   * Total number of pages.
+   * 
    * @example
    * 3
    */

package/src/models/RemoveWhiteListSettingRequest.ts

@@ -3,8 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RemoveWhiteListSettingRequest extends $dara.Model {
+  /**
+   * @remarks
+   * IDs of the whitelist to be deleted in bulk.
+   */
   ids?: number[];
   /**
+   * @remarks
+   * ServiceCode for the real person cloud product, only value: **antcloudauth**.
+   * 
    * @example
    * antcloudauth
    */

package/src/models/RemoveWhiteListSettingResponseBody.ts

@@ -4,29 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class RemoveWhiteListSettingResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */
   requestId?: string;
   /**
+   * @remarks
+   * Returned result information.
+   * 
    * @example
    * true
    */
   resultObject?: boolean;
   /**
+   * @remarks
+   * Whether the response was successful.
+   * 
    * @example
    * true
    */

package/src/models/RemoveWhiteListSettingShrinkRequest.ts

@@ -3,8 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RemoveWhiteListSettingShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * IDs of the whitelist to be deleted in bulk.
+   */
   idsShrink?: string;
   /**
+   * @remarks
+   * ServiceCode for the real person cloud product, only value: **antcloudauth**.
+   * 
    * @example
    * antcloudauth
    */

package/src/models/Vehicle5itemQueryRequest.ts

@@ -4,12 +4,36 @@ import * as $dara from '@darabonba/typescript';
 
 export class Vehicle5ItemQueryRequest extends $dara.Model {
   /**
+   * @remarks
+   * Parameter type:
+   * 
+   * - **normal**: Unencrypted.
+   * - **md5**: MD5 encrypted.
+   * 
    * @example
    * normal
    */
   paramType?: string;
+  /**
+   * @remarks
+   * License plate number
+   * 
+   * > 
+   * > - When paramType is set to normal, enter the plain text.
+   * > - When paramType is set to md5, enter the plain text of all but the last two characters of the license plate + MD5 encryption (32-bit lowercase MD5) of the last two characters.
+   * 
+   * @example
+   * 陕A9****
+   */
   vehicleNum?: string;
   /**
+   * @remarks
+   * Vehicle type
+   * 
+   * > 
+   * > - 02: Ordinary passenger car
+   * > - 52: New energy passenger car
+   * 
    * @example
    * 02
    */

package/src/models/Vehicle5itemQueryResponseBody.ts

@@ -1,24 +1,90 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { Vehicle5ItemQueryResponseBodyResultObject } from "./Vehicle5itemQueryResponseBodyResultObject";
 
 
+export class Vehicle5ItemQueryResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Verification result code:
+   * - **1**: Found (charged)
+   * - **3**: No record found (not charged)
+   * 
+   * @example
+   * 1
+   */
+  bizCode?: string;
+  /**
+   * @remarks
+   * Vehicle information
+   * 
+   * @example
+   * {
+   *         "engineNo": "F0******",
+   *         "useProperty": 0,
+   *         "registrationDate": "****-**-** **:**:**",
+   *         "engineType": "B******",
+   *         "vin": "A********",
+   *         "state": "0",
+   *         "modelNo": "B********",
+   *         "type": "小型轿车",
+   *         "brand": "宝马",
+   *         "usePropertyDesc": "非营运",
+   *         "stateDesc": "正常"
+   *     }
+   */
+  vehicleInfo?: string;
+  static names(): { [key: string]: string } {
+    return {
+      bizCode: 'BizCode',
+      vehicleInfo: 'VehicleInfo',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bizCode: 'string',
+      vehicleInfo: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class Vehicle5ItemQueryResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0D******
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result information.
+   */
   resultObject?: Vehicle5ItemQueryResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/VehicleInsureQueryRequest.ts

@@ -4,17 +4,44 @@ import * as $dara from '@darabonba/typescript';
 
 export class VehicleInsureQueryRequest extends $dara.Model {
   /**
+   * @remarks
+   * Parameter type:
+   * 
+   * - **normal**: Unencrypted.
+   * - **md5**: MD5 encrypted.
+   * 
    * @example
    * normal
    */
   paramType?: string;
+  /**
+   * @remarks
+   * License plate number
+   * > 
+   * > - When `paramType` is set to `normal`, enter the plain text.
+   * > - When `paramType` is set to `md5`, enter the plain text of all but the last two characters of the license plate + the MD5 encryption (32 lowercase characters) of the last two characters of the license plate.
+   * 
+   * @example
+   * 陕A9****
+   */
   vehicleNum?: string;
   /**
+   * @remarks
+   * Driver\\"s license vehicle type.
+   * 
    * @example
    * 02
    */
   vehicleType?: string;
   /**
+   * @remarks
+   * Vehicle identification code, i.e., the vehicle VIN
+   * 
+   * 
+   * > 
+   * > - When `paramType` is set to `normal`, enter the plain text.
+   * > - When `paramType` is set to `md5`, enter the plain text of all but the last four characters of the VIN + the MD5 encryption (32 lowercase characters) of the last four characters of the VIN.
+   * 
    * @example
    * LB**************
    */