@sitecore/sc-contenthub-webclient-sdk 1.1.1 → 1.2.1

package/dist/clients/commands-client.js

@@ -21,22 +21,22 @@ class CommandsClient {
         guard_1.default.notNull(client);
         this._client = client;
     }
-    executeCommandRawAsync(namespace, command, args = null) {
+    executeCommandRawAsync(namespace, command, args = null, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(namespace);
             guard_1.default.stringNotNullOrEmpty(command);
             const link = yield this._client.linkHelper.commandToLinkAsync(namespace, command);
             const content = ta_json_1.TaJson.serialize(args !== null && args !== void 0 ? args : {});
-            const response = yield this._client.raw.postAsync(link.href, content);
+            const response = yield this._client.raw.postAsync(link.href, content, undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
             return response;
         });
     }
-    executeCommandAsync(namespace, command, args = null) {
+    executeCommandAsync(namespace, command, args = null, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(namespace);
             guard_1.default.stringNotNullOrEmpty(command);
-            const response = yield this.executeCommandRawAsync(namespace, command, args);
+            const response = yield this.executeCommandRawAsync(namespace, command, args, cancelCallback);
             let result = null;
             if (response.content != null) {
                 result = response.content;
@@ -46,3 +46,4 @@ class CommandsClient {
     }
 }
 exports.CommandsClient = CommandsClient;
+//# sourceMappingURL=commands-client.js.map

package/dist/clients/content-hub-client.d.ts

@@ -11,6 +11,7 @@ import { EntityDefinitionMapper } from "../mappers/entity-definition-mapper";
 import { EntityMapper } from "../mappers/entity-mapper";
 import { IAggregateClient } from "./aggregates-client";
 import { IApiClient } from "./api-client";
+import { IAssetsClient } from "./assets-client";
 import { ICommandsClient } from "./commands-client";
 import { ICultureClient } from "./culture-client";
 import { IEntitiesClient } from "./entities-client";
@@ -36,6 +37,7 @@ export interface IContentHubClient {
     logger: ILogger;
     readonly api: IApiClient;
     readonly aggregates: IAggregateClient;
+    readonly assets: IAssetsClient;
     readonly commands: ICommandsClient;
     readonly cultures: ICultureClient;
     readonly entities: IEntitiesClient;
@@ -60,6 +62,7 @@ export declare class ContentHubClient implements IExtendedContentHubClient {
     readonly internalClient: IInternalClient;
     readonly api: IApiClient;
     readonly aggregates: IAggregateClient;
+    readonly assets: IAssetsClient;
     readonly commands: ICommandsClient;
     readonly cultures: ICultureClient;
     readonly entities: IEntitiesClient;

package/dist/clients/content-hub-client.js

@@ -15,6 +15,7 @@ const entity_mapper_1 = require("../mappers/entity-mapper");
 const typed_entity_creator_1 = require("../mappers/typed-entity-creator");
 const aggregates_client_1 = require("./aggregates-client");
 const api_client_1 = require("./api-client");
+const assets_client_1 = require("./assets-client");
 const commands_client_1 = require("./commands-client");
 const culture_client_1 = require("./culture-client");
 const culture_loader_1 = require("./culture-loader");
@@ -44,6 +45,7 @@ class ContentHubClient {
         this.internalClient = new internal_client_1.InternalClient(baseUri, oauthGrant);
         this.api = new api_client_1.ApiClient(this);
         this.aggregates = new aggregates_client_1.AggregateClient(this);
+        this.assets = new assets_client_1.AssetsClient(this);
         this.commands = new commands_client_1.CommandsClient(this);
         this.entities = new entities_client_1.EntitiesClient(this);
         this.entityDefinitions = new entity_definitions_client_1.EntityDefinitionsClient(this);
@@ -72,3 +74,4 @@ class ContentHubClient {
     }
 }
 exports.ContentHubClient = ContentHubClient;
+//# sourceMappingURL=content-hub-client.js.map

package/dist/clients/culture-client.js

@@ -41,3 +41,4 @@ class CultureClient {
     }
 }
 exports.CultureClient = CultureClient;
+//# sourceMappingURL=culture-client.js.map

package/dist/clients/culture-loader.js

@@ -101,3 +101,4 @@ CultureLoader._query = new query_1.Query({
     }),
     take: 1,
 });
+//# sourceMappingURL=culture-loader.js.map

package/dist/clients/entities-client.d.ts

@@ -6,7 +6,9 @@ import { IEntityQueryResult } from "../contracts/querying/entity-query-result";
 import { IIdIterator } from "../contracts/querying/id-iterator";
 import { IIdQueryResult } from "../contracts/querying/id-query-result";
 import { Sorting } from "../contracts/querying/sorting";
+import { IEntityCopyOptions } from "../models/content/entity-copy-options";
 import { IExtendedContentHubClient } from "./extended-client";
+import { CancelCallback } from "./internal-client";
 /**
  * Interface for the client responsible for getting, saving and deleting entities.
  *
@@ -18,23 +20,26 @@ export interface IEntitiesClient {
      * Gets the {@link IEntity} instance with the specified `id`.
      * @param id - The id of the entity to get
      * @param loadConfiguration - The loading configuration for the entity
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns The entity or `null` when it was not found.
      */
-    getAsync(id: number, loadConfiguration?: Nullable<IEntityLoadConfiguration>): NullableResultPromise<IEntity>;
+    getAsync(id: number, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): NullableResultPromise<IEntity>;
     /**
      * Gets the {@link IEntity} instance with the specified `identifier`.
      * @param identifier - The identifier of the entity to get
      * @param loadConfiguration - The loading configuration for the entity
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns The entity or `null` when it was not found.
      */
-    getAsync(identifier: string, loadConfiguration?: Nullable<IEntityLoadConfiguration>): NullableResultPromise<IEntity>;
+    getAsync(identifier: string, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): NullableResultPromise<IEntity>;
     /**
      * Gets the {@link IEntity} instance with the specified `id` or `identifier`.
      * @param param - The id or identifier of the entity to get
      * @param loadConfiguration - The loading configuration for the entity
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns The entity or `null` when it was not found.
      */
-    getAsync(param: number | string, loadConfiguration?: Nullable<IEntityLoadConfiguration>): NullableResultPromise<IEntity>;
+    getAsync(param: number | string, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): NullableResultPromise<IEntity>;
     /**
      * Gets the {@link IEntity} instances with the specified `ids`.
      *
@@ -44,9 +49,10 @@ export interface IEntitiesClient {
      *
      * @param ids - The ids of the entities to get
      * @param loadConfiguration - The loading configuration for an entity
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns List of entities.
      */
-    getManyAsync(ids: Array<number>, loadConfiguration?: Nullable<IEntityLoadConfiguration>): Promise<Array<IEntity>>;
+    getManyAsync(ids: Array<number>, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): Promise<Array<IEntity>>;
     /**
      * Gets the {@link IEntity} instances with the specified `identifiers`.
      *
@@ -56,9 +62,10 @@ export interface IEntitiesClient {
      *
      * @param identifiers - The identifiers of the entities to get
      * @param loadConfiguration - The loading configuration for an entity
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns List of entities.
      */
-    getManyAsync(identifiers: Array<string>, loadConfiguration?: Nullable<IEntityLoadConfiguration>): Promise<Array<IEntity>>;
+    getManyAsync(identifiers: Array<string>, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): Promise<Array<IEntity>>;
     /**
      * Gets the {@link IEntity} instances with the specified `ids` or `identifiers`.
      *
@@ -68,9 +75,10 @@ export interface IEntitiesClient {
      *
      * @param param - The ids or identifiers of the entities to get
      * @param loadConfiguration - The loading configuration for an entity
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns List of entities.
      */
-    getManyAsync(param: Array<number> | Array<string>, loadConfiguration?: Nullable<IEntityLoadConfiguration>): Promise<Array<IEntity>>;
+    getManyAsync(param: Array<number> | Array<string>, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): Promise<Array<IEntity>>;
     /**
      * Queries the {@link IEntity} instances for the specified `definitionName`.
      *
@@ -79,18 +87,20 @@ export interface IEntitiesClient {
      * @param skip - Skip the specified number of entities (optional)
      * @param take - Take only the specified number of entities (optional, default: {@link ENTITIES.take})
      * @param sorting - Sorting options
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns List of entities.
      */
-    getByDefinitionAsync(definitionName: string, loadConfiguration?: Nullable<IEntityLoadConfiguration>, skip?: number, take?: number, sorting?: Array<Sorting>): Promise<IEntityQueryResult>;
+    getByDefinitionAsync(definitionName: string, loadConfiguration?: Nullable<IEntityLoadConfiguration>, skip?: number, take?: number, sorting?: Array<Sorting>, cancelCallback?: CancelCallback): Promise<IEntityQueryResult>;
     /**
      * Queries the {@link IEntity} ids for the specified `definitionName`.
      *
      * @param definitionName - The name of the definition to get entity ids for (case insensitive)
      * @param skip - Skip the specified number of entities (optional)
      * @param take - Take only the specified number of entities (optional, default: {@link ENTITIES.take})
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns List of entity ids.
      */
-    getIdsByDefinitionAsync(definitionName: string, skip?: number, take?: number): Promise<IIdQueryResult>;
+    getIdsByDefinitionAsync(definitionName: string, skip?: number, take?: number, cancelCallback?: CancelCallback): Promise<IIdQueryResult>;
     /**
      * Creates an {@link IEntityIterator} instance for the specified definition that returns instances.
      * Results are sorted ascending on creation date.
@@ -117,15 +127,27 @@ export interface IEntitiesClient {
      * fetched again.
      *
      * @param entity - Entity to save
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      * @returns The id of the entity.
      */
-    saveAsync(entity: IEntity): Promise<number>;
+    saveAsync(entity: IEntity, cancelCallback?: CancelCallback): Promise<number>;
     /**
      * Deletes the {@link IEntity} with specified id.
      *
      * @param entityId - The id of the entity to delete
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
      */
-    deleteAsync(entityId: number): Promise<void>;
+    deleteAsync(entityId: number, cancelCallback?: CancelCallback): Promise<void>;
+    /**
+     * Copies an {@link IEntity} by id to a new or existing entity.
+     *
+     * @param entityId - The id of the entity to delete
+     * @param copyOptions - The copy options.
+     *
+     * @returns The id of the copied entity.
+     * @param cancelCallback - A {@link CancelCallback} that will be placed in an Axios {@link CancelToken} if provided
+     */
+    copyAsync(entityId: number, copyOptions: IEntityCopyOptions, cancelCallback?: CancelCallback): Promise<number>;
 }
 /**
  * The client responsible for getting, saving and deleting entities.
@@ -134,32 +156,21 @@ export declare class EntitiesClient implements IEntitiesClient {
     private readonly _client;
     constructor(client: IExtendedContentHubClient);
     /**
-     * Gets the {@link IEntity} instance with the specified `id` or `identifier`.
-     * @param param - The id or identifier of the entity to get
-     * @param loadConfiguration - The loading configuration for the entity
-     * @returns The entity or `null` when it was not found.
+     * {@inheritDoc}
      */
