@contrail/entity-types 1.4.0 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/.nojekyll +1 -0
- package/docs/assets/highlight.css +64 -0
- package/docs/assets/icons.js +15 -0
- package/docs/assets/icons.svg +1 -0
- package/docs/assets/main.js +59 -0
- package/docs/assets/navigation.js +1 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1414 -0
- package/docs/classes/ApiError.html +14 -0
- package/docs/classes/AssortmentSplit.html +7 -0
- package/docs/classes/ColumnDefinition.html +7 -0
- package/docs/classes/ConditionalValues.html +5 -0
- package/docs/classes/EntitiesClient.html +26 -0
- package/docs/classes/EntitiesClientBatchCreateOptions.html +12 -0
- package/docs/classes/EntitiesClientBatchDeleteOptions.html +13 -0
- package/docs/classes/EntitiesClientBatchUpdateOptions.html +12 -0
- package/docs/classes/EntitiesClientCreateOptions.html +20 -0
- package/docs/classes/EntitiesClientDeleteOptions.html +17 -0
- package/docs/classes/EntitiesClientGetOptions.html +39 -0
- package/docs/classes/EntitiesClientUpdateOptions.html +25 -0
- package/docs/classes/EntityReference.html +7 -0
- package/docs/classes/InvalidPolicyError.html +13 -0
- package/docs/classes/LoaderProcess.html +44 -0
- package/docs/classes/TimeoutError.html +13 -0
- package/docs/classes/ValueToAssortment.html +6 -0
- package/docs/enums/API_VERSION.html +7 -0
- package/docs/enums/AppAccessGrantScope.html +3 -0
- package/docs/enums/AppExtensionType.html +6 -0
- package/docs/enums/AppExtensionUserApps.html +7 -0
- package/docs/enums/AppOrgStatus.html +7 -0
- package/docs/enums/AppVersionStatus.html +8 -0
- package/docs/enums/AssortmentType.html +7 -0
- package/docs/enums/EntityType.html +7 -0
- package/docs/enums/IssueType.html +11 -0
- package/docs/enums/LoadStatus.html +7 -0
- package/docs/enums/LoadType.html +9 -0
- package/docs/enums/LoaderFailureArea.html +7 -0
- package/docs/enums/LogLevel.html +8 -0
- package/docs/enums/NodeRuntime.html +4 -0
- package/docs/enums/PropertyType.html +27 -0
- package/docs/enums/SharedLinkAccessLevel.html +7 -0
- package/docs/enums/SortOrderOptions.html +5 -0
- package/docs/enums/SubscriptionChannel.html +5 -0
- package/docs/enums/SubscriptionType.html +9 -0
- package/docs/enums/UserOrgRole.html +5 -0
- package/docs/enums/WorkspacePrincipalRole.html +5 -0
- package/docs/enums/WorkspaceType.html +5 -0
- package/docs/functions/isValidNodeRuntime.html +2 -0
- package/docs/home-hero.svg +11 -0
- package/docs/index.html +5 -0
- package/docs/interfaces/App.html +26 -0
- package/docs/interfaces/AppAccessGrant.html +15 -0
- package/docs/interfaces/AppApiKey.html +15 -0
- package/docs/interfaces/AppCodePackage.html +16 -0
- package/docs/interfaces/AppExtension.html +20 -0
- package/docs/interfaces/AppExtensionDefinition.html +19 -0
- package/docs/interfaces/AppOrg.html +17 -0
- package/docs/interfaces/AppVersion.html +22 -0
- package/docs/interfaces/Asset.html +25 -0
- package/docs/interfaces/Assortment.html +32 -0
- package/docs/interfaces/AssortmentItem.html +27 -0
- package/docs/interfaces/AssortmentSummary.html +16 -0
- package/docs/interfaces/Color.html +19 -0
- package/docs/interfaces/ColumnIssueDetails.html +6 -0
- package/docs/interfaces/CompositePlansSummary.html +16 -0
- package/docs/interfaces/ConfigProperty.html +6 -0
- package/docs/interfaces/Content.html +29 -0
- package/docs/interfaces/ContentHolderContent.html +12 -0
- package/docs/interfaces/EntityLoadResult.html +10 -0
- package/docs/interfaces/ExternalLink.html +7 -0
- package/docs/interfaces/ExternalLinkExtraAttribute.html +4 -0
- package/docs/interfaces/File.html +20 -0
- package/docs/interfaces/GeneralIssueDetails.html +4 -0
- package/docs/interfaces/Group.html +14 -0
- package/docs/interfaces/GroupPrincipal.html +16 -0
- package/docs/interfaces/Item.html +25 -0
- package/docs/interfaces/LoadResult.html +13 -0
- package/docs/interfaces/LoaderConfiguration.html +16 -0
- package/docs/interfaces/LoaderNumbersSummary.html +14 -0
- package/docs/interfaces/Org.html +13 -0
- package/docs/interfaces/PreprocessingStepStoredResultSummary.html +6 -0
- package/docs/interfaces/ProcessedData.html +9 -0
- package/docs/interfaces/ProcessingIssues.html +4 -0
- package/docs/interfaces/Project.html +11 -0
- package/docs/interfaces/ProjectItem.html +18 -0
- package/docs/interfaces/PropertyTypeMetaData.html +5 -0
- package/docs/interfaces/RowLoadError.html +4 -0
- package/docs/interfaces/SharedLink.html +22 -0
- package/docs/interfaces/SharedLinkPrincipal.html +18 -0
- package/docs/interfaces/SortOption.html +4 -0
- package/docs/interfaces/Subscription.html +18 -0
- package/docs/interfaces/TriggerKeyDefinition.html +6 -0
- package/docs/interfaces/User.html +14 -0
- package/docs/interfaces/UserOrg.html +19 -0
- package/docs/interfaces/Workspace.html +29 -0
- package/docs/interfaces/WorkspacePrincipal.html +21 -0
- package/docs/modules.html +94 -0
- package/docs/types/BatchFetchResponse.html +2 -0
- package/docs/types/SubscriptionMatrix.html +2 -0
- package/docs/variables/BOARD_APP_SUBSCRIBED_TO_CONST.html +2 -0
- package/docs/variables/DEFAULT_API_VERSION.html +2 -0
- package/docs/variables/PLAN_APP_SUBSCRIBED_TO_CONST.html +2 -0
- package/docs/variables/SHOWCASE_APP_SUBSCRIBED_TO_CONST.html +2 -0
- package/lib/app-access-grant.d.ts +15 -15
- package/lib/app-access-grant.js +7 -7
- package/lib/app-api-key.d.ts +15 -15
- package/lib/app-api-key.js +2 -2
- package/lib/app-code-package.d.ts +17 -17
- package/lib/app-code-package.js +2 -2
- package/lib/app-extension-definition.d.ts +34 -34
- package/lib/app-extension-definition.js +18 -18
- package/lib/app-extension.d.ts +23 -23
- package/lib/app-extension.js +2 -2
- package/lib/app-org.d.ts +20 -20
- package/lib/app-org.js +11 -11
- package/lib/app-version.d.ts +57 -57
- package/lib/app-version.js +21 -21
- package/lib/app.d.ts +25 -25
- package/lib/app.js +2 -2
- package/lib/asset.d.ts +16 -16
- package/lib/asset.js +2 -2
- package/lib/assortment-item.d.ts +27 -27
- package/lib/assortment-item.js +2 -2
- package/lib/assortment-summary.d.ts +15 -15
- package/lib/assortment-summary.js +2 -2
- package/lib/assortment.d.ts +39 -39
- package/lib/assortment.js +11 -11
- package/lib/base-managed-entity.d.ts +8 -8
- package/lib/base-managed-entity.js +2 -2
- package/lib/batch-fetch-response.d.ts +11 -11
- package/lib/batch-fetch-response.js +2 -2
- package/lib/client.d.ts +107 -107
- package/lib/client.js +114 -114
- package/lib/color.d.ts +14 -14
- package/lib/color.js +2 -2
- package/lib/composite-plans-summary.d.ts +15 -15
- package/lib/composite-plans-summary.js +2 -2
- package/lib/content-custom-size.d.ts +14 -14
- package/lib/content-custom-size.js +2 -2
- package/lib/content.d.ts +25 -23
- package/lib/content.js +2 -2
- package/lib/contentholder-content.d.ts +5 -5
- package/lib/contentholder-content.js +2 -2
- package/lib/file.d.ts +13 -13
- package/lib/file.js +2 -2
- package/lib/index.d.ts +35 -35
- package/lib/index.js +51 -51
- package/lib/item.d.ts +20 -20
- package/lib/item.js +2 -2
- package/lib/loader.d.ts +182 -182
- package/lib/loader.js +115 -115
- package/lib/log-level.d.ts +8 -8
- package/lib/log-level.js +12 -12
- package/lib/org-managed-entity.d.ts +5 -5
- package/lib/org-managed-entity.js +2 -2
- package/lib/org.d.ts +11 -11
- package/lib/org.js +2 -2
- package/lib/project-configuration.d.ts +39 -39
- package/lib/project-configuration.js +9 -9
- package/lib/project-item.d.ts +9 -9
- package/lib/project-item.js +2 -2
- package/lib/project.d.ts +4 -4
- package/lib/project.js +2 -2
- package/lib/property-type.d.ts +32 -32
- package/lib/property-type.js +31 -31
- package/lib/shared-links.d.ts +46 -46
- package/lib/shared-links.js +11 -11
- package/lib/subscription.d.ts +38 -38
- package/lib/subscription.js +22 -22
- package/lib/type-managed-entity.d.ts +8 -8
- package/lib/type-managed-entity.js +2 -2
- package/lib/user.d.ts +79 -79
- package/lib/user.js +20 -20
- package/lib/workspace-managed-entity.d.ts +5 -5
- package/lib/workspace-managed-entity.js +2 -2
- package/lib/workspace-principal.d.ts +24 -24
- package/lib/workspace-principal.js +9 -9
- package/lib/workspace.d.ts +32 -32
- package/lib/workspace.js +9 -9
- package/package.json +1 -1
package/lib/asset.d.ts
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { TypeManagedEntity } from './type-managed-entity';
|
|
2
|
-
import { Content } from './content';
|
|
3
|
-
export interface Asset extends TypeManagedEntity {
|
|
4
|
-
workspaceId?: string;
|
|
5
|
-
name?: string;
|
|
6
|
-
contentId: string;
|
|
7
|
-
content?: Content;
|
|
8
|
-
copyFileId?: string;
|
|
9
|
-
fileName?: string;
|
|
10
|
-
contentType?: string;
|
|
11
|
-
fileSize?: string;
|
|
12
|
-
largeViewableDownloadUrl?: string;
|
|
13
|
-
mediumViewableDownloadUrl?: string;
|
|
14
|
-
smallViewableDownloadUrl?: string;
|
|
15
|
-
tinyViewableDownloadUrl?: string;
|
|
16
|
-
}
|
|
1
|
+
import { TypeManagedEntity } from './type-managed-entity';
|
|
2
|
+
import { Content } from './content';
|
|
3
|
+
export interface Asset extends TypeManagedEntity {
|
|
4
|
+
workspaceId?: string;
|
|
5
|
+
name?: string;
|
|
6
|
+
contentId: string;
|
|
7
|
+
content?: Content;
|
|
8
|
+
copyFileId?: string;
|
|
9
|
+
fileName?: string;
|
|
10
|
+
contentType?: string;
|
|
11
|
+
fileSize?: string;
|
|
12
|
+
largeViewableDownloadUrl?: string;
|
|
13
|
+
mediumViewableDownloadUrl?: string;
|
|
14
|
+
smallViewableDownloadUrl?: string;
|
|
15
|
+
tinyViewableDownloadUrl?: string;
|
|
16
|
+
}
|
package/lib/asset.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/lib/assortment-item.d.ts
CHANGED
|
@@ -1,27 +1,27 @@
|
|
|
1
|
-
import { Assortment } from './assortment';
|
|
2
|
-
import { TypeManagedEntity } from './type-managed-entity';
|
|
3
|
-
export interface AssortmentItem extends TypeManagedEntity {
|
|
4
|
-
id: string;
|
|
5
|
-
createdOn?: Date;
|
|
6
|
-
updatedOn?: Date;
|
|
7
|
-
createdById?: string;
|
|
8
|
-
updatedById?: string;
|
|
9
|
-
createdBy?: any;
|
|
10
|
-
updatedBy?: any;
|
|
11
|
-
typeId?: string;
|
|
12
|
-
orgId?: string;
|
|
13
|
-
typePath?: string;
|
|
14
|
-
assortmentId?: string;
|
|
15
|
-
assortment?: Assortment;
|
|
16
|
-
itemId?: string;
|
|
17
|
-
item?: any;
|
|
18
|
-
projectItem?: any;
|
|
19
|
-
itemFederatedId?: string;
|
|
20
|
-
assortmentFederatedId?: string;
|
|
21
|
-
compositeAddedFrom?: string;
|
|
22
|
-
compositedOverlappingWith?: string[];
|
|
23
|
-
copyId?: string;
|
|
24
|
-
createdFromId?: string;
|
|
25
|
-
createMethod?: string;
|
|
26
|
-
[x: string]: any;
|
|
27
|
-
}
|
|
1
|
+
import { Assortment } from './assortment';
|
|
2
|
+
import { TypeManagedEntity } from './type-managed-entity';
|
|
3
|
+
export interface AssortmentItem extends TypeManagedEntity {
|
|
4
|
+
id: string;
|
|
5
|
+
createdOn?: Date;
|
|
6
|
+
updatedOn?: Date;
|
|
7
|
+
createdById?: string;
|
|
8
|
+
updatedById?: string;
|
|
9
|
+
createdBy?: any;
|
|
10
|
+
updatedBy?: any;
|
|
11
|
+
typeId?: string;
|
|
12
|
+
orgId?: string;
|
|
13
|
+
typePath?: string;
|
|
14
|
+
assortmentId?: string;
|
|
15
|
+
assortment?: Assortment;
|
|
16
|
+
itemId?: string;
|
|
17
|
+
item?: any;
|
|
18
|
+
projectItem?: any;
|
|
19
|
+
itemFederatedId?: string;
|
|
20
|
+
assortmentFederatedId?: string;
|
|
21
|
+
compositeAddedFrom?: string;
|
|
22
|
+
compositedOverlappingWith?: string[];
|
|
23
|
+
copyId?: string;
|
|
24
|
+
createdFromId?: string;
|
|
25
|
+
createMethod?: string;
|
|
26
|
+
[x: string]: any;
|
|
27
|
+
}
|
package/lib/assortment-item.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { OrgManagedEntity } from './org-managed-entity';
|
|
2
|
-
export interface AssortmentSummary extends OrgManagedEntity {
|
|
3
|
-
id: string;
|
|
4
|
-
createdOn?: Date;
|
|
5
|
-
updatedOn?: Date;
|
|
6
|
-
createdById?: string;
|
|
7
|
-
updatedById?: string;
|
|
8
|
-
createdBy?: any;
|
|
9
|
-
updatedBy?: any;
|
|
10
|
-
orgId?: string;
|
|
11
|
-
assortmentId?: string;
|
|
12
|
-
count?: number;
|
|
13
|
-
aggregates?: any;
|
|
14
|
-
optionAggregates?: any;
|
|
15
|
-
}
|
|
1
|
+
import { OrgManagedEntity } from './org-managed-entity';
|
|
2
|
+
export interface AssortmentSummary extends OrgManagedEntity {
|
|
3
|
+
id: string;
|
|
4
|
+
createdOn?: Date;
|
|
5
|
+
updatedOn?: Date;
|
|
6
|
+
createdById?: string;
|
|
7
|
+
updatedById?: string;
|
|
8
|
+
createdBy?: any;
|
|
9
|
+
updatedBy?: any;
|
|
10
|
+
orgId?: string;
|
|
11
|
+
assortmentId?: string;
|
|
12
|
+
count?: number;
|
|
13
|
+
aggregates?: any;
|
|
14
|
+
optionAggregates?: any;
|
|
15
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/lib/assortment.d.ts
CHANGED
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
import { AssortmentItem } from './assortment-item';
|
|
2
|
-
import { AssortmentSummary } from './assortment-summary';
|
|
3
|
-
import { CompositePlansSummary } from './composite-plans-summary';
|
|
4
|
-
import { TypeManagedEntity } from './type-managed-entity';
|
|
5
|
-
export declare enum AssortmentType {
|
|
6
|
-
PLAN = "PLAN",
|
|
7
|
-
BACKING = "BACKING",
|
|
8
|
-
SHOWCASE = "SHOWCASE",
|
|
9
|
-
INTEGRATION = "INTEGRATION",
|
|
10
|
-
ASSORTMENT = "ASSORTMENT"
|
|
11
|
-
}
|
|
12
|
-
export interface Assortment extends TypeManagedEntity {
|
|
13
|
-
id: string;
|
|
14
|
-
createdOn?: Date;
|
|
15
|
-
updatedOn?: Date;
|
|
16
|
-
createdById?: string;
|
|
17
|
-
updatedById?: string;
|
|
18
|
-
createdBy?: any;
|
|
19
|
-
updatedBy?: any;
|
|
20
|
-
typeId?: string;
|
|
21
|
-
orgId?: string;
|
|
22
|
-
name: string;
|
|
23
|
-
identifier?: string;
|
|
24
|
-
sourceAssortmentIds?: string[];
|
|
25
|
-
sourceAssortments?: Assortment[];
|
|
26
|
-
composedFromAssortmentIds?: string[];
|
|
27
|
-
thumbnail?: string;
|
|
28
|
-
federatedId?: string;
|
|
29
|
-
primaryViewableId?: string;
|
|
30
|
-
description?: string;
|
|
31
|
-
assortmentItems?: AssortmentItem[];
|
|
32
|
-
itemsDownloadURL?: any;
|
|
33
|
-
workspaceId?: string;
|
|
34
|
-
rootWorkspaceId?: string;
|
|
35
|
-
assortmentSummary?: AssortmentSummary;
|
|
36
|
-
compositePlansSummary?: CompositePlansSummary;
|
|
37
|
-
assortmentType?: AssortmentType;
|
|
38
|
-
createdForReference?: string;
|
|
39
|
-
}
|
|
1
|
+
import { AssortmentItem } from './assortment-item';
|
|
2
|
+
import { AssortmentSummary } from './assortment-summary';
|
|
3
|
+
import { CompositePlansSummary } from './composite-plans-summary';
|
|
4
|
+
import { TypeManagedEntity } from './type-managed-entity';
|
|
5
|
+
export declare enum AssortmentType {
|
|
6
|
+
PLAN = "PLAN",
|
|
7
|
+
BACKING = "BACKING",
|
|
8
|
+
SHOWCASE = "SHOWCASE",
|
|
9
|
+
INTEGRATION = "INTEGRATION",
|
|
10
|
+
ASSORTMENT = "ASSORTMENT"
|
|
11
|
+
}
|
|
12
|
+
export interface Assortment extends TypeManagedEntity {
|
|
13
|
+
id: string;
|
|
14
|
+
createdOn?: Date;
|
|
15
|
+
updatedOn?: Date;
|
|
16
|
+
createdById?: string;
|
|
17
|
+
updatedById?: string;
|
|
18
|
+
createdBy?: any;
|
|
19
|
+
updatedBy?: any;
|
|
20
|
+
typeId?: string;
|
|
21
|
+
orgId?: string;
|
|
22
|
+
name: string;
|
|
23
|
+
identifier?: string;
|
|
24
|
+
sourceAssortmentIds?: string[];
|
|
25
|
+
sourceAssortments?: Assortment[];
|
|
26
|
+
composedFromAssortmentIds?: string[];
|
|
27
|
+
thumbnail?: string;
|
|
28
|
+
federatedId?: string;
|
|
29
|
+
primaryViewableId?: string;
|
|
30
|
+
description?: string;
|
|
31
|
+
assortmentItems?: AssortmentItem[];
|
|
32
|
+
itemsDownloadURL?: any;
|
|
33
|
+
workspaceId?: string;
|
|
34
|
+
rootWorkspaceId?: string;
|
|
35
|
+
assortmentSummary?: AssortmentSummary;
|
|
36
|
+
compositePlansSummary?: CompositePlansSummary;
|
|
37
|
+
assortmentType?: AssortmentType;
|
|
38
|
+
createdForReference?: string;
|
|
39
|
+
}
|
package/lib/assortment.js
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.AssortmentType = void 0;
|
|
4
|
-
var AssortmentType;
|
|
5
|
-
(function (AssortmentType) {
|
|
6
|
-
AssortmentType["PLAN"] = "PLAN";
|
|
7
|
-
AssortmentType["BACKING"] = "BACKING";
|
|
8
|
-
AssortmentType["SHOWCASE"] = "SHOWCASE";
|
|
9
|
-
AssortmentType["INTEGRATION"] = "INTEGRATION";
|
|
10
|
-
AssortmentType["ASSORTMENT"] = "ASSORTMENT";
|
|
11
|
-
})(AssortmentType = exports.AssortmentType || (exports.AssortmentType = {}));
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AssortmentType = void 0;
|
|
4
|
+
var AssortmentType;
|
|
5
|
+
(function (AssortmentType) {
|
|
6
|
+
AssortmentType["PLAN"] = "PLAN";
|
|
7
|
+
AssortmentType["BACKING"] = "BACKING";
|
|
8
|
+
AssortmentType["SHOWCASE"] = "SHOWCASE";
|
|
9
|
+
AssortmentType["INTEGRATION"] = "INTEGRATION";
|
|
10
|
+
AssortmentType["ASSORTMENT"] = "ASSORTMENT";
|
|
11
|
+
})(AssortmentType = exports.AssortmentType || (exports.AssortmentType = {}));
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export interface BaseManagedEntity {
|
|
2
|
-
id?: string;
|
|
3
|
-
createdOn?: Date;
|
|
4
|
-
updatedOn?: Date;
|
|
5
|
-
createdById?: string;
|
|
6
|
-
updatedById?: string;
|
|
7
|
-
readUpdatedOn?: Date;
|
|
8
|
-
}
|
|
1
|
+
export interface BaseManagedEntity {
|
|
2
|
+
id?: string;
|
|
3
|
+
createdOn?: Date;
|
|
4
|
+
updatedOn?: Date;
|
|
5
|
+
createdById?: string;
|
|
6
|
+
updatedById?: string;
|
|
7
|
+
readUpdatedOn?: Date;
|
|
8
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
export type BatchFetchResponse<T> = BatchFetchResponseResults<T> | BatchFetchResponseCompressed | BatchFetchResponseDownloadUrl;
|
|
2
|
-
type BatchFetchResponseResults<T> = {
|
|
3
|
-
results: T[];
|
|
4
|
-
};
|
|
5
|
-
type BatchFetchResponseCompressed = {
|
|
6
|
-
resultsCompressedString: string;
|
|
7
|
-
};
|
|
8
|
-
type BatchFetchResponseDownloadUrl = {
|
|
9
|
-
resultsDownloadUrl: string;
|
|
10
|
-
};
|
|
11
|
-
export {};
|
|
1
|
+
export type BatchFetchResponse<T> = BatchFetchResponseResults<T> | BatchFetchResponseCompressed | BatchFetchResponseDownloadUrl;
|
|
2
|
+
type BatchFetchResponseResults<T> = {
|
|
3
|
+
results: T[];
|
|
4
|
+
};
|
|
5
|
+
type BatchFetchResponseCompressed = {
|
|
6
|
+
resultsCompressedString: string;
|
|
7
|
+
};
|
|
8
|
+
type BatchFetchResponseDownloadUrl = {
|
|
9
|
+
resultsDownloadUrl: string;
|
|
10
|
+
};
|
|
11
|
+
export {};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/lib/client.d.ts
CHANGED
|
@@ -1,107 +1,107 @@
|
|
|
1
|
-
export declare class InvalidPolicyError extends Error {
|
|
2
|
-
}
|
|
3
|
-
export declare class TimeoutError extends Error {
|
|
4
|
-
}
|
|
5
|
-
export declare class ApiError extends Error {
|
|
6
|
-
details: any;
|
|
7
|
-
constructor(message: any, details: any);
|
|
8
|
-
}
|
|
9
|
-
export declare abstract class EntityReference {
|
|
10
|
-
id: string;
|
|
11
|
-
entityType: string;
|
|
12
|
-
reference: string;
|
|
13
|
-
}
|
|
14
|
-
export interface SortOption {
|
|
15
|
-
orderField: string;
|
|
16
|
-
order?: SortOrderOptions;
|
|
17
|
-
}
|
|
18
|
-
export declare enum SortOrderOptions {
|
|
19
|
-
ASC = "asc",
|
|
20
|
-
DESC = "desc"
|
|
21
|
-
}
|
|
22
|
-
export declare enum API_VERSION {
|
|
23
|
-
EMPTY = "",
|
|
24
|
-
V1 = "1",
|
|
25
|
-
V2 = "2"
|
|
26
|
-
}
|
|
27
|
-
export declare const DEFAULT_API_VERSION = API_VERSION.EMPTY;
|
|
28
|
-
export declare abstract class EntitiesClientGetOptions {
|
|
29
|
-
entityName?: string;
|
|
30
|
-
id?: string;
|
|
31
|
-
reference?: string;
|
|
32
|
-
federatedId?: string;
|
|
33
|
-
federatedIds?: string[];
|
|
34
|
-
relation?: string;
|
|
35
|
-
relations?: Array<string>;
|
|
36
|
-
criteria?: {
|
|
37
|
-
[key: string]: any;
|
|
38
|
-
};
|
|
39
|
-
cacheMode?: string;
|
|
40
|
-
search?: string;
|
|
41
|
-
useSearch?: boolean;
|
|
42
|
-
order?: SortOption[];
|
|
43
|
-
skip?: number;
|
|
44
|
-
take?: number;
|
|
45
|
-
paginate?: boolean;
|
|
46
|
-
nextPageKey?: string;
|
|
47
|
-
apiVersion?: API_VERSION;
|
|
48
|
-
suffix?: string;
|
|
49
|
-
skipHydrateRelationships?: boolean;
|
|
50
|
-
}
|
|
51
|
-
export declare abstract class EntitiesClientCreateOptions {
|
|
52
|
-
entityName: string;
|
|
53
|
-
object: any;
|
|
54
|
-
id?: string;
|
|
55
|
-
relation?: string;
|
|
56
|
-
apiVersion?: API_VERSION;
|
|
57
|
-
suffix?: string;
|
|
58
|
-
skipHydrateRelationships?: boolean;
|
|
59
|
-
}
|
|
60
|
-
export declare abstract class EntitiesClientBatchCreateOptions {
|
|
61
|
-
entityName: string;
|
|
62
|
-
objects: any[];
|
|
63
|
-
apiVersion?: API_VERSION;
|
|
64
|
-
suffix?: string;
|
|
65
|
-
}
|
|
66
|
-
export declare abstract class EntitiesClientUpdateOptions {
|
|
67
|
-
entityName?: string;
|
|
68
|
-
object: any;
|
|
69
|
-
id?: string;
|
|
70
|
-
reference?: string;
|
|
71
|
-
relation?: string;
|
|
72
|
-
relationId?: string;
|
|
73
|
-
apiVersion?: API_VERSION;
|
|
74
|
-
suffix?: string;
|
|
75
|
-
skipHydrateRelationships?: boolean;
|
|
76
|
-
}
|
|
77
|
-
export declare abstract class EntitiesClientBatchUpdateOptions {
|
|
78
|
-
entityName: string;
|
|
79
|
-
objects: any[];
|
|
80
|
-
apiVersion?: API_VERSION;
|
|
81
|
-
suffix?: string;
|
|
82
|
-
}
|
|
83
|
-
export declare abstract class EntitiesClientDeleteOptions {
|
|
84
|
-
entityName?: string;
|
|
85
|
-
id?: string;
|
|
86
|
-
reference?: string;
|
|
87
|
-
relation?: string;
|
|
88
|
-
relationId?: string;
|
|
89
|
-
apiVersion?: API_VERSION;
|
|
90
|
-
suffix?: string;
|
|
91
|
-
}
|
|
92
|
-
export declare abstract class EntitiesClientBatchDeleteOptions {
|
|
93
|
-
entityName?: string;
|
|
94
|
-
ids?: string[];
|
|
95
|
-
apiVersion?: API_VERSION;
|
|
96
|
-
suffix?: string;
|
|
97
|
-
}
|
|
98
|
-
export declare abstract class EntitiesClient {
|
|
99
|
-
abstract getAllReferences(references: Array<EntityReference>, relations: Array<string>): Promise<Map<string, any>>;
|
|
100
|
-
abstract get(options: EntitiesClientGetOptions): Promise<any | any[]>;
|
|
101
|
-
abstract create(options: EntitiesClientCreateOptions): any;
|
|
102
|
-
abstract batchCreate(options: EntitiesClientBatchCreateOptions): any;
|
|
103
|
-
abstract update(options: EntitiesClientUpdateOptions): any;
|
|
104
|
-
abstract batchUpdate(options: EntitiesClientBatchUpdateOptions): any;
|
|
105
|
-
abstract delete(options: EntitiesClientDeleteOptions): any;
|
|
106
|
-
abstract batchDelete(options: EntitiesClientBatchDeleteOptions): any;
|
|
107
|
-
}
|
|
1
|
+
export declare class InvalidPolicyError extends Error {
|
|
2
|
+
}
|
|
3
|
+
export declare class TimeoutError extends Error {
|
|
4
|
+
}
|
|
5
|
+
export declare class ApiError extends Error {
|
|
6
|
+
details: any;
|
|
7
|
+
constructor(message: any, details: any);
|
|
8
|
+
}
|
|
9
|
+
export declare abstract class EntityReference {
|
|
10
|
+
id: string;
|
|
11
|
+
entityType: string;
|
|
12
|
+
reference: string;
|
|
13
|
+
}
|
|
14
|
+
export interface SortOption {
|
|
15
|
+
orderField: string;
|
|
16
|
+
order?: SortOrderOptions;
|
|
17
|
+
}
|
|
18
|
+
export declare enum SortOrderOptions {
|
|
19
|
+
ASC = "asc",
|
|
20
|
+
DESC = "desc"
|
|
21
|
+
}
|
|
22
|
+
export declare enum API_VERSION {
|
|
23
|
+
EMPTY = "",
|
|
24
|
+
V1 = "1",
|
|
25
|
+
V2 = "2"
|
|
26
|
+
}
|
|
27
|
+
export declare const DEFAULT_API_VERSION = API_VERSION.EMPTY;
|
|
28
|
+
export declare abstract class EntitiesClientGetOptions {
|
|
29
|
+
entityName?: string;
|
|
30
|
+
id?: string;
|
|
31
|
+
reference?: string;
|
|
32
|
+
federatedId?: string;
|
|
33
|
+
federatedIds?: string[];
|
|
34
|
+
relation?: string;
|
|
35
|
+
relations?: Array<string>;
|
|
36
|
+
criteria?: {
|
|
37
|
+
[key: string]: any;
|
|
38
|
+
};
|
|
39
|
+
cacheMode?: string;
|
|
40
|
+
search?: string;
|
|
41
|
+
useSearch?: boolean;
|
|
42
|
+
order?: SortOption[];
|
|
43
|
+
skip?: number;
|
|
44
|
+
take?: number;
|
|
45
|
+
paginate?: boolean;
|
|
46
|
+
nextPageKey?: string;
|
|
47
|
+
apiVersion?: API_VERSION;
|
|
48
|
+
suffix?: string;
|
|
49
|
+
skipHydrateRelationships?: boolean;
|
|
50
|
+
}
|
|
51
|
+
export declare abstract class EntitiesClientCreateOptions {
|
|
52
|
+
entityName: string;
|
|
53
|
+
object: any;
|
|
54
|
+
id?: string;
|
|
55
|
+
relation?: string;
|
|
56
|
+
apiVersion?: API_VERSION;
|
|
57
|
+
suffix?: string;
|
|
58
|
+
skipHydrateRelationships?: boolean;
|
|
59
|
+
}
|
|
60
|
+
export declare abstract class EntitiesClientBatchCreateOptions {
|
|
61
|
+
entityName: string;
|
|
62
|
+
objects: any[];
|
|
63
|
+
apiVersion?: API_VERSION;
|
|
64
|
+
suffix?: string;
|
|
65
|
+
}
|
|
66
|
+
export declare abstract class EntitiesClientUpdateOptions {
|
|
67
|
+
entityName?: string;
|
|
68
|
+
object: any;
|
|
69
|
+
id?: string;
|
|
70
|
+
reference?: string;
|
|
71
|
+
relation?: string;
|
|
72
|
+
relationId?: string;
|
|
73
|
+
apiVersion?: API_VERSION;
|
|
74
|
+
suffix?: string;
|
|
75
|
+
skipHydrateRelationships?: boolean;
|
|
76
|
+
}
|
|
77
|
+
export declare abstract class EntitiesClientBatchUpdateOptions {
|
|
78
|
+
entityName: string;
|
|
79
|
+
objects: any[];
|
|
80
|
+
apiVersion?: API_VERSION;
|
|
81
|
+
suffix?: string;
|
|
82
|
+
}
|
|
83
|
+
export declare abstract class EntitiesClientDeleteOptions {
|
|
84
|
+
entityName?: string;
|
|
85
|
+
id?: string;
|
|
86
|
+
reference?: string;
|
|
87
|
+
relation?: string;
|
|
88
|
+
relationId?: string;
|
|
89
|
+
apiVersion?: API_VERSION;
|
|
90
|
+
suffix?: string;
|
|
91
|
+
}
|
|
92
|
+
export declare abstract class EntitiesClientBatchDeleteOptions {
|
|
93
|
+
entityName?: string;
|
|
94
|
+
ids?: string[];
|
|
95
|
+
apiVersion?: API_VERSION;
|
|
96
|
+
suffix?: string;
|
|
97
|
+
}
|
|
98
|
+
export declare abstract class EntitiesClient {
|
|
99
|
+
abstract getAllReferences(references: Array<EntityReference>, relations: Array<string>): Promise<Map<string, any>>;
|
|
100
|
+
abstract get(options: EntitiesClientGetOptions): Promise<any | any[]>;
|
|
101
|
+
abstract create(options: EntitiesClientCreateOptions): any;
|
|
102
|
+
abstract batchCreate(options: EntitiesClientBatchCreateOptions): any;
|
|
103
|
+
abstract update(options: EntitiesClientUpdateOptions): any;
|
|
104
|
+
abstract batchUpdate(options: EntitiesClientBatchUpdateOptions): any;
|
|
105
|
+
abstract delete(options: EntitiesClientDeleteOptions): any;
|
|
106
|
+
abstract batchDelete(options: EntitiesClientBatchDeleteOptions): any;
|
|
107
|
+
}
|