@alicloud/cloudauth20190307 3.9.5 → 3.11.0

package/src/models/CredentialVerifyRequest.ts

@@ -3,7 +3,23 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CredentialVerifyRequestMerchantDetail extends $dara.Model {
+  /**
+   * @remarks
+   * The private key of the certificate.
+   * 
+   * >  If this parameter is specified, you must also specify **CertName** and **Cert**. If **CertName**, **Cert**, and **Key** are specified, you do not need to specify **CertId**.
+   * 
+   * @example
+   * keyword
+   */
   key?: string;
+  /**
+   * @remarks
+   * Keyword value.
+   * 
+   * @example
+   * -
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -30,50 +46,166 @@ export class CredentialVerifyRequestMerchantDetail extends $dara.Model {
 
 export class CredentialVerifyRequest extends $dara.Model {
   /**
+   * @remarks
+   * Relevant certificate number.
+   * 
    * @example
    * 4601*****
    */
   certNum?: string;
   /**
+   * @remarks
+   * - 01: Personal ID cards
+   *   - **0101**: ID card
+   *   - **0102**: Bank card
+   *   - **0104**: Teacher qualification certificate
+   *   - **0107**: Student ID card
+   * - 02: Business scenario
+   *   - **0201**: Storefront photo
+   *   - **0202**: Counter photo
+   *   - **0203**: Scene photo
+   * - 03: Corporate qualifications
+   *   - **0301**: Business license
+   * 
    * @example
    * 0104
    */
   credName?: string;
   /**
+   * @remarks
+   * Credential type:
+   * 
+   * - 01: Personal ID cards
+   * - 02: Business scenario
+   * - 03: Corporate qualifications
+   * 
    * @example
    * 01
    */
   credType?: string;
   /**
+   * @remarks
+   * ID number:
+   * 
+   * Note
+   * Only supports the ID numbers of second-generation resident IDs and Hong Kong, Macao, and Taiwan residence permits.
+   * 
+   * - When paramType is normal: enter the plaintext ID number.
+   * 
+   * - When paramType is md5: first 6 digits of the ID number (plaintext) + date of birth (ciphertext) + last 4 digits of the ID number (plaintext).
+   * 
    * @example
    * 429001********8211
    */
   identifyNum?: string;
   /**
+   * @remarks
+   * Base64 encoded image, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
    * @example
    * base64
    */
   imageContext?: string;
   /**
+   * @remarks
+   * Image URL, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
    * @example
    * http://marry.momocdn.com/avatar/3B/B6/3BB6527E-7467-926E-1048-B43614F20CC420230803_L.jpg
    */
   imageUrl?: string;
   /**
+   * @remarks
+   * Whether to enable authoritative authentication
+   * 
+   * - ****0****: No
+   * - **1**: Yes
+   * 
    * @example
    * 0
    */
   isCheck?: string;
   /**
+   * @remarks
+   * Whether to enable OCR recognition.
+   * 
+   * - **0**: No
+   * - **1**: Yes
+   * 
+   * > IsOCR can be set to 1 only when **CredType** is 01.
+   * 
    * @example
    * 1
    */
   isOCR?: string;
+  /**
+   * @remarks
+   * Merchant details:
+   * 
+   * 
+   * > This field is required when PromptModel is set to DEFAULT.
+   */
   merchantDetail?: CredentialVerifyRequestMerchantDetail[];
+  /**
+   * @remarks
+   * Merchant ID. 
+   * 
+   * > This field is required when ****CredName**** is set to **02**.
+   * 
+   * @example
+   * 913100********KW8P
+   */
   merchantId?: string;
+  /**
+   * @remarks
+   * Invocation mode:
+   * 
+   * - **ANTI_FAKE_CHECK**: Image anti-forgery check
+   * 
+   * - **ANTI_FAKE_VL**: Image anti-forgery check and semantic understanding
+   * 
+   * - **IMAGE_VL_COG**: Image semantic understanding
+   * 
+   * Default value: ANTI_FAKE_CHECK
+   * 
+   * > When **CredType** is set to 02, **ProductCode** can only be ANTI_FAKE_VL or IMAGE_VL_COG.
+   * 
+   * @example
+   * ANTI_FAKE_CHECK
+   */
   productCode?: string;
+  /**
+   * @remarks
+   * Customer-defined prompt content for image semantic understanding.
+   * 
+   * 
+   * > This field is required when PromptModel is set to CUSTOM.
+   * 
+   * @example
+   * -
+   */
   prompt?: string;
+  /**
+   * @remarks
+   * Prompt acquisition method for image semantic understanding:
+   * 
+   * - **DEFAULT**: System default
+   * 
+   * - **CUSTOM**: Customer-defined
+   * 
+   * > When **ProductCode** is set to **ANTI_FAKE_VL** or **IMAGE_VL_COG**, this parameter must be provided.
+   * 
+   * @example
+   * DEFAULT
+   */
   promptModel?: string;
+  /**
+   * @remarks
+   * UserName
+   * 
+   * @example
+   * 张*
+   */
   userName?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CredentialVerifyResponseBody.ts

@@ -3,7 +3,28 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CredentialVerifyResponseBodyResultObjectVlResult extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the call was successful. Valid values:
+   * 
+   * - **true**: The call was successful.
+   * - **false**: The call failed.
+   * 
+   * @example
+   * true
+   */
   success?: boolean;
+  /**
+   * @remarks
+   * Image understanding result:
+   * 
+   * - When PromptModel is DEFAULT, the output format refers to the example on the right.
+   * 
+   * - When PromptModel is CUSTOM, the output format follows the agreed format of the Prompt.
+   * 
+   * @example
+   * {\\"这张图有没有明显的PS特征\\":0,\\"图片是否为正常经营照片\\":1,\\"图片中有没有58、美团、大众点评字样\\":0,\\"这张图有没有网站信息\\":0,\\"图片经营的场景是否为酒店\\":0}
+   */
   vlContent?: string;
   static names(): { [key: string]: string } {
     return {
@@ -29,29 +50,98 @@ export class CredentialVerifyResponseBodyResultObjectVlResult extends $dara.Mode
 }
 
 export class CredentialVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Additional information in JSON format.
+   * 
+   * @example
+   * {
+   * 
+   * "sameBackgroundDetail": {
+   * 
+   * // 相似背景对于的原始图请求RequestId
+   * 
+   * "originalRequestId": "130A2C10-B9EE-4D84-88E3-5384FF03****";
+   * 
+   * // 相似背景对于的原始图请求商户ID
+   * 
+   * "originalMerchantId": "xxxxxxxx"
+   * 
+   * }
+   * 
+   * }
+   */
   materialInfo?: string;
+  /**
+   * @remarks
+   * OCR recognition result.
+   * 
+   * @example
+   * {
+   *    "certNo":"20216*********",
+   *   "certType":"小学教师资格",
+   *    "gender":"男",
+   *    "subject":"美术",
+   *     "name":"李**",
+   *     "ext_info":"{}",
+   *     "birthDate":"1998-07-28",
+   *     "idNo":"620************",
+   *     "certOrg":""
+   * }
+   */
   ocrInfo?: string;
   /**
+   * @remarks
+   * Risk result
+   * 
+   * - **0**: Low risk
+   * - **1**: High risk
+   * - **2**: Suspicious
+   * 
    * @example
    * 1
    */
   result?: string;
+  /**
+   * @remarks
+   * Risk score map.
+   */
   riskScore?: { [key: string]: string };
   /**
+   * @remarks
+   * Risk tags, separated by commas (,), including:
+   * 
+   * - **PS**: Image manipulation.
+   * - **SCREEN_PHOTO**: Screen recapture.
+   * - **SCREENSHOT**: Screenshot.
+   * - **WATERMARK**: Watermark.
+   * - **SAME_BACKGROUND**: Similar background.
+   * - **ORIGINAL_PHOTO**: Not the original image
+   * 
    * @example
    * PS,SCREEN_PHOTO
    */
   riskTag?: string;
   /**
+   * @remarks
+   * Authority verification details.
+   * 
    * @example
    * **
    */
   verifyDetail?: string;
   /**
+   * @remarks
+   * The verification result.
+   * 
    * @example
    * *
    */
   verifyResult?: string;
+  /**
+   * @remarks
+   * Qwen interpretation.
+   */
   vlResult?: CredentialVerifyResponseBodyResultObjectVlResult;
   static names(): { [key: string]: string } {
     return {
@@ -96,20 +186,33 @@ export class CredentialVerifyResponseBodyResultObject extends $dara.Model {
 
 export class CredentialVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * D6163397-15C5-419C-9ACC-B7C83E0B4C10
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result
+   */
   resultObject?: CredentialVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/CredentialVerifyShrinkRequest.ts

@@ -4,50 +4,166 @@ import * as $dara from '@darabonba/typescript';
 
 export class CredentialVerifyShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * Relevant certificate number.
+   * 
    * @example
    * 4601*****
    */
   certNum?: string;
   /**
+   * @remarks
+   * - 01: Personal ID cards
+   *   - **0101**: ID card
+   *   - **0102**: Bank card
+   *   - **0104**: Teacher qualification certificate
+   *   - **0107**: Student ID card
+   * - 02: Business scenario
+   *   - **0201**: Storefront photo
+   *   - **0202**: Counter photo
+   *   - **0203**: Scene photo
+   * - 03: Corporate qualifications
+   *   - **0301**: Business license
+   * 
    * @example
    * 0104
    */
   credName?: string;
   /**
+   * @remarks
+   * Credential type:
+   * 
+   * - 01: Personal ID cards
+   * - 02: Business scenario
+   * - 03: Corporate qualifications
+   * 
    * @example
    * 01
    */
   credType?: string;
   /**
+   * @remarks
+   * ID number:
+   * 
+   * Note
+   * Only supports the ID numbers of second-generation resident IDs and Hong Kong, Macao, and Taiwan residence permits.
+   * 
+   * - When paramType is normal: enter the plaintext ID number.
+   * 
+   * - When paramType is md5: first 6 digits of the ID number (plaintext) + date of birth (ciphertext) + last 4 digits of the ID number (plaintext).
+   * 
    * @example
    * 429001********8211
    */
   identifyNum?: string;
   /**
+   * @remarks
+   * Base64 encoded image, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
    * @example
    * base64
    */
   imageContext?: string;
   /**
+   * @remarks
+   * Image URL, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
    * @example
    * http://marry.momocdn.com/avatar/3B/B6/3BB6527E-7467-926E-1048-B43614F20CC420230803_L.jpg
    */
   imageUrl?: string;
   /**
+   * @remarks
+   * Whether to enable authoritative authentication
+   * 
+   * - ****0****: No
+   * - **1**: Yes
+   * 
    * @example
    * 0
    */
   isCheck?: string;
   /**
+   * @remarks
+   * Whether to enable OCR recognition.
+   * 
+   * - **0**: No
+   * - **1**: Yes
+   * 
+   * > IsOCR can be set to 1 only when **CredType** is 01.
+   * 
    * @example
    * 1
    */
   isOCR?: string;
+  /**
+   * @remarks
+   * Merchant details:
+   * 
+   * 
+   * > This field is required when PromptModel is set to DEFAULT.
+   */
   merchantDetailShrink?: string;
+  /**
+   * @remarks
+   * Merchant ID. 
+   * 
+   * > This field is required when ****CredName**** is set to **02**.
+   * 
+   * @example
+   * 913100********KW8P
+   */
   merchantId?: string;
+  /**
+   * @remarks
+   * Invocation mode:
+   * 
+   * - **ANTI_FAKE_CHECK**: Image anti-forgery check
+   * 
+   * - **ANTI_FAKE_VL**: Image anti-forgery check and semantic understanding
+   * 
+   * - **IMAGE_VL_COG**: Image semantic understanding
+   * 
+   * Default value: ANTI_FAKE_CHECK
+   * 
+   * > When **CredType** is set to 02, **ProductCode** can only be ANTI_FAKE_VL or IMAGE_VL_COG.
+   * 
+   * @example
+   * ANTI_FAKE_CHECK
+   */
   productCode?: string;
+  /**
+   * @remarks
+   * Customer-defined prompt content for image semantic understanding.
+   * 
+   * 
+   * > This field is required when PromptModel is set to CUSTOM.
+   * 
+   * @example
+   * -
+   */
   prompt?: string;
+  /**
+   * @remarks
+   * Prompt acquisition method for image semantic understanding:
+   * 
+   * - **DEFAULT**: System default
+   * 
+   * - **CUSTOM**: Customer-defined
+   * 
+   * > When **ProductCode** is set to **ANTI_FAKE_VL** or **IMAGE_VL_COG**, this parameter must be provided.
+   * 
+   * @example
+   * DEFAULT
+   */
   promptModel?: string;
+  /**
+   * @remarks
+   * UserName
+   * 
+   * @example
+   * 张*
+   */
   userName?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DeleteAllCustomizeFlowStrategyRequest.ts

@@ -0,0 +1,46 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteAllCustomizeFlowStrategyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Region ID
+   * 
+   * @example
+   * cn-shanghai
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * User ID
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 126005125163xxxx
+   */
+  userId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      regionId: 'RegionId',
+      userId: 'UserId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      regionId: 'string',
+      userId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteAllCustomizeFlowStrategyResponse.ts

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

@@ -0,0 +1,84 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteAllCustomizeFlowStrategyResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Return code: 200 indicates success, others indicate failure.
+   * 
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @remarks
+   * Returned data.
+   * 
+   * @example
+   * 1
+   */
+  data?: number;
+  /**
+   * @remarks
+   * HTTP status code.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * Return message.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * ID of this request.
+   * 
+   * @example
+   * 8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the response was successful.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      httpStatusCode: 'HttpStatusCode',
+      message: 'Message',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: 'number',
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteAntCloudAuthSceneRequest.ts

@@ -0,0 +1,36 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteAntCloudAuthSceneRequest extends $dara.Model {
+  /**
+   * @remarks
+   * ID of the scene to be deleted.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1000011589
+   */
+  sceneId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      sceneId: 'SceneId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      sceneId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+