-    getAsync(param: string | number, loadConfiguration?: Nullable<IEntityLoadConfiguration>): NullableResultPromise<IEntity>;
+    getAsync(param: string | number, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): NullableResultPromise<IEntity>;
     /**
-     * Gets the {@link IEntity} instances with the specified `ids` or `identifiers`.
-     *
-     * @remarks
-     * The returned list of entities can be empty or contain fewer items than the list of identifiers.
-     * The order of the entities in the returned list can be different than the order of the requested identifiers.
-     *
-     * @param param - The ids or identifiers of the entities to get
-     * @param loadConfiguration - The loading configuration for an entity
-     * @returns List of entities.
+     * {@inheritDoc}
      */
-    getManyAsync(param: Array<number> | Array<string>, loadConfiguration?: Nullable<IEntityLoadConfiguration>): Promise<Array<IEntity>>;
+    getManyAsync(param: Array<number> | Array<string>, loadConfiguration?: Nullable<IEntityLoadConfiguration>, cancelCallback?: CancelCallback): Promise<Array<IEntity>>;
     /**
      * {@inheritDoc}
      */
-    getByDefinitionAsync(definitionName: string, loadConfiguration?: Nullable<IEntityLoadConfiguration>, skip?: number, take?: number, sorting?: Array<Sorting>): Promise<IEntityQueryResult>;
+    getByDefinitionAsync(definitionName: string, loadConfiguration?: Nullable<IEntityLoadConfiguration>, skip?: number, take?: number, sorting?: Array<Sorting>, cancelCallback?: CancelCallback): Promise<IEntityQueryResult>;
     /**
      * {@inheritDoc}
      */
