@alfresco/js-api 7.3.0-1530 → 7.3.0

package/api/activiti-rest-api/model/userAccountCredentialsRepresentation.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface UserAccountCredentialsRepresentation {
+    password?: string;
+    username?: string;
+}

package/api/activiti-rest-api/model/userActionRepresentation.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface UserActionRepresentation {
+    action?: string;
+    newPassword?: string;
+    oldPassword?: string;
+}

package/api/activiti-rest-api/model/userFilterOrderRepresentation.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface UserFilterOrderRepresentation {
+    appId?: number;
+    order?: number[];
+}

package/api/activiti-rest-api/model/userIdentifierRepresentation.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface UserIdentifierRepresentation {
+    email?: string;
+    userId?: string;
+}

package/api/activiti-rest-api/model/userProcessInstanceFilterRepresentation.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ProcessInstanceFilterRepresentation } from './processInstanceFilterRepresentation';
+export interface UserProcessInstanceFilterRepresentation {
+    appId?: number;
+    filter?: ProcessInstanceFilterRepresentation;
+    icon?: string;
+    id?: number;
+    index?: number;
+    name?: string;
+    recent?: boolean;
+}

package/api/activiti-rest-api/model/validationErrorRepresentation.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface ValidationErrorRepresentation {
+    defaultDescription?: string;
+    id?: string;
+    name?: string;
+    problem?: string;
+    problemReference?: string;
+    validatorSetName?: string;
+    warning?: boolean;
+}

package/api/activiti-rest-api/model/variableMappingRepresentation.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface VariableMappingRepresentation {
+    inProcessVariable?: string;
+    inVariableType?: string;
+    mappedVariable?: string;
+    outProcessVariable?: string;
+    outVariableType?: string;
+    typeOfMapping?: string;
+}

package/api/activiti-rest-api/model/variableScopeRepresentation.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface VariableScopeRepresentation {
+    mapVariable?: string;
+    mappedColumn?: string;
+    mappedDataModel?: number;
+    mappedEntity?: string;
+    mappedVariableName?: string;
+    processVariableName?: string;
+    processVariableType?: string;
+}

package/api/auth-rest-api/README.md

