@gooddata/api-client-tiger 11.6.0-alpha.5 → 11.6.0-alpha.7
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/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +1735 -457
- package/esm/genAI.d.ts.map +1 -1
- package/esm/genAI.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +27 -26
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +280 -279
- package/esm/generated/automation-json-api/api.d.ts +1 -0
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +1 -0
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +1 -0
- package/esm/generated/export-json-api/api.d.ts +1 -0
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +1 -0
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +1 -0
- package/esm/generated/metadata-json-api/api.d.ts +1611 -385
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +1232 -133
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +8946 -8114
- package/esm/generated/scan-json-api/api.d.ts +8 -0
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/openapi-spec.json +10 -0
- package/package.json +4 -4
|
@@ -6976,6 +6976,10 @@ export declare interface AfmGetQualityIssuesResponse {
|
|
|
6976
6976
|
* List of quality issues found in the workspace
|
|
6977
6977
|
*/
|
|
6978
6978
|
issues: Array<AfmQualityIssue>;
|
|
6979
|
+
/**
|
|
6980
|
+
* Timestamp when the quality issues were last updated (ISO format)
|
|
6981
|
+
*/
|
|
6982
|
+
updatedAt?: string;
|
|
6979
6983
|
}
|
|
6980
6984
|
|
|
6981
6985
|
/**
|
|
@@ -7396,6 +7400,10 @@ export declare interface AfmPositiveAttributeFilterPositiveAttributeFilter {
|
|
|
7396
7400
|
* List of quality issues (available when status is COMPLETED)
|
|
7397
7401
|
*/
|
|
7398
7402
|
export declare interface AfmQualityIssue {
|
|
7403
|
+
/**
|
|
7404
|
+
* Unique identifier for the quality issue
|
|
7405
|
+
*/
|
|
7406
|
+
id: string;
|
|
7399
7407
|
/**
|
|
7400
7408
|
* List of objects affected by this quality issue
|
|
7401
7409
|
*/
|
|
@@ -7428,6 +7436,10 @@ export declare interface AfmQualityIssueObject {
|
|
|
7428
7436
|
* Object ID
|
|
7429
7437
|
*/
|
|
7430
7438
|
id: string;
|
|
7439
|
+
/**
|
|
7440
|
+
* Workspace ID where the object belongs
|
|
7441
|
+
*/
|
|
7442
|
+
workspaceId: string;
|
|
7431
7443
|
}
|
|
7432
7444
|
|
|
7433
7445
|
export declare interface AfmQualityIssuesCalculationStatusResponse {
|
|
@@ -9455,20 +9467,6 @@ export declare interface AttributeElementsByValue {
|
|
|
9455
9467
|
values: Array<string | null>;
|
|
9456
9468
|
}
|
|
9457
9469
|
|
|
9458
|
-
/**
|
|
9459
|
-
* Attribute equality filter
|
|
9460
|
-
*/
|
|
9461
|
-
declare interface AttributeEqualityFilter {
|
|
9462
|
-
/**
|
|
9463
|
-
* The attribute label identifier to filter on
|
|
9464
|
-
*/
|
|
9465
|
-
labelIdentifier: string;
|
|
9466
|
-
/**
|
|
9467
|
-
* List of values to match (IN operation)
|
|
9468
|
-
*/
|
|
9469
|
-
values: Array<string | null>;
|
|
9470
|
-
}
|
|
9471
|
-
|
|
9472
9470
|
export declare interface AttributeExecutionResultHeader {
|
|
9473
9471
|
attributeHeader: AttributeResultHeader;
|
|
9474
9472
|
}
|
|
@@ -11470,6 +11468,7 @@ export declare const AutomationIdentifierRefIdentifierTypeEnum: {
|
|
|
11470
11468
|
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
11471
11469
|
readonly AUTOMATION: "automation";
|
|
11472
11470
|
readonly AUTOMATION_RESULT: "automationResult";
|
|
11471
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
11473
11472
|
readonly PROMPT: "prompt";
|
|
11474
11473
|
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
11475
11474
|
readonly FILTER_CONTEXT: "filterContext";
|
|
@@ -14361,14 +14360,8 @@ export declare interface CacheUsageData {
|
|
|
14361
14360
|
* Request for change analysis computation
|
|
14362
14361
|
*/
|
|
14363
14362
|
declare interface ChangeAnalysisRequest {
|
|
14364
|
-
|
|
14365
|
-
|
|
14366
|
-
*/
|
|
14367
|
-
metricIdentifier: string;
|
|
14368
|
-
/**
|
|
14369
|
-
* The date attribute identifier to use for time period comparison
|
|
14370
|
-
*/
|
|
14371
|
-
dateAttributeIdentifier: string;
|
|
14363
|
+
measure: AfmMeasureItem;
|
|
14364
|
+
dateAttribute: AfmAttributeItem;
|
|
14372
14365
|
/**
|
|
14373
14366
|
* The reference time period (e.g., \'2025-01\')
|
|
14374
14367
|
*/
|
|
@@ -14378,19 +14371,28 @@ declare interface ChangeAnalysisRequest {
|
|
|
14378
14371
|
*/
|
|
14379
14372
|
analyzedPeriod: string;
|
|
14380
14373
|
/**
|
|
14381
|
-
*
|
|
14374
|
+
* Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.
|
|
14382
14375
|
*/
|
|
14383
|
-
|
|
14376
|
+
attributes?: Array<AfmAttributeItem>;
|
|
14384
14377
|
/**
|
|
14385
14378
|
* Optional filters to apply.
|
|
14386
14379
|
*/
|
|
14387
|
-
filters
|
|
14380
|
+
filters?: Array<ChangeAnalysisRequestFiltersInner>;
|
|
14381
|
+
/**
|
|
14382
|
+
* Auxiliary measures
|
|
14383
|
+
*/
|
|
14384
|
+
auxMeasures?: Array<AfmMeasureItem>;
|
|
14388
14385
|
/**
|
|
14389
14386
|
* Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.
|
|
14390
14387
|
*/
|
|
14391
|
-
useSmartAttributeSelection
|
|
14388
|
+
useSmartAttributeSelection?: boolean;
|
|
14392
14389
|
}
|
|
14393
14390
|
|
|
14391
|
+
/**
|
|
14392
|
+
* @type ChangeAnalysisRequestFiltersInner
|
|
14393
|
+
*/
|
|
14394
|
+
declare type ChangeAnalysisRequestFiltersInner = AbstractMeasureValueFilter | AfmFilterDefinitionForSimpleMeasure | AfmInlineFilterDefinition;
|
|
14395
|
+
|
|
14394
14396
|
/**
|
|
14395
14397
|
* Response for change analysis computation
|
|
14396
14398
|
*/
|
|
@@ -14615,8 +14617,8 @@ export declare interface ClusteringResult {
|
|
|
14615
14617
|
xCoord?: Array<number | null>;
|
|
14616
14618
|
yCoord?: Array<number | null>;
|
|
14617
14619
|
clusters: Array<number | null>;
|
|
14618
|
-
xcoord: Array<number>;
|
|
14619
14620
|
ycoord: Array<number>;
|
|
14621
|
+
xcoord: Array<number>;
|
|
14620
14622
|
}
|
|
14621
14623
|
|
|
14622
14624
|
/**
|
|
@@ -20591,6 +20593,10 @@ export declare interface DeclarativeColumn {
|
|
|
20591
20593
|
* Referenced table (Foreign key)
|
|
20592
20594
|
*/
|
|
20593
20595
|
referencedTableColumn?: string;
|
|
20596
|
+
/**
|
|
20597
|
+
* Column description/comment from database
|
|
20598
|
+
*/
|
|
20599
|
+
description?: string;
|
|
20594
20600
|
}
|
|
20595
20601
|
|
|
20596
20602
|
export declare const DeclarativeColumnDataTypeEnum: {
|
|
@@ -22414,6 +22420,7 @@ export declare const DependentEntitiesNodeTypeEnum: {
|
|
|
22414
22420
|
readonly METRIC: "metric";
|
|
22415
22421
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
22416
22422
|
readonly AUTOMATION: "automation";
|
|
22423
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
22417
22424
|
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
22418
22425
|
readonly FILTER_CONTEXT: "filterContext";
|
|
22419
22426
|
readonly FILTER_VIEW: "filterView";
|
|
@@ -22771,6 +22778,14 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
22771
22778
|
* @memberof EntitiesApi
|
|
22772
22779
|
*/
|
|
22773
22780
|
createEntityLlmEndpoints(requestParameters: EntitiesApiCreateEntityLlmEndpointsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiLlmEndpointOutDocument, any, {}>>;
|
|
22781
|
+
/**
|
|
22782
|
+
*
|
|
22783
|
+
* @param {EntitiesApiCreateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
22784
|
+
* @param {*} [options] Override http request option.
|
|
22785
|
+
* @throws {RequiredError}
|
|
22786
|
+
* @memberof EntitiesApi
|
|
22787
|
+
*/
|
|
22788
|
+
createEntityMemoryItems(requestParameters: EntitiesApiCreateEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutDocument, any, {}>>;
|
|
22774
22789
|
/**
|
|
22775
22790
|
*
|
|
22776
22791
|
* @summary Post Metrics
|
|
@@ -23031,6 +23046,14 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
23031
23046
|
* @memberof EntitiesApi
|
|
23032
23047
|
*/
|
|
23033
23048
|
deleteEntityLlmEndpoints(requestParameters: EntitiesApiDeleteEntityLlmEndpointsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any, {}>>;
|
|
23049
|
+
/**
|
|
23050
|
+
*
|
|
23051
|
+
* @param {EntitiesApiDeleteEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
23052
|
+
* @param {*} [options] Override http request option.
|
|
23053
|
+
* @throws {RequiredError}
|
|
23054
|
+
* @memberof EntitiesApi
|
|
23055
|
+
*/
|
|
23056
|
+
deleteEntityMemoryItems(requestParameters: EntitiesApiDeleteEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any, {}>>;
|
|
23034
23057
|
/**
|
|
23035
23058
|
*
|
|
23036
23059
|
* @summary Delete a Metric
|
|
@@ -23363,6 +23386,14 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
23363
23386
|
* @memberof EntitiesApi
|
|
23364
23387
|
*/
|
|
23365
23388
|
getAllEntitiesLlmEndpoints(requestParameters?: EntitiesApiGetAllEntitiesLlmEndpointsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiLlmEndpointOutList, any, {}>>;
|
|
23389
|
+
/**
|
|
23390
|
+
*
|
|
23391
|
+
* @param {EntitiesApiGetAllEntitiesMemoryItemsRequest} requestParameters Request parameters.
|
|
23392
|
+
* @param {*} [options] Override http request option.
|
|
23393
|
+
* @throws {RequiredError}
|
|
23394
|
+
* @memberof EntitiesApi
|
|
23395
|
+
*/
|
|
23396
|
+
getAllEntitiesMemoryItems(requestParameters: EntitiesApiGetAllEntitiesMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutList, any, {}>>;
|
|
23366
23397
|
/**
|
|
23367
23398
|
*
|
|
23368
23399
|
* @summary Get all Metrics
|
|
@@ -23730,6 +23761,14 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
23730
23761
|
* @memberof EntitiesApi
|
|
23731
23762
|
*/
|
|
23732
23763
|
getEntityLlmEndpoints(requestParameters: EntitiesApiGetEntityLlmEndpointsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiLlmEndpointOutDocument, any, {}>>;
|
|
23764
|
+
/**
|
|
23765
|
+
*
|
|
23766
|
+
* @param {EntitiesApiGetEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
23767
|
+
* @param {*} [options] Override http request option.
|
|
23768
|
+
* @throws {RequiredError}
|
|
23769
|
+
* @memberof EntitiesApi
|
|
23770
|
+
*/
|
|
23771
|
+
getEntityMemoryItems(requestParameters: EntitiesApiGetEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutDocument, any, {}>>;
|
|
23733
23772
|
/**
|
|
23734
23773
|
*
|
|
23735
23774
|
* @summary Get a Metric
|
|
@@ -24026,6 +24065,14 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
24026
24065
|
* @memberof EntitiesApi
|
|
24027
24066
|
*/
|
|
24028
24067
|
patchEntityLlmEndpoints(requestParameters: EntitiesApiPatchEntityLlmEndpointsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiLlmEndpointOutDocument, any, {}>>;
|
|
24068
|
+
/**
|
|
24069
|
+
*
|
|
24070
|
+
* @param {EntitiesApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
24071
|
+
* @param {*} [options] Override http request option.
|
|
24072
|
+
* @throws {RequiredError}
|
|
24073
|
+
* @memberof EntitiesApi
|
|
24074
|
+
*/
|
|
24075
|
+
patchEntityMemoryItems(requestParameters: EntitiesApiPatchEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutDocument, any, {}>>;
|
|
24029
24076
|
/**
|
|
24030
24077
|
*
|
|
24031
24078
|
* @summary Patch a Metric
|
|
@@ -24287,6 +24334,14 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
24287
24334
|
* @memberof EntitiesApi
|
|
24288
24335
|
*/
|
|
24289
24336
|
updateEntityLlmEndpoints(requestParameters: EntitiesApiUpdateEntityLlmEndpointsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiLlmEndpointOutDocument, any, {}>>;
|
|
24337
|
+
/**
|
|
24338
|
+
*
|
|
24339
|
+
* @param {EntitiesApiUpdateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
24340
|
+
* @param {*} [options] Override http request option.
|
|
24341
|
+
* @throws {RequiredError}
|
|
24342
|
+
* @memberof EntitiesApi
|
|
24343
|
+
*/
|
|
24344
|
+
updateEntityMemoryItems(requestParameters: EntitiesApiUpdateEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutDocument, any, {}>>;
|
|
24290
24345
|
/**
|
|
24291
24346
|
*
|
|
24292
24347
|
* @summary Put a Metric
|
|
@@ -24572,6 +24627,16 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
24572
24627
|
* @throws {RequiredError}
|
|
24573
24628
|
*/
|
|
24574
24629
|
createEntityLlmEndpoints: (jsonApiLlmEndpointInDocument: JsonApiLlmEndpointInDocument, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
24630
|
+
/**
|
|
24631
|
+
*
|
|
24632
|
+
* @param {string} workspaceId
|
|
24633
|
+
* @param {JsonApiMemoryItemPostOptionalIdDocument} jsonApiMemoryItemPostOptionalIdDocument
|
|
24634
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24635
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24636
|
+
* @param {*} [options] Override http request option.
|
|
24637
|
+
* @throws {RequiredError}
|
|
24638
|
+
*/
|
|
24639
|
+
createEntityMemoryItems: (workspaceId: string, jsonApiMemoryItemPostOptionalIdDocument: JsonApiMemoryItemPostOptionalIdDocument, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
24575
24640
|
/**
|
|
24576
24641
|
*
|
|
24577
24642
|
* @summary Post Metrics
|
|
@@ -24850,6 +24915,15 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
24850
24915
|
* @throws {RequiredError}
|
|
24851
24916
|
*/
|
|
24852
24917
|
deleteEntityLlmEndpoints: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
24918
|
+
/**
|
|
24919
|
+
*
|
|
24920
|
+
* @param {string} workspaceId
|
|
24921
|
+
* @param {string} objectId
|
|
24922
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
24923
|
+
* @param {*} [options] Override http request option.
|
|
24924
|
+
* @throws {RequiredError}
|
|
24925
|
+
*/
|
|
24926
|
+
deleteEntityMemoryItems: (workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
24853
24927
|
/**
|
|
24854
24928
|
*
|
|
24855
24929
|
* @summary Delete a Metric
|
|
@@ -25314,6 +25388,21 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
25314
25388
|
* @throws {RequiredError}
|
|
25315
25389
|
*/
|
|
25316
25390
|
getAllEntitiesLlmEndpoints: (filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
25391
|
+
/**
|
|
25392
|
+
*
|
|
25393
|
+
* @param {string} workspaceId
|
|
25394
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
25395
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
25396
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25397
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
25398
|
+
* @param {number} [size] The size of the page to be returned
|
|
25399
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
25400
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
25401
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
25402
|
+
* @param {*} [options] Override http request option.
|
|
25403
|
+
* @throws {RequiredError}
|
|
25404
|
+
*/
|
|
25405
|
+
getAllEntitiesMemoryItems: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
25317
25406
|
/**
|
|
25318
25407
|
*
|
|
25319
25408
|
* @summary Get all Metrics
|
|
@@ -25802,6 +25891,18 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
25802
25891
|
* @throws {RequiredError}
|
|
25803
25892
|
*/
|
|
25804
25893
|
getEntityLlmEndpoints: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
25894
|
+
/**
|
|
25895
|
+
*
|
|
25896
|
+
* @param {string} workspaceId
|
|
25897
|
+
* @param {string} objectId
|
|
25898
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
25899
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25900
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
25901
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
25902
|
+
* @param {*} [options] Override http request option.
|
|
25903
|
+
* @throws {RequiredError}
|
|
25904
|
+
*/
|
|
25905
|
+
getEntityMemoryItems: (workspaceId: string, objectId: string, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
25805
25906
|
/**
|
|
25806
25907
|
*
|
|
25807
25908
|
* @summary Get a Metric
|
|
@@ -26158,6 +26259,17 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
26158
26259
|
* @throws {RequiredError}
|
|
26159
26260
|
*/
|
|
26160
26261
|
patchEntityLlmEndpoints: (id: string, jsonApiLlmEndpointPatchDocument: JsonApiLlmEndpointPatchDocument, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
26262
|
+
/**
|
|
26263
|
+
*
|
|
26264
|
+
* @param {string} workspaceId
|
|
26265
|
+
* @param {string} objectId
|
|
26266
|
+
* @param {JsonApiMemoryItemPatchDocument} jsonApiMemoryItemPatchDocument
|
|
26267
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
26268
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
26269
|
+
* @param {*} [options] Override http request option.
|
|
26270
|
+
* @throws {RequiredError}
|
|
26271
|
+
*/
|
|
26272
|
+
patchEntityMemoryItems: (workspaceId: string, objectId: string, jsonApiMemoryItemPatchDocument: JsonApiMemoryItemPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
26161
26273
|
/**
|
|
26162
26274
|
*
|
|
26163
26275
|
* @summary Patch a Metric
|
|
@@ -26478,6 +26590,17 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
26478
26590
|
* @throws {RequiredError}
|
|
26479
26591
|
*/
|
|
26480
26592
|
updateEntityLlmEndpoints: (id: string, jsonApiLlmEndpointInDocument: JsonApiLlmEndpointInDocument, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
26593
|
+
/**
|
|
26594
|
+
*
|
|
26595
|
+
* @param {string} workspaceId
|
|
26596
|
+
* @param {string} objectId
|
|
26597
|
+
* @param {JsonApiMemoryItemInDocument} jsonApiMemoryItemInDocument
|
|
26598
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
26599
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
26600
|
+
* @param {*} [options] Override http request option.
|
|
26601
|
+
* @throws {RequiredError}
|
|
26602
|
+
*/
|
|
26603
|
+
updateEntityMemoryItems: (workspaceId: string, objectId: string, jsonApiMemoryItemInDocument: JsonApiMemoryItemInDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
26481
26604
|
/**
|
|
26482
26605
|
*
|
|
26483
26606
|
* @summary Put a Metric
|
|
@@ -27004,6 +27127,38 @@ export declare interface EntitiesApiCreateEntityLlmEndpointsRequest {
|
|
|
27004
27127
|
readonly jsonApiLlmEndpointInDocument: JsonApiLlmEndpointInDocument;
|
|
27005
27128
|
}
|
|
27006
27129
|
|
|
27130
|
+
/**
|
|
27131
|
+
* Request parameters for createEntityMemoryItems operation in EntitiesApi.
|
|
27132
|
+
* @export
|
|
27133
|
+
* @interface EntitiesApiCreateEntityMemoryItemsRequest
|
|
27134
|
+
*/
|
|
27135
|
+
export declare interface EntitiesApiCreateEntityMemoryItemsRequest {
|
|
27136
|
+
/**
|
|
27137
|
+
*
|
|
27138
|
+
* @type {string}
|
|
27139
|
+
* @memberof EntitiesApiCreateEntityMemoryItems
|
|
27140
|
+
*/
|
|
27141
|
+
readonly workspaceId: string;
|
|
27142
|
+
/**
|
|
27143
|
+
*
|
|
27144
|
+
* @type {JsonApiMemoryItemPostOptionalIdDocument}
|
|
27145
|
+
* @memberof EntitiesApiCreateEntityMemoryItems
|
|
27146
|
+
*/
|
|
27147
|
+
readonly jsonApiMemoryItemPostOptionalIdDocument: JsonApiMemoryItemPostOptionalIdDocument;
|
|
27148
|
+
/**
|
|
27149
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
27150
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
27151
|
+
* @memberof EntitiesApiCreateEntityMemoryItems
|
|
27152
|
+
*/
|
|
27153
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
27154
|
+
/**
|
|
27155
|
+
* Include Meta objects.
|
|
27156
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
27157
|
+
* @memberof EntitiesApiCreateEntityMemoryItems
|
|
27158
|
+
*/
|
|
27159
|
+
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
27160
|
+
}
|
|
27161
|
+
|
|
27007
27162
|
/**
|
|
27008
27163
|
* Request parameters for createEntityMetrics operation in EntitiesApi.
|
|
27009
27164
|
* @export
|
|
@@ -27692,6 +27847,32 @@ export declare interface EntitiesApiDeleteEntityLlmEndpointsRequest {
|
|
|
27692
27847
|
readonly filter?: string;
|
|
27693
27848
|
}
|
|
27694
27849
|
|
|
27850
|
+
/**
|
|
27851
|
+
* Request parameters for deleteEntityMemoryItems operation in EntitiesApi.
|
|
27852
|
+
* @export
|
|
27853
|
+
* @interface EntitiesApiDeleteEntityMemoryItemsRequest
|
|
27854
|
+
*/
|
|
27855
|
+
export declare interface EntitiesApiDeleteEntityMemoryItemsRequest {
|
|
27856
|
+
/**
|
|
27857
|
+
*
|
|
27858
|
+
* @type {string}
|
|
27859
|
+
* @memberof EntitiesApiDeleteEntityMemoryItems
|
|
27860
|
+
*/
|
|
27861
|
+
readonly workspaceId: string;
|
|
27862
|
+
/**
|
|
27863
|
+
*
|
|
27864
|
+
* @type {string}
|
|
27865
|
+
* @memberof EntitiesApiDeleteEntityMemoryItems
|
|
27866
|
+
*/
|
|
27867
|
+
readonly objectId: string;
|
|
27868
|
+
/**
|
|
27869
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
27870
|
+
* @type {string}
|
|
27871
|
+
* @memberof EntitiesApiDeleteEntityMemoryItems
|
|
27872
|
+
*/
|
|
27873
|
+
readonly filter?: string;
|
|
27874
|
+
}
|
|
27875
|
+
|
|
27695
27876
|
/**
|
|
27696
27877
|
* Request parameters for deleteEntityMetrics operation in EntitiesApi.
|
|
27697
27878
|
* @export
|
|
@@ -28127,6 +28308,13 @@ export declare const EntitiesApiFactory: (configuration?: MetadataConfiguration,
|
|
|
28127
28308
|
* @throws {RequiredError}
|
|
28128
28309
|
*/
|
|
28129
28310
|
createEntityLlmEndpoints(requestParameters: EntitiesApiCreateEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutDocument>;
|
|
28311
|
+
/**
|
|
28312
|
+
*
|
|
28313
|
+
* @param {EntitiesApiCreateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
28314
|
+
* @param {*} [options] Override http request option.
|
|
28315
|
+
* @throws {RequiredError}
|
|
28316
|
+
*/
|
|
28317
|
+
createEntityMemoryItems(requestParameters: EntitiesApiCreateEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
28130
28318
|
/**
|
|
28131
28319
|
*
|
|
28132
28320
|
* @summary Post Metrics
|
|
@@ -28358,6 +28546,13 @@ export declare const EntitiesApiFactory: (configuration?: MetadataConfiguration,
|
|
|
28358
28546
|
* @throws {RequiredError}
|
|
28359
28547
|
*/
|
|
28360
28548
|
deleteEntityLlmEndpoints(requestParameters: EntitiesApiDeleteEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
28549
|
+
/**
|
|
28550
|
+
*
|
|
28551
|
+
* @param {EntitiesApiDeleteEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
28552
|
+
* @param {*} [options] Override http request option.
|
|
28553
|
+
* @throws {RequiredError}
|
|
28554
|
+
*/
|
|
28555
|
+
deleteEntityMemoryItems(requestParameters: EntitiesApiDeleteEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
28361
28556
|
/**
|
|
28362
28557
|
*
|
|
28363
28558
|
* @summary Delete a Metric
|
|
@@ -28653,6 +28848,13 @@ export declare const EntitiesApiFactory: (configuration?: MetadataConfiguration,
|
|
|
28653
28848
|
* @throws {RequiredError}
|
|
28654
28849
|
*/
|
|
28655
28850
|
getAllEntitiesLlmEndpoints(requestParameters: EntitiesApiGetAllEntitiesLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutList>;
|
|
28851
|
+
/**
|
|
28852
|
+
*
|
|
28853
|
+
* @param {EntitiesApiGetAllEntitiesMemoryItemsRequest} requestParameters Request parameters.
|
|
28854
|
+
* @param {*} [options] Override http request option.
|
|
28855
|
+
* @throws {RequiredError}
|
|
28856
|
+
*/
|
|
28857
|
+
getAllEntitiesMemoryItems(requestParameters: EntitiesApiGetAllEntitiesMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutList>;
|
|
28656
28858
|
/**
|
|
28657
28859
|
*
|
|
28658
28860
|
* @summary Get all Metrics
|
|
@@ -28979,6 +29181,13 @@ export declare const EntitiesApiFactory: (configuration?: MetadataConfiguration,
|
|
|
28979
29181
|
* @throws {RequiredError}
|
|
28980
29182
|
*/
|
|
28981
29183
|
getEntityLlmEndpoints(requestParameters: EntitiesApiGetEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutDocument>;
|
|
29184
|
+
/**
|
|
29185
|
+
*
|
|
29186
|
+
* @param {EntitiesApiGetEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
29187
|
+
* @param {*} [options] Override http request option.
|
|
29188
|
+
* @throws {RequiredError}
|
|
29189
|
+
*/
|
|
29190
|
+
getEntityMemoryItems(requestParameters: EntitiesApiGetEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
28982
29191
|
/**
|
|
28983
29192
|
*
|
|
28984
29193
|
* @summary Get a Metric
|
|
@@ -29242,6 +29451,13 @@ export declare const EntitiesApiFactory: (configuration?: MetadataConfiguration,
|
|
|
29242
29451
|
* @throws {RequiredError}
|
|
29243
29452
|
*/
|
|
29244
29453
|
patchEntityLlmEndpoints(requestParameters: EntitiesApiPatchEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutDocument>;
|
|
29454
|
+
/**
|
|
29455
|
+
*
|
|
29456
|
+
* @param {EntitiesApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
29457
|
+
* @param {*} [options] Override http request option.
|
|
29458
|
+
* @throws {RequiredError}
|
|
29459
|
+
*/
|
|
29460
|
+
patchEntityMemoryItems(requestParameters: EntitiesApiPatchEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
29245
29461
|
/**
|
|
29246
29462
|
*
|
|
29247
29463
|
* @summary Patch a Metric
|
|
@@ -29474,6 +29690,13 @@ export declare const EntitiesApiFactory: (configuration?: MetadataConfiguration,
|
|
|
29474
29690
|
* @throws {RequiredError}
|
|
29475
29691
|
*/
|
|
29476
29692
|
updateEntityLlmEndpoints(requestParameters: EntitiesApiUpdateEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutDocument>;
|
|
29693
|
+
/**
|
|
29694
|
+
*
|
|
29695
|
+
* @param {EntitiesApiUpdateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
29696
|
+
* @param {*} [options] Override http request option.
|
|
29697
|
+
* @throws {RequiredError}
|
|
29698
|
+
*/
|
|
29699
|
+
updateEntityMemoryItems(requestParameters: EntitiesApiUpdateEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
29477
29700
|
/**
|
|
29478
29701
|
*
|
|
29479
29702
|
* @summary Put a Metric
|
|
@@ -29745,6 +29968,16 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
29745
29968
|
* @throws {RequiredError}
|
|
29746
29969
|
*/
|
|
29747
29970
|
createEntityLlmEndpoints(jsonApiLlmEndpointInDocument: JsonApiLlmEndpointInDocument, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiLlmEndpointOutDocument>>;
|
|
29971
|
+
/**
|
|
29972
|
+
*
|
|
29973
|
+
* @param {string} workspaceId
|
|
29974
|
+
* @param {JsonApiMemoryItemPostOptionalIdDocument} jsonApiMemoryItemPostOptionalIdDocument
|
|
29975
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
29976
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
29977
|
+
* @param {*} [options] Override http request option.
|
|
29978
|
+
* @throws {RequiredError}
|
|
29979
|
+
*/
|
|
29980
|
+
createEntityMemoryItems(workspaceId: string, jsonApiMemoryItemPostOptionalIdDocument: JsonApiMemoryItemPostOptionalIdDocument, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutDocument>>;
|
|
29748
29981
|
/**
|
|
29749
29982
|
*
|
|
29750
29983
|
* @summary Post Metrics
|
|
@@ -30023,6 +30256,15 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
30023
30256
|
* @throws {RequiredError}
|
|
30024
30257
|
*/
|
|
30025
30258
|
deleteEntityLlmEndpoints(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
30259
|
+
/**
|
|
30260
|
+
*
|
|
30261
|
+
* @param {string} workspaceId
|
|
30262
|
+
* @param {string} objectId
|
|
30263
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30264
|
+
* @param {*} [options] Override http request option.
|
|
30265
|
+
* @throws {RequiredError}
|
|
30266
|
+
*/
|
|
30267
|
+
deleteEntityMemoryItems(workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
30026
30268
|
/**
|
|
30027
30269
|
*
|
|
30028
30270
|
* @summary Delete a Metric
|
|
@@ -30487,6 +30729,21 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
30487
30729
|
* @throws {RequiredError}
|
|
30488
30730
|
*/
|
|
30489
30731
|
getAllEntitiesLlmEndpoints(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiLlmEndpointOutList>>;
|
|
30732
|
+
/**
|
|
30733
|
+
*
|
|
30734
|
+
* @param {string} workspaceId
|
|
30735
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
30736
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30737
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30738
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
30739
|
+
* @param {number} [size] The size of the page to be returned
|
|
30740
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
30741
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
30742
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
30743
|
+
* @param {*} [options] Override http request option.
|
|
30744
|
+
* @throws {RequiredError}
|
|
30745
|
+
*/
|
|
30746
|
+
getAllEntitiesMemoryItems(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutList>>;
|
|
30490
30747
|
/**
|
|
30491
30748
|
*
|
|
30492
30749
|
* @summary Get all Metrics
|
|
@@ -30977,6 +31234,18 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
30977
31234
|
* @throws {RequiredError}
|
|
30978
31235
|
*/
|
|
30979
31236
|
getEntityLlmEndpoints(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiLlmEndpointOutDocument>>;
|
|
31237
|
+
/**
|
|
31238
|
+
*
|
|
31239
|
+
* @param {string} workspaceId
|
|
31240
|
+
* @param {string} objectId
|
|
31241
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
31242
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31243
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
31244
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
31245
|
+
* @param {*} [options] Override http request option.
|
|
31246
|
+
* @throws {RequiredError}
|
|
31247
|
+
*/
|
|
31248
|
+
getEntityMemoryItems(workspaceId: string, objectId: string, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutDocument>>;
|
|
30980
31249
|
/**
|
|
30981
31250
|
*
|
|
30982
31251
|
* @summary Get a Metric
|
|
@@ -31333,6 +31602,17 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
31333
31602
|
* @throws {RequiredError}
|
|
31334
31603
|
*/
|
|
31335
31604
|
patchEntityLlmEndpoints(id: string, jsonApiLlmEndpointPatchDocument: JsonApiLlmEndpointPatchDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiLlmEndpointOutDocument>>;
|
|
31605
|
+
/**
|
|
31606
|
+
*
|
|
31607
|
+
* @param {string} workspaceId
|
|
31608
|
+
* @param {string} objectId
|
|
31609
|
+
* @param {JsonApiMemoryItemPatchDocument} jsonApiMemoryItemPatchDocument
|
|
31610
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
31611
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31612
|
+
* @param {*} [options] Override http request option.
|
|
31613
|
+
* @throws {RequiredError}
|
|
31614
|
+
*/
|
|
31615
|
+
patchEntityMemoryItems(workspaceId: string, objectId: string, jsonApiMemoryItemPatchDocument: JsonApiMemoryItemPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutDocument>>;
|
|
31336
31616
|
/**
|
|
31337
31617
|
*
|
|
31338
31618
|
* @summary Patch a Metric
|
|
@@ -31653,6 +31933,17 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
31653
31933
|
* @throws {RequiredError}
|
|
31654
31934
|
*/
|
|
31655
31935
|
updateEntityLlmEndpoints(id: string, jsonApiLlmEndpointInDocument: JsonApiLlmEndpointInDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiLlmEndpointOutDocument>>;
|
|
31936
|
+
/**
|
|
31937
|
+
*
|
|
31938
|
+
* @param {string} workspaceId
|
|
31939
|
+
* @param {string} objectId
|
|
31940
|
+
* @param {JsonApiMemoryItemInDocument} jsonApiMemoryItemInDocument
|
|
31941
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
31942
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31943
|
+
* @param {*} [options] Override http request option.
|
|
31944
|
+
* @throws {RequiredError}
|
|
31945
|
+
*/
|
|
31946
|
+
updateEntityMemoryItems(workspaceId: string, objectId: string, jsonApiMemoryItemInDocument: JsonApiMemoryItemInDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutDocument>>;
|
|
31656
31947
|
/**
|
|
31657
31948
|
*
|
|
31658
31949
|
* @summary Put a Metric
|
|
@@ -33041,6 +33332,68 @@ export declare interface EntitiesApiGetAllEntitiesLlmEndpointsRequest {
|
|
|
33041
33332
|
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
33042
33333
|
}
|
|
33043
33334
|
|
|
33335
|
+
/**
|
|
33336
|
+
* Request parameters for getAllEntitiesMemoryItems operation in EntitiesApi.
|
|
33337
|
+
* @export
|
|
33338
|
+
* @interface EntitiesApiGetAllEntitiesMemoryItemsRequest
|
|
33339
|
+
*/
|
|
33340
|
+
export declare interface EntitiesApiGetAllEntitiesMemoryItemsRequest {
|
|
33341
|
+
/**
|
|
33342
|
+
*
|
|
33343
|
+
* @type {string}
|
|
33344
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33345
|
+
*/
|
|
33346
|
+
readonly workspaceId: string;
|
|
33347
|
+
/**
|
|
33348
|
+
*
|
|
33349
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
33350
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33351
|
+
*/
|
|
33352
|
+
readonly origin?: "ALL" | "PARENTS" | "NATIVE";
|
|
33353
|
+
/**
|
|
33354
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
33355
|
+
* @type {string}
|
|
33356
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33357
|
+
*/
|
|
33358
|
+
readonly filter?: string;
|
|
33359
|
+
/**
|
|
33360
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
33361
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
33362
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33363
|
+
*/
|
|
33364
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
33365
|
+
/**
|
|
33366
|
+
* Zero-based page index (0..N)
|
|
33367
|
+
* @type {number}
|
|
33368
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33369
|
+
*/
|
|
33370
|
+
readonly page?: number;
|
|
33371
|
+
/**
|
|
33372
|
+
* The size of the page to be returned
|
|
33373
|
+
* @type {number}
|
|
33374
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33375
|
+
*/
|
|
33376
|
+
readonly size?: number;
|
|
33377
|
+
/**
|
|
33378
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
33379
|
+
* @type {Array<string>}
|
|
33380
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33381
|
+
*/
|
|
33382
|
+
readonly sort?: Array<string>;
|
|
33383
|
+
/**
|
|
33384
|
+
*
|
|
33385
|
+
* @type {boolean}
|
|
33386
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33387
|
+
*/
|
|
33388
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
33389
|
+
/**
|
|
33390
|
+
* Include Meta objects.
|
|
33391
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
33392
|
+
* @memberof EntitiesApiGetAllEntitiesMemoryItems
|
|
33393
|
+
*/
|
|
33394
|
+
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
33395
|
+
}
|
|
33396
|
+
|
|
33044
33397
|
/**
|
|
33045
33398
|
* Request parameters for getAllEntitiesMetrics operation in EntitiesApi.
|
|
33046
33399
|
* @export
|
|
@@ -34571,6 +34924,50 @@ export declare interface EntitiesApiGetEntityLlmEndpointsRequest {
|
|
|
34571
34924
|
readonly filter?: string;
|
|
34572
34925
|
}
|
|
34573
34926
|
|
|
34927
|
+
/**
|
|
34928
|
+
* Request parameters for getEntityMemoryItems operation in EntitiesApi.
|
|
34929
|
+
* @export
|
|
34930
|
+
* @interface EntitiesApiGetEntityMemoryItemsRequest
|
|
34931
|
+
*/
|
|
34932
|
+
export declare interface EntitiesApiGetEntityMemoryItemsRequest {
|
|
34933
|
+
/**
|
|
34934
|
+
*
|
|
34935
|
+
* @type {string}
|
|
34936
|
+
* @memberof EntitiesApiGetEntityMemoryItems
|
|
34937
|
+
*/
|
|
34938
|
+
readonly workspaceId: string;
|
|
34939
|
+
/**
|
|
34940
|
+
*
|
|
34941
|
+
* @type {string}
|
|
34942
|
+
* @memberof EntitiesApiGetEntityMemoryItems
|
|
34943
|
+
*/
|
|
34944
|
+
readonly objectId: string;
|
|
34945
|
+
/**
|
|
34946
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
34947
|
+
* @type {string}
|
|
34948
|
+
* @memberof EntitiesApiGetEntityMemoryItems
|
|
34949
|
+
*/
|
|
34950
|
+
readonly filter?: string;
|
|
34951
|
+
/**
|
|
34952
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
34953
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
34954
|
+
* @memberof EntitiesApiGetEntityMemoryItems
|
|
34955
|
+
*/
|
|
34956
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
34957
|
+
/**
|
|
34958
|
+
*
|
|
34959
|
+
* @type {boolean}
|
|
34960
|
+
* @memberof EntitiesApiGetEntityMemoryItems
|
|
34961
|
+
*/
|
|
34962
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
34963
|
+
/**
|
|
34964
|
+
* Include Meta objects.
|
|
34965
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
34966
|
+
* @memberof EntitiesApiGetEntityMemoryItems
|
|
34967
|
+
*/
|
|
34968
|
+
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
34969
|
+
}
|
|
34970
|
+
|
|
34574
34971
|
/**
|
|
34575
34972
|
* Request parameters for getEntityMetrics operation in EntitiesApi.
|
|
34576
34973
|
* @export
|
|
@@ -35235,6 +35632,14 @@ export declare interface EntitiesApiInterface {
|
|
|
35235
35632
|
* @memberof EntitiesApiInterface
|
|
35236
35633
|
*/
|
|
35237
35634
|
createEntityLlmEndpoints(requestParameters: EntitiesApiCreateEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutDocument>;
|
|
35635
|
+
/**
|
|
35636
|
+
*
|
|
35637
|
+
* @param {EntitiesApiCreateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
35638
|
+
* @param {*} [options] Override http request option.
|
|
35639
|
+
* @throws {RequiredError}
|
|
35640
|
+
* @memberof EntitiesApiInterface
|
|
35641
|
+
*/
|
|
35642
|
+
createEntityMemoryItems(requestParameters: EntitiesApiCreateEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
35238
35643
|
/**
|
|
35239
35644
|
*
|
|
35240
35645
|
* @summary Post Metrics
|
|
@@ -35495,6 +35900,14 @@ export declare interface EntitiesApiInterface {
|
|
|
35495
35900
|
* @memberof EntitiesApiInterface
|
|
35496
35901
|
*/
|
|
35497
35902
|
deleteEntityLlmEndpoints(requestParameters: EntitiesApiDeleteEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
35903
|
+
/**
|
|
35904
|
+
*
|
|
35905
|
+
* @param {EntitiesApiDeleteEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
35906
|
+
* @param {*} [options] Override http request option.
|
|
35907
|
+
* @throws {RequiredError}
|
|
35908
|
+
* @memberof EntitiesApiInterface
|
|
35909
|
+
*/
|
|
35910
|
+
deleteEntityMemoryItems(requestParameters: EntitiesApiDeleteEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
35498
35911
|
/**
|
|
35499
35912
|
*
|
|
35500
35913
|
* @summary Delete a Metric
|
|
@@ -35827,6 +36240,14 @@ export declare interface EntitiesApiInterface {
|
|
|
35827
36240
|
* @memberof EntitiesApiInterface
|
|
35828
36241
|
*/
|
|
35829
36242
|
getAllEntitiesLlmEndpoints(requestParameters: EntitiesApiGetAllEntitiesLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutList>;
|
|
36243
|
+
/**
|
|
36244
|
+
*
|
|
36245
|
+
* @param {EntitiesApiGetAllEntitiesMemoryItemsRequest} requestParameters Request parameters.
|
|
36246
|
+
* @param {*} [options] Override http request option.
|
|
36247
|
+
* @throws {RequiredError}
|
|
36248
|
+
* @memberof EntitiesApiInterface
|
|
36249
|
+
*/
|
|
36250
|
+
getAllEntitiesMemoryItems(requestParameters: EntitiesApiGetAllEntitiesMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutList>;
|
|
35830
36251
|
/**
|
|
35831
36252
|
*
|
|
35832
36253
|
* @summary Get all Metrics
|
|
@@ -36194,6 +36615,14 @@ export declare interface EntitiesApiInterface {
|
|
|
36194
36615
|
* @memberof EntitiesApiInterface
|
|
36195
36616
|
*/
|
|
36196
36617
|
getEntityLlmEndpoints(requestParameters: EntitiesApiGetEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutDocument>;
|
|
36618
|
+
/**
|
|
36619
|
+
*
|
|
36620
|
+
* @param {EntitiesApiGetEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
36621
|
+
* @param {*} [options] Override http request option.
|
|
36622
|
+
* @throws {RequiredError}
|
|
36623
|
+
* @memberof EntitiesApiInterface
|
|
36624
|
+
*/
|
|
36625
|
+
getEntityMemoryItems(requestParameters: EntitiesApiGetEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
36197
36626
|
/**
|
|
36198
36627
|
*
|
|
36199
36628
|
* @summary Get a Metric
|
|
@@ -36490,6 +36919,14 @@ export declare interface EntitiesApiInterface {
|
|
|
36490
36919
|
* @memberof EntitiesApiInterface
|
|
36491
36920
|
*/
|
|
36492
36921
|
patchEntityLlmEndpoints(requestParameters: EntitiesApiPatchEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutDocument>;
|
|
36922
|
+
/**
|
|
36923
|
+
*
|
|
36924
|
+
* @param {EntitiesApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
36925
|
+
* @param {*} [options] Override http request option.
|
|
36926
|
+
* @throws {RequiredError}
|
|
36927
|
+
* @memberof EntitiesApiInterface
|
|
36928
|
+
*/
|
|
36929
|
+
patchEntityMemoryItems(requestParameters: EntitiesApiPatchEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
36493
36930
|
/**
|
|
36494
36931
|
*
|
|
36495
36932
|
* @summary Patch a Metric
|
|
@@ -36751,6 +37188,14 @@ export declare interface EntitiesApiInterface {
|
|
|
36751
37188
|
* @memberof EntitiesApiInterface
|
|
36752
37189
|
*/
|
|
36753
37190
|
updateEntityLlmEndpoints(requestParameters: EntitiesApiUpdateEntityLlmEndpointsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmEndpointOutDocument>;
|
|
37191
|
+
/**
|
|
37192
|
+
*
|
|
37193
|
+
* @param {EntitiesApiUpdateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
37194
|
+
* @param {*} [options] Override http request option.
|
|
37195
|
+
* @throws {RequiredError}
|
|
37196
|
+
* @memberof EntitiesApiInterface
|
|
37197
|
+
*/
|
|
37198
|
+
updateEntityMemoryItems(requestParameters: EntitiesApiUpdateEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
36754
37199
|
/**
|
|
36755
37200
|
*
|
|
36756
37201
|
* @summary Put a Metric
|
|
@@ -37385,6 +37830,44 @@ export declare interface EntitiesApiPatchEntityLlmEndpointsRequest {
|
|
|
37385
37830
|
readonly filter?: string;
|
|
37386
37831
|
}
|
|
37387
37832
|
|
|
37833
|
+
/**
|
|
37834
|
+
* Request parameters for patchEntityMemoryItems operation in EntitiesApi.
|
|
37835
|
+
* @export
|
|
37836
|
+
* @interface EntitiesApiPatchEntityMemoryItemsRequest
|
|
37837
|
+
*/
|
|
37838
|
+
export declare interface EntitiesApiPatchEntityMemoryItemsRequest {
|
|
37839
|
+
/**
|
|
37840
|
+
*
|
|
37841
|
+
* @type {string}
|
|
37842
|
+
* @memberof EntitiesApiPatchEntityMemoryItems
|
|
37843
|
+
*/
|
|
37844
|
+
readonly workspaceId: string;
|
|
37845
|
+
/**
|
|
37846
|
+
*
|
|
37847
|
+
* @type {string}
|
|
37848
|
+
* @memberof EntitiesApiPatchEntityMemoryItems
|
|
37849
|
+
*/
|
|
37850
|
+
readonly objectId: string;
|
|
37851
|
+
/**
|
|
37852
|
+
*
|
|
37853
|
+
* @type {JsonApiMemoryItemPatchDocument}
|
|
37854
|
+
* @memberof EntitiesApiPatchEntityMemoryItems
|
|
37855
|
+
*/
|
|
37856
|
+
readonly jsonApiMemoryItemPatchDocument: JsonApiMemoryItemPatchDocument;
|
|
37857
|
+
/**
|
|
37858
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
37859
|
+
* @type {string}
|
|
37860
|
+
* @memberof EntitiesApiPatchEntityMemoryItems
|
|
37861
|
+
*/
|
|
37862
|
+
readonly filter?: string;
|
|
37863
|
+
/**
|
|
37864
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37865
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
37866
|
+
* @memberof EntitiesApiPatchEntityMemoryItems
|
|
37867
|
+
*/
|
|
37868
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
37869
|
+
}
|
|
37870
|
+
|
|
37388
37871
|
/**
|
|
37389
37872
|
* Request parameters for patchEntityMetrics operation in EntitiesApi.
|
|
37390
37873
|
* @export
|
|
@@ -38319,6 +38802,44 @@ export declare interface EntitiesApiUpdateEntityLlmEndpointsRequest {
|
|
|
38319
38802
|
readonly filter?: string;
|
|
38320
38803
|
}
|
|
38321
38804
|
|
|
38805
|
+
/**
|
|
38806
|
+
* Request parameters for updateEntityMemoryItems operation in EntitiesApi.
|
|
38807
|
+
* @export
|
|
38808
|
+
* @interface EntitiesApiUpdateEntityMemoryItemsRequest
|
|
38809
|
+
*/
|
|
38810
|
+
export declare interface EntitiesApiUpdateEntityMemoryItemsRequest {
|
|
38811
|
+
/**
|
|
38812
|
+
*
|
|
38813
|
+
* @type {string}
|
|
38814
|
+
* @memberof EntitiesApiUpdateEntityMemoryItems
|
|
38815
|
+
*/
|
|
38816
|
+
readonly workspaceId: string;
|
|
38817
|
+
/**
|
|
38818
|
+
*
|
|
38819
|
+
* @type {string}
|
|
38820
|
+
* @memberof EntitiesApiUpdateEntityMemoryItems
|
|
38821
|
+
*/
|
|
38822
|
+
readonly objectId: string;
|
|
38823
|
+
/**
|
|
38824
|
+
*
|
|
38825
|
+
* @type {JsonApiMemoryItemInDocument}
|
|
38826
|
+
* @memberof EntitiesApiUpdateEntityMemoryItems
|
|
38827
|
+
*/
|
|
38828
|
+
readonly jsonApiMemoryItemInDocument: JsonApiMemoryItemInDocument;
|
|
38829
|
+
/**
|
|
38830
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
38831
|
+
* @type {string}
|
|
38832
|
+
* @memberof EntitiesApiUpdateEntityMemoryItems
|
|
38833
|
+
*/
|
|
38834
|
+
readonly filter?: string;
|
|
38835
|
+
/**
|
|
38836
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
38837
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38838
|
+
* @memberof EntitiesApiUpdateEntityMemoryItems
|
|
38839
|
+
*/
|
|
38840
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
38841
|
+
}
|
|
38842
|
+
|
|
38322
38843
|
/**
|
|
38323
38844
|
* Request parameters for updateEntityMetrics operation in EntitiesApi.
|
|
38324
38845
|
* @export
|
|
@@ -40490,6 +41011,7 @@ export declare const ExportIdentifierRefIdentifierTypeEnum: {
|
|
|
40490
41011
|
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
40491
41012
|
readonly AUTOMATION: "automation";
|
|
40492
41013
|
readonly AUTOMATION_RESULT: "automationResult";
|
|
41014
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
40493
41015
|
readonly PROMPT: "prompt";
|
|
40494
41016
|
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
40495
41017
|
readonly FILTER_CONTEXT: "filterContext";
|
|
@@ -43339,6 +43861,7 @@ export declare const IdentifierRefIdentifierTypeEnum: {
|
|
|
43339
43861
|
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
43340
43862
|
readonly AUTOMATION: "automation";
|
|
43341
43863
|
readonly AUTOMATION_RESULT: "automationResult";
|
|
43864
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
43342
43865
|
readonly PROMPT: "prompt";
|
|
43343
43866
|
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
43344
43867
|
readonly FILTER_CONTEXT: "filterContext";
|
|
@@ -44797,7 +45320,7 @@ export declare interface JsonApiAnalyticalDashboardIn {
|
|
|
44797
45320
|
* API identifier of an object
|
|
44798
45321
|
*/
|
|
44799
45322
|
id: string;
|
|
44800
|
-
attributes:
|
|
45323
|
+
attributes: JsonApiAnalyticalDashboardPostOptionalIdAttributes;
|
|
44801
45324
|
}
|
|
44802
45325
|
|
|
44803
45326
|
export declare interface JsonApiAnalyticalDashboardInDocument {
|
|
@@ -45020,7 +45543,18 @@ export declare interface JsonApiAnalyticalDashboardPostOptionalId {
|
|
|
45020
45543
|
* API identifier of an object
|
|
45021
45544
|
*/
|
|
45022
45545
|
id?: string;
|
|
45023
|
-
attributes:
|
|
45546
|
+
attributes: JsonApiAnalyticalDashboardPostOptionalIdAttributes;
|
|
45547
|
+
}
|
|
45548
|
+
|
|
45549
|
+
export declare interface JsonApiAnalyticalDashboardPostOptionalIdAttributes {
|
|
45550
|
+
title?: string;
|
|
45551
|
+
description?: string;
|
|
45552
|
+
tags?: Array<string>;
|
|
45553
|
+
areRelationsValid?: boolean;
|
|
45554
|
+
/**
|
|
45555
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
45556
|
+
*/
|
|
45557
|
+
content: object;
|
|
45024
45558
|
}
|
|
45025
45559
|
|
|
45026
45560
|
export declare interface JsonApiAnalyticalDashboardPostOptionalIdDocument {
|
|
@@ -45130,7 +45664,18 @@ export declare interface JsonApiAttributeHierarchyIn {
|
|
|
45130
45664
|
* API identifier of an object
|
|
45131
45665
|
*/
|
|
45132
45666
|
id: string;
|
|
45133
|
-
attributes?:
|
|
45667
|
+
attributes?: JsonApiAttributeHierarchyInAttributes;
|
|
45668
|
+
}
|
|
45669
|
+
|
|
45670
|
+
export declare interface JsonApiAttributeHierarchyInAttributes {
|
|
45671
|
+
title?: string;
|
|
45672
|
+
description?: string;
|
|
45673
|
+
tags?: Array<string>;
|
|
45674
|
+
areRelationsValid?: boolean;
|
|
45675
|
+
/**
|
|
45676
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
45677
|
+
*/
|
|
45678
|
+
content?: object;
|
|
45134
45679
|
}
|
|
45135
45680
|
|
|
45136
45681
|
export declare interface JsonApiAttributeHierarchyInDocument {
|
|
@@ -45259,18 +45804,7 @@ export declare interface JsonApiAttributeHierarchyPatch {
|
|
|
45259
45804
|
* API identifier of an object
|
|
45260
45805
|
*/
|
|
45261
45806
|
id: string;
|
|
45262
|
-
attributes?:
|
|
45263
|
-
}
|
|
45264
|
-
|
|
45265
|
-
export declare interface JsonApiAttributeHierarchyPatchAttributes {
|
|
45266
|
-
title?: string;
|
|
45267
|
-
description?: string;
|
|
45268
|
-
tags?: Array<string>;
|
|
45269
|
-
areRelationsValid?: boolean;
|
|
45270
|
-
/**
|
|
45271
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
45272
|
-
*/
|
|
45273
|
-
content?: object;
|
|
45807
|
+
attributes?: JsonApiAttributeHierarchyInAttributes;
|
|
45274
45808
|
}
|
|
45275
45809
|
|
|
45276
45810
|
export declare interface JsonApiAttributeHierarchyPatchDocument {
|
|
@@ -45455,14 +45989,164 @@ export declare interface JsonApiAutomationIn {
|
|
|
45455
45989
|
* API identifier of an object
|
|
45456
45990
|
*/
|
|
45457
45991
|
id: string;
|
|
45458
|
-
attributes?:
|
|
45459
|
-
relationships?:
|
|
45992
|
+
attributes?: JsonApiAutomationInAttributes;
|
|
45993
|
+
relationships?: JsonApiAutomationInRelationships;
|
|
45994
|
+
}
|
|
45995
|
+
|
|
45996
|
+
export declare interface JsonApiAutomationInAttributes {
|
|
45997
|
+
title?: string;
|
|
45998
|
+
description?: string;
|
|
45999
|
+
tags?: Array<string>;
|
|
46000
|
+
areRelationsValid?: boolean;
|
|
46001
|
+
/**
|
|
46002
|
+
* Additional details to be included in the automated message.
|
|
46003
|
+
*/
|
|
46004
|
+
details?: object;
|
|
46005
|
+
metadata?: JsonApiAutomationInAttributesMetadata | null;
|
|
46006
|
+
/**
|
|
46007
|
+
* Current state of the automation.
|
|
46008
|
+
*/
|
|
46009
|
+
state?: JsonApiAutomationInAttributesStateEnum;
|
|
46010
|
+
/**
|
|
46011
|
+
* Specify automation evaluation mode.
|
|
46012
|
+
*/
|
|
46013
|
+
evaluationMode?: JsonApiAutomationInAttributesEvaluationModeEnum;
|
|
46014
|
+
schedule?: JsonApiAutomationInAttributesSchedule;
|
|
46015
|
+
alert?: JsonApiAutomationInAttributesAlert;
|
|
46016
|
+
tabularExports?: Array<JsonApiAutomationInAttributesTabularExportsInner>;
|
|
46017
|
+
visualExports?: Array<JsonApiAutomationInAttributesVisualExportsInner>;
|
|
46018
|
+
imageExports?: Array<JsonApiAutomationInAttributesImageExportsInner>;
|
|
46019
|
+
rawExports?: Array<JsonApiAutomationInAttributesRawExportsInner>;
|
|
46020
|
+
slidesExports?: Array<JsonApiAutomationInAttributesSlidesExportsInner>;
|
|
46021
|
+
dashboardTabularExports?: Array<JsonApiAutomationInAttributesDashboardTabularExportsInner>;
|
|
46022
|
+
/**
|
|
46023
|
+
* External recipients of the automation action results.
|
|
46024
|
+
*/
|
|
46025
|
+
externalRecipients?: Array<JsonApiAutomationInAttributesExternalRecipientsInner>;
|
|
46026
|
+
}
|
|
46027
|
+
|
|
46028
|
+
export declare interface JsonApiAutomationInAttributesAlert {
|
|
46029
|
+
execution: AlertAfm;
|
|
46030
|
+
condition: AlertCondition;
|
|
46031
|
+
/**
|
|
46032
|
+
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
|
|
46033
|
+
*/
|
|
46034
|
+
trigger?: JsonApiAutomationInAttributesAlertTriggerEnum;
|
|
46035
|
+
}
|
|
46036
|
+
|
|
46037
|
+
export declare const JsonApiAutomationInAttributesAlertTriggerEnum: {
|
|
46038
|
+
readonly ALWAYS: "ALWAYS";
|
|
46039
|
+
readonly ONCE: "ONCE";
|
|
46040
|
+
};
|
|
46041
|
+
|
|
46042
|
+
export declare type JsonApiAutomationInAttributesAlertTriggerEnum = (typeof JsonApiAutomationInAttributesAlertTriggerEnum)[keyof typeof JsonApiAutomationInAttributesAlertTriggerEnum];
|
|
46043
|
+
|
|
46044
|
+
export declare interface JsonApiAutomationInAttributesDashboardTabularExportsInner {
|
|
46045
|
+
requestPayload: DashboardTabularExportRequestV2;
|
|
46046
|
+
}
|
|
46047
|
+
|
|
46048
|
+
export declare const JsonApiAutomationInAttributesEvaluationModeEnum: {
|
|
46049
|
+
readonly SHARED: "SHARED";
|
|
46050
|
+
readonly PER_RECIPIENT: "PER_RECIPIENT";
|
|
46051
|
+
};
|
|
46052
|
+
|
|
46053
|
+
export declare type JsonApiAutomationInAttributesEvaluationModeEnum = (typeof JsonApiAutomationInAttributesEvaluationModeEnum)[keyof typeof JsonApiAutomationInAttributesEvaluationModeEnum];
|
|
46054
|
+
|
|
46055
|
+
export declare interface JsonApiAutomationInAttributesExternalRecipientsInner {
|
|
46056
|
+
/**
|
|
46057
|
+
* E-mail address to send notifications from.
|
|
46058
|
+
*/
|
|
46059
|
+
email: string;
|
|
46060
|
+
}
|
|
46061
|
+
|
|
46062
|
+
export declare interface JsonApiAutomationInAttributesImageExportsInner {
|
|
46063
|
+
requestPayload: ImageExportRequest;
|
|
46064
|
+
}
|
|
46065
|
+
|
|
46066
|
+
/**
|
|
46067
|
+
* Additional information for the automation.
|
|
46068
|
+
*/
|
|
46069
|
+
export declare interface JsonApiAutomationInAttributesMetadata {
|
|
46070
|
+
[key: string]: any;
|
|
46071
|
+
widget?: string;
|
|
46072
|
+
visibleFilters?: Array<VisibleFilter>;
|
|
46073
|
+
}
|
|
46074
|
+
|
|
46075
|
+
export declare interface JsonApiAutomationInAttributesRawExportsInner {
|
|
46076
|
+
requestPayload: RawExportAutomationRequest;
|
|
46077
|
+
}
|
|
46078
|
+
|
|
46079
|
+
export declare interface JsonApiAutomationInAttributesSchedule {
|
|
46080
|
+
/**
|
|
46081
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
46082
|
+
*/
|
|
46083
|
+
cron: string;
|
|
46084
|
+
/**
|
|
46085
|
+
* Human-readable description of the cron expression.
|
|
46086
|
+
*/
|
|
46087
|
+
cronDescription?: string;
|
|
46088
|
+
/**
|
|
46089
|
+
* Timezone in which the schedule is defined.
|
|
46090
|
+
*/
|
|
46091
|
+
timezone: string;
|
|
46092
|
+
/**
|
|
46093
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
46094
|
+
*/
|
|
46095
|
+
firstRun?: string;
|
|
46096
|
+
}
|
|
46097
|
+
|
|
46098
|
+
export declare interface JsonApiAutomationInAttributesSlidesExportsInner {
|
|
46099
|
+
requestPayload: SlidesExportRequest;
|
|
46100
|
+
}
|
|
46101
|
+
|
|
46102
|
+
export declare const JsonApiAutomationInAttributesStateEnum: {
|
|
46103
|
+
readonly ACTIVE: "ACTIVE";
|
|
46104
|
+
readonly PAUSED: "PAUSED";
|
|
46105
|
+
};
|
|
46106
|
+
|
|
46107
|
+
export declare type JsonApiAutomationInAttributesStateEnum = (typeof JsonApiAutomationInAttributesStateEnum)[keyof typeof JsonApiAutomationInAttributesStateEnum];
|
|
46108
|
+
|
|
46109
|
+
export declare interface JsonApiAutomationInAttributesTabularExportsInner {
|
|
46110
|
+
requestPayload: TabularExportRequest;
|
|
46111
|
+
}
|
|
46112
|
+
|
|
46113
|
+
export declare interface JsonApiAutomationInAttributesVisualExportsInner {
|
|
46114
|
+
requestPayload: VisualExportRequest;
|
|
45460
46115
|
}
|
|
45461
46116
|
|
|
45462
46117
|
export declare interface JsonApiAutomationInDocument {
|
|
45463
46118
|
data: JsonApiAutomationIn;
|
|
45464
46119
|
}
|
|
45465
46120
|
|
|
46121
|
+
export declare interface JsonApiAutomationInRelationships {
|
|
46122
|
+
notificationChannel?: JsonApiAutomationInRelationshipsNotificationChannel;
|
|
46123
|
+
analyticalDashboard?: JsonApiAutomationInRelationshipsAnalyticalDashboard;
|
|
46124
|
+
exportDefinitions?: JsonApiAutomationInRelationshipsExportDefinitions;
|
|
46125
|
+
recipients?: JsonApiAutomationInRelationshipsRecipients;
|
|
46126
|
+
}
|
|
46127
|
+
|
|
46128
|
+
export declare interface JsonApiAutomationInRelationshipsAnalyticalDashboard {
|
|
46129
|
+
data: JsonApiAnalyticalDashboardLinkage | null;
|
|
46130
|
+
}
|
|
46131
|
+
|
|
46132
|
+
export declare interface JsonApiAutomationInRelationshipsExportDefinitions {
|
|
46133
|
+
/**
|
|
46134
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
46135
|
+
*/
|
|
46136
|
+
data: Array<JsonApiExportDefinitionLinkage>;
|
|
46137
|
+
}
|
|
46138
|
+
|
|
46139
|
+
export declare interface JsonApiAutomationInRelationshipsNotificationChannel {
|
|
46140
|
+
data: JsonApiNotificationChannelLinkage | null;
|
|
46141
|
+
}
|
|
46142
|
+
|
|
46143
|
+
export declare interface JsonApiAutomationInRelationshipsRecipients {
|
|
46144
|
+
/**
|
|
46145
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
46146
|
+
*/
|
|
46147
|
+
data: Array<JsonApiUserLinkage>;
|
|
46148
|
+
}
|
|
46149
|
+
|
|
45466
46150
|
export declare const JsonApiAutomationInTypeEnum: {
|
|
45467
46151
|
readonly AUTOMATION: "automation";
|
|
45468
46152
|
};
|
|
@@ -45509,7 +46193,7 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
45509
46193
|
* Additional details to be included in the automated message.
|
|
45510
46194
|
*/
|
|
45511
46195
|
details?: object;
|
|
45512
|
-
metadata?:
|
|
46196
|
+
metadata?: JsonApiAutomationInAttributesMetadata | null;
|
|
45513
46197
|
/**
|
|
45514
46198
|
* Current state of the automation.
|
|
45515
46199
|
*/
|
|
@@ -45518,18 +46202,18 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
45518
46202
|
* Specify automation evaluation mode.
|
|
45519
46203
|
*/
|
|
45520
46204
|
evaluationMode?: JsonApiAutomationOutAttributesEvaluationModeEnum;
|
|
45521
|
-
schedule?:
|
|
45522
|
-
alert?:
|
|
45523
|
-
tabularExports?: Array<
|
|
45524
|
-
visualExports?: Array<
|
|
45525
|
-
imageExports?: Array<
|
|
45526
|
-
rawExports?: Array<
|
|
45527
|
-
slidesExports?: Array<
|
|
45528
|
-
dashboardTabularExports?: Array<
|
|
46205
|
+
schedule?: JsonApiAutomationInAttributesSchedule;
|
|
46206
|
+
alert?: JsonApiAutomationInAttributesAlert;
|
|
46207
|
+
tabularExports?: Array<JsonApiAutomationInAttributesTabularExportsInner>;
|
|
46208
|
+
visualExports?: Array<JsonApiAutomationInAttributesVisualExportsInner>;
|
|
46209
|
+
imageExports?: Array<JsonApiAutomationInAttributesImageExportsInner>;
|
|
46210
|
+
rawExports?: Array<JsonApiAutomationInAttributesRawExportsInner>;
|
|
46211
|
+
slidesExports?: Array<JsonApiAutomationInAttributesSlidesExportsInner>;
|
|
46212
|
+
dashboardTabularExports?: Array<JsonApiAutomationInAttributesDashboardTabularExportsInner>;
|
|
45529
46213
|
/**
|
|
45530
46214
|
* External recipients of the automation action results.
|
|
45531
46215
|
*/
|
|
45532
|
-
externalRecipients?: Array<
|
|
46216
|
+
externalRecipients?: Array<JsonApiAutomationInAttributesExternalRecipientsInner>;
|
|
45533
46217
|
createdAt?: string;
|
|
45534
46218
|
modifiedAt?: string;
|
|
45535
46219
|
}
|
|
@@ -45576,12 +46260,12 @@ export declare interface JsonApiAutomationOutList {
|
|
|
45576
46260
|
}
|
|
45577
46261
|
|
|
45578
46262
|
export declare interface JsonApiAutomationOutRelationships {
|
|
45579
|
-
notificationChannel?:
|
|
45580
|
-
analyticalDashboard?:
|
|
46263
|
+
notificationChannel?: JsonApiAutomationInRelationshipsNotificationChannel;
|
|
46264
|
+
analyticalDashboard?: JsonApiAutomationInRelationshipsAnalyticalDashboard;
|
|
45581
46265
|
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
45582
46266
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
45583
|
-
exportDefinitions?:
|
|
45584
|
-
recipients?:
|
|
46267
|
+
exportDefinitions?: JsonApiAutomationInRelationshipsExportDefinitions;
|
|
46268
|
+
recipients?: JsonApiAutomationInRelationshipsRecipients;
|
|
45585
46269
|
automationResults?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
45586
46270
|
}
|
|
45587
46271
|
|
|
@@ -45631,164 +46315,14 @@ export declare interface JsonApiAutomationPatch {
|
|
|
45631
46315
|
* API identifier of an object
|
|
45632
46316
|
*/
|
|
45633
46317
|
id: string;
|
|
45634
|
-
attributes?:
|
|
45635
|
-
relationships?:
|
|
45636
|
-
}
|
|
45637
|
-
|
|
45638
|
-
export declare interface JsonApiAutomationPatchAttributes {
|
|
45639
|
-
title?: string;
|
|
45640
|
-
description?: string;
|
|
45641
|
-
tags?: Array<string>;
|
|
45642
|
-
areRelationsValid?: boolean;
|
|
45643
|
-
/**
|
|
45644
|
-
* Additional details to be included in the automated message.
|
|
45645
|
-
*/
|
|
45646
|
-
details?: object;
|
|
45647
|
-
metadata?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
45648
|
-
/**
|
|
45649
|
-
* Current state of the automation.
|
|
45650
|
-
*/
|
|
45651
|
-
state?: JsonApiAutomationPatchAttributesStateEnum;
|
|
45652
|
-
/**
|
|
45653
|
-
* Specify automation evaluation mode.
|
|
45654
|
-
*/
|
|
45655
|
-
evaluationMode?: JsonApiAutomationPatchAttributesEvaluationModeEnum;
|
|
45656
|
-
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
45657
|
-
alert?: JsonApiAutomationPatchAttributesAlert;
|
|
45658
|
-
tabularExports?: Array<JsonApiAutomationPatchAttributesTabularExportsInner>;
|
|
45659
|
-
visualExports?: Array<JsonApiAutomationPatchAttributesVisualExportsInner>;
|
|
45660
|
-
imageExports?: Array<JsonApiAutomationPatchAttributesImageExportsInner>;
|
|
45661
|
-
rawExports?: Array<JsonApiAutomationPatchAttributesRawExportsInner>;
|
|
45662
|
-
slidesExports?: Array<JsonApiAutomationPatchAttributesSlidesExportsInner>;
|
|
45663
|
-
dashboardTabularExports?: Array<JsonApiAutomationPatchAttributesDashboardTabularExportsInner>;
|
|
45664
|
-
/**
|
|
45665
|
-
* External recipients of the automation action results.
|
|
45666
|
-
*/
|
|
45667
|
-
externalRecipients?: Array<JsonApiAutomationPatchAttributesExternalRecipientsInner>;
|
|
45668
|
-
}
|
|
45669
|
-
|
|
45670
|
-
export declare interface JsonApiAutomationPatchAttributesAlert {
|
|
45671
|
-
execution: AlertAfm;
|
|
45672
|
-
condition: AlertCondition;
|
|
45673
|
-
/**
|
|
45674
|
-
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
|
|
45675
|
-
*/
|
|
45676
|
-
trigger?: JsonApiAutomationPatchAttributesAlertTriggerEnum;
|
|
45677
|
-
}
|
|
45678
|
-
|
|
45679
|
-
export declare const JsonApiAutomationPatchAttributesAlertTriggerEnum: {
|
|
45680
|
-
readonly ALWAYS: "ALWAYS";
|
|
45681
|
-
readonly ONCE: "ONCE";
|
|
45682
|
-
};
|
|
45683
|
-
|
|
45684
|
-
export declare type JsonApiAutomationPatchAttributesAlertTriggerEnum = (typeof JsonApiAutomationPatchAttributesAlertTriggerEnum)[keyof typeof JsonApiAutomationPatchAttributesAlertTriggerEnum];
|
|
45685
|
-
|
|
45686
|
-
export declare interface JsonApiAutomationPatchAttributesDashboardTabularExportsInner {
|
|
45687
|
-
requestPayload: DashboardTabularExportRequestV2;
|
|
45688
|
-
}
|
|
45689
|
-
|
|
45690
|
-
export declare const JsonApiAutomationPatchAttributesEvaluationModeEnum: {
|
|
45691
|
-
readonly SHARED: "SHARED";
|
|
45692
|
-
readonly PER_RECIPIENT: "PER_RECIPIENT";
|
|
45693
|
-
};
|
|
45694
|
-
|
|
45695
|
-
export declare type JsonApiAutomationPatchAttributesEvaluationModeEnum = (typeof JsonApiAutomationPatchAttributesEvaluationModeEnum)[keyof typeof JsonApiAutomationPatchAttributesEvaluationModeEnum];
|
|
45696
|
-
|
|
45697
|
-
export declare interface JsonApiAutomationPatchAttributesExternalRecipientsInner {
|
|
45698
|
-
/**
|
|
45699
|
-
* E-mail address to send notifications from.
|
|
45700
|
-
*/
|
|
45701
|
-
email: string;
|
|
45702
|
-
}
|
|
45703
|
-
|
|
45704
|
-
export declare interface JsonApiAutomationPatchAttributesImageExportsInner {
|
|
45705
|
-
requestPayload: ImageExportRequest;
|
|
45706
|
-
}
|
|
45707
|
-
|
|
45708
|
-
/**
|
|
45709
|
-
* Additional information for the automation.
|
|
45710
|
-
*/
|
|
45711
|
-
export declare interface JsonApiAutomationPatchAttributesMetadata {
|
|
45712
|
-
[key: string]: any;
|
|
45713
|
-
widget?: string;
|
|
45714
|
-
visibleFilters?: Array<VisibleFilter>;
|
|
45715
|
-
}
|
|
45716
|
-
|
|
45717
|
-
export declare interface JsonApiAutomationPatchAttributesRawExportsInner {
|
|
45718
|
-
requestPayload: RawExportAutomationRequest;
|
|
45719
|
-
}
|
|
45720
|
-
|
|
45721
|
-
export declare interface JsonApiAutomationPatchAttributesSchedule {
|
|
45722
|
-
/**
|
|
45723
|
-
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
45724
|
-
*/
|
|
45725
|
-
cron: string;
|
|
45726
|
-
/**
|
|
45727
|
-
* Human-readable description of the cron expression.
|
|
45728
|
-
*/
|
|
45729
|
-
cronDescription?: string;
|
|
45730
|
-
/**
|
|
45731
|
-
* Timezone in which the schedule is defined.
|
|
45732
|
-
*/
|
|
45733
|
-
timezone: string;
|
|
45734
|
-
/**
|
|
45735
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
45736
|
-
*/
|
|
45737
|
-
firstRun?: string;
|
|
45738
|
-
}
|
|
45739
|
-
|
|
45740
|
-
export declare interface JsonApiAutomationPatchAttributesSlidesExportsInner {
|
|
45741
|
-
requestPayload: SlidesExportRequest;
|
|
45742
|
-
}
|
|
45743
|
-
|
|
45744
|
-
export declare const JsonApiAutomationPatchAttributesStateEnum: {
|
|
45745
|
-
readonly ACTIVE: "ACTIVE";
|
|
45746
|
-
readonly PAUSED: "PAUSED";
|
|
45747
|
-
};
|
|
45748
|
-
|
|
45749
|
-
export declare type JsonApiAutomationPatchAttributesStateEnum = (typeof JsonApiAutomationPatchAttributesStateEnum)[keyof typeof JsonApiAutomationPatchAttributesStateEnum];
|
|
45750
|
-
|
|
45751
|
-
export declare interface JsonApiAutomationPatchAttributesTabularExportsInner {
|
|
45752
|
-
requestPayload: TabularExportRequest;
|
|
45753
|
-
}
|
|
45754
|
-
|
|
45755
|
-
export declare interface JsonApiAutomationPatchAttributesVisualExportsInner {
|
|
45756
|
-
requestPayload: VisualExportRequest;
|
|
46318
|
+
attributes?: JsonApiAutomationInAttributes;
|
|
46319
|
+
relationships?: JsonApiAutomationInRelationships;
|
|
45757
46320
|
}
|
|
45758
46321
|
|
|
45759
46322
|
export declare interface JsonApiAutomationPatchDocument {
|
|
45760
46323
|
data: JsonApiAutomationPatch;
|
|
45761
46324
|
}
|
|
45762
46325
|
|
|
45763
|
-
export declare interface JsonApiAutomationPatchRelationships {
|
|
45764
|
-
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
45765
|
-
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
45766
|
-
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
45767
|
-
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
45768
|
-
}
|
|
45769
|
-
|
|
45770
|
-
export declare interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard {
|
|
45771
|
-
data: JsonApiAnalyticalDashboardLinkage | null;
|
|
45772
|
-
}
|
|
45773
|
-
|
|
45774
|
-
export declare interface JsonApiAutomationPatchRelationshipsExportDefinitions {
|
|
45775
|
-
/**
|
|
45776
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
45777
|
-
*/
|
|
45778
|
-
data: Array<JsonApiExportDefinitionLinkage>;
|
|
45779
|
-
}
|
|
45780
|
-
|
|
45781
|
-
export declare interface JsonApiAutomationPatchRelationshipsNotificationChannel {
|
|
45782
|
-
data: JsonApiNotificationChannelLinkage | null;
|
|
45783
|
-
}
|
|
45784
|
-
|
|
45785
|
-
export declare interface JsonApiAutomationPatchRelationshipsRecipients {
|
|
45786
|
-
/**
|
|
45787
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
45788
|
-
*/
|
|
45789
|
-
data: Array<JsonApiUserLinkage>;
|
|
45790
|
-
}
|
|
45791
|
-
|
|
45792
46326
|
export declare const JsonApiAutomationPatchTypeEnum: {
|
|
45793
46327
|
readonly AUTOMATION: "automation";
|
|
45794
46328
|
};
|
|
@@ -46011,7 +46545,15 @@ export declare interface JsonApiCookieSecurityConfigurationIn {
|
|
|
46011
46545
|
* API identifier of an object
|
|
46012
46546
|
*/
|
|
46013
46547
|
id: string;
|
|
46014
|
-
attributes?:
|
|
46548
|
+
attributes?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
46549
|
+
}
|
|
46550
|
+
|
|
46551
|
+
export declare interface JsonApiCookieSecurityConfigurationInAttributes {
|
|
46552
|
+
lastRotation?: string;
|
|
46553
|
+
/**
|
|
46554
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
46555
|
+
*/
|
|
46556
|
+
rotationInterval?: string;
|
|
46015
46557
|
}
|
|
46016
46558
|
|
|
46017
46559
|
export declare interface JsonApiCookieSecurityConfigurationInDocument {
|
|
@@ -46036,7 +46578,7 @@ export declare interface JsonApiCookieSecurityConfigurationOut {
|
|
|
46036
46578
|
* API identifier of an object
|
|
46037
46579
|
*/
|
|
46038
46580
|
id: string;
|
|
46039
|
-
attributes?:
|
|
46581
|
+
attributes?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
46040
46582
|
}
|
|
46041
46583
|
|
|
46042
46584
|
export declare interface JsonApiCookieSecurityConfigurationOutDocument {
|
|
@@ -46062,15 +46604,7 @@ export declare interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
46062
46604
|
* API identifier of an object
|
|
46063
46605
|
*/
|
|
46064
46606
|
id: string;
|
|
46065
|
-
attributes?:
|
|
46066
|
-
}
|
|
46067
|
-
|
|
46068
|
-
export declare interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
46069
|
-
lastRotation?: string;
|
|
46070
|
-
/**
|
|
46071
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
46072
|
-
*/
|
|
46073
|
-
rotationInterval?: string;
|
|
46607
|
+
attributes?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
46074
46608
|
}
|
|
46075
46609
|
|
|
46076
46610
|
export declare interface JsonApiCookieSecurityConfigurationPatchDocument {
|
|
@@ -46207,7 +46741,7 @@ export declare interface JsonApiCustomApplicationSettingIn {
|
|
|
46207
46741
|
* API identifier of an object
|
|
46208
46742
|
*/
|
|
46209
46743
|
id: string;
|
|
46210
|
-
attributes:
|
|
46744
|
+
attributes: JsonApiCustomApplicationSettingPostOptionalIdAttributes;
|
|
46211
46745
|
}
|
|
46212
46746
|
|
|
46213
46747
|
export declare interface JsonApiCustomApplicationSettingInDocument {
|
|
@@ -46233,15 +46767,7 @@ export declare interface JsonApiCustomApplicationSettingOut {
|
|
|
46233
46767
|
*/
|
|
46234
46768
|
id: string;
|
|
46235
46769
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
46236
|
-
attributes:
|
|
46237
|
-
}
|
|
46238
|
-
|
|
46239
|
-
export declare interface JsonApiCustomApplicationSettingOutAttributes {
|
|
46240
|
-
applicationName: string;
|
|
46241
|
-
/**
|
|
46242
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
46243
|
-
*/
|
|
46244
|
-
content: object;
|
|
46770
|
+
attributes: JsonApiCustomApplicationSettingPostOptionalIdAttributes;
|
|
46245
46771
|
}
|
|
46246
46772
|
|
|
46247
46773
|
export declare interface JsonApiCustomApplicationSettingOutDocument {
|
|
@@ -46274,7 +46800,7 @@ export declare interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
|
46274
46800
|
*/
|
|
46275
46801
|
id: string;
|
|
46276
46802
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
46277
|
-
attributes:
|
|
46803
|
+
attributes: JsonApiCustomApplicationSettingPostOptionalIdAttributes;
|
|
46278
46804
|
links?: ObjectLinks;
|
|
46279
46805
|
}
|
|
46280
46806
|
|
|
@@ -46329,7 +46855,15 @@ export declare interface JsonApiCustomApplicationSettingPostOptionalId {
|
|
|
46329
46855
|
* API identifier of an object
|
|
46330
46856
|
*/
|
|
46331
46857
|
id?: string;
|
|
46332
|
-
attributes:
|
|
46858
|
+
attributes: JsonApiCustomApplicationSettingPostOptionalIdAttributes;
|
|
46859
|
+
}
|
|
46860
|
+
|
|
46861
|
+
export declare interface JsonApiCustomApplicationSettingPostOptionalIdAttributes {
|
|
46862
|
+
applicationName: string;
|
|
46863
|
+
/**
|
|
46864
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
46865
|
+
*/
|
|
46866
|
+
content: object;
|
|
46333
46867
|
}
|
|
46334
46868
|
|
|
46335
46869
|
export declare interface JsonApiCustomApplicationSettingPostOptionalIdDocument {
|
|
@@ -46354,7 +46888,7 @@ export declare interface JsonApiDashboardPluginIn {
|
|
|
46354
46888
|
* API identifier of an object
|
|
46355
46889
|
*/
|
|
46356
46890
|
id: string;
|
|
46357
|
-
attributes?:
|
|
46891
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
46358
46892
|
}
|
|
46359
46893
|
|
|
46360
46894
|
export declare interface JsonApiDashboardPluginInDocument {
|
|
@@ -46477,18 +47011,7 @@ export declare interface JsonApiDashboardPluginPatch {
|
|
|
46477
47011
|
* API identifier of an object
|
|
46478
47012
|
*/
|
|
46479
47013
|
id: string;
|
|
46480
|
-
attributes?:
|
|
46481
|
-
}
|
|
46482
|
-
|
|
46483
|
-
export declare interface JsonApiDashboardPluginPatchAttributes {
|
|
46484
|
-
title?: string;
|
|
46485
|
-
description?: string;
|
|
46486
|
-
tags?: Array<string>;
|
|
46487
|
-
areRelationsValid?: boolean;
|
|
46488
|
-
/**
|
|
46489
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
46490
|
-
*/
|
|
46491
|
-
content?: object;
|
|
47014
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
46492
47015
|
}
|
|
46493
47016
|
|
|
46494
47017
|
export declare interface JsonApiDashboardPluginPatchDocument {
|
|
@@ -46513,7 +47036,18 @@ export declare interface JsonApiDashboardPluginPostOptionalId {
|
|
|
46513
47036
|
* API identifier of an object
|
|
46514
47037
|
*/
|
|
46515
47038
|
id?: string;
|
|
46516
|
-
attributes?:
|
|
47039
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
47040
|
+
}
|
|
47041
|
+
|
|
47042
|
+
export declare interface JsonApiDashboardPluginPostOptionalIdAttributes {
|
|
47043
|
+
title?: string;
|
|
47044
|
+
description?: string;
|
|
47045
|
+
tags?: Array<string>;
|
|
47046
|
+
areRelationsValid?: boolean;
|
|
47047
|
+
/**
|
|
47048
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
47049
|
+
*/
|
|
47050
|
+
content?: object;
|
|
46517
47051
|
}
|
|
46518
47052
|
|
|
46519
47053
|
export declare interface JsonApiDashboardPluginPostOptionalIdDocument {
|
|
@@ -47300,8 +47834,8 @@ export declare interface JsonApiExportDefinitionIn {
|
|
|
47300
47834
|
* API identifier of an object
|
|
47301
47835
|
*/
|
|
47302
47836
|
id: string;
|
|
47303
|
-
attributes?:
|
|
47304
|
-
relationships?:
|
|
47837
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
47838
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
47305
47839
|
}
|
|
47306
47840
|
|
|
47307
47841
|
export declare interface JsonApiExportDefinitionInDocument {
|
|
@@ -47390,7 +47924,7 @@ export declare interface JsonApiExportDefinitionOutList {
|
|
|
47390
47924
|
|
|
47391
47925
|
export declare interface JsonApiExportDefinitionOutRelationships {
|
|
47392
47926
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
47393
|
-
analyticalDashboard?:
|
|
47927
|
+
analyticalDashboard?: JsonApiAutomationInRelationshipsAnalyticalDashboard;
|
|
47394
47928
|
automation?: JsonApiExportDefinitionOutRelationshipsAutomation;
|
|
47395
47929
|
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
47396
47930
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
@@ -47443,27 +47977,14 @@ export declare interface JsonApiExportDefinitionPatch {
|
|
|
47443
47977
|
* API identifier of an object
|
|
47444
47978
|
*/
|
|
47445
47979
|
id: string;
|
|
47446
|
-
attributes?:
|
|
47447
|
-
relationships?:
|
|
47448
|
-
}
|
|
47449
|
-
|
|
47450
|
-
export declare interface JsonApiExportDefinitionPatchAttributes {
|
|
47451
|
-
title?: string;
|
|
47452
|
-
description?: string;
|
|
47453
|
-
tags?: Array<string>;
|
|
47454
|
-
requestPayload?: JsonApiExportDefinitionOutAttributesRequestPayload;
|
|
47455
|
-
areRelationsValid?: boolean;
|
|
47980
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
47981
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
47456
47982
|
}
|
|
47457
47983
|
|
|
47458
47984
|
export declare interface JsonApiExportDefinitionPatchDocument {
|
|
47459
47985
|
data: JsonApiExportDefinitionPatch;
|
|
47460
47986
|
}
|
|
47461
47987
|
|
|
47462
|
-
export declare interface JsonApiExportDefinitionPatchRelationships {
|
|
47463
|
-
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
47464
|
-
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
47465
|
-
}
|
|
47466
|
-
|
|
47467
47988
|
export declare const JsonApiExportDefinitionPatchTypeEnum: {
|
|
47468
47989
|
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
47469
47990
|
};
|
|
@@ -47482,14 +48003,27 @@ export declare interface JsonApiExportDefinitionPostOptionalId {
|
|
|
47482
48003
|
* API identifier of an object
|
|
47483
48004
|
*/
|
|
47484
48005
|
id?: string;
|
|
47485
|
-
attributes?:
|
|
47486
|
-
relationships?:
|
|
48006
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
48007
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
48008
|
+
}
|
|
48009
|
+
|
|
48010
|
+
export declare interface JsonApiExportDefinitionPostOptionalIdAttributes {
|
|
48011
|
+
title?: string;
|
|
48012
|
+
description?: string;
|
|
48013
|
+
tags?: Array<string>;
|
|
48014
|
+
requestPayload?: JsonApiExportDefinitionOutAttributesRequestPayload;
|
|
48015
|
+
areRelationsValid?: boolean;
|
|
47487
48016
|
}
|
|
47488
48017
|
|
|
47489
48018
|
export declare interface JsonApiExportDefinitionPostOptionalIdDocument {
|
|
47490
48019
|
data: JsonApiExportDefinitionPostOptionalId;
|
|
47491
48020
|
}
|
|
47492
48021
|
|
|
48022
|
+
export declare interface JsonApiExportDefinitionPostOptionalIdRelationships {
|
|
48023
|
+
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
48024
|
+
analyticalDashboard?: JsonApiAutomationInRelationshipsAnalyticalDashboard;
|
|
48025
|
+
}
|
|
48026
|
+
|
|
47493
48027
|
export declare const JsonApiExportDefinitionPostOptionalIdTypeEnum: {
|
|
47494
48028
|
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
47495
48029
|
};
|
|
@@ -47800,7 +48334,7 @@ export declare interface JsonApiFilterContextIn {
|
|
|
47800
48334
|
* API identifier of an object
|
|
47801
48335
|
*/
|
|
47802
48336
|
id: string;
|
|
47803
|
-
attributes:
|
|
48337
|
+
attributes: JsonApiAnalyticalDashboardPostOptionalIdAttributes;
|
|
47804
48338
|
}
|
|
47805
48339
|
|
|
47806
48340
|
export declare interface JsonApiFilterContextInDocument {
|
|
@@ -47840,21 +48374,10 @@ export declare interface JsonApiFilterContextOut {
|
|
|
47840
48374
|
*/
|
|
47841
48375
|
id: string;
|
|
47842
48376
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
47843
|
-
attributes:
|
|
48377
|
+
attributes: JsonApiAnalyticalDashboardPostOptionalIdAttributes;
|
|
47844
48378
|
relationships?: JsonApiFilterContextOutRelationships;
|
|
47845
48379
|
}
|
|
47846
48380
|
|
|
47847
|
-
export declare interface JsonApiFilterContextOutAttributes {
|
|
47848
|
-
title?: string;
|
|
47849
|
-
description?: string;
|
|
47850
|
-
tags?: Array<string>;
|
|
47851
|
-
areRelationsValid?: boolean;
|
|
47852
|
-
/**
|
|
47853
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
47854
|
-
*/
|
|
47855
|
-
content: object;
|
|
47856
|
-
}
|
|
47857
|
-
|
|
47858
48381
|
export declare interface JsonApiFilterContextOutDocument {
|
|
47859
48382
|
data: JsonApiFilterContextOut;
|
|
47860
48383
|
links?: ObjectLinks;
|
|
@@ -47904,7 +48427,7 @@ export declare interface JsonApiFilterContextOutWithLinks {
|
|
|
47904
48427
|
*/
|
|
47905
48428
|
id: string;
|
|
47906
48429
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
47907
|
-
attributes:
|
|
48430
|
+
attributes: JsonApiAnalyticalDashboardPostOptionalIdAttributes;
|
|
47908
48431
|
relationships?: JsonApiFilterContextOutRelationships;
|
|
47909
48432
|
links?: ObjectLinks;
|
|
47910
48433
|
}
|
|
@@ -47952,7 +48475,7 @@ export declare interface JsonApiFilterContextPostOptionalId {
|
|
|
47952
48475
|
* API identifier of an object
|
|
47953
48476
|
*/
|
|
47954
48477
|
id?: string;
|
|
47955
|
-
attributes:
|
|
48478
|
+
attributes: JsonApiAnalyticalDashboardPostOptionalIdAttributes;
|
|
47956
48479
|
}
|
|
47957
48480
|
|
|
47958
48481
|
export declare interface JsonApiFilterContextPostOptionalIdDocument {
|
|
@@ -47977,14 +48500,34 @@ export declare interface JsonApiFilterViewIn {
|
|
|
47977
48500
|
* API identifier of an object
|
|
47978
48501
|
*/
|
|
47979
48502
|
id: string;
|
|
47980
|
-
attributes:
|
|
47981
|
-
relationships?:
|
|
48503
|
+
attributes: JsonApiFilterViewInAttributes;
|
|
48504
|
+
relationships?: JsonApiFilterViewInRelationships;
|
|
48505
|
+
}
|
|
48506
|
+
|
|
48507
|
+
export declare interface JsonApiFilterViewInAttributes {
|
|
48508
|
+
title: string;
|
|
48509
|
+
description?: string;
|
|
48510
|
+
tags?: Array<string>;
|
|
48511
|
+
areRelationsValid?: boolean;
|
|
48512
|
+
/**
|
|
48513
|
+
* Indicator whether the filter view should by applied by default.
|
|
48514
|
+
*/
|
|
48515
|
+
isDefault?: boolean;
|
|
48516
|
+
/**
|
|
48517
|
+
* The respective filter context.
|
|
48518
|
+
*/
|
|
48519
|
+
content: object;
|
|
47982
48520
|
}
|
|
47983
48521
|
|
|
47984
48522
|
export declare interface JsonApiFilterViewInDocument {
|
|
47985
48523
|
data: JsonApiFilterViewIn;
|
|
47986
48524
|
}
|
|
47987
48525
|
|
|
48526
|
+
export declare interface JsonApiFilterViewInRelationships {
|
|
48527
|
+
analyticalDashboard?: JsonApiAutomationInRelationshipsAnalyticalDashboard;
|
|
48528
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
48529
|
+
}
|
|
48530
|
+
|
|
47988
48531
|
export declare const JsonApiFilterViewInTypeEnum: {
|
|
47989
48532
|
readonly FILTER_VIEW: "filterView";
|
|
47990
48533
|
};
|
|
@@ -48003,23 +48546,8 @@ export declare interface JsonApiFilterViewOut {
|
|
|
48003
48546
|
* API identifier of an object
|
|
48004
48547
|
*/
|
|
48005
48548
|
id: string;
|
|
48006
|
-
attributes:
|
|
48007
|
-
relationships?:
|
|
48008
|
-
}
|
|
48009
|
-
|
|
48010
|
-
export declare interface JsonApiFilterViewOutAttributes {
|
|
48011
|
-
title: string;
|
|
48012
|
-
description?: string;
|
|
48013
|
-
tags?: Array<string>;
|
|
48014
|
-
areRelationsValid?: boolean;
|
|
48015
|
-
/**
|
|
48016
|
-
* Indicator whether the filter view should by applied by default.
|
|
48017
|
-
*/
|
|
48018
|
-
isDefault?: boolean;
|
|
48019
|
-
/**
|
|
48020
|
-
* The respective filter context.
|
|
48021
|
-
*/
|
|
48022
|
-
content: object;
|
|
48549
|
+
attributes: JsonApiFilterViewInAttributes;
|
|
48550
|
+
relationships?: JsonApiFilterViewInRelationships;
|
|
48023
48551
|
}
|
|
48024
48552
|
|
|
48025
48553
|
export declare interface JsonApiFilterViewOutDocument {
|
|
@@ -48064,8 +48592,8 @@ export declare interface JsonApiFilterViewOutWithLinks {
|
|
|
48064
48592
|
* API identifier of an object
|
|
48065
48593
|
*/
|
|
48066
48594
|
id: string;
|
|
48067
|
-
attributes:
|
|
48068
|
-
relationships?:
|
|
48595
|
+
attributes: JsonApiFilterViewInAttributes;
|
|
48596
|
+
relationships?: JsonApiFilterViewInRelationships;
|
|
48069
48597
|
links?: ObjectLinks;
|
|
48070
48598
|
}
|
|
48071
48599
|
|
|
@@ -48088,7 +48616,7 @@ export declare interface JsonApiFilterViewPatch {
|
|
|
48088
48616
|
*/
|
|
48089
48617
|
id: string;
|
|
48090
48618
|
attributes: JsonApiFilterViewPatchAttributes;
|
|
48091
|
-
relationships?:
|
|
48619
|
+
relationships?: JsonApiFilterViewInRelationships;
|
|
48092
48620
|
}
|
|
48093
48621
|
|
|
48094
48622
|
export declare interface JsonApiFilterViewPatchAttributes {
|
|
@@ -48110,11 +48638,6 @@ export declare interface JsonApiFilterViewPatchDocument {
|
|
|
48110
48638
|
data: JsonApiFilterViewPatch;
|
|
48111
48639
|
}
|
|
48112
48640
|
|
|
48113
|
-
export declare interface JsonApiFilterViewPatchRelationships {
|
|
48114
|
-
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
48115
|
-
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
48116
|
-
}
|
|
48117
|
-
|
|
48118
48641
|
export declare const JsonApiFilterViewPatchTypeEnum: {
|
|
48119
48642
|
readonly FILTER_VIEW: "filterView";
|
|
48120
48643
|
};
|
|
@@ -48790,27 +49313,251 @@ export declare const JsonApiLlmEndpointPatchTypeEnum: {
|
|
|
48790
49313
|
export declare type JsonApiLlmEndpointPatchTypeEnum = (typeof JsonApiLlmEndpointPatchTypeEnum)[keyof typeof JsonApiLlmEndpointPatchTypeEnum];
|
|
48791
49314
|
|
|
48792
49315
|
/**
|
|
48793
|
-
* JSON:API representation of
|
|
49316
|
+
* JSON:API representation of memoryItem entity.
|
|
48794
49317
|
*/
|
|
48795
|
-
export declare interface
|
|
49318
|
+
export declare interface JsonApiMemoryItemIn {
|
|
48796
49319
|
/**
|
|
48797
49320
|
* Object type
|
|
48798
49321
|
*/
|
|
48799
|
-
type:
|
|
49322
|
+
type: JsonApiMemoryItemInTypeEnum;
|
|
49323
|
+
/**
|
|
49324
|
+
* API identifier of an object
|
|
49325
|
+
*/
|
|
49326
|
+
id: string;
|
|
49327
|
+
attributes: JsonApiMemoryItemPostOptionalIdAttributes;
|
|
49328
|
+
}
|
|
49329
|
+
|
|
49330
|
+
export declare interface JsonApiMemoryItemInDocument {
|
|
49331
|
+
data: JsonApiMemoryItemIn;
|
|
49332
|
+
}
|
|
49333
|
+
|
|
49334
|
+
export declare const JsonApiMemoryItemInTypeEnum: {
|
|
49335
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
49336
|
+
};
|
|
49337
|
+
|
|
49338
|
+
export declare type JsonApiMemoryItemInTypeEnum = (typeof JsonApiMemoryItemInTypeEnum)[keyof typeof JsonApiMemoryItemInTypeEnum];
|
|
49339
|
+
|
|
49340
|
+
/**
|
|
49341
|
+
* JSON:API representation of memoryItem entity.
|
|
49342
|
+
*/
|
|
49343
|
+
export declare interface JsonApiMemoryItemOut {
|
|
49344
|
+
/**
|
|
49345
|
+
* Object type
|
|
49346
|
+
*/
|
|
49347
|
+
type: JsonApiMemoryItemOutTypeEnum;
|
|
48800
49348
|
/**
|
|
48801
49349
|
* API identifier of an object
|
|
48802
49350
|
*/
|
|
48803
49351
|
id: string;
|
|
48804
|
-
|
|
49352
|
+
meta?: JsonApiVisualizationObjectOutMeta;
|
|
49353
|
+
attributes: JsonApiMemoryItemOutAttributes;
|
|
49354
|
+
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
48805
49355
|
}
|
|
48806
49356
|
|
|
48807
|
-
export declare interface
|
|
49357
|
+
export declare interface JsonApiMemoryItemOutAttributes {
|
|
48808
49358
|
title?: string;
|
|
48809
49359
|
description?: string;
|
|
48810
49360
|
tags?: Array<string>;
|
|
48811
49361
|
areRelationsValid?: boolean;
|
|
48812
|
-
|
|
48813
|
-
|
|
49362
|
+
/**
|
|
49363
|
+
* Strategy defining when the memory item should be applied
|
|
49364
|
+
*/
|
|
49365
|
+
strategy: JsonApiMemoryItemOutAttributesStrategyEnum;
|
|
49366
|
+
/**
|
|
49367
|
+
* The text that will be injected into the system prompt
|
|
49368
|
+
*/
|
|
49369
|
+
instruction: string;
|
|
49370
|
+
/**
|
|
49371
|
+
* Set of unique strings used for semantic similarity filtering
|
|
49372
|
+
*/
|
|
49373
|
+
keywords?: Array<string>;
|
|
49374
|
+
/**
|
|
49375
|
+
* Whether memory item is disabled
|
|
49376
|
+
*/
|
|
49377
|
+
isDisabled?: boolean;
|
|
49378
|
+
createdAt?: string;
|
|
49379
|
+
modifiedAt?: string;
|
|
49380
|
+
}
|
|
49381
|
+
|
|
49382
|
+
export declare const JsonApiMemoryItemOutAttributesStrategyEnum: {
|
|
49383
|
+
readonly ALWAYS: "ALWAYS";
|
|
49384
|
+
readonly AUTO: "AUTO";
|
|
49385
|
+
};
|
|
49386
|
+
|
|
49387
|
+
export declare type JsonApiMemoryItemOutAttributesStrategyEnum = (typeof JsonApiMemoryItemOutAttributesStrategyEnum)[keyof typeof JsonApiMemoryItemOutAttributesStrategyEnum];
|
|
49388
|
+
|
|
49389
|
+
export declare interface JsonApiMemoryItemOutDocument {
|
|
49390
|
+
data: JsonApiMemoryItemOut;
|
|
49391
|
+
links?: ObjectLinks;
|
|
49392
|
+
/**
|
|
49393
|
+
* Included resources
|
|
49394
|
+
*/
|
|
49395
|
+
included?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
49396
|
+
}
|
|
49397
|
+
|
|
49398
|
+
/**
|
|
49399
|
+
* A JSON:API document with a list of resources
|
|
49400
|
+
*/
|
|
49401
|
+
export declare interface JsonApiMemoryItemOutList {
|
|
49402
|
+
data: Array<JsonApiMemoryItemOutWithLinks>;
|
|
49403
|
+
links?: ListLinks;
|
|
49404
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
49405
|
+
/**
|
|
49406
|
+
* Included resources
|
|
49407
|
+
*/
|
|
49408
|
+
included?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
49409
|
+
}
|
|
49410
|
+
|
|
49411
|
+
export declare const JsonApiMemoryItemOutTypeEnum: {
|
|
49412
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
49413
|
+
};
|
|
49414
|
+
|
|
49415
|
+
export declare type JsonApiMemoryItemOutTypeEnum = (typeof JsonApiMemoryItemOutTypeEnum)[keyof typeof JsonApiMemoryItemOutTypeEnum];
|
|
49416
|
+
|
|
49417
|
+
export declare interface JsonApiMemoryItemOutWithLinks {
|
|
49418
|
+
/**
|
|
49419
|
+
* Object type
|
|
49420
|
+
*/
|
|
49421
|
+
type: JsonApiMemoryItemOutWithLinksTypeEnum;
|
|
49422
|
+
/**
|
|
49423
|
+
* API identifier of an object
|
|
49424
|
+
*/
|
|
49425
|
+
id: string;
|
|
49426
|
+
meta?: JsonApiVisualizationObjectOutMeta;
|
|
49427
|
+
attributes: JsonApiMemoryItemOutAttributes;
|
|
49428
|
+
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
49429
|
+
links?: ObjectLinks;
|
|
49430
|
+
}
|
|
49431
|
+
|
|
49432
|
+
export declare const JsonApiMemoryItemOutWithLinksTypeEnum: {
|
|
49433
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
49434
|
+
};
|
|
49435
|
+
|
|
49436
|
+
export declare type JsonApiMemoryItemOutWithLinksTypeEnum = (typeof JsonApiMemoryItemOutWithLinksTypeEnum)[keyof typeof JsonApiMemoryItemOutWithLinksTypeEnum];
|
|
49437
|
+
|
|
49438
|
+
/**
|
|
49439
|
+
* JSON:API representation of patching memoryItem entity.
|
|
49440
|
+
*/
|
|
49441
|
+
export declare interface JsonApiMemoryItemPatch {
|
|
49442
|
+
/**
|
|
49443
|
+
* Object type
|
|
49444
|
+
*/
|
|
49445
|
+
type: JsonApiMemoryItemPatchTypeEnum;
|
|
49446
|
+
/**
|
|
49447
|
+
* API identifier of an object
|
|
49448
|
+
*/
|
|
49449
|
+
id: string;
|
|
49450
|
+
attributes: JsonApiMemoryItemPatchAttributes;
|
|
49451
|
+
}
|
|
49452
|
+
|
|
49453
|
+
export declare interface JsonApiMemoryItemPatchAttributes {
|
|
49454
|
+
title?: string;
|
|
49455
|
+
description?: string;
|
|
49456
|
+
tags?: Array<string>;
|
|
49457
|
+
areRelationsValid?: boolean;
|
|
49458
|
+
/**
|
|
49459
|
+
* Strategy defining when the memory item should be applied
|
|
49460
|
+
*/
|
|
49461
|
+
strategy?: JsonApiMemoryItemPatchAttributesStrategyEnum;
|
|
49462
|
+
/**
|
|
49463
|
+
* The text that will be injected into the system prompt
|
|
49464
|
+
*/
|
|
49465
|
+
instruction?: string;
|
|
49466
|
+
/**
|
|
49467
|
+
* Set of unique strings used for semantic similarity filtering
|
|
49468
|
+
*/
|
|
49469
|
+
keywords?: Array<string>;
|
|
49470
|
+
/**
|
|
49471
|
+
* Whether memory item is disabled
|
|
49472
|
+
*/
|
|
49473
|
+
isDisabled?: boolean;
|
|
49474
|
+
}
|
|
49475
|
+
|
|
49476
|
+
export declare const JsonApiMemoryItemPatchAttributesStrategyEnum: {
|
|
49477
|
+
readonly ALWAYS: "ALWAYS";
|
|
49478
|
+
readonly AUTO: "AUTO";
|
|
49479
|
+
};
|
|
49480
|
+
|
|
49481
|
+
export declare type JsonApiMemoryItemPatchAttributesStrategyEnum = (typeof JsonApiMemoryItemPatchAttributesStrategyEnum)[keyof typeof JsonApiMemoryItemPatchAttributesStrategyEnum];
|
|
49482
|
+
|
|
49483
|
+
export declare interface JsonApiMemoryItemPatchDocument {
|
|
49484
|
+
data: JsonApiMemoryItemPatch;
|
|
49485
|
+
}
|
|
49486
|
+
|
|
49487
|
+
export declare const JsonApiMemoryItemPatchTypeEnum: {
|
|
49488
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
49489
|
+
};
|
|
49490
|
+
|
|
49491
|
+
export declare type JsonApiMemoryItemPatchTypeEnum = (typeof JsonApiMemoryItemPatchTypeEnum)[keyof typeof JsonApiMemoryItemPatchTypeEnum];
|
|
49492
|
+
|
|
49493
|
+
/**
|
|
49494
|
+
* JSON:API representation of memoryItem entity.
|
|
49495
|
+
*/
|
|
49496
|
+
export declare interface JsonApiMemoryItemPostOptionalId {
|
|
49497
|
+
/**
|
|
49498
|
+
* Object type
|
|
49499
|
+
*/
|
|
49500
|
+
type: JsonApiMemoryItemPostOptionalIdTypeEnum;
|
|
49501
|
+
/**
|
|
49502
|
+
* API identifier of an object
|
|
49503
|
+
*/
|
|
49504
|
+
id?: string;
|
|
49505
|
+
attributes: JsonApiMemoryItemPostOptionalIdAttributes;
|
|
49506
|
+
}
|
|
49507
|
+
|
|
49508
|
+
export declare interface JsonApiMemoryItemPostOptionalIdAttributes {
|
|
49509
|
+
title?: string;
|
|
49510
|
+
description?: string;
|
|
49511
|
+
tags?: Array<string>;
|
|
49512
|
+
areRelationsValid?: boolean;
|
|
49513
|
+
/**
|
|
49514
|
+
* Strategy defining when the memory item should be applied
|
|
49515
|
+
*/
|
|
49516
|
+
strategy: JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum;
|
|
49517
|
+
/**
|
|
49518
|
+
* The text that will be injected into the system prompt
|
|
49519
|
+
*/
|
|
49520
|
+
instruction: string;
|
|
49521
|
+
/**
|
|
49522
|
+
* Set of unique strings used for semantic similarity filtering
|
|
49523
|
+
*/
|
|
49524
|
+
keywords?: Array<string>;
|
|
49525
|
+
/**
|
|
49526
|
+
* Whether memory item is disabled
|
|
49527
|
+
*/
|
|
49528
|
+
isDisabled?: boolean;
|
|
49529
|
+
}
|
|
49530
|
+
|
|
49531
|
+
export declare const JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum: {
|
|
49532
|
+
readonly ALWAYS: "ALWAYS";
|
|
49533
|
+
readonly AUTO: "AUTO";
|
|
49534
|
+
};
|
|
49535
|
+
|
|
49536
|
+
export declare type JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum = (typeof JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum)[keyof typeof JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum];
|
|
49537
|
+
|
|
49538
|
+
export declare interface JsonApiMemoryItemPostOptionalIdDocument {
|
|
49539
|
+
data: JsonApiMemoryItemPostOptionalId;
|
|
49540
|
+
}
|
|
49541
|
+
|
|
49542
|
+
export declare const JsonApiMemoryItemPostOptionalIdTypeEnum: {
|
|
49543
|
+
readonly MEMORY_ITEM: "memoryItem";
|
|
49544
|
+
};
|
|
49545
|
+
|
|
49546
|
+
export declare type JsonApiMemoryItemPostOptionalIdTypeEnum = (typeof JsonApiMemoryItemPostOptionalIdTypeEnum)[keyof typeof JsonApiMemoryItemPostOptionalIdTypeEnum];
|
|
49547
|
+
|
|
49548
|
+
/**
|
|
49549
|
+
* JSON:API representation of metric entity.
|
|
49550
|
+
*/
|
|
49551
|
+
export declare interface JsonApiMetricIn {
|
|
49552
|
+
/**
|
|
49553
|
+
* Object type
|
|
49554
|
+
*/
|
|
49555
|
+
type: JsonApiMetricInTypeEnum;
|
|
49556
|
+
/**
|
|
49557
|
+
* API identifier of an object
|
|
49558
|
+
*/
|
|
49559
|
+
id: string;
|
|
49560
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
48814
49561
|
}
|
|
48815
49562
|
|
|
48816
49563
|
export declare interface JsonApiMetricInDocument {
|
|
@@ -48970,7 +49717,16 @@ export declare interface JsonApiMetricPostOptionalId {
|
|
|
48970
49717
|
* API identifier of an object
|
|
48971
49718
|
*/
|
|
48972
49719
|
id?: string;
|
|
48973
|
-
attributes:
|
|
49720
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
49721
|
+
}
|
|
49722
|
+
|
|
49723
|
+
export declare interface JsonApiMetricPostOptionalIdAttributes {
|
|
49724
|
+
title?: string;
|
|
49725
|
+
description?: string;
|
|
49726
|
+
tags?: Array<string>;
|
|
49727
|
+
areRelationsValid?: boolean;
|
|
49728
|
+
content: JsonApiMetricOutAttributesContent;
|
|
49729
|
+
isHidden?: boolean;
|
|
48974
49730
|
}
|
|
48975
49731
|
|
|
48976
49732
|
export declare interface JsonApiMetricPostOptionalIdDocument {
|
|
@@ -49076,9 +49832,58 @@ export declare interface JsonApiNotificationChannelIn {
|
|
|
49076
49832
|
* API identifier of an object
|
|
49077
49833
|
*/
|
|
49078
49834
|
id: string;
|
|
49079
|
-
attributes?:
|
|
49835
|
+
attributes?: JsonApiNotificationChannelInAttributes;
|
|
49080
49836
|
}
|
|
49081
49837
|
|
|
49838
|
+
export declare interface JsonApiNotificationChannelInAttributes {
|
|
49839
|
+
name?: string | null;
|
|
49840
|
+
description?: string | null;
|
|
49841
|
+
destination?: JsonApiNotificationChannelOutAttributesDestination;
|
|
49842
|
+
/**
|
|
49843
|
+
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
49844
|
+
*/
|
|
49845
|
+
customDashboardUrl?: string;
|
|
49846
|
+
/**
|
|
49847
|
+
* Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
|
|
49848
|
+
*/
|
|
49849
|
+
dashboardLinkVisibility?: JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum;
|
|
49850
|
+
/**
|
|
49851
|
+
* Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
|
|
49852
|
+
*/
|
|
49853
|
+
notificationSource?: string;
|
|
49854
|
+
/**
|
|
49855
|
+
* Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
|
|
49856
|
+
*/
|
|
49857
|
+
allowedRecipients?: JsonApiNotificationChannelInAttributesAllowedRecipientsEnum;
|
|
49858
|
+
/**
|
|
49859
|
+
* In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
|
|
49860
|
+
*/
|
|
49861
|
+
inPlatformNotification?: JsonApiNotificationChannelInAttributesInPlatformNotificationEnum;
|
|
49862
|
+
}
|
|
49863
|
+
|
|
49864
|
+
export declare const JsonApiNotificationChannelInAttributesAllowedRecipientsEnum: {
|
|
49865
|
+
readonly CREATOR: "CREATOR";
|
|
49866
|
+
readonly INTERNAL: "INTERNAL";
|
|
49867
|
+
readonly EXTERNAL: "EXTERNAL";
|
|
49868
|
+
};
|
|
49869
|
+
|
|
49870
|
+
export declare type JsonApiNotificationChannelInAttributesAllowedRecipientsEnum = (typeof JsonApiNotificationChannelInAttributesAllowedRecipientsEnum)[keyof typeof JsonApiNotificationChannelInAttributesAllowedRecipientsEnum];
|
|
49871
|
+
|
|
49872
|
+
export declare const JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum: {
|
|
49873
|
+
readonly HIDDEN: "HIDDEN";
|
|
49874
|
+
readonly INTERNAL_ONLY: "INTERNAL_ONLY";
|
|
49875
|
+
readonly ALL: "ALL";
|
|
49876
|
+
};
|
|
49877
|
+
|
|
49878
|
+
export declare type JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum = (typeof JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum)[keyof typeof JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum];
|
|
49879
|
+
|
|
49880
|
+
export declare const JsonApiNotificationChannelInAttributesInPlatformNotificationEnum: {
|
|
49881
|
+
readonly DISABLED: "DISABLED";
|
|
49882
|
+
readonly ENABLED: "ENABLED";
|
|
49883
|
+
};
|
|
49884
|
+
|
|
49885
|
+
export declare type JsonApiNotificationChannelInAttributesInPlatformNotificationEnum = (typeof JsonApiNotificationChannelInAttributesInPlatformNotificationEnum)[keyof typeof JsonApiNotificationChannelInAttributesInPlatformNotificationEnum];
|
|
49886
|
+
|
|
49082
49887
|
export declare interface JsonApiNotificationChannelInDocument {
|
|
49083
49888
|
data: JsonApiNotificationChannelIn;
|
|
49084
49889
|
}
|
|
@@ -49234,7 +50039,7 @@ export declare interface JsonApiNotificationChannelPatch {
|
|
|
49234
50039
|
* API identifier of an object
|
|
49235
50040
|
*/
|
|
49236
50041
|
id: string;
|
|
49237
|
-
attributes?:
|
|
50042
|
+
attributes?: JsonApiNotificationChannelInAttributes;
|
|
49238
50043
|
}
|
|
49239
50044
|
|
|
49240
50045
|
export declare interface JsonApiNotificationChannelPatchDocument {
|
|
@@ -49259,58 +50064,9 @@ export declare interface JsonApiNotificationChannelPostOptionalId {
|
|
|
49259
50064
|
* API identifier of an object
|
|
49260
50065
|
*/
|
|
49261
50066
|
id?: string;
|
|
49262
|
-
attributes?:
|
|
50067
|
+
attributes?: JsonApiNotificationChannelInAttributes;
|
|
49263
50068
|
}
|
|
49264
50069
|
|
|
49265
|
-
export declare interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
49266
|
-
name?: string | null;
|
|
49267
|
-
description?: string | null;
|
|
49268
|
-
destination?: JsonApiNotificationChannelOutAttributesDestination;
|
|
49269
|
-
/**
|
|
49270
|
-
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
49271
|
-
*/
|
|
49272
|
-
customDashboardUrl?: string;
|
|
49273
|
-
/**
|
|
49274
|
-
* Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
|
|
49275
|
-
*/
|
|
49276
|
-
dashboardLinkVisibility?: JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum;
|
|
49277
|
-
/**
|
|
49278
|
-
* Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
|
|
49279
|
-
*/
|
|
49280
|
-
notificationSource?: string;
|
|
49281
|
-
/**
|
|
49282
|
-
* Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
|
|
49283
|
-
*/
|
|
49284
|
-
allowedRecipients?: JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum;
|
|
49285
|
-
/**
|
|
49286
|
-
* In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
|
|
49287
|
-
*/
|
|
49288
|
-
inPlatformNotification?: JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum;
|
|
49289
|
-
}
|
|
49290
|
-
|
|
49291
|
-
export declare const JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum: {
|
|
49292
|
-
readonly CREATOR: "CREATOR";
|
|
49293
|
-
readonly INTERNAL: "INTERNAL";
|
|
49294
|
-
readonly EXTERNAL: "EXTERNAL";
|
|
49295
|
-
};
|
|
49296
|
-
|
|
49297
|
-
export declare type JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum = (typeof JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum)[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum];
|
|
49298
|
-
|
|
49299
|
-
export declare const JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum: {
|
|
49300
|
-
readonly HIDDEN: "HIDDEN";
|
|
49301
|
-
readonly INTERNAL_ONLY: "INTERNAL_ONLY";
|
|
49302
|
-
readonly ALL: "ALL";
|
|
49303
|
-
};
|
|
49304
|
-
|
|
49305
|
-
export declare type JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum = (typeof JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum)[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum];
|
|
49306
|
-
|
|
49307
|
-
export declare const JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum: {
|
|
49308
|
-
readonly DISABLED: "DISABLED";
|
|
49309
|
-
readonly ENABLED: "ENABLED";
|
|
49310
|
-
};
|
|
49311
|
-
|
|
49312
|
-
export declare type JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum = (typeof JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum)[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum];
|
|
49313
|
-
|
|
49314
50070
|
export declare interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
49315
50071
|
data: JsonApiNotificationChannelPostOptionalId;
|
|
49316
50072
|
}
|
|
@@ -49333,14 +50089,37 @@ export declare interface JsonApiOrganizationIn {
|
|
|
49333
50089
|
* API identifier of an object
|
|
49334
50090
|
*/
|
|
49335
50091
|
id: string;
|
|
49336
|
-
attributes?:
|
|
49337
|
-
relationships?:
|
|
50092
|
+
attributes?: JsonApiOrganizationInAttributes;
|
|
50093
|
+
relationships?: JsonApiOrganizationInRelationships;
|
|
50094
|
+
}
|
|
50095
|
+
|
|
50096
|
+
export declare interface JsonApiOrganizationInAttributes {
|
|
50097
|
+
name?: string | null;
|
|
50098
|
+
hostname?: string;
|
|
50099
|
+
allowedOrigins?: Array<string>;
|
|
50100
|
+
/**
|
|
50101
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
50102
|
+
* @deprecated
|
|
50103
|
+
*/
|
|
50104
|
+
earlyAccess?: string | null;
|
|
50105
|
+
/**
|
|
50106
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
50107
|
+
*/
|
|
50108
|
+
earlyAccessValues?: Array<string> | null;
|
|
49338
50109
|
}
|
|
49339
50110
|
|
|
49340
50111
|
export declare interface JsonApiOrganizationInDocument {
|
|
49341
50112
|
data: JsonApiOrganizationIn;
|
|
49342
50113
|
}
|
|
49343
50114
|
|
|
50115
|
+
export declare interface JsonApiOrganizationInRelationships {
|
|
50116
|
+
identityProvider?: JsonApiOrganizationInRelationshipsIdentityProvider;
|
|
50117
|
+
}
|
|
50118
|
+
|
|
50119
|
+
export declare interface JsonApiOrganizationInRelationshipsIdentityProvider {
|
|
50120
|
+
data: JsonApiIdentityProviderLinkage | null;
|
|
50121
|
+
}
|
|
50122
|
+
|
|
49344
50123
|
export declare const JsonApiOrganizationInTypeEnum: {
|
|
49345
50124
|
readonly ORGANIZATION: "organization";
|
|
49346
50125
|
};
|
|
@@ -49423,7 +50202,7 @@ export declare type JsonApiOrganizationOutMetaPermissionsEnum = (typeof JsonApiO
|
|
|
49423
50202
|
export declare interface JsonApiOrganizationOutRelationships {
|
|
49424
50203
|
bootstrapUser?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
49425
50204
|
bootstrapUserGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
49426
|
-
identityProvider?:
|
|
50205
|
+
identityProvider?: JsonApiOrganizationInRelationshipsIdentityProvider;
|
|
49427
50206
|
}
|
|
49428
50207
|
|
|
49429
50208
|
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
@@ -49452,37 +50231,14 @@ export declare interface JsonApiOrganizationPatch {
|
|
|
49452
50231
|
* API identifier of an object
|
|
49453
50232
|
*/
|
|
49454
50233
|
id: string;
|
|
49455
|
-
attributes?:
|
|
49456
|
-
relationships?:
|
|
49457
|
-
}
|
|
49458
|
-
|
|
49459
|
-
export declare interface JsonApiOrganizationPatchAttributes {
|
|
49460
|
-
name?: string | null;
|
|
49461
|
-
hostname?: string;
|
|
49462
|
-
allowedOrigins?: Array<string>;
|
|
49463
|
-
/**
|
|
49464
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
49465
|
-
* @deprecated
|
|
49466
|
-
*/
|
|
49467
|
-
earlyAccess?: string | null;
|
|
49468
|
-
/**
|
|
49469
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
49470
|
-
*/
|
|
49471
|
-
earlyAccessValues?: Array<string> | null;
|
|
50234
|
+
attributes?: JsonApiOrganizationInAttributes;
|
|
50235
|
+
relationships?: JsonApiOrganizationInRelationships;
|
|
49472
50236
|
}
|
|
49473
50237
|
|
|
49474
50238
|
export declare interface JsonApiOrganizationPatchDocument {
|
|
49475
50239
|
data: JsonApiOrganizationPatch;
|
|
49476
50240
|
}
|
|
49477
50241
|
|
|
49478
|
-
export declare interface JsonApiOrganizationPatchRelationships {
|
|
49479
|
-
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
49480
|
-
}
|
|
49481
|
-
|
|
49482
|
-
export declare interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
49483
|
-
data: JsonApiIdentityProviderLinkage | null;
|
|
49484
|
-
}
|
|
49485
|
-
|
|
49486
50242
|
export declare const JsonApiOrganizationPatchTypeEnum: {
|
|
49487
50243
|
readonly ORGANIZATION: "organization";
|
|
49488
50244
|
};
|
|
@@ -49754,8 +50510,8 @@ export declare interface JsonApiUserDataFilterIn {
|
|
|
49754
50510
|
* API identifier of an object
|
|
49755
50511
|
*/
|
|
49756
50512
|
id: string;
|
|
49757
|
-
attributes:
|
|
49758
|
-
relationships?:
|
|
50513
|
+
attributes: JsonApiUserDataFilterPostOptionalIdAttributes;
|
|
50514
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
49759
50515
|
}
|
|
49760
50516
|
|
|
49761
50517
|
export declare interface JsonApiUserDataFilterInDocument {
|
|
@@ -49781,18 +50537,10 @@ export declare interface JsonApiUserDataFilterOut {
|
|
|
49781
50537
|
*/
|
|
49782
50538
|
id: string;
|
|
49783
50539
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
49784
|
-
attributes:
|
|
50540
|
+
attributes: JsonApiUserDataFilterPostOptionalIdAttributes;
|
|
49785
50541
|
relationships?: JsonApiUserDataFilterOutRelationships;
|
|
49786
50542
|
}
|
|
49787
50543
|
|
|
49788
|
-
export declare interface JsonApiUserDataFilterOutAttributes {
|
|
49789
|
-
title?: string;
|
|
49790
|
-
description?: string;
|
|
49791
|
-
tags?: Array<string>;
|
|
49792
|
-
areRelationsValid?: boolean;
|
|
49793
|
-
maql: string;
|
|
49794
|
-
}
|
|
49795
|
-
|
|
49796
50544
|
export declare interface JsonApiUserDataFilterOutDocument {
|
|
49797
50545
|
data: JsonApiUserDataFilterOut;
|
|
49798
50546
|
links?: ObjectLinks;
|
|
@@ -49846,7 +50594,7 @@ export declare interface JsonApiUserDataFilterOutWithLinks {
|
|
|
49846
50594
|
*/
|
|
49847
50595
|
id: string;
|
|
49848
50596
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
49849
|
-
attributes:
|
|
50597
|
+
attributes: JsonApiUserDataFilterPostOptionalIdAttributes;
|
|
49850
50598
|
relationships?: JsonApiUserDataFilterOutRelationships;
|
|
49851
50599
|
links?: ObjectLinks;
|
|
49852
50600
|
}
|
|
@@ -49870,7 +50618,7 @@ export declare interface JsonApiUserDataFilterPatch {
|
|
|
49870
50618
|
*/
|
|
49871
50619
|
id: string;
|
|
49872
50620
|
attributes: JsonApiUserDataFilterPatchAttributes;
|
|
49873
|
-
relationships?:
|
|
50621
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
49874
50622
|
}
|
|
49875
50623
|
|
|
49876
50624
|
export declare interface JsonApiUserDataFilterPatchAttributes {
|
|
@@ -49885,11 +50633,6 @@ export declare interface JsonApiUserDataFilterPatchDocument {
|
|
|
49885
50633
|
data: JsonApiUserDataFilterPatch;
|
|
49886
50634
|
}
|
|
49887
50635
|
|
|
49888
|
-
export declare interface JsonApiUserDataFilterPatchRelationships {
|
|
49889
|
-
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
49890
|
-
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
49891
|
-
}
|
|
49892
|
-
|
|
49893
50636
|
export declare const JsonApiUserDataFilterPatchTypeEnum: {
|
|
49894
50637
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
49895
50638
|
};
|
|
@@ -49908,14 +50651,27 @@ export declare interface JsonApiUserDataFilterPostOptionalId {
|
|
|
49908
50651
|
* API identifier of an object
|
|
49909
50652
|
*/
|
|
49910
50653
|
id?: string;
|
|
49911
|
-
attributes:
|
|
49912
|
-
relationships?:
|
|
50654
|
+
attributes: JsonApiUserDataFilterPostOptionalIdAttributes;
|
|
50655
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
50656
|
+
}
|
|
50657
|
+
|
|
50658
|
+
export declare interface JsonApiUserDataFilterPostOptionalIdAttributes {
|
|
50659
|
+
title?: string;
|
|
50660
|
+
description?: string;
|
|
50661
|
+
tags?: Array<string>;
|
|
50662
|
+
areRelationsValid?: boolean;
|
|
50663
|
+
maql: string;
|
|
49913
50664
|
}
|
|
49914
50665
|
|
|
49915
50666
|
export declare interface JsonApiUserDataFilterPostOptionalIdDocument {
|
|
49916
50667
|
data: JsonApiUserDataFilterPostOptionalId;
|
|
49917
50668
|
}
|
|
49918
50669
|
|
|
50670
|
+
export declare interface JsonApiUserDataFilterPostOptionalIdRelationships {
|
|
50671
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
50672
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
50673
|
+
}
|
|
50674
|
+
|
|
49919
50675
|
export declare const JsonApiUserDataFilterPostOptionalIdTypeEnum: {
|
|
49920
50676
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
49921
50677
|
};
|
|
@@ -50373,19 +51129,7 @@ export declare interface JsonApiVisualizationObjectIn {
|
|
|
50373
51129
|
* API identifier of an object
|
|
50374
51130
|
*/
|
|
50375
51131
|
id: string;
|
|
50376
|
-
attributes:
|
|
50377
|
-
}
|
|
50378
|
-
|
|
50379
|
-
export declare interface JsonApiVisualizationObjectInAttributes {
|
|
50380
|
-
title?: string;
|
|
50381
|
-
description?: string;
|
|
50382
|
-
tags?: Array<string>;
|
|
50383
|
-
areRelationsValid?: boolean;
|
|
50384
|
-
/**
|
|
50385
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
50386
|
-
*/
|
|
50387
|
-
content: object;
|
|
50388
|
-
isHidden?: boolean;
|
|
51132
|
+
attributes: JsonApiVisualizationObjectPostOptionalIdAttributes;
|
|
50389
51133
|
}
|
|
50390
51134
|
|
|
50391
51135
|
export declare interface JsonApiVisualizationObjectInDocument {
|
|
@@ -50612,7 +51356,19 @@ export declare interface JsonApiVisualizationObjectPostOptionalId {
|
|
|
50612
51356
|
* API identifier of an object
|
|
50613
51357
|
*/
|
|
50614
51358
|
id?: string;
|
|
50615
|
-
attributes:
|
|
51359
|
+
attributes: JsonApiVisualizationObjectPostOptionalIdAttributes;
|
|
51360
|
+
}
|
|
51361
|
+
|
|
51362
|
+
export declare interface JsonApiVisualizationObjectPostOptionalIdAttributes {
|
|
51363
|
+
title?: string;
|
|
51364
|
+
description?: string;
|
|
51365
|
+
tags?: Array<string>;
|
|
51366
|
+
areRelationsValid?: boolean;
|
|
51367
|
+
/**
|
|
51368
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
51369
|
+
*/
|
|
51370
|
+
content: object;
|
|
51371
|
+
isHidden?: boolean;
|
|
50616
51372
|
}
|
|
50617
51373
|
|
|
50618
51374
|
export declare interface JsonApiVisualizationObjectPostOptionalIdDocument {
|
|
@@ -50661,12 +51417,12 @@ export declare interface JsonApiWorkspaceAutomationOutList {
|
|
|
50661
51417
|
|
|
50662
51418
|
export declare interface JsonApiWorkspaceAutomationOutRelationships {
|
|
50663
51419
|
workspace?: JsonApiWorkspaceOutRelationshipsParent;
|
|
50664
|
-
notificationChannel?:
|
|
50665
|
-
analyticalDashboard?:
|
|
51420
|
+
notificationChannel?: JsonApiAutomationInRelationshipsNotificationChannel;
|
|
51421
|
+
analyticalDashboard?: JsonApiAutomationInRelationshipsAnalyticalDashboard;
|
|
50666
51422
|
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
50667
51423
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
50668
|
-
exportDefinitions?:
|
|
50669
|
-
recipients?:
|
|
51424
|
+
exportDefinitions?: JsonApiAutomationInRelationshipsExportDefinitions;
|
|
51425
|
+
recipients?: JsonApiAutomationInRelationshipsRecipients;
|
|
50670
51426
|
automationResults?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
50671
51427
|
}
|
|
50672
51428
|
|
|
@@ -50857,14 +51613,28 @@ export declare interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
50857
51613
|
* API identifier of an object
|
|
50858
51614
|
*/
|
|
50859
51615
|
id: string;
|
|
50860
|
-
attributes?:
|
|
50861
|
-
relationships?:
|
|
51616
|
+
attributes?: JsonApiWorkspaceDataFilterSettingInAttributes;
|
|
51617
|
+
relationships?: JsonApiWorkspaceDataFilterSettingInRelationships;
|
|
51618
|
+
}
|
|
51619
|
+
|
|
51620
|
+
export declare interface JsonApiWorkspaceDataFilterSettingInAttributes {
|
|
51621
|
+
title?: string;
|
|
51622
|
+
description?: string;
|
|
51623
|
+
filterValues?: Array<string>;
|
|
50862
51624
|
}
|
|
50863
51625
|
|
|
50864
51626
|
export declare interface JsonApiWorkspaceDataFilterSettingInDocument {
|
|
50865
51627
|
data: JsonApiWorkspaceDataFilterSettingIn;
|
|
50866
51628
|
}
|
|
50867
51629
|
|
|
51630
|
+
export declare interface JsonApiWorkspaceDataFilterSettingInRelationships {
|
|
51631
|
+
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter;
|
|
51632
|
+
}
|
|
51633
|
+
|
|
51634
|
+
export declare interface JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter {
|
|
51635
|
+
data: JsonApiWorkspaceDataFilterLinkage | null;
|
|
51636
|
+
}
|
|
51637
|
+
|
|
50868
51638
|
export declare const JsonApiWorkspaceDataFilterSettingInTypeEnum: {
|
|
50869
51639
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
50870
51640
|
};
|
|
@@ -50898,8 +51668,8 @@ export declare interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
50898
51668
|
*/
|
|
50899
51669
|
id: string;
|
|
50900
51670
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
50901
|
-
attributes?:
|
|
50902
|
-
relationships?:
|
|
51671
|
+
attributes?: JsonApiWorkspaceDataFilterSettingInAttributes;
|
|
51672
|
+
relationships?: JsonApiWorkspaceDataFilterSettingInRelationships;
|
|
50903
51673
|
}
|
|
50904
51674
|
|
|
50905
51675
|
export declare interface JsonApiWorkspaceDataFilterSettingOutDocument {
|
|
@@ -50940,8 +51710,8 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
50940
51710
|
*/
|
|
50941
51711
|
id: string;
|
|
50942
51712
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
50943
|
-
attributes?:
|
|
50944
|
-
relationships?:
|
|
51713
|
+
attributes?: JsonApiWorkspaceDataFilterSettingInAttributes;
|
|
51714
|
+
relationships?: JsonApiWorkspaceDataFilterSettingInRelationships;
|
|
50945
51715
|
links?: ObjectLinks;
|
|
50946
51716
|
}
|
|
50947
51717
|
|
|
@@ -50963,28 +51733,14 @@ export declare interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
50963
51733
|
* API identifier of an object
|
|
50964
51734
|
*/
|
|
50965
51735
|
id: string;
|
|
50966
|
-
attributes?:
|
|
50967
|
-
relationships?:
|
|
50968
|
-
}
|
|
50969
|
-
|
|
50970
|
-
export declare interface JsonApiWorkspaceDataFilterSettingPatchAttributes {
|
|
50971
|
-
title?: string;
|
|
50972
|
-
description?: string;
|
|
50973
|
-
filterValues?: Array<string>;
|
|
51736
|
+
attributes?: JsonApiWorkspaceDataFilterSettingInAttributes;
|
|
51737
|
+
relationships?: JsonApiWorkspaceDataFilterSettingInRelationships;
|
|
50974
51738
|
}
|
|
50975
51739
|
|
|
50976
51740
|
export declare interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
50977
51741
|
data: JsonApiWorkspaceDataFilterSettingPatch;
|
|
50978
51742
|
}
|
|
50979
51743
|
|
|
50980
|
-
export declare interface JsonApiWorkspaceDataFilterSettingPatchRelationships {
|
|
50981
|
-
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter;
|
|
50982
|
-
}
|
|
50983
|
-
|
|
50984
|
-
export declare interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter {
|
|
50985
|
-
data: JsonApiWorkspaceDataFilterLinkage | null;
|
|
50986
|
-
}
|
|
50987
|
-
|
|
50988
51744
|
export declare const JsonApiWorkspaceDataFilterSettingPatchTypeEnum: {
|
|
50989
51745
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
50990
51746
|
};
|
|
@@ -68339,6 +69095,10 @@ export declare interface ScanApiSqlColumn {
|
|
|
68339
69095
|
* Column type
|
|
68340
69096
|
*/
|
|
68341
69097
|
dataType: ScanApiSqlColumnDataTypeEnum;
|
|
69098
|
+
/**
|
|
69099
|
+
* Column description/comment from database
|
|
69100
|
+
*/
|
|
69101
|
+
description?: string;
|
|
68342
69102
|
}
|
|
68343
69103
|
|
|
68344
69104
|
export declare const ScanApiSqlColumnDataTypeEnum: {
|
|
@@ -68522,6 +69282,10 @@ export declare interface ScanModelDeclarativeColumn {
|
|
|
68522
69282
|
* Referenced table (Foreign key)
|
|
68523
69283
|
*/
|
|
68524
69284
|
referencedTableColumn?: string;
|
|
69285
|
+
/**
|
|
69286
|
+
* Column description
|
|
69287
|
+
*/
|
|
69288
|
+
description?: string;
|
|
68525
69289
|
}
|
|
68526
69290
|
|
|
68527
69291
|
export declare const ScanModelDeclarativeColumnDataTypeEnum: {
|
|
@@ -75371,6 +76135,14 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
75371
76135
|
* @memberof WorkspaceObjectControllerApi
|
|
75372
76136
|
*/
|
|
75373
76137
|
createEntityFilterViews(requestParameters: WorkspaceObjectControllerApiCreateEntityFilterViewsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiFilterViewOutDocument, any, {}>>;
|
|
76138
|
+
/**
|
|
76139
|
+
*
|
|
76140
|
+
* @param {WorkspaceObjectControllerApiCreateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
76141
|
+
* @param {*} [options] Override http request option.
|
|
76142
|
+
* @throws {RequiredError}
|
|
76143
|
+
* @memberof WorkspaceObjectControllerApi
|
|
76144
|
+
*/
|
|
76145
|
+
createEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiCreateEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutDocument, any, {}>>;
|
|
75374
76146
|
/**
|
|
75375
76147
|
*
|
|
75376
76148
|
* @summary Post Metrics
|
|
@@ -75497,6 +76269,14 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
75497
76269
|
* @memberof WorkspaceObjectControllerApi
|
|
75498
76270
|
*/
|
|
75499
76271
|
deleteEntityFilterViews(requestParameters: WorkspaceObjectControllerApiDeleteEntityFilterViewsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any, {}>>;
|
|
76272
|
+
/**
|
|
76273
|
+
*
|
|
76274
|
+
* @param {WorkspaceObjectControllerApiDeleteEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
76275
|
+
* @param {*} [options] Override http request option.
|
|
76276
|
+
* @throws {RequiredError}
|
|
76277
|
+
* @memberof WorkspaceObjectControllerApi
|
|
76278
|
+
*/
|
|
76279
|
+
deleteEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiDeleteEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any, {}>>;
|
|
75500
76280
|
/**
|
|
75501
76281
|
*
|
|
75502
76282
|
* @summary Delete a Metric
|
|
@@ -75667,6 +76447,14 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
75667
76447
|
* @memberof WorkspaceObjectControllerApi
|
|
75668
76448
|
*/
|
|
75669
76449
|
getAllEntitiesLabels(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesLabelsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiLabelOutList, any, {}>>;
|
|
76450
|
+
/**
|
|
76451
|
+
*
|
|
76452
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesMemoryItemsRequest} requestParameters Request parameters.
|
|
76453
|
+
* @param {*} [options] Override http request option.
|
|
76454
|
+
* @throws {RequiredError}
|
|
76455
|
+
* @memberof WorkspaceObjectControllerApi
|
|
76456
|
+
*/
|
|
76457
|
+
getAllEntitiesMemoryItems(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutList, any, {}>>;
|
|
75670
76458
|
/**
|
|
75671
76459
|
*
|
|
75672
76460
|
* @summary Get all Metrics
|
|
@@ -75837,6 +76625,14 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
75837
76625
|
* @memberof WorkspaceObjectControllerApi
|
|
75838
76626
|
*/
|
|
75839
76627
|
getEntityLabels(requestParameters: WorkspaceObjectControllerApiGetEntityLabelsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiLabelOutDocument, any, {}>>;
|
|
76628
|
+
/**
|
|
76629
|
+
*
|
|
76630
|
+
* @param {WorkspaceObjectControllerApiGetEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
76631
|
+
* @param {*} [options] Override http request option.
|
|
76632
|
+
* @throws {RequiredError}
|
|
76633
|
+
* @memberof WorkspaceObjectControllerApi
|
|
76634
|
+
*/
|
|
76635
|
+
getEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiGetEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutDocument, any, {}>>;
|
|
75840
76636
|
/**
|
|
75841
76637
|
*
|
|
75842
76638
|
* @summary Get a Metric
|
|
@@ -75963,6 +76759,14 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
75963
76759
|
* @memberof WorkspaceObjectControllerApi
|
|
75964
76760
|
*/
|
|
75965
76761
|
patchEntityFilterViews(requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiFilterViewOutDocument, any, {}>>;
|
|
76762
|
+
/**
|
|
76763
|
+
*
|
|
76764
|
+
* @param {WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
76765
|
+
* @param {*} [options] Override http request option.
|
|
76766
|
+
* @throws {RequiredError}
|
|
76767
|
+
* @memberof WorkspaceObjectControllerApi
|
|
76768
|
+
*/
|
|
76769
|
+
patchEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutDocument, any, {}>>;
|
|
75966
76770
|
/**
|
|
75967
76771
|
*
|
|
75968
76772
|
* @summary Patch a Metric
|
|
@@ -76089,6 +76893,14 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
76089
76893
|
* @memberof WorkspaceObjectControllerApi
|
|
76090
76894
|
*/
|
|
76091
76895
|
updateEntityFilterViews(requestParameters: WorkspaceObjectControllerApiUpdateEntityFilterViewsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiFilterViewOutDocument, any, {}>>;
|
|
76896
|
+
/**
|
|
76897
|
+
*
|
|
76898
|
+
* @param {WorkspaceObjectControllerApiUpdateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
76899
|
+
* @param {*} [options] Override http request option.
|
|
76900
|
+
* @throws {RequiredError}
|
|
76901
|
+
* @memberof WorkspaceObjectControllerApi
|
|
76902
|
+
*/
|
|
76903
|
+
updateEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiUpdateEntityMemoryItemsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiMemoryItemOutDocument, any, {}>>;
|
|
76092
76904
|
/**
|
|
76093
76905
|
*
|
|
76094
76906
|
* @summary Put a Metric
|
|
@@ -76236,6 +77048,16 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
76236
77048
|
* @throws {RequiredError}
|
|
76237
77049
|
*/
|
|
76238
77050
|
createEntityFilterViews: (workspaceId: string, jsonApiFilterViewInDocument: JsonApiFilterViewInDocument, include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
77051
|
+
/**
|
|
77052
|
+
*
|
|
77053
|
+
* @param {string} workspaceId
|
|
77054
|
+
* @param {JsonApiMemoryItemPostOptionalIdDocument} jsonApiMemoryItemPostOptionalIdDocument
|
|
77055
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
77056
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
77057
|
+
* @param {*} [options] Override http request option.
|
|
77058
|
+
* @throws {RequiredError}
|
|
77059
|
+
*/
|
|
77060
|
+
createEntityMemoryItems: (workspaceId: string, jsonApiMemoryItemPostOptionalIdDocument: JsonApiMemoryItemPostOptionalIdDocument, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
76239
77061
|
/**
|
|
76240
77062
|
*
|
|
76241
77063
|
* @summary Post Metrics
|
|
@@ -76381,6 +77203,15 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
76381
77203
|
* @throws {RequiredError}
|
|
76382
77204
|
*/
|
|
76383
77205
|
deleteEntityFilterViews: (workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
77206
|
+
/**
|
|
77207
|
+
*
|
|
77208
|
+
* @param {string} workspaceId
|
|
77209
|
+
* @param {string} objectId
|
|
77210
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
77211
|
+
* @param {*} [options] Override http request option.
|
|
77212
|
+
* @throws {RequiredError}
|
|
77213
|
+
*/
|
|
77214
|
+
deleteEntityMemoryItems: (workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
76384
77215
|
/**
|
|
76385
77216
|
*
|
|
76386
77217
|
* @summary Delete a Metric
|
|
@@ -76647,6 +77478,21 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
76647
77478
|
* @throws {RequiredError}
|
|
76648
77479
|
*/
|
|
76649
77480
|
getAllEntitiesLabels: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
77481
|
+
/**
|
|
77482
|
+
*
|
|
77483
|
+
* @param {string} workspaceId
|
|
77484
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
77485
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
77486
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
77487
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
77488
|
+
* @param {number} [size] The size of the page to be returned
|
|
77489
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
77490
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
77491
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
77492
|
+
* @param {*} [options] Override http request option.
|
|
77493
|
+
* @throws {RequiredError}
|
|
77494
|
+
*/
|
|
77495
|
+
getAllEntitiesMemoryItems: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
76650
77496
|
/**
|
|
76651
77497
|
*
|
|
76652
77498
|
* @summary Get all Metrics
|
|
@@ -76908,6 +77754,18 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
76908
77754
|
* @throws {RequiredError}
|
|
76909
77755
|
*/
|
|
76910
77756
|
getEntityLabels: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
77757
|
+
/**
|
|
77758
|
+
*
|
|
77759
|
+
* @param {string} workspaceId
|
|
77760
|
+
* @param {string} objectId
|
|
77761
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
77762
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
77763
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
77764
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
77765
|
+
* @param {*} [options] Override http request option.
|
|
77766
|
+
* @throws {RequiredError}
|
|
77767
|
+
*/
|
|
77768
|
+
getEntityMemoryItems: (workspaceId: string, objectId: string, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
76911
77769
|
/**
|
|
76912
77770
|
*
|
|
76913
77771
|
* @summary Get a Metric
|
|
@@ -77080,6 +77938,17 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
77080
77938
|
* @throws {RequiredError}
|
|
77081
77939
|
*/
|
|
77082
77940
|
patchEntityFilterViews: (workspaceId: string, objectId: string, jsonApiFilterViewPatchDocument: JsonApiFilterViewPatchDocument, filter?: string, include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
77941
|
+
/**
|
|
77942
|
+
*
|
|
77943
|
+
* @param {string} workspaceId
|
|
77944
|
+
* @param {string} objectId
|
|
77945
|
+
* @param {JsonApiMemoryItemPatchDocument} jsonApiMemoryItemPatchDocument
|
|
77946
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
77947
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
77948
|
+
* @param {*} [options] Override http request option.
|
|
77949
|
+
* @throws {RequiredError}
|
|
77950
|
+
*/
|
|
77951
|
+
patchEntityMemoryItems: (workspaceId: string, objectId: string, jsonApiMemoryItemPatchDocument: JsonApiMemoryItemPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
77083
77952
|
/**
|
|
77084
77953
|
*
|
|
77085
77954
|
* @summary Patch a Metric
|
|
@@ -77246,6 +78115,17 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
77246
78115
|
* @throws {RequiredError}
|
|
77247
78116
|
*/
|
|
77248
78117
|
updateEntityFilterViews: (workspaceId: string, objectId: string, jsonApiFilterViewInDocument: JsonApiFilterViewInDocument, filter?: string, include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
78118
|
+
/**
|
|
78119
|
+
*
|
|
78120
|
+
* @param {string} workspaceId
|
|
78121
|
+
* @param {string} objectId
|
|
78122
|
+
* @param {JsonApiMemoryItemInDocument} jsonApiMemoryItemInDocument
|
|
78123
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
78124
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
78125
|
+
* @param {*} [options] Override http request option.
|
|
78126
|
+
* @throws {RequiredError}
|
|
78127
|
+
*/
|
|
78128
|
+
updateEntityMemoryItems: (workspaceId: string, objectId: string, jsonApiMemoryItemInDocument: JsonApiMemoryItemInDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
77249
78129
|
/**
|
|
77250
78130
|
*
|
|
77251
78131
|
* @summary Put a Metric
|
|
@@ -77563,6 +78443,38 @@ export declare interface WorkspaceObjectControllerApiCreateEntityFilterViewsRequ
|
|
|
77563
78443
|
readonly include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">;
|
|
77564
78444
|
}
|
|
77565
78445
|
|
|
78446
|
+
/**
|
|
78447
|
+
* Request parameters for createEntityMemoryItems operation in WorkspaceObjectControllerApi.
|
|
78448
|
+
* @export
|
|
78449
|
+
* @interface WorkspaceObjectControllerApiCreateEntityMemoryItemsRequest
|
|
78450
|
+
*/
|
|
78451
|
+
export declare interface WorkspaceObjectControllerApiCreateEntityMemoryItemsRequest {
|
|
78452
|
+
/**
|
|
78453
|
+
*
|
|
78454
|
+
* @type {string}
|
|
78455
|
+
* @memberof WorkspaceObjectControllerApiCreateEntityMemoryItems
|
|
78456
|
+
*/
|
|
78457
|
+
readonly workspaceId: string;
|
|
78458
|
+
/**
|
|
78459
|
+
*
|
|
78460
|
+
* @type {JsonApiMemoryItemPostOptionalIdDocument}
|
|
78461
|
+
* @memberof WorkspaceObjectControllerApiCreateEntityMemoryItems
|
|
78462
|
+
*/
|
|
78463
|
+
readonly jsonApiMemoryItemPostOptionalIdDocument: JsonApiMemoryItemPostOptionalIdDocument;
|
|
78464
|
+
/**
|
|
78465
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
78466
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
78467
|
+
* @memberof WorkspaceObjectControllerApiCreateEntityMemoryItems
|
|
78468
|
+
*/
|
|
78469
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
78470
|
+
/**
|
|
78471
|
+
* Include Meta objects.
|
|
78472
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
78473
|
+
* @memberof WorkspaceObjectControllerApiCreateEntityMemoryItems
|
|
78474
|
+
*/
|
|
78475
|
+
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
78476
|
+
}
|
|
78477
|
+
|
|
77566
78478
|
/**
|
|
77567
78479
|
* Request parameters for createEntityMetrics operation in WorkspaceObjectControllerApi.
|
|
77568
78480
|
* @export
|
|
@@ -77957,6 +78869,32 @@ export declare interface WorkspaceObjectControllerApiDeleteEntityFilterViewsRequ
|
|
|
77957
78869
|
readonly filter?: string;
|
|
77958
78870
|
}
|
|
77959
78871
|
|
|
78872
|
+
/**
|
|
78873
|
+
* Request parameters for deleteEntityMemoryItems operation in WorkspaceObjectControllerApi.
|
|
78874
|
+
* @export
|
|
78875
|
+
* @interface WorkspaceObjectControllerApiDeleteEntityMemoryItemsRequest
|
|
78876
|
+
*/
|
|
78877
|
+
export declare interface WorkspaceObjectControllerApiDeleteEntityMemoryItemsRequest {
|
|
78878
|
+
/**
|
|
78879
|
+
*
|
|
78880
|
+
* @type {string}
|
|
78881
|
+
* @memberof WorkspaceObjectControllerApiDeleteEntityMemoryItems
|
|
78882
|
+
*/
|
|
78883
|
+
readonly workspaceId: string;
|
|
78884
|
+
/**
|
|
78885
|
+
*
|
|
78886
|
+
* @type {string}
|
|
78887
|
+
* @memberof WorkspaceObjectControllerApiDeleteEntityMemoryItems
|
|
78888
|
+
*/
|
|
78889
|
+
readonly objectId: string;
|
|
78890
|
+
/**
|
|
78891
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
78892
|
+
* @type {string}
|
|
78893
|
+
* @memberof WorkspaceObjectControllerApiDeleteEntityMemoryItems
|
|
78894
|
+
*/
|
|
78895
|
+
readonly filter?: string;
|
|
78896
|
+
}
|
|
78897
|
+
|
|
77960
78898
|
/**
|
|
77961
78899
|
* Request parameters for deleteEntityMetrics operation in WorkspaceObjectControllerApi.
|
|
77962
78900
|
* @export
|
|
@@ -78182,6 +79120,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Metad
|
|
|
78182
79120
|
* @throws {RequiredError}
|
|
78183
79121
|
*/
|
|
78184
79122
|
createEntityFilterViews(requestParameters: WorkspaceObjectControllerApiCreateEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
79123
|
+
/**
|
|
79124
|
+
*
|
|
79125
|
+
* @param {WorkspaceObjectControllerApiCreateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
79126
|
+
* @param {*} [options] Override http request option.
|
|
79127
|
+
* @throws {RequiredError}
|
|
79128
|
+
*/
|
|
79129
|
+
createEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiCreateEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
78185
79130
|
/**
|
|
78186
79131
|
*
|
|
78187
79132
|
* @summary Post Metrics
|
|
@@ -78294,6 +79239,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Metad
|
|
|
78294
79239
|
* @throws {RequiredError}
|
|
78295
79240
|
*/
|
|
78296
79241
|
deleteEntityFilterViews(requestParameters: WorkspaceObjectControllerApiDeleteEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
79242
|
+
/**
|
|
79243
|
+
*
|
|
79244
|
+
* @param {WorkspaceObjectControllerApiDeleteEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
79245
|
+
* @param {*} [options] Override http request option.
|
|
79246
|
+
* @throws {RequiredError}
|
|
79247
|
+
*/
|
|
79248
|
+
deleteEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiDeleteEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
78297
79249
|
/**
|
|
78298
79250
|
*
|
|
78299
79251
|
* @summary Delete a Metric
|
|
@@ -78445,6 +79397,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Metad
|
|
|
78445
79397
|
* @throws {RequiredError}
|
|
78446
79398
|
*/
|
|
78447
79399
|
getAllEntitiesLabels(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutList>;
|
|
79400
|
+
/**
|
|
79401
|
+
*
|
|
79402
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesMemoryItemsRequest} requestParameters Request parameters.
|
|
79403
|
+
* @param {*} [options] Override http request option.
|
|
79404
|
+
* @throws {RequiredError}
|
|
79405
|
+
*/
|
|
79406
|
+
getAllEntitiesMemoryItems(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutList>;
|
|
78448
79407
|
/**
|
|
78449
79408
|
*
|
|
78450
79409
|
* @summary Get all Metrics
|
|
@@ -78596,6 +79555,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Metad
|
|
|
78596
79555
|
* @throws {RequiredError}
|
|
78597
79556
|
*/
|
|
78598
79557
|
getEntityLabels(requestParameters: WorkspaceObjectControllerApiGetEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
79558
|
+
/**
|
|
79559
|
+
*
|
|
79560
|
+
* @param {WorkspaceObjectControllerApiGetEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
79561
|
+
* @param {*} [options] Override http request option.
|
|
79562
|
+
* @throws {RequiredError}
|
|
79563
|
+
*/
|
|
79564
|
+
getEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiGetEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
78599
79565
|
/**
|
|
78600
79566
|
*
|
|
78601
79567
|
* @summary Get a Metric
|
|
@@ -78708,6 +79674,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Metad
|
|
|
78708
79674
|
* @throws {RequiredError}
|
|
78709
79675
|
*/
|
|
78710
79676
|
patchEntityFilterViews(requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
79677
|
+
/**
|
|
79678
|
+
*
|
|
79679
|
+
* @param {WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
79680
|
+
* @param {*} [options] Override http request option.
|
|
79681
|
+
* @throws {RequiredError}
|
|
79682
|
+
*/
|
|
79683
|
+
patchEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
78711
79684
|
/**
|
|
78712
79685
|
*
|
|
78713
79686
|
* @summary Patch a Metric
|
|
@@ -78820,6 +79793,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Metad
|
|
|
78820
79793
|
* @throws {RequiredError}
|
|
78821
79794
|
*/
|
|
78822
79795
|
updateEntityFilterViews(requestParameters: WorkspaceObjectControllerApiUpdateEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
79796
|
+
/**
|
|
79797
|
+
*
|
|
79798
|
+
* @param {WorkspaceObjectControllerApiUpdateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
79799
|
+
* @param {*} [options] Override http request option.
|
|
79800
|
+
* @throws {RequiredError}
|
|
79801
|
+
*/
|
|
79802
|
+
updateEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiUpdateEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
78823
79803
|
/**
|
|
78824
79804
|
*
|
|
78825
79805
|
* @summary Put a Metric
|
|
@@ -78961,6 +79941,16 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
78961
79941
|
* @throws {RequiredError}
|
|
78962
79942
|
*/
|
|
78963
79943
|
createEntityFilterViews(workspaceId: string, jsonApiFilterViewInDocument: JsonApiFilterViewInDocument, include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFilterViewOutDocument>>;
|
|
79944
|
+
/**
|
|
79945
|
+
*
|
|
79946
|
+
* @param {string} workspaceId
|
|
79947
|
+
* @param {JsonApiMemoryItemPostOptionalIdDocument} jsonApiMemoryItemPostOptionalIdDocument
|
|
79948
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
79949
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
79950
|
+
* @param {*} [options] Override http request option.
|
|
79951
|
+
* @throws {RequiredError}
|
|
79952
|
+
*/
|
|
79953
|
+
createEntityMemoryItems(workspaceId: string, jsonApiMemoryItemPostOptionalIdDocument: JsonApiMemoryItemPostOptionalIdDocument, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutDocument>>;
|
|
78964
79954
|
/**
|
|
78965
79955
|
*
|
|
78966
79956
|
* @summary Post Metrics
|
|
@@ -79106,6 +80096,15 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
79106
80096
|
* @throws {RequiredError}
|
|
79107
80097
|
*/
|
|
79108
80098
|
deleteEntityFilterViews(workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
80099
|
+
/**
|
|
80100
|
+
*
|
|
80101
|
+
* @param {string} workspaceId
|
|
80102
|
+
* @param {string} objectId
|
|
80103
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
80104
|
+
* @param {*} [options] Override http request option.
|
|
80105
|
+
* @throws {RequiredError}
|
|
80106
|
+
*/
|
|
80107
|
+
deleteEntityMemoryItems(workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
79109
80108
|
/**
|
|
79110
80109
|
*
|
|
79111
80110
|
* @summary Delete a Metric
|
|
@@ -79372,6 +80371,21 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
79372
80371
|
* @throws {RequiredError}
|
|
79373
80372
|
*/
|
|
79374
80373
|
getAllEntitiesLabels(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiLabelOutList>>;
|
|
80374
|
+
/**
|
|
80375
|
+
*
|
|
80376
|
+
* @param {string} workspaceId
|
|
80377
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
80378
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
80379
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
80380
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
80381
|
+
* @param {number} [size] The size of the page to be returned
|
|
80382
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
80383
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
80384
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
80385
|
+
* @param {*} [options] Override http request option.
|
|
80386
|
+
* @throws {RequiredError}
|
|
80387
|
+
*/
|
|
80388
|
+
getAllEntitiesMemoryItems(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutList>>;
|
|
79375
80389
|
/**
|
|
79376
80390
|
*
|
|
79377
80391
|
* @summary Get all Metrics
|
|
@@ -79633,6 +80647,18 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
79633
80647
|
* @throws {RequiredError}
|
|
79634
80648
|
*/
|
|
79635
80649
|
getEntityLabels(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiLabelOutDocument>>;
|
|
80650
|
+
/**
|
|
80651
|
+
*
|
|
80652
|
+
* @param {string} workspaceId
|
|
80653
|
+
* @param {string} objectId
|
|
80654
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
80655
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
80656
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
80657
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
80658
|
+
* @param {*} [options] Override http request option.
|
|
80659
|
+
* @throws {RequiredError}
|
|
80660
|
+
*/
|
|
80661
|
+
getEntityMemoryItems(workspaceId: string, objectId: string, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutDocument>>;
|
|
79636
80662
|
/**
|
|
79637
80663
|
*
|
|
79638
80664
|
* @summary Get a Metric
|
|
@@ -79805,6 +80831,17 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
79805
80831
|
* @throws {RequiredError}
|
|
79806
80832
|
*/
|
|
79807
80833
|
patchEntityFilterViews(workspaceId: string, objectId: string, jsonApiFilterViewPatchDocument: JsonApiFilterViewPatchDocument, filter?: string, include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFilterViewOutDocument>>;
|
|
80834
|
+
/**
|
|
80835
|
+
*
|
|
80836
|
+
* @param {string} workspaceId
|
|
80837
|
+
* @param {string} objectId
|
|
80838
|
+
* @param {JsonApiMemoryItemPatchDocument} jsonApiMemoryItemPatchDocument
|
|
80839
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
80840
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
80841
|
+
* @param {*} [options] Override http request option.
|
|
80842
|
+
* @throws {RequiredError}
|
|
80843
|
+
*/
|
|
80844
|
+
patchEntityMemoryItems(workspaceId: string, objectId: string, jsonApiMemoryItemPatchDocument: JsonApiMemoryItemPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutDocument>>;
|
|
79808
80845
|
/**
|
|
79809
80846
|
*
|
|
79810
80847
|
* @summary Patch a Metric
|
|
@@ -79971,6 +81008,17 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
79971
81008
|
* @throws {RequiredError}
|
|
79972
81009
|
*/
|
|
79973
81010
|
updateEntityFilterViews(workspaceId: string, objectId: string, jsonApiFilterViewInDocument: JsonApiFilterViewInDocument, filter?: string, include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFilterViewOutDocument>>;
|
|
81011
|
+
/**
|
|
81012
|
+
*
|
|
81013
|
+
* @param {string} workspaceId
|
|
81014
|
+
* @param {string} objectId
|
|
81015
|
+
* @param {JsonApiMemoryItemInDocument} jsonApiMemoryItemInDocument
|
|
81016
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
81017
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
81018
|
+
* @param {*} [options] Override http request option.
|
|
81019
|
+
* @throws {RequiredError}
|
|
81020
|
+
*/
|
|
81021
|
+
updateEntityMemoryItems(workspaceId: string, objectId: string, jsonApiMemoryItemInDocument: JsonApiMemoryItemInDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiMemoryItemOutDocument>>;
|
|
79974
81022
|
/**
|
|
79975
81023
|
*
|
|
79976
81024
|
* @summary Put a Metric
|
|
@@ -80844,6 +81892,68 @@ export declare interface WorkspaceObjectControllerApiGetAllEntitiesLabelsRequest
|
|
|
80844
81892
|
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
80845
81893
|
}
|
|
80846
81894
|
|
|
81895
|
+
/**
|
|
81896
|
+
* Request parameters for getAllEntitiesMemoryItems operation in WorkspaceObjectControllerApi.
|
|
81897
|
+
* @export
|
|
81898
|
+
* @interface WorkspaceObjectControllerApiGetAllEntitiesMemoryItemsRequest
|
|
81899
|
+
*/
|
|
81900
|
+
export declare interface WorkspaceObjectControllerApiGetAllEntitiesMemoryItemsRequest {
|
|
81901
|
+
/**
|
|
81902
|
+
*
|
|
81903
|
+
* @type {string}
|
|
81904
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81905
|
+
*/
|
|
81906
|
+
readonly workspaceId: string;
|
|
81907
|
+
/**
|
|
81908
|
+
*
|
|
81909
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
81910
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81911
|
+
*/
|
|
81912
|
+
readonly origin?: "ALL" | "PARENTS" | "NATIVE";
|
|
81913
|
+
/**
|
|
81914
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
81915
|
+
* @type {string}
|
|
81916
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81917
|
+
*/
|
|
81918
|
+
readonly filter?: string;
|
|
81919
|
+
/**
|
|
81920
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
81921
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
81922
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81923
|
+
*/
|
|
81924
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
81925
|
+
/**
|
|
81926
|
+
* Zero-based page index (0..N)
|
|
81927
|
+
* @type {number}
|
|
81928
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81929
|
+
*/
|
|
81930
|
+
readonly page?: number;
|
|
81931
|
+
/**
|
|
81932
|
+
* The size of the page to be returned
|
|
81933
|
+
* @type {number}
|
|
81934
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81935
|
+
*/
|
|
81936
|
+
readonly size?: number;
|
|
81937
|
+
/**
|
|
81938
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
81939
|
+
* @type {Array<string>}
|
|
81940
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81941
|
+
*/
|
|
81942
|
+
readonly sort?: Array<string>;
|
|
81943
|
+
/**
|
|
81944
|
+
*
|
|
81945
|
+
* @type {boolean}
|
|
81946
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81947
|
+
*/
|
|
81948
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
81949
|
+
/**
|
|
81950
|
+
* Include Meta objects.
|
|
81951
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
81952
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesMemoryItems
|
|
81953
|
+
*/
|
|
81954
|
+
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
81955
|
+
}
|
|
81956
|
+
|
|
80847
81957
|
/**
|
|
80848
81958
|
* Request parameters for getAllEntitiesMetrics operation in WorkspaceObjectControllerApi.
|
|
80849
81959
|
* @export
|
|
@@ -81770,6 +82880,50 @@ export declare interface WorkspaceObjectControllerApiGetEntityLabelsRequest {
|
|
|
81770
82880
|
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
81771
82881
|
}
|
|
81772
82882
|
|
|
82883
|
+
/**
|
|
82884
|
+
* Request parameters for getEntityMemoryItems operation in WorkspaceObjectControllerApi.
|
|
82885
|
+
* @export
|
|
82886
|
+
* @interface WorkspaceObjectControllerApiGetEntityMemoryItemsRequest
|
|
82887
|
+
*/
|
|
82888
|
+
export declare interface WorkspaceObjectControllerApiGetEntityMemoryItemsRequest {
|
|
82889
|
+
/**
|
|
82890
|
+
*
|
|
82891
|
+
* @type {string}
|
|
82892
|
+
* @memberof WorkspaceObjectControllerApiGetEntityMemoryItems
|
|
82893
|
+
*/
|
|
82894
|
+
readonly workspaceId: string;
|
|
82895
|
+
/**
|
|
82896
|
+
*
|
|
82897
|
+
* @type {string}
|
|
82898
|
+
* @memberof WorkspaceObjectControllerApiGetEntityMemoryItems
|
|
82899
|
+
*/
|
|
82900
|
+
readonly objectId: string;
|
|
82901
|
+
/**
|
|
82902
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
82903
|
+
* @type {string}
|
|
82904
|
+
* @memberof WorkspaceObjectControllerApiGetEntityMemoryItems
|
|
82905
|
+
*/
|
|
82906
|
+
readonly filter?: string;
|
|
82907
|
+
/**
|
|
82908
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
82909
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
82910
|
+
* @memberof WorkspaceObjectControllerApiGetEntityMemoryItems
|
|
82911
|
+
*/
|
|
82912
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
82913
|
+
/**
|
|
82914
|
+
*
|
|
82915
|
+
* @type {boolean}
|
|
82916
|
+
* @memberof WorkspaceObjectControllerApiGetEntityMemoryItems
|
|
82917
|
+
*/
|
|
82918
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
82919
|
+
/**
|
|
82920
|
+
* Include Meta objects.
|
|
82921
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
82922
|
+
* @memberof WorkspaceObjectControllerApiGetEntityMemoryItems
|
|
82923
|
+
*/
|
|
82924
|
+
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
82925
|
+
}
|
|
82926
|
+
|
|
81773
82927
|
/**
|
|
81774
82928
|
* Request parameters for getEntityMetrics operation in WorkspaceObjectControllerApi.
|
|
81775
82929
|
* @export
|
|
@@ -82106,6 +83260,14 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
82106
83260
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
82107
83261
|
*/
|
|
82108
83262
|
createEntityFilterViews(requestParameters: WorkspaceObjectControllerApiCreateEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
83263
|
+
/**
|
|
83264
|
+
*
|
|
83265
|
+
* @param {WorkspaceObjectControllerApiCreateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
83266
|
+
* @param {*} [options] Override http request option.
|
|
83267
|
+
* @throws {RequiredError}
|
|
83268
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
83269
|
+
*/
|
|
83270
|
+
createEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiCreateEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
82109
83271
|
/**
|
|
82110
83272
|
*
|
|
82111
83273
|
* @summary Post Metrics
|
|
@@ -82232,6 +83394,14 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
82232
83394
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
82233
83395
|
*/
|
|
82234
83396
|
deleteEntityFilterViews(requestParameters: WorkspaceObjectControllerApiDeleteEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
83397
|
+
/**
|
|
83398
|
+
*
|
|
83399
|
+
* @param {WorkspaceObjectControllerApiDeleteEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
83400
|
+
* @param {*} [options] Override http request option.
|
|
83401
|
+
* @throws {RequiredError}
|
|
83402
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
83403
|
+
*/
|
|
83404
|
+
deleteEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiDeleteEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
82235
83405
|
/**
|
|
82236
83406
|
*
|
|
82237
83407
|
* @summary Delete a Metric
|
|
@@ -82402,6 +83572,14 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
82402
83572
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
82403
83573
|
*/
|
|
82404
83574
|
getAllEntitiesLabels(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutList>;
|
|
83575
|
+
/**
|
|
83576
|
+
*
|
|
83577
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesMemoryItemsRequest} requestParameters Request parameters.
|
|
83578
|
+
* @param {*} [options] Override http request option.
|
|
83579
|
+
* @throws {RequiredError}
|
|
83580
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
83581
|
+
*/
|
|
83582
|
+
getAllEntitiesMemoryItems(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutList>;
|
|
82405
83583
|
/**
|
|
82406
83584
|
*
|
|
82407
83585
|
* @summary Get all Metrics
|
|
@@ -82572,6 +83750,14 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
82572
83750
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
82573
83751
|
*/
|
|
82574
83752
|
getEntityLabels(requestParameters: WorkspaceObjectControllerApiGetEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
83753
|
+
/**
|
|
83754
|
+
*
|
|
83755
|
+
* @param {WorkspaceObjectControllerApiGetEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
83756
|
+
* @param {*} [options] Override http request option.
|
|
83757
|
+
* @throws {RequiredError}
|
|
83758
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
83759
|
+
*/
|
|
83760
|
+
getEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiGetEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
82575
83761
|
/**
|
|
82576
83762
|
*
|
|
82577
83763
|
* @summary Get a Metric
|
|
@@ -82698,6 +83884,14 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
82698
83884
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
82699
83885
|
*/
|
|
82700
83886
|
patchEntityFilterViews(requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
83887
|
+
/**
|
|
83888
|
+
*
|
|
83889
|
+
* @param {WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
83890
|
+
* @param {*} [options] Override http request option.
|
|
83891
|
+
* @throws {RequiredError}
|
|
83892
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
83893
|
+
*/
|
|
83894
|
+
patchEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
82701
83895
|
/**
|
|
82702
83896
|
*
|
|
82703
83897
|
* @summary Patch a Metric
|
|
@@ -82824,6 +84018,14 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
82824
84018
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
82825
84019
|
*/
|
|
82826
84020
|
updateEntityFilterViews(requestParameters: WorkspaceObjectControllerApiUpdateEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
84021
|
+
/**
|
|
84022
|
+
*
|
|
84023
|
+
* @param {WorkspaceObjectControllerApiUpdateEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
84024
|
+
* @param {*} [options] Override http request option.
|
|
84025
|
+
* @throws {RequiredError}
|
|
84026
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
84027
|
+
*/
|
|
84028
|
+
updateEntityMemoryItems(requestParameters: WorkspaceObjectControllerApiUpdateEntityMemoryItemsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiMemoryItemOutDocument>;
|
|
82827
84029
|
/**
|
|
82828
84030
|
*
|
|
82829
84031
|
* @summary Put a Metric
|
|
@@ -83178,6 +84380,44 @@ export declare interface WorkspaceObjectControllerApiPatchEntityFilterViewsReque
|
|
|
83178
84380
|
readonly include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">;
|
|
83179
84381
|
}
|
|
83180
84382
|
|
|
84383
|
+
/**
|
|
84384
|
+
* Request parameters for patchEntityMemoryItems operation in WorkspaceObjectControllerApi.
|
|
84385
|
+
* @export
|
|
84386
|
+
* @interface WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest
|
|
84387
|
+
*/
|
|
84388
|
+
export declare interface WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest {
|
|
84389
|
+
/**
|
|
84390
|
+
*
|
|
84391
|
+
* @type {string}
|
|
84392
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityMemoryItems
|
|
84393
|
+
*/
|
|
84394
|
+
readonly workspaceId: string;
|
|
84395
|
+
/**
|
|
84396
|
+
*
|
|
84397
|
+
* @type {string}
|
|
84398
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityMemoryItems
|
|
84399
|
+
*/
|
|
84400
|
+
readonly objectId: string;
|
|
84401
|
+
/**
|
|
84402
|
+
*
|
|
84403
|
+
* @type {JsonApiMemoryItemPatchDocument}
|
|
84404
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityMemoryItems
|
|
84405
|
+
*/
|
|
84406
|
+
readonly jsonApiMemoryItemPatchDocument: JsonApiMemoryItemPatchDocument;
|
|
84407
|
+
/**
|
|
84408
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
84409
|
+
* @type {string}
|
|
84410
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityMemoryItems
|
|
84411
|
+
*/
|
|
84412
|
+
readonly filter?: string;
|
|
84413
|
+
/**
|
|
84414
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
84415
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
84416
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityMemoryItems
|
|
84417
|
+
*/
|
|
84418
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
84419
|
+
}
|
|
84420
|
+
|
|
83181
84421
|
/**
|
|
83182
84422
|
* Request parameters for patchEntityMetrics operation in WorkspaceObjectControllerApi.
|
|
83183
84423
|
* @export
|
|
@@ -83698,6 +84938,44 @@ export declare interface WorkspaceObjectControllerApiUpdateEntityFilterViewsRequ
|
|
|
83698
84938
|
readonly include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">;
|
|
83699
84939
|
}
|
|
83700
84940
|
|
|
84941
|
+
/**
|
|
84942
|
+
* Request parameters for updateEntityMemoryItems operation in WorkspaceObjectControllerApi.
|
|
84943
|
+
* @export
|
|
84944
|
+
* @interface WorkspaceObjectControllerApiUpdateEntityMemoryItemsRequest
|
|
84945
|
+
*/
|
|
84946
|
+
export declare interface WorkspaceObjectControllerApiUpdateEntityMemoryItemsRequest {
|
|
84947
|
+
/**
|
|
84948
|
+
*
|
|
84949
|
+
* @type {string}
|
|
84950
|
+
* @memberof WorkspaceObjectControllerApiUpdateEntityMemoryItems
|
|
84951
|
+
*/
|
|
84952
|
+
readonly workspaceId: string;
|
|
84953
|
+
/**
|
|
84954
|
+
*
|
|
84955
|
+
* @type {string}
|
|
84956
|
+
* @memberof WorkspaceObjectControllerApiUpdateEntityMemoryItems
|
|
84957
|
+
*/
|
|
84958
|
+
readonly objectId: string;
|
|
84959
|
+
/**
|
|
84960
|
+
*
|
|
84961
|
+
* @type {JsonApiMemoryItemInDocument}
|
|
84962
|
+
* @memberof WorkspaceObjectControllerApiUpdateEntityMemoryItems
|
|
84963
|
+
*/
|
|
84964
|
+
readonly jsonApiMemoryItemInDocument: JsonApiMemoryItemInDocument;
|
|
84965
|
+
/**
|
|
84966
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
84967
|
+
* @type {string}
|
|
84968
|
+
* @memberof WorkspaceObjectControllerApiUpdateEntityMemoryItems
|
|
84969
|
+
*/
|
|
84970
|
+
readonly filter?: string;
|
|
84971
|
+
/**
|
|
84972
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
84973
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
84974
|
+
* @memberof WorkspaceObjectControllerApiUpdateEntityMemoryItems
|
|
84975
|
+
*/
|
|
84976
|
+
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
84977
|
+
}
|
|
84978
|
+
|
|
83701
84979
|
/**
|
|
83702
84980
|
* Request parameters for updateEntityMetrics operation in WorkspaceObjectControllerApi.
|
|
83703
84981
|
* @export
|