-    getIdsByDefinitionAsync(definitionName: string, skip?: number, take?: number): Promise<IIdQueryResult>;
+    getIdsByDefinitionAsync(definitionName: string, skip?: number, take?: number, cancelCallback?: CancelCallback): Promise<IIdQueryResult>;
     /**
      * {@inheritDoc}
      */
@@ -171,11 +182,15 @@ export declare class EntitiesClient implements IEntitiesClient {
     /**
      * {@inheritDoc}
      */
-    saveAsync(entity: IEntity): Promise<number>;
+    saveAsync(entity: IEntity, cancelCallback?: CancelCallback): Promise<number>;
+    /**
+     * {@inheritDoc}
+     */
+    deleteAsync(entityId: number, cancelCallback?: CancelCallback): Promise<void>;
     /**
      * {@inheritDoc}
      */
-    deleteAsync(entityId: number): Promise<void>;
+    copyAsync(entityId: number, copyOptions: IEntityCopyOptions, cancelCallback?: CancelCallback): Promise<number>;
     /**
      * Creates the specified {@link IEntity} in the system.
      *

package/dist/clients/entities-client.js

@@ -26,6 +26,7 @@ const internal_error_1 = require("../errors/internal-error");
 const web_api_error_1 = require("../errors/web-api-error");
 const guard_1 = __importDefault(require("../guard"));
 const link_1 = __importDefault(require("../link"));
+const entity_copy_options_mapper_1 = require("../mappers/entity-copy-options-mapper");
 const type_guards_1 = require("../type-guards");
 const response_handler_1 = require("./response-handler");
 /**
@@ -37,12 +38,9 @@ class EntitiesClient {
         this._client = client;
     }
     /**
-     * Gets the {@link IEntity} instance with the specified `id` or `identifier`.
-     * @param param - The id or identifier of the entity to get
-     * @param loadConfiguration - The loading configuration for the entity
-     * @returns The entity or `null` when it was not found.
+     * {@inheritDoc}
      */
-    getAsync(param, loadConfiguration) {
+    getAsync(param, loadConfiguration, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             let query;
             if (typeof param === "string") {
@@ -63,23 +61,15 @@ class EntitiesClient {
                     }),
                 });
             }