@@ -0,0 +1,29 @@
+# **Authentication API**
+
+Provides access to the authentication features of Alfresco Content Services.
+
+> Documentation updated on: 2019-10-17T13:35:27.038+01:00
+
+## Methods
+
+All URIs are relative to:
+
+```text
+https://localhost/alfresco/api/-default-/public/authentication/versions/1
+```
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+AuthenticationApi | [**createTicket**](docs/AuthenticationApi.md#createTicket) | **POST** /tickets | Create ticket (login)
+AuthenticationApi | [**deleteTicket**](docs/AuthenticationApi.md#deleteTicket) | **DELETE** /tickets/-me- | Delete ticket (logout)
+AuthenticationApi | [**validateTicket**](docs/AuthenticationApi.md#validateTicket) | **GET** /tickets/-me- | Validate ticket
+
+## Models
+
+- [ErrorError](docs/ErrorError.md)
+- [ModelError](docs/ModelError.md)
+- [Ticket](docs/Ticket.md)
+- [TicketBody](docs/TicketBody.md)
+- [TicketEntry](docs/TicketEntry.md)
+- [ValidTicket](docs/ValidTicket.md)
+- [ValidTicketEntry](docs/ValidTicketEntry.md)

package/api/auth-rest-api/api/authentication.api.d.ts

@@ -0,0 +1,61 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { TicketBody } from '../model/ticketBody';
+import { TicketEntry } from '../model/ticketEntry';
+import { ValidTicketEntry } from '../model/validTicketEntry';
+import { BaseApi } from './base.api';
+/**
+ * Authentication service.
+ */
+export declare class AuthenticationApi extends BaseApi {
+    /**
+     * Create ticket (login)
+     *
+     * **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+     *
+     * @param ticketBodyCreate The user credential.
+     * @returns Promise<TicketEntry>
+     */
+    createTicket(ticketBodyCreate: TicketBody): Promise<TicketEntry>;
+    /**
+     * Get ticket (login)
+     *
+     * @returns Promise<TicketEntry>
+     */
+    getTicket(): Promise<TicketEntry>;
+    /**
+     * Delete ticket (logout)
+     *
+     * **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+     *
+     * @returns Promise<{}>
+     */
+    deleteTicket(): Promise<void>;
+    /**
+     * Validate ticket
+     *
+     * **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+     *
+     * Validates the specified ticket (derived from Authorization header) is still valid.
+     * For example, you can pass the Authorization request header using Javascript:
+     * Javascript
+     * request.setRequestHeader (\"Authorization\", \"Basic \" + btoa(ticket));
+     *
+     * @returns Promise<ValidTicketEntry>
+     */
+    validateTicket(): Promise<ValidTicketEntry>;
+}

package/api/content-custom-api/api/classes.api.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ClassDescription } from '../model/classDescription';
+import { BaseApi } from './base.api';
+/**
+ * Constructs a new ClassesApi.
+ */
+export declare class ClassesApi extends BaseApi {
+    /**
+     * Gets the class information for the specified className.
+     *
+     * @param className The identifier of the class.
+     * @returns a Promise, with data of type ClassDescription
+     */
+    getClass(className: string): Promise<ClassDescription>;
+    getSubclasses(className: string): Promise<ClassDescription[]>;
+}

package/api/content-custom-api/api/customModel.api.d.ts

@@ -0,0 +1,172 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { PaginatedList, PaginatedEntries } from '../model/pagination';
+import { BaseApi } from './base.api';
+export interface CustomModel {
+    name: string;
+    namespacePrefix: string;
+    description: string;
+    author: string;
+    namespaceUri: string;
+    status: 'ACTIVE' | 'DRAFT';
+}
+export interface CustomType {
+    name?: string;
+    parentName?: string;
+    prefixedName?: string;
+    description?: string;
+    properties?: CustomModelProperty[];
+    title?: string;
+}
+export interface CustomAspect {
+    description?: string;
+    name?: string;
+    parentName?: string;
+    prefixedName?: string;
+    properties?: CustomModelProperty[];
+    title?: string;
+}
+export interface CustomModelProperty {
+    name?: string;
+    prefixedName?: string;
+    title?: string;
+    dataType?: string;
+    facetable?: 'FALSE' | 'TRUE';
+    indexTokenisationMode?: 'FALSE' | 'TRUE';
+    constraints?: CustomModelPropertyConstraint[];
+    multiValued?: boolean;
+    mandatoryEnforced?: boolean;
+    mandatory?: boolean;
+    indexed?: boolean;
+}
+export interface CustomModelPropertyConstraint {
+    name: string;
+    prefixedName: string;
+    type: string;
+    parameters: any[];
+}
+/**
+ * Constructs a new CustomModelApi.
+ */
+export declare class CustomModelApi extends BaseApi {
+    private: boolean;
+    /**
+     * create Custom Model
+     */
+    createCustomModel(status: string, description: string, name: string, namespaceUri: string, namespacePrefix: string, author?: string): Promise<{
+        entry: CustomModel;
+    }>;
+    /**
+     * Create a custom type
+     */
+    createCustomType(modelName: string, name: string, parentName?: string, title?: string, description?: string): Promise<{
+        entry: CustomType;
+    }>;
+    /**
+     * Create a custom aspect
+     */
+    createCustomAspect(modelName: string, name: string, parentName?: string, title?: string, description?: string): Promise<any>;
+    /**
+     * Create a custom constraint
+     */
+    createCustomConstraint(modelName: string, name: string, type: string, parameters?: any): Promise<any>;
+    /**
+     * Activate the custom model
+     */
+    activateCustomModel(modelName: string): Promise<{
+        entry: CustomModel;
+    }>;
+    /**
+     * Deactivate the custom model
+     */
+    deactivateCustomModel(modelName: string): Promise<{
+        entry: CustomModel;
+    }>;
+    /**
+     * Add property into an existing aspect
+     */
+    addPropertyToAspect(modelName: string, aspectName: string, properties?: CustomModelProperty[]): Promise<CustomAspect>;
+    /**
+     * Add Property into an existing type
+     */
+    addPropertyToType(modelName: string, typeName: string, properties?: CustomModelProperty[]): Promise<CustomType>;
+    /**
+     * Edit an existing custom model
+     */
+    updateCustomModel(modelName: string, description?: string, namespaceUri?: string, namespacePrefix?: string, author?: string): Promise<any>;
+    /**
+     * Edit an existing custom model type
+     */
+    updateCustomType(modelName: string, typeName: string, description?: string, parentName?: string, title?: string): Promise<any>;
+    /**
+     * Edit an existing custom model aspect
+     */
+    updateCustomAspect(modelName: string, aspectName: string, description?: string, parentName?: string, title?: string): Promise<any>;
+    /**
+     * Get all custom models
+     */
+    getAllCustomModel(): Promise<PaginatedEntries<CustomModel>>;
+    /**
+     * Get custom model
+     */
+    getCustomModel(modelName: string, queryParams?: any): Promise<{
+        entry: CustomModel;
+    }>;
+    /**
+     * Get all custom model types
+     */
+    getAllCustomType(modelName: string): Promise<PaginatedList<CustomType>>;
+    /**
+     * Get custom model type
+     */
+    getCustomType(modelName: string, typeName?: string, queryParams?: any): Promise<{
+        entry: CustomType;
+    }>;
+    /**
+     * Get all custom model aspect
+     */
+    getAllCustomAspect(modelName: string, queryParams?: any): Promise<PaginatedList<CustomAspect>>;
+    /**
+     * Get custom model aspect
+     */
+    getCustomAspect(modelName: string, aspectName: string, queryParams?: any): Promise<{
+        entry: CustomAspect;
+    }>;
+    /**
+     * Get all custom model defined constraints
+     */
+    getAllCustomConstraints(modelName: string, queryParams?: any): Promise<any>;
+    /**
+     * Get custom model defined constraints
+     */
+    getCustomConstraints(modelName: string, constraintName: string, queryParams?: any): Promise<any>;
+    /**
+     * Delete the given custom model
+     */
+    deleteCustomModel(modelName: string): Promise<void>;
+    /**
+     * Delete the given custom type
+     */
+    deleteCustomType(modelName: string, typeName: string): Promise<void>;
+    deleteCustomAspect(modelName: string, aspectName: string): Promise<void>;
+    deleteCustomAspectProperty(modelName: string, aspectName: string, propertyName: string): Promise<{
+        entry: CustomAspect;
+    }>;
+    deleteCustomTypeProperty(modelName: string, typeName: string, propertyName: string): Promise<{
+        entry: CustomType;
+    }>;
+}

package/api/content-custom-api/api/webscript.api.d.ts

@@ -0,0 +1,37 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { BaseApi } from './base.api';
+/**
+ * Constructs a new WebscriptApi.
+ */
+export declare class WebscriptApi extends BaseApi {
+    allowedMethod: string[];
+    /**
+     * Call a get on a  Web Scripts see https://wiki.alfresco.com/wiki/Web_Scripts for more details about Web Scripts
+     * Url syntax definition : http[s]://<host>:<port>/[<contextPath>/]/<servicePath>[/<scriptPath>][?<scriptArgs>]
+     * example: http://localhost:8081/share/service/mytasks?priority=1
+     *
+     * @param httpMethod  GET, POST, PUT and DELETE
+     * @param scriptPath script path
+     * @param scriptArgs script arguments
+     * @param contextRoot default value alfresco
+     * @param servicePath default value service
+     * @param postBody post body
+     * @returns A promise that is resolved return the webScript data and {error} if rejected.
+     */
+    executeWebScript(httpMethod: string, scriptPath: string, scriptArgs?: any, contextRoot?: string, servicePath?: string, postBody?: any): Promise<any>;
+}

package/api/content-custom-api/model/dateAlfresco.d.ts

@@ -0,0 +1,39 @@
+/*!
+ * @license
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare class DateAlfresco extends Date {
+    /**
+     * Parses an ISO-8601 string representation of a date value.
+     *
+     * @param  dateToConvert The date value as a string.
+     * @returns  The parsed date object.
+     */
+    static parseDate(dateToConvert: any): Date;
+    /**
+     * Parses the date component of a ISO-8601 string representation of a date value.
+     *
+     * @param dateToConvert The date value as a string.
+     * @returns The parsed date object.
+     */
+    static parseDateTime(dateToConvert: string): Date;
+    /**
+     * Parses the timezone component of a ISO-8601 string representation of a date value.
+     *
+     * @param dateToConvert The timezone offset as a string, e.g. '+0000', '+2000' or '-0500'.
+     * @returns The number of minutes offset from UTC.
+     */
+    static parseDateTimeZone(dateToConvert: string): number;
+}

package/api/content-rest-api/README.md

@@ -0,0 +1,32 @@
+# **Core API**
+
+Provides access to the core features of Alfresco Content Services.
+
+## Endpoint Clients
+
+All URIs are relative to:
+
+```text
+https://localhost/alfresco/api/-default-/public/alfresco/versions/1
+```
+
+- [ActionsApi](docs/ActionsApi.md)
+- [ActivitiesApi](docs/ActivitiesApi.md)
+- [AuditApi](docs/AuditApi.md)
+- [CommentsApi](docs/CommentsApi.md)
+- [DownloadsApi](docs/DownloadsApi.md)
+- [FavoritesApi](docs/FavoritesApi.md)
+- [GroupsApi](docs/GroupsApi.md)
+- [NetworksApi](docs/NetworksApi.md)
+- [NodesApi](docs/NodesApi.md)
+- [PeopleApi](docs/PeopleApi.md)
+- [PreferencesApi](docs/PreferencesApi.md)
+- [ProbesApi](docs/ProbesApi.md)
+- [QueriesApi](docs/QueriesApi.md)
+- [RatingsApi](docs/RatingsApi.md)
+- [RenditionsApi](docs/RenditionsApi.md)
+- [SharedlinksApi](docs/SharedlinksApi.md)
+- [SitesApi](docs/SitesApi.md)
+- [TagsApi](docs/TagsApi.md)
+- [TrashcanApi](docs/TrashcanApi.md)
+- [VersionsApi](docs/VersionsApi.md)