@alicloud/dataworks-public20200518 10.1.0 → 10.1.2

package/src/models/CreateTableResponseBody.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateTableResponseBodyTaskInfo extends $dara.Model {
   /**
    * @remarks
-   * The details about the status of the current subtask.
-   * 
-   * - If the current subtask is successful, success is returned.
-   * 
-   * - If the current subtask fails, the error details are displayed.
+   * The detailed execution status of the current subtask. Details:
+   * - If the execution is successful, success is displayed.
+   * - If the execution fails, the corresponding error details are displayed.
    * 
    * @example
    * success
@@ -17,7 +15,7 @@ export class CreateTableResponseBodyTaskInfo extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete.
+   * The ID of the next subtask to be executed. If this parameter is empty, all subtasks are completed.
    * 
    * @example
    * abc1
@@ -26,12 +24,9 @@ export class CreateTableResponseBodyTaskInfo extends $dara.Model {
   /**
    * @remarks
    * The status of the current subtask. Valid values:
-   * 
-   * - operating: The subtask is running.
-   * 
-   * - success: The subtask succeeds.
-   * 
-   * - failure: The subtask fails to run. For more information about the error details, see the Content parameter.
+   * - operating: The subtask is being executed.
+   * - success: The subtask is executed successfully.
+   * - failure: The subtask fails to be executed. For more information about the error details, see the Content parameter.
    * 
    * @example
    * success
@@ -83,13 +78,11 @@ export class CreateTableResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete.
-   * 
-   * If a request task is aborted due to one of the following issues, address the issue based on the error code and initiate the request task again:
+   * The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are executed in sequence. The next subtask is executed only after the current subtask is executed. The request task ends when all subtasks are completed.
    * 
+   * The request task is terminated in the following scenarios. You must troubleshoot the issue based on the error code and resubmit the request task:
    * - The request task fails to be submitted.
-   * 
-   * - After the request task is submitted, a subtask fails to run.
+   * - A subtask fails to be executed after the request task is submitted.
    */
   taskInfo?: CreateTableResponseBodyTaskInfo;
   static names(): { [key: string]: string } {

package/src/models/CreateTableThemeRequest.ts

@@ -20,7 +20,7 @@ export class CreateTableThemeRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * Topic name
+   * Theme name
    */
   name?: string;
   /**

package/src/models/CreateUdfFileRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateUdfFileRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the class in which the function is defined. This parameter corresponds to the Class Name parameter in the Register Function section of the configuration tab of the function in the DataWorks console.
+   * The name of the class where the function is defined. This parameter corresponds to the Class Name field in the Create Function dialog box.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   className?: string;
   /**
    * @remarks
-   * The syntax used for calling the function. This parameter corresponds to the Expression Syntax parameter in the Register Function section of the configuration tab of the function in the DataWorks console.
+   * The command format to invoke function calling. This parameter corresponds to the Command Format field in the Create Function form.
    * 
    * @example
    * StringConcat(String... substrs)
@@ -23,10 +23,11 @@ export class CreateUdfFileRequest extends $dara.Model {
   cmdDescription?: string;
   /**
    * @remarks
-   * Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:
+   * Specifies whether to enable automatic creation of the folder specified by the FileFolderPath parameter if the folder does not exist in the system. Valid values:
    * 
-   * *   true: The system automatically creates the directory if the directory does not exist.
-   * *   false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.
+   * - true: Enables automatic creation of the folder if it does not exist.
+   * 
+   * - false: The call fails if the folder does not exist.
    * 
    * @example
    * false
@@ -34,7 +35,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   createFolderIfNotExists?: boolean;
   /**
    * @remarks
-   * The example for calling the function. This parameter corresponds to the Example parameter in the Register Function section of the configuration tab of the function in the DataWorks console.
+   * The example to invoke function calling. This parameter corresponds to the Example field in the Create Function form.
    * 
    * @example
    * StringConcat(\\"a\\", \\"b\\", \\"c\\")
@@ -42,7 +43,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   example?: string;
   /**
    * @remarks
-   * The path of the folder in which the file for the function is stored.
+   * The path of the folder where the function file is located.
    * 
    * @example
    * Business_process/First_Business_Process/function/string_processing
@@ -50,7 +51,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   fileFolderPath?: string;
   /**
    * @remarks
-   * The name of the file for the function.
+   * The name of the function.
    * 
    * This parameter is required.
    * 
@@ -60,7 +61,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   fileName?: string;
   /**
    * @remarks
-   * The type of the function. Valid values: MATH, AGGREGATE, STRING, DATE, ANALYTIC, and OTHER. This parameter corresponds to the Function Type parameter in the Register Function section of the configuration tab of the function on the DataStudio page.
+   * The category of the function. This parameter corresponds to the Function Type field in the Create Function dialog box. Valid values: MATH (mathematical operation functions), AGGREGATE (aggregate functions), STRING (string processing functions), DATE (date processing functions), ANALYTIC (window functions), and OTHER (other functions).
    * 
    * This parameter is required.
    * 
@@ -70,7 +71,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   functionType?: string;
   /**
    * @remarks
-   * The description of the input parameters of the function. This parameter corresponds to the Parameter Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.
+   * The description of the input parameters of the function. This parameter corresponds to the parameter description field in the Create Function form.
    * 
    * @example
    * List of strings to be connected
@@ -78,7 +79,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   parameterDescription?: string;
   /**
    * @remarks
-   * The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.
+   * The ID of the DataWorks workspace. You can click the wrench icon in the upper-right corner of the page to go to the Workspace Management page and view the ID.
    * 
    * @example
    * 10000
@@ -86,9 +87,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.
-   * 
-   * You must specify either this parameter or the projectId parameter to determine the DataWorks workspace to which the operation is called.
+   * The unique identifier of the DataWorks workspace. It is the English identifier displayed when you switch workspaces at the top of the Data Studio page.
    * 
    * @example
    * dw_project
@@ -96,7 +95,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   projectIdentifier?: string;
   /**
    * @remarks
-   * The names of the resources that are referenced by the function. This parameter corresponds to the Resources parameter in the Register Function section of the configuration tab of the function in the DataWorks console. Multiple resource names are separated by commas (,).
+   * The list of names of the resources referenced by the function. This parameter corresponds to the Resources field in the Create Function dialog box. Separate multiple resource names with commas (,).
    * 
    * This parameter is required.
    * 
@@ -106,7 +105,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   resources?: string;
   /**
    * @remarks
-   * The description of the return value of the function. This parameter corresponds to the Return Value parameter in the Register Function section of the configuration tab of the function on the DataStudio page.
+   * The description of the return value of the function. This parameter corresponds to the Return Value field in the Create Function dialog box.
    * 
    * @example
    * New strings generated by concatenating all strings before and after the input order
@@ -114,7 +113,7 @@ export class CreateUdfFileRequest extends $dara.Model {
   returnValue?: string;
   /**
    * @remarks
-   * The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.
+   * The description of the function purpose. This parameter corresponds to the Description field in the Create Function dialog box.
    * 
    * @example
    * Concatenate several strings to generate a new string

package/src/models/CreateUdfFileResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateUdfFileResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the file that was created.
+   * The ID of the created file.
    * 
    * @example
    * 100000002
@@ -13,7 +13,7 @@ export class CreateUdfFileResponseBody extends $dara.Model {
   data?: number;
   /**
    * @remarks
-   * The error code returned.
+   * The error code.
    * 
    * @example
    * Invalid.Tenant.ConnectionNotExists
@@ -21,7 +21,7 @@ export class CreateUdfFileResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned.
+   * The error message.
    * 
    * @example
    * The connection does not exist.
@@ -29,7 +29,7 @@ export class CreateUdfFileResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The HTTP status code returned.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -37,7 +37,7 @@ export class CreateUdfFileResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request. You can troubleshoot issues based on the ID.
+   * The unique ID of the request. You can use the ID to troubleshoot issues if an error occurs.
    * 
    * @example
    * 0000-ABCD-EFG****

package/src/models/DataDesensPlanTemplateValue.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DataDesensPlanTemplateValue extends $dara.Model {
   /**
    * @remarks
-   * The name of the Desensitization Method.
+   * The name of the masking method.
    * 
    * @example
    * hash
@@ -13,11 +13,9 @@ export class DataDesensPlanTemplateValue extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Indicates whether watermarking is supported. Valid values:
-   * 
-   * - true: Watermarking is supported.
-   * 
-   * - false: Watermarking is not supported.
+   * Indicates whether adding watermarks is allowed. Valid values:
+   * - true: Allowed.
+   * - false: Not allowed.
    * 
    * @example
    * true
@@ -25,7 +23,7 @@ export class DataDesensPlanTemplateValue extends $dara.Model {
   supportWaterMark?: boolean;
   /**
    * @remarks
-   * A list of Desensitization Parameters and their descriptions.
+   * The list of masking parameters and their descriptions.
    */
   extParamTemplate?: any[];
   static names(): { [key: string]: string } {

package/src/models/DeleteDataServiceApiAuthorityRequest.ts

@@ -5,40 +5,40 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataServiceApiAuthorityRequest extends $dara.Model {
   /**
    * @remarks
-   * The API ID.
+   * The ID of the API.
    * 
    * This parameter is required.
    * 
    * @example
-   * 10001
+   * 10003
    */
   apiId?: number;
   /**
    * @remarks
-   * The ID of the workspace from which you want to revoke the access permissions on the API.
+   * The ID of the workspace whose authorization is revoked.
    * 
    * This parameter is required.
    * 
    * @example
-   * 10002
+   * 10004
    */
   authorizedProjectId?: number;
   /**
    * @remarks
-   * The workspace ID.
+   * The ID of the workspace.
    * 
    * This parameter is required.
    * 
    * @example
-   * 10003
+   * 10002
    */
   projectId?: number;
   /**
    * @remarks
-   * The tenant ID. This parameter is deprecated.
+   * **[Deprecated]** The ID of the tenant.
    * 
    * @example
-   * 10004
+   * 10001
    */
   tenantId?: number;
   static names(): { [key: string]: string } {

package/src/models/DeleteDataServiceApiAuthorityResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataServiceApiAuthorityResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request, which uniquely identifies the request.
    * 
    * @example
    * 0000-ABCD-EF****
@@ -13,7 +13,7 @@ export class DeleteDataServiceApiAuthorityResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the authorization revocation was successful.
    * 
    * @example
    * true

package/src/models/DeleteDataServiceApiRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataServiceApiRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the API in DataService Studio.
+   * The ID of the DataService API.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,9 @@ export class DeleteDataServiceApiRequest extends $dara.Model {
   apiId?: number;
   /**
    * @remarks
-   * The ID of the workspace.
+   * The workspace ID.
+   * 
+   * You can obtain the workspace ID from PageResult.ProjectList[].ProjectId in the response of ListProjects.
    * 
    * This parameter is required.
    * 
@@ -25,7 +27,12 @@ export class DeleteDataServiceApiRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.
+   * The tenant ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console), go to the Data Studio page, click the username in the upper-right corner, and choose Menu > User Info to obtain the tenant ID.
+   * 
+   * 
+   * 
+   * 
+   * You can also obtain the tenant ID from Data.Apis[\\].TenantId in the response of ListDataServiceApis.
    * 
    * @example
    * 10002

package/src/models/DeleteDataServiceApiResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataServiceApiResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the API was deleted.
+   * Indicates whether the deletion was successful.
    * 
    * @example
    * true
@@ -37,7 +37,7 @@ export class DeleteDataServiceApiResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID.
+   * The request ID. It is a unique identifier for the request.
    * 
    * @example
    * 0000-ABCD-EFG****
@@ -45,7 +45,7 @@ export class DeleteDataServiceApiResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the call was successful.
    * 
    * @example
    * true

package/src/models/DeleteDisyncTaskResponseBody.ts

@@ -64,9 +64,11 @@ export class DeleteDISyncTaskResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * - true
    * 
-   * - false
+   * 
+   * 
+   * - true: successful
+   * - false: failed
    * 
    * @example
    * true

package/src/models/DeleteFileRequest.ts

@@ -15,9 +15,7 @@ export class DeleteFileRequest extends $dara.Model {
   fileId?: number;
   /**
    * @remarks
-   * The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to view the workspace name.
-   * 
-   * You must specify one of the ProjectId and ProjectIdentifier parameters to determine the DataWorks workspace to which the operation is applied.
+   * The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the workspace configuration page to obtain the workspace ID. Specify either this parameter or ProjectIdentifier to determine the workspace for this operation.
    * 
    * @example
    * 10000
@@ -25,7 +23,7 @@ export class DeleteFileRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The ID of the file. You can call the [ListFiles](https://help.aliyun.com/document_detail/173942.html) operation to query the ID of the file.
+   * The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the workspace configuration page to obtain the workspace name. Specify either this parameter or ProjectId to determine the workspace for this operation.
    * 
    * @example
    * dw_project

package/src/models/DeleteFileResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteFileResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request. You can troubleshoot errors based on the ID.
+   * If the file has been submitted, DeleteFile also triggers an asynchronous process to delete the file from the scheduling system. Use the DeploymentId returned by DeleteFile to call GetDeployment and poll the status of this process. If this field is empty, the file has been deleted and no further polling is required.
    * 
    * @example
    * 1000000001
@@ -13,7 +13,7 @@ export class DeleteFileResponseBody extends $dara.Model {
   deploymentId?: number;
   /**
    * @remarks
-   * The ID of the file. You can use the ListFiles interface to query the ID of the corresponding file.
+   * The error code.
    * 
    * @example
    * Invalid.Tenant.ConnectionNotExists
@@ -21,10 +21,7 @@ export class DeleteFileResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * Indicates whether the request is successful. Valid values:
-   * 
-   * *   true: The request is successful.
-   * *   false: The request fails.
+   * The error message.
    * 
    * @example
    * The connection does not exist.
@@ -32,9 +29,7 @@ export class DeleteFileResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The ID of the deployment task that deploys the file. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of this parameter is used to call the GetDeployment operation to poll the status of the asynchronous process.
-   * 
-   * If this parameter is empty, the file is deleted and the polling is not required.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -42,7 +37,7 @@ export class DeleteFileResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The error message returned.
+   * The request ID. You can use it to troubleshoot errors.
    * 
    * @example
    * 0000-ABCD-EFG****
@@ -50,7 +45,7 @@ export class DeleteFileResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The error code returned.
+   * Indicates whether the request is successful. Valid values: true (successful) and false (failed).
    * 
    * @example
    * true

package/src/models/DeleteMetaCollectionEntityResponseBody.ts

@@ -29,7 +29,7 @@ export class DeleteMetaCollectionEntityResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID. Used to locate logs and troubleshoot issues.
    * 
    * @example
    * 0000-ABCD-E****
@@ -37,11 +37,9 @@ export class DeleteMetaCollectionEntityResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The result of the operation. Valid values:
-   * 
-   * true: succeeded
-   * 
-   * false: failed
+   * The operation result. Valid values:
+   * - true: Succeeded.
+   * - false: Failed.
    * 
    * @example
    * true
@@ -49,11 +47,9 @@ export class DeleteMetaCollectionEntityResponseBody extends $dara.Model {
   status?: boolean;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * true
-   * 
-   * false
+   * Indicates whether the call was successful. Valid values:
+   * - true: The call was successful.
+   * - false: The call failed.
    * 
    * @example
    * true

package/src/models/DeleteMetaCollectionResponseBody.ts

@@ -29,7 +29,7 @@ export class DeleteMetaCollectionResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID.
+   * The request ID. Used for locating logs and troubleshooting issues.
    * 
    * @example
    * 0000-ABCD-E****
@@ -37,11 +37,11 @@ export class DeleteMetaCollectionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The result of the operation. Valid values:
+   * The operation result. Valid values:
+   *  
+   * true: Succeeded.
    * 
-   * true: succeeded
-   * 
-   * false: failed
+   * false: Failed.
    * 
    * @example
    * true
@@ -49,11 +49,11 @@ export class DeleteMetaCollectionResponseBody extends $dara.Model {
   status?: boolean;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the call was successful. Valid values:
    * 
-   * true
+   * true: The call was successful.
    * 
-   * false
+   * false: The call failed.
    * 
    * @example
    * true

package/src/models/DeleteProjectMemberRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteProjectMemberRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.
+   * The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the workspace configuration page to obtain the workspace ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteQualityEntityRequest.ts

@@ -15,7 +15,7 @@ export class DeleteQualityEntityRequest extends $dara.Model {
   entityId?: number;
   /**
    * @remarks
-   * The type of the engine or data source. Valid values: E-MapReduce (EMR), Hologres, AnalyticDB for PostgreSQL, CDH, MaxCompute, Kafka, and DataHub.
+   * The type of the engine or data source. Supported data sources include EMR, Hologres, AnalyticDB for PostgreSQL, CDH, MaxCompute, Kafka, and DataHub.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteQualityEntityResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityEntityResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the partition expression was successfully deleted.
+   * The result details returned after the DeleteQualityEntity operation is called.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class DeleteQualityEntityResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The error code returned if the request fails.
+   * The error code.
    * 
    * @example
    * 401
@@ -21,7 +21,7 @@ export class DeleteQualityEntityResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the request fails.
+   * The error message.
    * 
    * @example
    * You have no permission.
@@ -37,7 +37,7 @@ export class DeleteQualityEntityResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * ecb967ec-c137-48****
@@ -45,7 +45,7 @@ export class DeleteQualityEntityResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the call was successful.
    * 
    * @example
    * true