-            const result = yield this._client.querying.queryAsync(query, loadConfiguration || null);
+            const result = yield this._client.querying.queryAsync(query, loadConfiguration || null, cancelCallback);
             const entity = EntitiesClient.single(result);
             return entity;
         });
     }
     /**
-     * Gets the {@link IEntity} instances with the specified `ids` or `identifiers`.
-     *
-     * @remarks
-     * The returned list of entities can be empty or contain fewer items than the list of identifiers.
-     * The order of the entities in the returned list can be different than the order of the requested identifiers.
-     *
-     * @param param - The ids or identifiers of the entities to get
-     * @param loadConfiguration - The loading configuration for an entity
-     * @returns List of entities.
+     * {@inheritDoc}
      */
-    getManyAsync(param, loadConfiguration) {
+    getManyAsync(param, loadConfiguration, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             if (param == null || param.length === 0)
                 return [];
@@ -105,14 +95,14 @@ class EntitiesClient {
                     }),
                 });
             }
-            const result = yield this._client.querying.queryAsync(query, loadConfiguration || null);
+            const result = yield this._client.querying.queryAsync(query, loadConfiguration || null, cancelCallback);
             return result.items;
         });
     }
     /**
      * {@inheritDoc}
      */
-    getByDefinitionAsync(definitionName, loadConfiguration, skip = defaults_1.ENTITIES.skip, take = defaults_1.ENTITIES.take, sorting) {
+    getByDefinitionAsync(definitionName, loadConfiguration, skip = defaults_1.ENTITIES.skip, take = defaults_1.ENTITIES.take, sorting, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(definitionName);
             guard_1.default.notNegative(skip);
@@ -126,13 +116,13 @@ class EntitiesClient {
                 take: take,
                 sorting: sorting,
             });
-            return this._client.querying.queryAsync(query, loadConfiguration);
+            return this._client.querying.queryAsync(query, loadConfiguration, cancelCallback);
         });
     }
     /**
      * {@inheritDoc}
      */
