@gooddata/api-client-tiger 11.60.0-alpha.2 → 11.60.0-alpha.4
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 +128 -62
- package/esm/generated/ai-json-api/api.d.ts +25 -1
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +19 -0
- package/esm/generated/metadata-json-api/api.d.ts +96 -61
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +15 -15
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -9455,6 +9455,10 @@ declare interface AiAgentListItemResponse {
|
|
|
9455
9455
|
'lastUsedAt'?: string | null;
|
|
9456
9456
|
'modifiedAt'?: string | null;
|
|
9457
9457
|
'name': string;
|
|
9458
|
+
/**
|
|
9459
|
+
* Names of the skills this agent can use in this workspace, as listed by GET /api/v1/ai/agent/skills.
|
|
9460
|
+
*/
|
|
9461
|
+
'skills'?: Array<AiSkillName>;
|
|
9458
9462
|
}
|
|
9459
9463
|
export { AiAgentListItemResponse }
|
|
9460
9464
|
export { AiAgentListItemResponse as GenAiApiAgentListItemResponse }
|
|
@@ -13649,13 +13653,35 @@ export declare interface AiSingleChoiceControl {
|
|
|
13649
13653
|
|
|
13650
13654
|
export declare type AiSingleChoiceControlTypeEnum = 'singleChoice';
|
|
13651
13655
|
|
|
13656
|
+
/**
|
|
13657
|
+
* Name of a skill an agent can be configured with.
|
|
13658
|
+
*/
|
|
13659
|
+
export declare const AiSkillName: {
|
|
13660
|
+
readonly ALERT: 'alert';
|
|
13661
|
+
readonly ANOMALY_DETECTION: 'anomaly_detection';
|
|
13662
|
+
readonly CLUSTERING: 'clustering';
|
|
13663
|
+
readonly FORECASTING: 'forecasting';
|
|
13664
|
+
readonly KEY_DRIVER_ANALYSIS: 'key_driver_analysis';
|
|
13665
|
+
readonly METRIC: 'metric';
|
|
13666
|
+
readonly SCHEDULE_EXPORT: 'schedule_export';
|
|
13667
|
+
readonly VISUALIZATION: 'visualization';
|
|
13668
|
+
readonly VISUALIZATION_SUMMARY: 'visualization_summary';
|
|
13669
|
+
readonly DASHBOARD_SUMMARY: 'dashboard_summary';
|
|
13670
|
+
readonly WHAT_IF_ANALYSIS: 'what_if_analysis';
|
|
13671
|
+
readonly KNOWLEDGE: 'knowledge';
|
|
13672
|
+
readonly DASHBOARD_BUILDER: 'dashboard_builder';
|
|
13673
|
+
readonly DASHBOARD_EDITOR: 'dashboard_editor';
|
|
13674
|
+
};
|
|
13675
|
+
|
|
13676
|
+
export declare type AiSkillName = typeof AiSkillName[keyof typeof AiSkillName];
|
|
13677
|
+
|
|
13652
13678
|
/**
|
|
13653
13679
|
* A single skill available to the organization.
|
|
13654
13680
|
*/
|
|
13655
13681
|
export declare interface AiSkillResponse {
|
|
13656
13682
|
'description': string;
|
|
13657
13683
|
'examples': Array<string>;
|
|
13658
|
-
'name':
|
|
13684
|
+
'name': AiSkillName;
|
|
13659
13685
|
'tags': Array<string>;
|
|
13660
13686
|
'title': string;
|
|
13661
13687
|
}
|
|
@@ -21983,13 +22009,13 @@ export declare function AutomationControllerApi_UpdateEntityAutomations(axios: A
|
|
|
21983
22009
|
* @summary Post Automations
|
|
21984
22010
|
* @param {string} workspaceId
|
|
21985
22011
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
21986
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22012
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
21987
22013
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
21988
22014
|
* @param {*} [options] Override http request option.
|
|
21989
22015
|
* @param {Configuration} [configuration] Optional configuration.
|
|
21990
22016
|
* @throws {RequiredError}
|
|
21991
22017
|
*/
|
|
21992
|
-
export declare function AutomationControllerApiAxiosParamCreator_CreateEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22018
|
+
export declare function AutomationControllerApiAxiosParamCreator_CreateEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
21993
22019
|
|
|
21994
22020
|
/**
|
|
21995
22021
|
*
|
|
@@ -22008,7 +22034,7 @@ export declare function AutomationControllerApiAxiosParamCreator_DeleteEntityAut
|
|
|
22008
22034
|
* @param {string} workspaceId
|
|
22009
22035
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
22010
22036
|
* @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\').
|
|
22011
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22037
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22012
22038
|
* @param {number} [page] Zero-based page index (0..N)
|
|
22013
22039
|
* @param {number} [size] The size of the page to be returned
|
|
22014
22040
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -22018,7 +22044,7 @@ export declare function AutomationControllerApiAxiosParamCreator_DeleteEntityAut
|
|
|
22018
22044
|
* @param {Configuration} [configuration] Optional configuration.
|
|
22019
22045
|
* @throws {RequiredError}
|
|
22020
22046
|
*/
|
|
22021
|
-
export declare function AutomationControllerApiAxiosParamCreator_GetAllEntitiesAutomations(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22047
|
+
export declare function AutomationControllerApiAxiosParamCreator_GetAllEntitiesAutomations(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22022
22048
|
|
|
22023
22049
|
/**
|
|
22024
22050
|
*
|
|
@@ -22026,14 +22052,14 @@ export declare function AutomationControllerApiAxiosParamCreator_GetAllEntitiesA
|
|
|
22026
22052
|
* @param {string} workspaceId
|
|
22027
22053
|
* @param {string} objectId
|
|
22028
22054
|
* @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\').
|
|
22029
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22055
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22030
22056
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
22031
22057
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
22032
22058
|
* @param {*} [options] Override http request option.
|
|
22033
22059
|
* @param {Configuration} [configuration] Optional configuration.
|
|
22034
22060
|
* @throws {RequiredError}
|
|
22035
22061
|
*/
|
|
22036
|
-
export declare function AutomationControllerApiAxiosParamCreator_GetEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22062
|
+
export declare function AutomationControllerApiAxiosParamCreator_GetEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22037
22063
|
|
|
22038
22064
|
/**
|
|
22039
22065
|
*
|
|
@@ -22042,12 +22068,12 @@ export declare function AutomationControllerApiAxiosParamCreator_GetEntityAutoma
|
|
|
22042
22068
|
* @param {string} objectId
|
|
22043
22069
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
22044
22070
|
* @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\').
|
|
22045
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22071
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22046
22072
|
* @param {*} [options] Override http request option.
|
|
22047
22073
|
* @param {Configuration} [configuration] Optional configuration.
|
|
22048
22074
|
* @throws {RequiredError}
|
|
22049
22075
|
*/
|
|
22050
|
-
export declare function AutomationControllerApiAxiosParamCreator_PatchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22076
|
+
export declare function AutomationControllerApiAxiosParamCreator_PatchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22051
22077
|
|
|
22052
22078
|
/**
|
|
22053
22079
|
*
|
|
@@ -22069,12 +22095,12 @@ export declare function AutomationControllerApiAxiosParamCreator_SearchEntitiesA
|
|
|
22069
22095
|
* @param {string} objectId
|
|
22070
22096
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
22071
22097
|
* @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\').
|
|
22072
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22098
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
22073
22099
|
* @param {*} [options] Override http request option.
|
|
22074
22100
|
* @param {Configuration} [configuration] Optional configuration.
|
|
22075
22101
|
* @throws {RequiredError}
|
|
22076
22102
|
*/
|
|
22077
|
-
export declare function AutomationControllerApiAxiosParamCreator_UpdateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22103
|
+
export declare function AutomationControllerApiAxiosParamCreator_UpdateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
22078
22104
|
|
|
22079
22105
|
/**
|
|
22080
22106
|
* Request parameters for createEntityAutomations operation in AutomationControllerApi.
|
|
@@ -22096,10 +22122,10 @@ export declare interface AutomationControllerApiCreateEntityAutomationsRequest {
|
|
|
22096
22122
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
22097
22123
|
/**
|
|
22098
22124
|
* 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.
|
|
22099
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22125
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22100
22126
|
* @memberof AutomationControllerApiCreateEntityAutomations
|
|
22101
22127
|
*/
|
|
22102
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22128
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22103
22129
|
/**
|
|
22104
22130
|
* Include Meta objects.
|
|
22105
22131
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -22154,10 +22180,10 @@ export declare interface AutomationControllerApiGetAllEntitiesAutomationsRequest
|
|
|
22154
22180
|
readonly filter?: string;
|
|
22155
22181
|
/**
|
|
22156
22182
|
* 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.
|
|
22157
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22183
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22158
22184
|
* @memberof AutomationControllerApiGetAllEntitiesAutomations
|
|
22159
22185
|
*/
|
|
22160
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22186
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22161
22187
|
/**
|
|
22162
22188
|
* Zero-based page index (0..N)
|
|
22163
22189
|
* @type {number}
|
|
@@ -22216,10 +22242,10 @@ export declare interface AutomationControllerApiGetEntityAutomationsRequest {
|
|
|
22216
22242
|
readonly filter?: string;
|
|
22217
22243
|
/**
|
|
22218
22244
|
* 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.
|
|
22219
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22245
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22220
22246
|
* @memberof AutomationControllerApiGetEntityAutomations
|
|
22221
22247
|
*/
|
|
22222
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22248
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22223
22249
|
/**
|
|
22224
22250
|
*
|
|
22225
22251
|
* @type {boolean}
|
|
@@ -22337,10 +22363,10 @@ export declare interface AutomationControllerApiPatchEntityAutomationsRequest {
|
|
|
22337
22363
|
readonly filter?: string;
|
|
22338
22364
|
/**
|
|
22339
22365
|
* 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.
|
|
22340
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22366
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22341
22367
|
* @memberof AutomationControllerApiPatchEntityAutomations
|
|
22342
22368
|
*/
|
|
22343
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22369
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22344
22370
|
}
|
|
22345
22371
|
|
|
22346
22372
|
/**
|
|
@@ -22407,10 +22433,10 @@ export declare interface AutomationControllerApiUpdateEntityAutomationsRequest {
|
|
|
22407
22433
|
readonly filter?: string;
|
|
22408
22434
|
/**
|
|
22409
22435
|
* 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.
|
|
22410
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22436
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
22411
22437
|
* @memberof AutomationControllerApiUpdateEntityAutomations
|
|
22412
22438
|
*/
|
|
22413
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22439
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
22414
22440
|
}
|
|
22415
22441
|
|
|
22416
22442
|
/**
|
|
@@ -24075,13 +24101,13 @@ export declare function AutomationsApi_UpdateEntityAutomations(axios: AxiosInsta
|
|
|
24075
24101
|
* @summary Post Automations
|
|
24076
24102
|
* @param {string} workspaceId
|
|
24077
24103
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
24078
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24104
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24079
24105
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24080
24106
|
* @param {*} [options] Override http request option.
|
|
24081
24107
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24082
24108
|
* @throws {RequiredError}
|
|
24083
24109
|
*/
|
|
24084
|
-
export declare function AutomationsApiAxiosParamCreator_CreateEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24110
|
+
export declare function AutomationsApiAxiosParamCreator_CreateEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24085
24111
|
|
|
24086
24112
|
/**
|
|
24087
24113
|
*
|
|
@@ -24136,7 +24162,7 @@ export declare function AutomationsApiAxiosParamCreator_GetAllAutomationsWorkspa
|
|
|
24136
24162
|
* @param {string} workspaceId
|
|
24137
24163
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
24138
24164
|
* @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\').
|
|
24139
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24165
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24140
24166
|
* @param {number} [page] Zero-based page index (0..N)
|
|
24141
24167
|
* @param {number} [size] The size of the page to be returned
|
|
24142
24168
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -24146,7 +24172,7 @@ export declare function AutomationsApiAxiosParamCreator_GetAllAutomationsWorkspa
|
|
|
24146
24172
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24147
24173
|
* @throws {RequiredError}
|
|
24148
24174
|
*/
|
|
24149
|
-
export declare function AutomationsApiAxiosParamCreator_GetAllEntitiesAutomations(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24175
|
+
export declare function AutomationsApiAxiosParamCreator_GetAllEntitiesAutomations(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24150
24176
|
|
|
24151
24177
|
/**
|
|
24152
24178
|
* Retrieve automations for the specific workspace
|
|
@@ -24165,14 +24191,14 @@ export declare function AutomationsApiAxiosParamCreator_GetAutomations(workspace
|
|
|
24165
24191
|
* @param {string} workspaceId
|
|
24166
24192
|
* @param {string} objectId
|
|
24167
24193
|
* @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\').
|
|
24168
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24194
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24169
24195
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
24170
24196
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24171
24197
|
* @param {*} [options] Override http request option.
|
|
24172
24198
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24173
24199
|
* @throws {RequiredError}
|
|
24174
24200
|
*/
|
|
24175
|
-
export declare function AutomationsApiAxiosParamCreator_GetEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24201
|
+
export declare function AutomationsApiAxiosParamCreator_GetEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24176
24202
|
|
|
24177
24203
|
/**
|
|
24178
24204
|
*
|
|
@@ -24181,12 +24207,12 @@ export declare function AutomationsApiAxiosParamCreator_GetEntityAutomations(wor
|
|
|
24181
24207
|
* @param {string} objectId
|
|
24182
24208
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
24183
24209
|
* @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\').
|
|
24184
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24210
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24185
24211
|
* @param {*} [options] Override http request option.
|
|
24186
24212
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24187
24213
|
* @throws {RequiredError}
|
|
24188
24214
|
*/
|
|
24189
|
-
export declare function AutomationsApiAxiosParamCreator_PatchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24215
|
+
export declare function AutomationsApiAxiosParamCreator_PatchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24190
24216
|
|
|
24191
24217
|
/**
|
|
24192
24218
|
*
|
|
@@ -24325,12 +24351,12 @@ export declare function AutomationsApiAxiosParamCreator_UnsubscribeWorkspaceAuto
|
|
|
24325
24351
|
* @param {string} objectId
|
|
24326
24352
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
24327
24353
|
* @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\').
|
|
24328
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24354
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
24329
24355
|
* @param {*} [options] Override http request option.
|
|
24330
24356
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24331
24357
|
* @throws {RequiredError}
|
|
24332
24358
|
*/
|
|
24333
|
-
export declare function AutomationsApiAxiosParamCreator_UpdateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24359
|
+
export declare function AutomationsApiAxiosParamCreator_UpdateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24334
24360
|
|
|
24335
24361
|
/**
|
|
24336
24362
|
* Request parameters for createEntityAutomations operation in AutomationsApi.
|
|
@@ -24352,10 +24378,10 @@ export declare interface AutomationsApiCreateEntityAutomationsRequest {
|
|
|
24352
24378
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
24353
24379
|
/**
|
|
24354
24380
|
* 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.
|
|
24355
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24381
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24356
24382
|
* @memberof AutomationsApiCreateEntityAutomations
|
|
24357
24383
|
*/
|
|
24358
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
24384
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
24359
24385
|
/**
|
|
24360
24386
|
* Include Meta objects.
|
|
24361
24387
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -24488,10 +24514,10 @@ export declare interface AutomationsApiGetAllEntitiesAutomationsRequest {
|
|
|
24488
24514
|
readonly filter?: string;
|
|
24489
24515
|
/**
|
|
24490
24516
|
* 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.
|
|
24491
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24517
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24492
24518
|
* @memberof AutomationsApiGetAllEntitiesAutomations
|
|
24493
24519
|
*/
|
|
24494
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
24520
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
24495
24521
|
/**
|
|
24496
24522
|
* Zero-based page index (0..N)
|
|
24497
24523
|
* @type {number}
|
|
@@ -24570,10 +24596,10 @@ export declare interface AutomationsApiGetEntityAutomationsRequest {
|
|
|
24570
24596
|
readonly filter?: string;
|
|
24571
24597
|
/**
|
|
24572
24598
|
* 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.
|
|
24573
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24599
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24574
24600
|
* @memberof AutomationsApiGetEntityAutomations
|
|
24575
24601
|
*/
|
|
24576
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
24602
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
24577
24603
|
/**
|
|
24578
24604
|
*
|
|
24579
24605
|
* @type {boolean}
|
|
@@ -24825,10 +24851,10 @@ export declare interface AutomationsApiPatchEntityAutomationsRequest {
|
|
|
24825
24851
|
readonly filter?: string;
|
|
24826
24852
|
/**
|
|
24827
24853
|
* 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.
|
|
24828
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24854
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24829
24855
|
* @memberof AutomationsApiPatchEntityAutomations
|
|
24830
24856
|
*/
|
|
24831
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
24857
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
24832
24858
|
}
|
|
24833
24859
|
|
|
24834
24860
|
/**
|
|
@@ -25083,10 +25109,10 @@ export declare interface AutomationsApiUpdateEntityAutomationsRequest {
|
|
|
25083
25109
|
readonly filter?: string;
|
|
25084
25110
|
/**
|
|
25085
25111
|
* 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.
|
|
25086
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
25112
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
25087
25113
|
* @memberof AutomationsApiUpdateEntityAutomations
|
|
25088
25114
|
*/
|
|
25089
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
25115
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
25090
25116
|
}
|
|
25091
25117
|
|
|
25092
25118
|
/**
|
|
@@ -44971,13 +44997,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityAttributeHierar
|
|
|
44971
44997
|
* @summary Post Automations
|
|
44972
44998
|
* @param {string} workspaceId
|
|
44973
44999
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
44974
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
45000
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
44975
45001
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
44976
45002
|
* @param {*} [options] Override http request option.
|
|
44977
45003
|
* @param {Configuration} [configuration] Optional configuration.
|
|
44978
45004
|
* @throws {RequiredError}
|
|
44979
45005
|
*/
|
|
44980
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
45006
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
44981
45007
|
|
|
44982
45008
|
/**
|
|
44983
45009
|
*
|
|
@@ -45842,7 +45868,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAttributes(wo
|
|
|
45842
45868
|
* @param {string} workspaceId
|
|
45843
45869
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
45844
45870
|
* @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\').
|
|
45845
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
45871
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
45846
45872
|
* @param {number} [page] Zero-based page index (0..N)
|
|
45847
45873
|
* @param {number} [size] The size of the page to be returned
|
|
45848
45874
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -45852,7 +45878,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAttributes(wo
|
|
|
45852
45878
|
* @param {Configuration} [configuration] Optional configuration.
|
|
45853
45879
|
* @throws {RequiredError}
|
|
45854
45880
|
*/
|
|
45855
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAutomations(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
45881
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAutomations(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
45856
45882
|
|
|
45857
45883
|
/**
|
|
45858
45884
|
*
|
|
@@ -46570,14 +46596,14 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityAttributes(workspa
|
|
|
46570
46596
|
* @param {string} workspaceId
|
|
46571
46597
|
* @param {string} objectId
|
|
46572
46598
|
* @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\').
|
|
46573
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
46599
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
46574
46600
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
46575
46601
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46576
46602
|
* @param {*} [options] Override http request option.
|
|
46577
46603
|
* @param {Configuration} [configuration] Optional configuration.
|
|
46578
46604
|
* @throws {RequiredError}
|
|
46579
46605
|
*/
|
|
46580
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
46606
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
46581
46607
|
|
|
46582
46608
|
/**
|
|
46583
46609
|
*
|
|
@@ -47171,12 +47197,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityAttributes(works
|
|
|
47171
47197
|
* @param {string} objectId
|
|
47172
47198
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
47173
47199
|
* @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\').
|
|
47174
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
47200
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
47175
47201
|
* @param {*} [options] Override http request option.
|
|
47176
47202
|
* @param {Configuration} [configuration] Optional configuration.
|
|
47177
47203
|
* @throws {RequiredError}
|
|
47178
47204
|
*/
|
|
47179
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
47205
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
47180
47206
|
|
|
47181
47207
|
/**
|
|
47182
47208
|
*
|
|
@@ -47983,12 +48009,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityAttributeHierar
|
|
|
47983
48009
|
* @param {string} objectId
|
|
47984
48010
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
47985
48011
|
* @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\').
|
|
47986
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
48012
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | '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.
|
|
47987
48013
|
* @param {*} [options] Override http request option.
|
|
47988
48014
|
* @param {Configuration} [configuration] Optional configuration.
|
|
47989
48015
|
* @throws {RequiredError}
|
|
47990
48016
|
*/
|
|
47991
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
48017
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
47992
48018
|
|
|
47993
48019
|
/**
|
|
47994
48020
|
*
|
|
@@ -48543,10 +48569,10 @@ export declare interface EntitiesApiCreateEntityAutomationsRequest {
|
|
|
48543
48569
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
48544
48570
|
/**
|
|
48545
48571
|
* 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.
|
|
48546
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
48572
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
48547
48573
|
* @memberof EntitiesApiCreateEntityAutomations
|
|
48548
48574
|
*/
|
|
48549
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
48575
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
48550
48576
|
/**
|
|
48551
48577
|
* Include Meta objects.
|
|
48552
48578
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -50695,10 +50721,10 @@ export declare interface EntitiesApiGetAllEntitiesAutomationsRequest {
|
|
|
50695
50721
|
readonly filter?: string;
|
|
50696
50722
|
/**
|
|
50697
50723
|
* 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.
|
|
50698
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
50724
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
50699
50725
|
* @memberof EntitiesApiGetAllEntitiesAutomations
|
|
50700
50726
|
*/
|
|
50701
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
50727
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
50702
50728
|
/**
|
|
50703
50729
|
* Zero-based page index (0..N)
|
|
50704
50730
|
* @type {number}
|
|
@@ -53377,10 +53403,10 @@ export declare interface EntitiesApiGetEntityAutomationsRequest {
|
|
|
53377
53403
|
readonly filter?: string;
|
|
53378
53404
|
/**
|
|
53379
53405
|
* 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.
|
|
53380
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
53406
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
53381
53407
|
* @memberof EntitiesApiGetEntityAutomations
|
|
53382
53408
|
*/
|
|
53383
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
53409
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
53384
53410
|
/**
|
|
53385
53411
|
*
|
|
53386
53412
|
* @type {boolean}
|
|
@@ -58124,10 +58150,10 @@ export declare interface EntitiesApiPatchEntityAutomationsRequest {
|
|
|
58124
58150
|
readonly filter?: string;
|
|
58125
58151
|
/**
|
|
58126
58152
|
* 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.
|
|
58127
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
58153
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
58128
58154
|
* @memberof EntitiesApiPatchEntityAutomations
|
|
58129
58155
|
*/
|
|
58130
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
58156
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
58131
58157
|
}
|
|
58132
58158
|
|
|
58133
58159
|
/**
|
|
@@ -60406,10 +60432,10 @@ export declare interface EntitiesApiUpdateEntityAutomationsRequest {
|
|
|
60406
60432
|
readonly filter?: string;
|
|
60407
60433
|
/**
|
|
60408
60434
|
* 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.
|
|
60409
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
60435
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
60410
60436
|
* @memberof EntitiesApiUpdateEntityAutomations
|
|
60411
60437
|
*/
|
|
60412
|
-
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
60438
|
+
readonly include?: Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'visualizationObjects' | 'metrics' | 'attributes' | 'labels' | 'facts' | 'computedAttributes' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>;
|
|
60413
60439
|
}
|
|
60414
60440
|
|
|
60415
60441
|
/**
|
|
@@ -75607,7 +75633,7 @@ export declare interface JsonApiAutomationOutDocumentMeta {
|
|
|
75607
75633
|
/**
|
|
75608
75634
|
* @type JsonApiAutomationOutIncludes
|
|
75609
75635
|
*/
|
|
75610
|
-
export declare type JsonApiAutomationOutIncludes = JsonApiAnalyticalDashboardOutWithLinks | JsonApiAutomationResultOutWithLinks | JsonApiExportDefinitionOutWithLinks | JsonApiNotificationChannelOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiUserOutWithLinks | JsonApiVisualizationObjectOutWithLinks;
|
|
75636
|
+
export declare type JsonApiAutomationOutIncludes = JsonApiAnalyticalDashboardOutWithLinks | JsonApiAttributeOutWithLinks | JsonApiAutomationResultOutWithLinks | JsonApiComputedAttributeOutWithLinks | JsonApiExportDefinitionOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiNotificationChannelOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiUserOutWithLinks | JsonApiVisualizationObjectOutWithLinks;
|
|
75611
75637
|
|
|
75612
75638
|
/**
|
|
75613
75639
|
* A JSON:API document with a list of resources
|
|
@@ -75649,9 +75675,14 @@ export declare type JsonApiAutomationOutMetaOriginOriginTypeEnum = 'NATIVE' | 'P
|
|
|
75649
75675
|
|
|
75650
75676
|
export declare interface JsonApiAutomationOutRelationships {
|
|
75651
75677
|
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
75678
|
+
'attributes'?: JsonApiAutomationOutRelationshipsAttributes;
|
|
75652
75679
|
'automationResults'?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
75680
|
+
'computedAttributes'?: JsonApiAutomationOutRelationshipsComputedAttributes;
|
|
75653
75681
|
'createdBy'?: JsonApiAutomationOutRelationshipsCreatedBy;
|
|
75654
75682
|
'exportDefinitions'?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
75683
|
+
'facts'?: JsonApiAutomationOutRelationshipsFacts;
|
|
75684
|
+
'labels'?: JsonApiAutomationOutRelationshipsLabels;
|
|
75685
|
+
'metrics'?: JsonApiAutomationOutRelationshipsMetrics;
|
|
75655
75686
|
'modifiedBy'?: JsonApiAutomationOutRelationshipsModifiedBy;
|
|
75656
75687
|
'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
75657
75688
|
'recipients'?: JsonApiAutomationOutRelationshipsRecipients;
|
|
@@ -75662,6 +75693,13 @@ export declare interface JsonApiAutomationOutRelationshipsAnalyticalDashboard {
|
|
|
75662
75693
|
'data': JsonApiAnalyticalDashboardLinkage | null;
|
|
75663
75694
|
}
|
|
75664
75695
|
|
|
75696
|
+
export declare interface JsonApiAutomationOutRelationshipsAttributes {
|
|
75697
|
+
/**
|
|
75698
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
75699
|
+
*/
|
|
75700
|
+
'data': Array<JsonApiAttributeLinkage>;
|
|
75701
|
+
}
|
|
75702
|
+
|
|
75665
75703
|
export declare interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
75666
75704
|
/**
|
|
75667
75705
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -75669,6 +75707,13 @@ export declare interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
|
75669
75707
|
'data': Array<JsonApiAutomationResultLinkage>;
|
|
75670
75708
|
}
|
|
75671
75709
|
|
|
75710
|
+
export declare interface JsonApiAutomationOutRelationshipsComputedAttributes {
|
|
75711
|
+
/**
|
|
75712
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
75713
|
+
*/
|
|
75714
|
+
'data': Array<JsonApiComputedAttributeLinkage>;
|
|
75715
|
+
}
|
|
75716
|
+
|
|
75672
75717
|
export declare interface JsonApiAutomationOutRelationshipsCreatedBy {
|
|
75673
75718
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
75674
75719
|
}
|
|
@@ -75680,6 +75725,27 @@ export declare interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
|
75680
75725
|
'data': Array<JsonApiExportDefinitionLinkage>;
|
|
75681
75726
|
}
|
|
75682
75727
|
|
|
75728
|
+
export declare interface JsonApiAutomationOutRelationshipsFacts {
|
|
75729
|
+
/**
|
|
75730
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
75731
|
+
*/
|
|
75732
|
+
'data': Array<JsonApiFactLinkage>;
|
|
75733
|
+
}
|
|
75734
|
+
|
|
75735
|
+
export declare interface JsonApiAutomationOutRelationshipsLabels {
|
|
75736
|
+
/**
|
|
75737
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
75738
|
+
*/
|
|
75739
|
+
'data': Array<JsonApiLabelLinkage>;
|
|
75740
|
+
}
|
|
75741
|
+
|
|
75742
|
+
export declare interface JsonApiAutomationOutRelationshipsMetrics {
|
|
75743
|
+
/**
|
|
75744
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
75745
|
+
*/
|
|
75746
|
+
'data': Array<JsonApiMetricLinkage>;
|
|
75747
|
+
}
|
|
75748
|
+
|
|
75683
75749
|
export declare interface JsonApiAutomationOutRelationshipsModifiedBy {
|
|
75684
75750
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
75685
75751
|
}
|