@alfresco/js-api 10.2.0-30612540894 → 10.2.0-30804668708

package/typings/src/api/activiti-rest-api/api/adminTenants.api.d.ts

@@ -23,30 +23,35 @@ export declare class AdminTenantsApi extends BaseApi {
     /**
      * Create a tenant
      * Only a tenant manager may access this endpoint
+     *
      * @param createTenantRepresentation createTenantRepresentation
      * @return Promise<LightTenantRepresentation>
      */
     createTenant(createTenantRepresentation: CreateTenantRepresentation): Promise<LightTenantRepresentation>;
     /**
      * Delete a tenant
+     *
      * @param tenantId tenantId
      * @return Promise<{}>
      */
     deleteTenant(tenantId: number): Promise<void>;
     /**
      * Get tenant events
+     *
      * @param tenantId tenantId
      * @return Promise<TenantEvent>
      */
     getTenantEvents(tenantId: number): Promise<TenantEvent>;
     /**
      * Get a tenant's logo
+     *
      * @param tenantId tenantId
      * @return Promise<{}>
      */
     getTenantLogo(tenantId: number): Promise<any>;
     /**
      * Get a tenant
+     *
      * @param tenantId tenantId
      * @return Promise<TenantRepresentation>
      */
@@ -54,11 +59,13 @@ export declare class AdminTenantsApi extends BaseApi {
     /**
      * List tenants
      * Only a tenant manager may access this endpoint
+     *
      * @return Promise<LightTenantRepresentation>
      */
     getTenants(): Promise<LightTenantRepresentation>;
     /**
      * Update a tenant
+     *
      * @param tenantId tenantId
      * @param createTenantRepresentation createTenantRepresentation
      * @return Promise<TenantRepresentation>
@@ -66,6 +73,7 @@ export declare class AdminTenantsApi extends BaseApi {
     update(tenantId: number, createTenantRepresentation: CreateTenantRepresentation): Promise<TenantRepresentation>;
     /**
      * Update a tenant's logo
+     *
      * @param tenantId tenantId
      * @param file file
      * @return Promise<ImageUploadRepresentation>

package/typings/src/api/activiti-rest-api/api/adminUsers.api.d.ts

@@ -35,18 +35,21 @@ export interface GetUsersOpts {
 export declare class AdminUsersApi extends BaseApi {
     /**
      * Bulk update a list of users
+     *
      * @param update update
      * @return Promise<{}>
      */
     bulkUpdateUsers(update: BulkUserUpdateRepresentation): Promise<any>;
     /**
      * Create a user
+     *
      * @param userRepresentation userRepresentation
      * @return Promise<UserRepresentation>
      */
     createNewUser(userRepresentation: UserRepresentation): Promise<UserRepresentation>;
     /**
      * Get a user
+     *
      * @param userId userId
      * @param opts Optional parameters
      * @return Promise<AbstractUserRepresentation>
@@ -56,12 +59,14 @@ export declare class AdminUsersApi extends BaseApi {
     }): Promise<AbstractUserRepresentation>;
     /**
      * Query users
+     *
      * @param opts Optional parameters
      * @return Promise<ResultListDataRepresentationAbstractUserRepresentation>
      */
     getUsers(opts?: GetUsersOpts): Promise<ResultListDataRepresentationAbstractUserRepresentation>;
     /**
      * Update a user
+     *
      * @param userId userId
      * @param userRepresentation userRepresentation
      * @return Promise<{}>

package/typings/src/api/activiti-rest-api/api/appDefinitions.api.d.ts

@@ -22,6 +22,7 @@ import { BaseApi } from './base.api';
 export declare class AppDefinitionsApi extends BaseApi {
     /**
      * deleteAppDefinition
+     *
      * @param appDefinitionId appDefinitionId
      * @return Promise<{}>
      */
@@ -30,18 +31,21 @@ export declare class AppDefinitionsApi extends BaseApi {
      * Export an app definition
      *
      * This will return a zip file containing the app definition model and all related models (process definitions and forms).
+     *
      * @param modelId modelId from a runtime app or the id of an app definition model
      * @return Promise<{}>
      */
     exportAppDefinition(modelId: number): Promise<any>;
     /**
      * Get an app definition
+     *
      * @param modelId Application definition ID
      * @return Promise<AppDefinitionRepresentation>
      */
     getAppDefinition(modelId: number): Promise<AppDefinitionRepresentation>;
     /**
      * importAndPublishApp
+     *
      * @param file file
      * @param opts options
      * @return Promise<AppDefinitionUpdateResultRepresentation>
@@ -55,6 +59,7 @@ export declare class AppDefinitionsApi extends BaseApi {
      * Allows a zip file to be uploaded containing an app definition and any number of included models.
      * <p>This is useful to bootstrap an environment (for users or continuous integration).<p>
      * Before using any processes included in the import the app must be published and deployed.
+     *
      * @param file file
      * @param opts Optional parameters
      * @param opts.renewIdmEntries Whether to renew user and group identifiers (default to false)
@@ -67,6 +72,7 @@ export declare class AppDefinitionsApi extends BaseApi {
      * Publish an app definition
      *
      * Publishing an app definition makes it available for use. The application must not have any validation errors or an error will be returned.<p>Before an app definition can be used by other users, it must also be deployed for their use
+     *
      * @param modelId modelId
      * @param publishModel publishModel
      * @return Promise<AppDefinitionUpdateResultRepresentation>
@@ -74,6 +80,7 @@ export declare class AppDefinitionsApi extends BaseApi {
     publishAppDefinition(modelId: number, publishModel: AppDefinitionPublishRepresentation): Promise<AppDefinitionUpdateResultRepresentation>;
     /**
      * Update an app definition
+     *
      * @param modelId Application definition ID
      * @param updatedModel updatedModel |
      * @return Promise<AppDefinitionUpdateResultRepresentation>

package/typings/src/api/activiti-rest-api/api/checklists.api.d.ts

@@ -24,6 +24,7 @@ import { BaseApi } from './base.api';
 export declare class ChecklistsApi extends BaseApi {
     /**
      * Create a task checklist
+     *
      * @param taskId taskId
      * @param taskRepresentation taskRepresentation
      * @return Promise<TaskRepresentation>
@@ -31,12 +32,14 @@ export declare class ChecklistsApi extends BaseApi {
     addSubtask(taskId: string, taskRepresentation: TaskRepresentation): Promise<TaskRepresentation>;
     /**
      * Get checklist for a task
+     *
      * @param taskId taskId
      * @return Promise<ResultListDataRepresentationTaskRepresentation>
      */
     getChecklist(taskId: string): Promise<ResultListDataRepresentationTaskRepresentation>;
     /**
      * Change the order of items on a checklist
+     *
      * @param taskId taskId
      * @param orderRepresentation orderRepresentation
      * @return Promise<{}>

package/typings/src/api/activiti-rest-api/api/comments.api.d.ts

@@ -23,6 +23,7 @@ import { BaseApi } from './base.api';
 export declare class ActivitiCommentsApi extends BaseApi {
     /**
      * Add a comment to a process instance
+     *
      * @param commentRequest commentRequest
      * @param processInstanceId processInstanceId
      * @return Promise<CommentRepresentation>
@@ -30,6 +31,7 @@ export declare class ActivitiCommentsApi extends BaseApi {
     addProcessInstanceComment(commentRequest: CommentRepresentation, processInstanceId: string): Promise<CommentRepresentation>;
     /**
      * Add a comment to a task
+     *
      * @param commentRequest commentRequest
      * @param taskId taskId
      * @return Promise<CommentRepresentation>
@@ -37,6 +39,7 @@ export declare class ActivitiCommentsApi extends BaseApi {
     addTaskComment(commentRequest: CommentRepresentation, taskId: string): Promise<CommentRepresentation>;
     /**
      * Get comments for a process
+     *
      * @param processInstanceId processInstanceId
      * @param opts Optional parameters
      * @return Promise<ResultListDataRepresentationCommentRepresentation>
@@ -46,6 +49,7 @@ export declare class ActivitiCommentsApi extends BaseApi {
     }): Promise<ResultListDataRepresentationCommentRepresentation>;
     /**
      * Get comments for a task
+     *
      * @param taskId taskId
      * @param opts Optional parameters
      * @return Promise<ResultListDataRepresentationCommentRepresentation>

package/typings/src/api/activiti-rest-api/api/content.api.d.ts

@@ -22,6 +22,7 @@ import { BaseApi } from './base.api';
 export declare class ContentApi extends BaseApi {
     /**
      * Attach existing content to a process instance
+     *
      * @param processInstanceId processInstanceId
      * @param relatedContent relatedContent
      * @param opts Optional parameters
@@ -32,6 +33,7 @@ export declare class ContentApi extends BaseApi {
     }): Promise<RelatedContentRepresentation>;
     /**
      * Attach existing content to a task
+     *
      * @param taskId taskId
      * @param relatedContent relatedContent
      * @param opts Optional parameters
@@ -42,35 +44,41 @@ export declare class ContentApi extends BaseApi {
     }): Promise<RelatedContentRepresentation>;
     /**
      * Upload content and create a local representation
+     *
      * @param file file
      * @return Promise<RelatedContentRepresentation>
      */
     createTemporaryRawRelatedContent(file: any): Promise<RelatedContentRepresentation>;
     /**
      * Create a local representation of content from a remote repository
+     *
      * @param relatedContent relatedContent
      * @return Promise<RelatedContentRepresentation>
      */
     createTemporaryRelatedContent(relatedContent: RelatedContentRepresentation): Promise<RelatedContentRepresentation>;
     /**
      * Remove a local content representation
+     *
      * @param contentId contentId
      * @return Promise<{}>
      */
     deleteContent(contentId: number): Promise<void>;
     /**
      * Get a local content representation
+     *
      * @param contentId contentId
      * @return Promise<RelatedContentRepresentation>
      */
     getContent(contentId: number): Promise<RelatedContentRepresentation>;
     /**
      * Get content Raw URL for the given contentId
+     *
      * @param contentId contentId
      */
     getRawContentUrl(contentId: number): string;
     /**
      * Stream content rendition
+     *
      * @param contentId contentId
      * @param renditionType renditionType
      * @return Promise<{}>
@@ -78,6 +86,7 @@ export declare class ContentApi extends BaseApi {
     getRawContent(contentId: number, renditionType?: string): Promise<any>;
     /**
      * List content attached to a process instance
+     *
      * @param processInstanceId processInstanceId
      * @param opts Optional parameters
      * @return Promise<ResultListDataRepresentationRelatedContentRepresentation>
@@ -87,6 +96,7 @@ export declare class ContentApi extends BaseApi {
     }): Promise<ResultListDataRepresentationRelatedContentRepresentation>;
     /**
      * List content attached to a task
+     *
      * @param taskId taskId
      * @param opts Optional parameters
      * @return Promise<ResultListDataRepresentationRelatedContentRepresentation>
@@ -96,6 +106,7 @@ export declare class ContentApi extends BaseApi {
     }): Promise<ResultListDataRepresentationRelatedContentRepresentation>;
     /**
      * Lists processes and tasks on workflow started with provided document
+     *
      * @param sourceId - id of the document that workflow or task has been started with
      * @param source - source of the document that workflow or task has been started with
      * @param size - size of the entries to get

package/typings/src/api/activiti-rest-api/api/dataSources.api.d.ts

@@ -22,6 +22,7 @@ import { BaseApi } from './base.api';
 export declare class DataSourcesApi extends BaseApi {
     /**
      * Get data sources
+     *
      * @param opts Optional parameters
      * @return Promise<ResultListDataRepresentationDataSourceRepresentation>
      */

package/typings/src/api/activiti-rest-api/api/decisionAudits.api.d.ts

@@ -23,12 +23,14 @@ import { BaseApi } from './base.api';
 export declare class DecisionAuditsApi extends BaseApi {
     /**
      * Get an audit trail
+     *
      * @param auditTrailId auditTrailId
      * @return Promise<DecisionAuditRepresentation>
      */
     getAuditTrail(auditTrailId: number): Promise<DecisionAuditRepresentation>;
     /**
      * Query decision table audit trails
+     *
      * @param decisionKey decisionKey
      * @param dmnDeploymentId dmnDeploymentId
      * @return Promise<ResultListDataRepresentationDecisionAuditRepresentation>

package/typings/src/api/activiti-rest-api/api/decisionTables.api.d.ts

@@ -32,18 +32,21 @@ export interface GetDecisionTablesOpts {
 export declare class DecisionTablesApi extends BaseApi {
     /**
      * Get definition for a decision table
+     *
      * @param decisionTableId decisionTableId
      * @return Promise<JsonNode>
      */
     getDecisionTableEditorJson(decisionTableId: number): Promise<JsonNode>;
     /**
      * Get a decision table
+     *
      * @param decisionTableId decisionTableId
      * @return Promise<RuntimeDecisionTableRepresentation>
      */
     getDecisionTable(decisionTableId: number): Promise<RuntimeDecisionTableRepresentation>;
     /**
      * Query decision tables
+     *
      * @param opts Optional parameters
      * @return Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation>
      */

package/typings/src/api/activiti-rest-api/api/endpoints.api.d.ts

@@ -22,12 +22,14 @@ import { BaseApi } from './base.api';
 export declare class EndpointsApi extends BaseApi {
     /**
      * Get an endpoint configuration
+     *
      * @param endpointConfigurationId endpointConfigurationId
      * @return Promise<EndpointConfigurationRepresentation>
      */
     getEndpointConfiguration(endpointConfigurationId: number): Promise<EndpointConfigurationRepresentation>;
     /**
      * List endpoint configurations
+     *
      * @return Promise<EndpointConfigurationRepresentation>
      */
     getEndpointConfigurations(): Promise<EndpointConfigurationRepresentation>;

package/typings/src/api/activiti-rest-api/api/formModels.api.d.ts

@@ -31,12 +31,14 @@ export interface GetFormsOpts {
 export declare class FormModelsApi extends BaseApi {
     /**
      * Get form content
+     *
      * @param formId formId
      * @return Promise<FormDefinitionRepresentation>
      */
     getFormEditorJson(formId: number): Promise<FormDefinitionRepresentation>;
     /**
      * Get form history
+     *
      * @param formId formId
      * @param formHistoryId formHistoryId
      * @return Promise<FormRepresentation>
@@ -44,18 +46,21 @@ export declare class FormModelsApi extends BaseApi {
     getFormHistory(formId: number, formHistoryId: number): Promise<FormRepresentation>;
     /**
      * Get a form model
+     *
      * @param formId {number} formId
      * @return Promise<FormRepresentation>
      */
     getForm(formId: number): Promise<FormRepresentation>;
     /**
      * Get forms
+     *
      * @param input input
      * @return Promise<FormRepresentation>
      */
     getForms(input: string[] | GetFormsOpts): Promise<FormRepresentation | ResultListDataRepresentationRuntimeFormRepresentation | ResultListDataRepresentationFormRepresentation>;
     /**
      * Update form model content
+     *
      * @param formId ID of the form to update
      * @param saveRepresentation saveRepresentation
      * @return Promise<FormRepresentation>
@@ -65,6 +70,7 @@ export declare class FormModelsApi extends BaseApi {
      * Validate form model content
      *
      * The model content to be validated must be specified in the POST body
+     *
      * @param formId formId
      * @param saveRepresentation saveRepresentation
      * @return Promise<ValidationErrorRepresentation>

package/typings/src/api/activiti-rest-api/api/groups.api.d.ts

@@ -29,12 +29,14 @@ export interface GetGroupsOpts {
 export declare class ActivitiGroupsApi extends BaseApi {
     /**
      * Query groups
+     *
      * @param opts Optional parameters
      * @return Promise<ResultListDataRepresentationLightGroupRepresentation>
      */
     getGroups(opts?: GetGroupsOpts): Promise<ResultListDataRepresentationLightGroupRepresentation>;
     /**
      * List members of a group
+     *
      * @param groupId groupId
      * @return Promise<ResultListDataRepresentationLightUserRepresentation>
      */

package/typings/src/api/activiti-rest-api/api/iDMSync.api.d.ts

@@ -22,12 +22,14 @@ import { BaseApi } from './base.api';
 export declare class IDMSyncApi extends BaseApi {
     /**
      * Get log file for a sync log entry
+     *
      * @param syncLogEntryId syncLogEntryId
      * @return Promise<{}>
      */
     getLogFile(syncLogEntryId: number): Promise<any>;
     /**
      * List sync log entries
+     *
      * @param opts Optional parameters
      * @param opts.tenantId {number} tenantId
      * @param opts.page {number} page

package/typings/src/api/activiti-rest-api/api/integrationAlfrescoCloud.api.d.ts

@@ -23,24 +23,28 @@ export declare class IntegrationAlfrescoCloudApi extends BaseApi {
     /**
      * Alfresco Cloud Authorization
      * Returns Alfresco OAuth HTML Page
+     *
      * @param code code
      * @return Promise<{}>
      */
     confirmAuthorisation(code: string): Promise<any>;
     /**
      * List Alfresco networks
+     *
      * @return Promise<ResultListDataRepresentationAlfrescoNetworkRepresenation>
      */
     getAllNetworks(): Promise<ResultListDataRepresentationAlfrescoNetworkRepresenation>;
     /**
      * List Alfresco sites
      * Returns ALL Sites
+     *
      * @param networkId networkId
      * @return Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>
      */
     getAllSites(networkId: string): Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>;
     /**
      * List files and folders inside a specific folder identified by path
+     *
      * @param networkId networkId
      * @param opts Optional parameters
      * @param opts.siteId {string} siteId
@@ -53,6 +57,7 @@ export declare class IntegrationAlfrescoCloudApi extends BaseApi {
     }): Promise<ResultListDataRepresentationAlfrescoContentRepresentation>;
     /**
      * List files and folders inside a specific folder
+     *
      * @param networkId networkId
      * @param folderId folderId
      * @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
@@ -60,6 +65,7 @@ export declare class IntegrationAlfrescoCloudApi extends BaseApi {
     getContentInFolder(networkId: string, folderId: string): Promise<ResultListDataRepresentationAlfrescoContentRepresentation>;
     /**
      * List files and folders inside a specific site
+     *
      * @param networkId networkId
      * @param siteId siteId
      * @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>

package/typings/src/api/activiti-rest-api/api/integrationAlfrescoOnPremise.api.d.ts

@@ -23,12 +23,14 @@ export declare class IntegrationAlfrescoOnPremiseApi extends BaseApi {
     /**
      * List Alfresco sites
      * Returns ALL Sites
+     *
      * @param repositoryId repositoryId
      * @return Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>
      */
     getAllSites(repositoryId: string): Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>;
     /**
      * List files and folders inside a specific folder identified by folder path
+     *
      * @param repositoryId repositoryId
      * @param siteId siteId
      * @param folderPath folderPath
@@ -37,6 +39,7 @@ export declare class IntegrationAlfrescoOnPremiseApi extends BaseApi {
     getContentInFolderPath(repositoryId: string, siteId: string, folderPath: string): Promise<ResultListDataRepresentationAlfrescoContentRepresentation>;
     /**
      * List files and folders inside a specific folder
+     *
      * @param repositoryId repositoryId
      * @param folderId folderId
      * @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
@@ -44,6 +47,7 @@ export declare class IntegrationAlfrescoOnPremiseApi extends BaseApi {
     getContentInFolder(repositoryId: string, folderId: string): Promise<ResultListDataRepresentationAlfrescoContentRepresentation>;
     /**
      * List files and folders inside a specific site
+     *
      * @param repositoryId repositoryId
      * @param siteId siteId
      * @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
@@ -53,6 +57,7 @@ export declare class IntegrationAlfrescoOnPremiseApi extends BaseApi {
      * List Alfresco repositories
      *
      * A tenant administrator can configure one or more Alfresco repositories to use when working with content.
+     *
      * @param opts Optional parameters
      * @param opts.tenantId {string} tenantId
      * @param opts.includeAccounts {boolean} includeAccounts (default to true)

package/typings/src/api/activiti-rest-api/api/integrationBox.api.d.ts

@@ -23,11 +23,13 @@ export declare class IntegrationBoxApi extends BaseApi {
     /**
      * Box Authorization
      * Returns Box OAuth HTML Page
+     *
      * @return Promise<{}>
      */
     confirmAuthorisation(): Promise<any>;
     /**
      * Add Box account
+     *
      * @param userId userId
      * @param credentials credentials
      * @return Promise<{}>
@@ -35,17 +37,20 @@ export declare class IntegrationBoxApi extends BaseApi {
     createRepositoryAccount(userId: number, credentials: UserAccountCredentialsRepresentation): Promise<any>;
     /**
      * Delete account information
+     *
      * @param userId userId
      * @return Promise<{}>
      */
     deleteRepositoryAccount(userId: number): Promise<void>;
     /**
      * Get status information
+     *
      * @return Promise<boolean>
      */
     getBoxPluginStatus(): Promise<boolean>;
     /**
      * List file and folders
+     *
      * @param opts Optional parameters
      * @param opts.filter filter
      * @param opts.parent parent
@@ -57,12 +62,14 @@ export declare class IntegrationBoxApi extends BaseApi {
     }): Promise<ResultListDataRepresentationBoxContent>;
     /**
      * Get account information
+     *
      * @param userId userId
      * @return Promise<{}>
      */
     getRepositoryAccount(userId: number): Promise<any>;
     /**
      * Update account information
+     *
      * @param userId userId
      * @param credentials credentials
      * @return Promise<{}>

package/typings/src/api/activiti-rest-api/api/integrationDrive.api.d.ts

@@ -23,11 +23,13 @@ export declare class IntegrationDriveApi extends BaseApi {
     /**
      * Drive Authorization
      * Returns Drive OAuth HTML Page
+     *
      * @return Promise<{}>
      */
     confirmAuthorisation(): Promise<any>;
     /**
      * List files and folders
+     *
      * @param opts Optional parameters
      * @param opts.filter {string} filter
      * @param opts.parent {string} parent

package/typings/src/api/activiti-rest-api/api/integrationSSO.api.d.ts

@@ -22,6 +22,7 @@ import { SSOUserAccountCredentialsRepresentation } from '../model';
 export declare class IntegrationSSOApi extends BaseApi {
     /**
      * Get account information
+     *
      * @param repositoryId repositoryId
      * @return Promise<SSOUserAccountCredentialsRepresentation>
      */

package/typings/src/api/activiti-rest-api/api/modelJsonBpmn.api.d.ts

@@ -18,22 +18,26 @@ import { BaseApi } from './base.api';
 export declare class ModelJsonBpmnApi extends BaseApi {
     /**
      * Export a previous process definition model to a JSON
+     *
      * @param processModelId processModelId
      * @param processModelHistoryId processModelHistoryId
      */
     getHistoricEditorDisplayJsonClient(processModelId: number, processModelHistoryId: number): Promise<any>;
     /**
      * Export a process definition model to a JSON
+     *
      * @param processModelId processModelId
      */
     getEditorDisplayJsonClient(processModelId: number): Promise<any>;
     /**
      * Function to receive the result of the getModelJSONForProcessDefinition operation.
+     *
      * @param processDefinitionId processDefinitionId
      */
     getModelJSON(processDefinitionId: string): Promise<any>;
     /**
      * Function to receive the result of the getModelHistoryJSON operation.
+     *
      * @param processInstanceId processInstanceId
      */
     getModelJSONForProcessDefinition(processInstanceId: string): Promise<any>;