-    getIdsByDefinitionAsync(definitionName, skip, take) {
+    getIdsByDefinitionAsync(definitionName, skip, take, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.stringNotNullOrEmpty(definitionName);
             if (skip != null)
@@ -146,8 +136,9 @@ class EntitiesClient {
                 }),
                 skip: skip,
                 take: take,
+                //TODO sorting on created on ascending?
             });
-            const result = yield this._client.querying.queryIdsAsync(query);
+            const result = yield this._client.querying.queryIdsAsync(query, cancelCallback);
             return result;
         });
     }
@@ -181,15 +172,15 @@ class EntitiesClient {
     /**
      * {@inheritDoc}
      */
-    saveAsync(entity) {
+    saveAsync(entity, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.notNullOrUndefined(entity);
             let id;
             if (entity.isNew) {
-                id = yield this.createEntityAsync(entity);
+                id = yield this.createEntityAsync(entity, cancelCallback);
             }
             else {
-                yield this.updateEntityAsync(entity);
+                yield this.updateEntityAsync(entity, cancelCallback);
                 id = entity.id;
             }
             entity.markClean();
@@ -199,12 +190,34 @@ class EntitiesClient {
     /**
      * {@inheritDoc}
      */
-    deleteAsync(entityId) {
+    deleteAsync(entityId, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             guard_1.default.validId(entityId);
             const link = yield this._client.linkHelper.entityToLinkAsync(entityId);
-            const response = yield this._client.raw.deleteAsync(link.href);
+            const response = yield this._client.raw.deleteAsync(link.href, undefined, cancelCallback);
+            response_handler_1.ResponseHandler.handleErrors(response);
+        });
+    }
+    /**
+     * {@inheritDoc}
+     */
+    copyAsync(entityId, copyOptions, cancelCallback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            guard_1.default.validId(entityId);
+            guard_1.default.notNull(copyOptions);
+            const link = yield this._client.linkHelper.copyEntityToLinkAsync(entityId);
+            const options = entity_copy_options_mapper_1.EntityCopyOptionsMapper.map(copyOptions);
+            const response = yield this._client.raw.postAsync(link.href, ta_json_1.TaJson.serialize(options), undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
+            const href = response.responseHeaders[api_1.HEADERS.location];
+            if (!href) {
+                throw new web_api_error_1.WebApiError(error_messages_1.default.EntitiesClient.UnableToExtractLocationHeaderFromResponse, response.statusCode, response);
+            }
+            const id = yield this._client.linkHelper.idFromEntityAsync(new link_1.default(href));
+            if (id === null || id === 0) {
+                throw new internal_error_1.InternalError(error_messages_1.default.EntitiesClient.UnableToExtractEntityIdFromHeader);
+            }
+            return id;
         });
     }
     /**
@@ -212,11 +225,11 @@ class EntitiesClient {
      *
      * @param entity - The entity to create/save in the system
      */
-    createEntityAsync(entity) {
+    createEntityAsync(entity, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             const link = yield this._client.linkHelper.entitiesLinkAsync();
             const resource = yield this._client.entityMapper.toResourceAsync(entity);
-            const response = yield this._client.raw.postAsync(link.href, ta_json_1.TaJson.serialize(resource));
+            const response = yield this._client.raw.postAsync(link.href, ta_json_1.TaJson.serialize(resource), undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
             const href = response.responseHeaders[api_1.HEADERS.location];
             if (!href) {
@@ -234,7 +247,7 @@ class EntitiesClient {
      *
      * @param entity - The entity to update
      */
-    updateEntityAsync(entity) {
+    updateEntityAsync(entity, cancelCallback) {
         return __awaiter(this, void 0, void 0, function* () {
             // Check if the entity is loaded in only one culture to improve save performance.
             let culture = null;
@@ -243,7 +256,7 @@ class EntitiesClient {
             }
             const link = yield this._client.linkHelper.entityToLinkAsync(entity.id, culture !== null && culture !== void 0 ? culture : undefined);
             const resource = yield this._client.entityMapper.mapDirtiesToResourceAsync(entity);
-            const response = yield this._client.raw.putAsync(link.href, ta_json_1.TaJson.serialize(resource));
+            const response = yield this._client.raw.putAsync(link.href, ta_json_1.TaJson.serialize(resource), undefined, cancelCallback);
             response_handler_1.ResponseHandler.handleErrors(response);
         });
     }
@@ -269,3 +282,4 @@ class EntitiesClient {
     }
 }
 exports.EntitiesClient = EntitiesClient;
+//# sourceMappingURL=entities-client.js.map

package/dist/clients/entity-definitions-client.d.ts

@@ -9,40 +9,78 @@ export interface IEntityDefinitionsClient {
     /**
      * Get the {@link IEntityDefinition} instance by the specified name.
      * @param name - The name of the definition
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
      * @returns Promise which resolves to an {@link IEntityDefinition} or null.
      */
-    getAsync(name: string): NullableResultPromise<IEntityDefinition>;
+    getAsync(name: string, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
     /**
      * Get the {@link IEntityDefinition} instance by the specified id.
      * @param id - The id of the definition
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
      * @returns Promise which resolves to an {@link IEntityDefinition} or null.
      */
-    getAsync(id: number): NullableResultPromise<IEntityDefinition>;
+    getAsync(id: number, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
     /**
-     * Get all the {@link IEntityDefinition}s
+     * Get all the {@link IEntityDefinition}s.
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
      * @returns Promise which resolved to an array of {@link IEntityDefinition}s.
      */
-    getAllAsync(): Promise<Array<IEntityDefinition>>;
+    getAllAsync(includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
     /**
      * Get all the {@link IEntityDefinition}s (cached).
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
      * @returns Promise which resolved to an array of {@link IEntityDefinition}s.
      */
-    getAllCachedAsync(): Promise<Array<IEntityDefinition>>;
+    getAllCachedAsync(includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
     /**
      * Get the cached {@link IEntityDefinition} instance by the specified name.
      * @param name - The name of the definition
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definition
      * @returns Promise which resolves to an {@link IEntityDefinition} or null.
      */
-    getCachedAsync(name: string): NullableResultPromise<IEntityDefinition>;
-    getCachedAsync(id: number): NullableResultPromise<IEntityDefinition>;
+    getCachedAsync(name: string, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
+    getCachedAsync(id: number, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
     getNameAsync(id: number): NullableResultPromise<string>;
     getNameCachedAsync(id: number): NullableResultPromise<string>;
     getIdAsync(name: string): NullableResultPromise<number>;
     getIdCachedAsync(name: string): NullableResultPromise<number>;
-    getManyAsync(names: Array<string>): Promise<Array<IEntityDefinition>>;
-    getManyAsync(ids: Array<number>): Promise<Array<IEntityDefinition>>;
-    getManyCachedAsync(names: Array<string>): Promise<Array<IEntityDefinition>>;
-    getManyCachedAsync(ids: Array<number>): Promise<Array<IEntityDefinition>>;
+    /**
+     * Get multiple entity definitions.
+     * @param names - Names of the definitions to fetch
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
+     * @returns A list of entity definitions.
+     */
+    getManyAsync(names: Array<string>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
+    /**
+     * Get multiple entity definitions.
+     * @param ids - The ids of the definitions to fetch
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
+     * @returns A list of entity definitions.
+     */
+    getManyAsync(ids: Array<number>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
+    /**
+     * Get multiple entity definitions. Check the cache before making a request.
+     * @param names - Names of the definitions to fetch
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
+     * @returns A list of entity definitions.
+     */
+    getManyCachedAsync(names: Array<string>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
+    /**
+     * Get multiple entity definitions. Check the cache before making a request.
+     * @param ids - The ids of the definitions to fetch
+     * @param includeConditionalMembers - Include conditional members
+     * @param loadPermissions - Load permissions for the definitions
+     * @returns A list of entity definitions.
+     */
+    getManyCachedAsync(ids: Array<number>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
     getNamesAsync(ids: Array<number>): Promise<MapNumberTo<string>>;
     getNamesCachedAsync(ids: Array<number>): Promise<MapNumberTo<string>>;
     getIdsAsync(names: Array<string>): Promise<MapStringTo<number>>;
@@ -60,16 +98,16 @@ export declare class EntityDefinitionsClient implements IEntityDefinitionsClient
     private readonly _client;
     private readonly _cache;
     constructor(client: IExtendedContentHubClient);
-    getAllCachedAsync(): Promise<Array<IEntityDefinition>>;
-    getAllAsync(): Promise<Array<IEntityDefinition>>;
-    getAsync(param: string | number): NullableResultPromise<IEntityDefinition>;
-    getCachedAsync(param: string | number): NullableResultPromise<IEntityDefinition>;
+    getAllCachedAsync(includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
+    getAllAsync(includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
+    getAsync(param: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
+    getCachedAsync(param: string | number, includeConditionalMembers?: boolean, loadPermissions?: boolean): NullableResultPromise<IEntityDefinition>;
     getNameAsync(id: number): NullableResultPromise<string>;
     getNameCachedAsync(id: number): NullableResultPromise<string>;
     getIdAsync(name: string): NullableResultPromise<number>;
     getIdCachedAsync(name: string): NullableResultPromise<number>;
-    getManyAsync(param: Array<string> | Array<number>): Promise<Array<IEntityDefinition>>;
-    getManyCachedAsync(param: Array<string> | Array<number>): Promise<Array<IEntityDefinition>>;
+    getManyAsync(param: Array<string> | Array<number>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
+    getManyCachedAsync(param: Array<string> | Array<number>, includeConditionalMembers?: boolean, loadPermissions?: boolean): Promise<Array<IEntityDefinition>>;
     getNamesAsync(ids: Array<number>): Promise<MapNumberTo<string>>;
     getNamesCachedAsync(ids: Array<number>): Promise<MapNumberTo<string>>;
     getIdsAsync(names: Array<string>): Promise<MapStringTo<number>>;