@gooddata/api-client-tiger 10.8.0-alpha.3 → 10.8.0-alpha.30
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.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +1539 -723
- package/esm/client.d.ts +2 -2
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +2 -2
- package/esm/client.js.map +1 -1
- package/esm/export.d.ts +2 -2
- package/esm/export.d.ts.map +1 -1
- package/esm/export.js +2 -1
- package/esm/export.js.map +1 -1
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.d.ts +1 -0
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.d.ts.map +1 -1
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +126 -5
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +125 -7
- package/esm/generated/auth-json-api/api.d.ts +19 -0
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/auth-json-api/api.js +1 -12
- package/esm/generated/auth-json-api/api.js.map +1 -1
- package/esm/generated/auth-json-api/openapi-spec.json +14 -0
- package/esm/generated/export-json-api/api.d.ts +7 -1
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +6 -1
- package/esm/generated/metadata-json-api/api.d.ts +1105 -590
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +77 -46
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +5815 -5373
- package/esm/index.d.ts +2 -2
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +0 -1
- package/esm/index.js.map +1 -1
- package/package.json +3 -3
|
@@ -104,6 +104,37 @@ export declare const AssigneeRuleTypeEnum: {
|
|
|
104
104
|
readonly ALL_WORKSPACE_USERS: "allWorkspaceUsers";
|
|
105
105
|
};
|
|
106
106
|
export type AssigneeRuleTypeEnum = typeof AssigneeRuleTypeEnum[keyof typeof AssigneeRuleTypeEnum];
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @export
|
|
110
|
+
* @interface AutomationSchedule
|
|
111
|
+
*/
|
|
112
|
+
export interface AutomationSchedule {
|
|
113
|
+
/**
|
|
114
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
115
|
+
* @type {string}
|
|
116
|
+
* @memberof AutomationSchedule
|
|
117
|
+
*/
|
|
118
|
+
cron: string;
|
|
119
|
+
/**
|
|
120
|
+
* Human-readable description of the cron expression.
|
|
121
|
+
* @type {string}
|
|
122
|
+
* @memberof AutomationSchedule
|
|
123
|
+
*/
|
|
124
|
+
cronDescription?: string;
|
|
125
|
+
/**
|
|
126
|
+
* Timezone in which the schedule is defined.
|
|
127
|
+
* @type {string}
|
|
128
|
+
* @memberof AutomationSchedule
|
|
129
|
+
*/
|
|
130
|
+
timezone?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
133
|
+
* @type {string}
|
|
134
|
+
* @memberof AutomationSchedule
|
|
135
|
+
*/
|
|
136
|
+
firstRun?: string;
|
|
137
|
+
}
|
|
107
138
|
/**
|
|
108
139
|
*
|
|
109
140
|
* @export
|
|
@@ -593,6 +624,12 @@ export interface DeclarativeAnalyticsLayer {
|
|
|
593
624
|
* @memberof DeclarativeAnalyticsLayer
|
|
594
625
|
*/
|
|
595
626
|
attributeHierarchies?: Array<DeclarativeAttributeHierarchy>;
|
|
627
|
+
/**
|
|
628
|
+
* A list of export definitions.
|
|
629
|
+
* @type {Array<DeclarativeExportDefinition>}
|
|
630
|
+
* @memberof DeclarativeAnalyticsLayer
|
|
631
|
+
*/
|
|
632
|
+
exportDefinitions?: Array<DeclarativeExportDefinition>;
|
|
596
633
|
}
|
|
597
634
|
/**
|
|
598
635
|
* A dataset attribute.
|
|
@@ -737,6 +774,99 @@ export interface DeclarativeAttributeHierarchy {
|
|
|
737
774
|
*/
|
|
738
775
|
createdAt?: string | null;
|
|
739
776
|
}
|
|
777
|
+
/**
|
|
778
|
+
*
|
|
779
|
+
* @export
|
|
780
|
+
* @interface DeclarativeAutomation
|
|
781
|
+
*/
|
|
782
|
+
export interface DeclarativeAutomation {
|
|
783
|
+
/**
|
|
784
|
+
*
|
|
785
|
+
* @type {string}
|
|
786
|
+
* @memberof DeclarativeAutomation
|
|
787
|
+
*/
|
|
788
|
+
id: string;
|
|
789
|
+
/**
|
|
790
|
+
*
|
|
791
|
+
* @type {string}
|
|
792
|
+
* @memberof DeclarativeAutomation
|
|
793
|
+
*/
|
|
794
|
+
title?: string;
|
|
795
|
+
/**
|
|
796
|
+
*
|
|
797
|
+
* @type {string}
|
|
798
|
+
* @memberof DeclarativeAutomation
|
|
799
|
+
*/
|
|
800
|
+
description?: string;
|
|
801
|
+
/**
|
|
802
|
+
* A list of tags.
|
|
803
|
+
* @type {Array<string>}
|
|
804
|
+
* @memberof DeclarativeAutomation
|
|
805
|
+
*/
|
|
806
|
+
tags?: Array<string>;
|
|
807
|
+
/**
|
|
808
|
+
*
|
|
809
|
+
* @type {AutomationSchedule}
|
|
810
|
+
* @memberof DeclarativeAutomation
|
|
811
|
+
*/
|
|
812
|
+
schedule?: AutomationSchedule;
|
|
813
|
+
/**
|
|
814
|
+
*
|
|
815
|
+
* @type {DeclarativeNotificationChannelIdentifier}
|
|
816
|
+
* @memberof DeclarativeAutomation
|
|
817
|
+
*/
|
|
818
|
+
notificationChannel?: DeclarativeNotificationChannelIdentifier;
|
|
819
|
+
/**
|
|
820
|
+
*
|
|
821
|
+
* @type {Array<DeclarativeExportDefinitionIdentifier>}
|
|
822
|
+
* @memberof DeclarativeAutomation
|
|
823
|
+
*/
|
|
824
|
+
exportDefinitions?: Array<DeclarativeExportDefinitionIdentifier>;
|
|
825
|
+
/**
|
|
826
|
+
*
|
|
827
|
+
* @type {Array<DeclarativeUserIdentifier>}
|
|
828
|
+
* @memberof DeclarativeAutomation
|
|
829
|
+
*/
|
|
830
|
+
recipients?: Array<DeclarativeUserIdentifier>;
|
|
831
|
+
/**
|
|
832
|
+
* TODO
|
|
833
|
+
* @type {{ [key: string]: string; }}
|
|
834
|
+
* @memberof DeclarativeAutomation
|
|
835
|
+
*/
|
|
836
|
+
details?: {
|
|
837
|
+
[key: string]: string;
|
|
838
|
+
};
|
|
839
|
+
/**
|
|
840
|
+
* Free-form JSON object
|
|
841
|
+
* @type {object}
|
|
842
|
+
* @memberof DeclarativeAutomation
|
|
843
|
+
*/
|
|
844
|
+
metadata?: object | null;
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
* @type {DeclarativeUserIdentifier}
|
|
848
|
+
* @memberof DeclarativeAutomation
|
|
849
|
+
*/
|
|
850
|
+
createdBy?: DeclarativeUserIdentifier;
|
|
851
|
+
/**
|
|
852
|
+
*
|
|
853
|
+
* @type {DeclarativeUserIdentifier}
|
|
854
|
+
* @memberof DeclarativeAutomation
|
|
855
|
+
*/
|
|
856
|
+
modifiedBy?: DeclarativeUserIdentifier;
|
|
857
|
+
/**
|
|
858
|
+
* Time of the last entity modification.
|
|
859
|
+
* @type {string}
|
|
860
|
+
* @memberof DeclarativeAutomation
|
|
861
|
+
*/
|
|
862
|
+
modifiedAt?: string | null;
|
|
863
|
+
/**
|
|
864
|
+
* Time of the entity creation.
|
|
865
|
+
* @type {string}
|
|
866
|
+
* @memberof DeclarativeAutomation
|
|
867
|
+
*/
|
|
868
|
+
createdAt?: string | null;
|
|
869
|
+
}
|
|
740
870
|
/**
|
|
741
871
|
* Color palette and its properties.
|
|
742
872
|
* @export
|
|
@@ -1264,6 +1394,90 @@ export declare const DeclarativeDateDatasetGranularitiesEnum: {
|
|
|
1264
1394
|
readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
|
|
1265
1395
|
};
|
|
1266
1396
|
export type DeclarativeDateDatasetGranularitiesEnum = typeof DeclarativeDateDatasetGranularitiesEnum[keyof typeof DeclarativeDateDatasetGranularitiesEnum];
|
|
1397
|
+
/**
|
|
1398
|
+
*
|
|
1399
|
+
* @export
|
|
1400
|
+
* @interface DeclarativeExportDefinition
|
|
1401
|
+
*/
|
|
1402
|
+
export interface DeclarativeExportDefinition {
|
|
1403
|
+
/**
|
|
1404
|
+
* Export definition id.
|
|
1405
|
+
* @type {string}
|
|
1406
|
+
* @memberof DeclarativeExportDefinition
|
|
1407
|
+
*/
|
|
1408
|
+
id: string;
|
|
1409
|
+
/**
|
|
1410
|
+
* Export definition object title.
|
|
1411
|
+
* @type {string}
|
|
1412
|
+
* @memberof DeclarativeExportDefinition
|
|
1413
|
+
*/
|
|
1414
|
+
title: string;
|
|
1415
|
+
/**
|
|
1416
|
+
* Export definition object description.
|
|
1417
|
+
* @type {string}
|
|
1418
|
+
* @memberof DeclarativeExportDefinition
|
|
1419
|
+
*/
|
|
1420
|
+
description?: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* A list of tags.
|
|
1423
|
+
* @type {Array<string>}
|
|
1424
|
+
* @memberof DeclarativeExportDefinition
|
|
1425
|
+
*/
|
|
1426
|
+
tags?: Array<string>;
|
|
1427
|
+
/**
|
|
1428
|
+
*
|
|
1429
|
+
* @type {TabularExportRequest | VisualExportRequest}
|
|
1430
|
+
* @memberof DeclarativeExportDefinition
|
|
1431
|
+
*/
|
|
1432
|
+
requestPayload?: TabularExportRequest | VisualExportRequest;
|
|
1433
|
+
/**
|
|
1434
|
+
*
|
|
1435
|
+
* @type {DeclarativeUserIdentifier}
|
|
1436
|
+
* @memberof DeclarativeExportDefinition
|
|
1437
|
+
*/
|
|
1438
|
+
createdBy?: DeclarativeUserIdentifier;
|
|
1439
|
+
/**
|
|
1440
|
+
*
|
|
1441
|
+
* @type {DeclarativeUserIdentifier}
|
|
1442
|
+
* @memberof DeclarativeExportDefinition
|
|
1443
|
+
*/
|
|
1444
|
+
modifiedBy?: DeclarativeUserIdentifier;
|
|
1445
|
+
/**
|
|
1446
|
+
* Time of the last entity modification.
|
|
1447
|
+
* @type {string}
|
|
1448
|
+
* @memberof DeclarativeExportDefinition
|
|
1449
|
+
*/
|
|
1450
|
+
modifiedAt?: string | null;
|
|
1451
|
+
/**
|
|
1452
|
+
* Time of the entity creation.
|
|
1453
|
+
* @type {string}
|
|
1454
|
+
* @memberof DeclarativeExportDefinition
|
|
1455
|
+
*/
|
|
1456
|
+
createdAt?: string | null;
|
|
1457
|
+
}
|
|
1458
|
+
/**
|
|
1459
|
+
* An export definition identifier.
|
|
1460
|
+
* @export
|
|
1461
|
+
* @interface DeclarativeExportDefinitionIdentifier
|
|
1462
|
+
*/
|
|
1463
|
+
export interface DeclarativeExportDefinitionIdentifier {
|
|
1464
|
+
/**
|
|
1465
|
+
* Export definition identifier.
|
|
1466
|
+
* @type {string}
|
|
1467
|
+
* @memberof DeclarativeExportDefinitionIdentifier
|
|
1468
|
+
*/
|
|
1469
|
+
id: string;
|
|
1470
|
+
/**
|
|
1471
|
+
* A type.
|
|
1472
|
+
* @type {string}
|
|
1473
|
+
* @memberof DeclarativeExportDefinitionIdentifier
|
|
1474
|
+
*/
|
|
1475
|
+
type: DeclarativeExportDefinitionIdentifierTypeEnum;
|
|
1476
|
+
}
|
|
1477
|
+
export declare const DeclarativeExportDefinitionIdentifierTypeEnum: {
|
|
1478
|
+
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
1479
|
+
};
|
|
1480
|
+
export type DeclarativeExportDefinitionIdentifierTypeEnum = typeof DeclarativeExportDefinitionIdentifierTypeEnum[keyof typeof DeclarativeExportDefinitionIdentifierTypeEnum];
|
|
1267
1481
|
/**
|
|
1268
1482
|
* A dataset fact.
|
|
1269
1483
|
* @export
|
|
@@ -1546,6 +1760,76 @@ export interface DeclarativeModel {
|
|
|
1546
1760
|
*/
|
|
1547
1761
|
ldm?: DeclarativeLdm;
|
|
1548
1762
|
}
|
|
1763
|
+
/**
|
|
1764
|
+
* A declarative form of a particular notification channel.
|
|
1765
|
+
* @export
|
|
1766
|
+
* @interface DeclarativeNotificationChannel
|
|
1767
|
+
*/
|
|
1768
|
+
export interface DeclarativeNotificationChannel {
|
|
1769
|
+
/**
|
|
1770
|
+
* Identifier of a notification channel
|
|
1771
|
+
* @type {string}
|
|
1772
|
+
* @memberof DeclarativeNotificationChannel
|
|
1773
|
+
*/
|
|
1774
|
+
id: string;
|
|
1775
|
+
/**
|
|
1776
|
+
* Name of a notification channel.
|
|
1777
|
+
* @type {string}
|
|
1778
|
+
* @memberof DeclarativeNotificationChannel
|
|
1779
|
+
*/
|
|
1780
|
+
name?: string;
|
|
1781
|
+
/**
|
|
1782
|
+
* Description of a notification channel.
|
|
1783
|
+
* @type {string}
|
|
1784
|
+
* @memberof DeclarativeNotificationChannel
|
|
1785
|
+
*/
|
|
1786
|
+
description?: string;
|
|
1787
|
+
/**
|
|
1788
|
+
*
|
|
1789
|
+
* @type {Webhook}
|
|
1790
|
+
* @memberof DeclarativeNotificationChannel
|
|
1791
|
+
*/
|
|
1792
|
+
destination?: Webhook;
|
|
1793
|
+
/**
|
|
1794
|
+
*
|
|
1795
|
+
* @type {string}
|
|
1796
|
+
* @memberof DeclarativeNotificationChannel
|
|
1797
|
+
*/
|
|
1798
|
+
destinationType?: DeclarativeNotificationChannelDestinationTypeEnum;
|
|
1799
|
+
/**
|
|
1800
|
+
* The triggers that are to be used to send notifications to the channel.
|
|
1801
|
+
* @type {Array<NotificationTrigger>}
|
|
1802
|
+
* @memberof DeclarativeNotificationChannel
|
|
1803
|
+
*/
|
|
1804
|
+
triggers?: Array<NotificationTrigger>;
|
|
1805
|
+
}
|
|
1806
|
+
export declare const DeclarativeNotificationChannelDestinationTypeEnum: {
|
|
1807
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
1808
|
+
};
|
|
1809
|
+
export type DeclarativeNotificationChannelDestinationTypeEnum = typeof DeclarativeNotificationChannelDestinationTypeEnum[keyof typeof DeclarativeNotificationChannelDestinationTypeEnum];
|
|
1810
|
+
/**
|
|
1811
|
+
* A notification channel identifier.
|
|
1812
|
+
* @export
|
|
1813
|
+
* @interface DeclarativeNotificationChannelIdentifier
|
|
1814
|
+
*/
|
|
1815
|
+
export interface DeclarativeNotificationChannelIdentifier {
|
|
1816
|
+
/**
|
|
1817
|
+
* Notification channel identifier.
|
|
1818
|
+
* @type {string}
|
|
1819
|
+
* @memberof DeclarativeNotificationChannelIdentifier
|
|
1820
|
+
*/
|
|
1821
|
+
id: string;
|
|
1822
|
+
/**
|
|
1823
|
+
* A type.
|
|
1824
|
+
* @type {string}
|
|
1825
|
+
* @memberof DeclarativeNotificationChannelIdentifier
|
|
1826
|
+
*/
|
|
1827
|
+
type: DeclarativeNotificationChannelIdentifierTypeEnum;
|
|
1828
|
+
}
|
|
1829
|
+
export declare const DeclarativeNotificationChannelIdentifierTypeEnum: {
|
|
1830
|
+
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
1831
|
+
};
|
|
1832
|
+
export type DeclarativeNotificationChannelIdentifierTypeEnum = typeof DeclarativeNotificationChannelIdentifierTypeEnum[keyof typeof DeclarativeNotificationChannelIdentifierTypeEnum];
|
|
1549
1833
|
/**
|
|
1550
1834
|
* Complete definition of an organization in a declarative form.
|
|
1551
1835
|
* @export
|
|
@@ -1594,6 +1878,12 @@ export interface DeclarativeOrganization {
|
|
|
1594
1878
|
* @memberof DeclarativeOrganization
|
|
1595
1879
|
*/
|
|
1596
1880
|
jwks?: Array<DeclarativeJwk>;
|
|
1881
|
+
/**
|
|
1882
|
+
*
|
|
1883
|
+
* @type {Array<DeclarativeNotificationChannel>}
|
|
1884
|
+
* @memberof DeclarativeOrganization
|
|
1885
|
+
*/
|
|
1886
|
+
notificationChannels?: Array<DeclarativeNotificationChannel>;
|
|
1597
1887
|
}
|
|
1598
1888
|
/**
|
|
1599
1889
|
* Information available about an organization.
|
|
@@ -2477,6 +2767,12 @@ export interface DeclarativeWorkspace {
|
|
|
2477
2767
|
* @memberof DeclarativeWorkspace
|
|
2478
2768
|
*/
|
|
2479
2769
|
dataSource?: WorkspaceDataSource;
|
|
2770
|
+
/**
|
|
2771
|
+
*
|
|
2772
|
+
* @type {Array<DeclarativeAutomation>}
|
|
2773
|
+
* @memberof DeclarativeWorkspace
|
|
2774
|
+
*/
|
|
2775
|
+
automations?: Array<DeclarativeAutomation>;
|
|
2480
2776
|
}
|
|
2481
2777
|
/**
|
|
2482
2778
|
* Workspace Data Filters serving the filtering of what data users can see in workspaces.
|
|
@@ -2876,6 +3172,12 @@ export declare const EntityIdentifierTypeEnum: {
|
|
|
2876
3172
|
readonly FILTER_CONTEXT: "filterContext";
|
|
2877
3173
|
};
|
|
2878
3174
|
export type EntityIdentifierTypeEnum = typeof EntityIdentifierTypeEnum[keyof typeof EntityIdentifierTypeEnum];
|
|
3175
|
+
/**
|
|
3176
|
+
* @type ExportRequest
|
|
3177
|
+
* JSON content to be used as export request payload for /export/tabular and /export/visual endpoints.
|
|
3178
|
+
* @export
|
|
3179
|
+
*/
|
|
3180
|
+
export type ExportRequest = TabularExportRequest | VisualExportRequest;
|
|
2879
3181
|
/**
|
|
2880
3182
|
* A request containing all information needed for generation of logical model.
|
|
2881
3183
|
* @export
|
|
@@ -3818,7 +4120,7 @@ export type JsonApiApiTokenOutTypeEnum = typeof JsonApiApiTokenOutTypeEnum[keyof
|
|
|
3818
4120
|
*/
|
|
3819
4121
|
export interface JsonApiApiTokenOutAttributes {
|
|
3820
4122
|
/**
|
|
3821
|
-
*
|
|
4123
|
+
* The value of the Bearer token. It is only returned when the API token is created.
|
|
3822
4124
|
* @type {string}
|
|
3823
4125
|
* @memberof JsonApiApiTokenOutAttributes
|
|
3824
4126
|
*/
|
|
@@ -4757,12 +5059,6 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
4757
5059
|
* @memberof JsonApiAutomationOutAttributes
|
|
4758
5060
|
*/
|
|
4759
5061
|
areRelationsValid?: boolean;
|
|
4760
|
-
/**
|
|
4761
|
-
*
|
|
4762
|
-
* @type {JsonApiAutomationOutAttributesSchedule}
|
|
4763
|
-
* @memberof JsonApiAutomationOutAttributes
|
|
4764
|
-
*/
|
|
4765
|
-
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
4766
5062
|
/**
|
|
4767
5063
|
* Additional details to be included in the automated message.
|
|
4768
5064
|
* @type {any}
|
|
@@ -4770,48 +5066,29 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
4770
5066
|
*/
|
|
4771
5067
|
details?: any;
|
|
4772
5068
|
/**
|
|
4773
|
-
*
|
|
4774
|
-
* @type {
|
|
5069
|
+
* Additional information for the automation.
|
|
5070
|
+
* @type {object}
|
|
4775
5071
|
* @memberof JsonApiAutomationOutAttributes
|
|
4776
5072
|
*/
|
|
4777
|
-
|
|
5073
|
+
metadata?: object | null;
|
|
4778
5074
|
/**
|
|
4779
5075
|
*
|
|
4780
|
-
* @type {
|
|
5076
|
+
* @type {JsonApiAutomationPatchAttributesSchedule}
|
|
4781
5077
|
* @memberof JsonApiAutomationOutAttributes
|
|
4782
5078
|
*/
|
|
4783
|
-
|
|
4784
|
-
}
|
|
4785
|
-
/**
|
|
4786
|
-
*
|
|
4787
|
-
* @export
|
|
4788
|
-
* @interface JsonApiAutomationOutAttributesSchedule
|
|
4789
|
-
*/
|
|
4790
|
-
export interface JsonApiAutomationOutAttributesSchedule {
|
|
4791
|
-
/**
|
|
4792
|
-
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
4793
|
-
* @type {string}
|
|
4794
|
-
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
4795
|
-
*/
|
|
4796
|
-
cron: string;
|
|
5079
|
+
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
4797
5080
|
/**
|
|
4798
|
-
*
|
|
4799
|
-
* @type {string}
|
|
4800
|
-
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
4801
|
-
*/
|
|
4802
|
-
cronDescription?: string;
|
|
4803
|
-
/**
|
|
4804
|
-
* Timezone in which the schedule is defined.
|
|
5081
|
+
*
|
|
4805
5082
|
* @type {string}
|
|
4806
|
-
* @memberof
|
|
5083
|
+
* @memberof JsonApiAutomationOutAttributes
|
|
4807
5084
|
*/
|
|
4808
|
-
|
|
5085
|
+
createdAt?: string;
|
|
4809
5086
|
/**
|
|
4810
|
-
*
|
|
5087
|
+
*
|
|
4811
5088
|
* @type {string}
|
|
4812
|
-
* @memberof
|
|
5089
|
+
* @memberof JsonApiAutomationOutAttributes
|
|
4813
5090
|
*/
|
|
4814
|
-
|
|
5091
|
+
modifiedAt?: string;
|
|
4815
5092
|
}
|
|
4816
5093
|
/**
|
|
4817
5094
|
*
|
|
@@ -4842,7 +5119,7 @@ export interface JsonApiAutomationOutDocument {
|
|
|
4842
5119
|
* @type JsonApiAutomationOutIncludes
|
|
4843
5120
|
* @export
|
|
4844
5121
|
*/
|
|
4845
|
-
export type JsonApiAutomationOutIncludes = JsonApiExportDefinitionOutWithLinks | JsonApiNotificationChannelOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiUserOutWithLinks;
|
|
5122
|
+
export type JsonApiAutomationOutIncludes = JsonApiAnalyticalDashboardOutWithLinks | JsonApiExportDefinitionOutWithLinks | JsonApiNotificationChannelOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiUserOutWithLinks;
|
|
4846
5123
|
/**
|
|
4847
5124
|
* A JSON:API document with a list of resources
|
|
4848
5125
|
* @export
|
|
@@ -4882,73 +5159,40 @@ export interface JsonApiAutomationOutList {
|
|
|
4882
5159
|
export interface JsonApiAutomationOutRelationships {
|
|
4883
5160
|
/**
|
|
4884
5161
|
*
|
|
4885
|
-
* @type {
|
|
5162
|
+
* @type {JsonApiAutomationPatchRelationshipsNotificationChannel}
|
|
4886
5163
|
* @memberof JsonApiAutomationOutRelationships
|
|
4887
5164
|
*/
|
|
4888
|
-
notificationChannel?:
|
|
5165
|
+
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
4889
5166
|
/**
|
|
4890
5167
|
*
|
|
4891
|
-
* @type {
|
|
5168
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
4892
5169
|
* @memberof JsonApiAutomationOutRelationships
|
|
4893
5170
|
*/
|
|
4894
|
-
|
|
5171
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
4895
5172
|
/**
|
|
4896
5173
|
*
|
|
4897
5174
|
* @type {JsonApiAnalyticalDashboardOutRelationshipsCreatedBy}
|
|
4898
5175
|
* @memberof JsonApiAutomationOutRelationships
|
|
4899
5176
|
*/
|
|
4900
|
-
|
|
5177
|
+
createdBy?: JsonApiAnalyticalDashboardOutRelationshipsCreatedBy;
|
|
4901
5178
|
/**
|
|
4902
5179
|
*
|
|
4903
|
-
* @type {
|
|
5180
|
+
* @type {JsonApiAnalyticalDashboardOutRelationshipsCreatedBy}
|
|
4904
5181
|
* @memberof JsonApiAutomationOutRelationships
|
|
4905
5182
|
*/
|
|
4906
|
-
|
|
5183
|
+
modifiedBy?: JsonApiAnalyticalDashboardOutRelationshipsCreatedBy;
|
|
4907
5184
|
/**
|
|
4908
5185
|
*
|
|
4909
|
-
* @type {
|
|
5186
|
+
* @type {JsonApiAutomationPatchRelationshipsExportDefinitions}
|
|
4910
5187
|
* @memberof JsonApiAutomationOutRelationships
|
|
4911
5188
|
*/
|
|
4912
|
-
|
|
4913
|
-
}
|
|
4914
|
-
/**
|
|
4915
|
-
*
|
|
4916
|
-
* @export
|
|
4917
|
-
* @interface JsonApiAutomationOutRelationshipsExportDefinitions
|
|
4918
|
-
*/
|
|
4919
|
-
export interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
4920
|
-
/**
|
|
4921
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
4922
|
-
* @type {Array<JsonApiExportDefinitionLinkage>}
|
|
4923
|
-
* @memberof JsonApiAutomationOutRelationshipsExportDefinitions
|
|
4924
|
-
*/
|
|
4925
|
-
data: Array<JsonApiExportDefinitionLinkage>;
|
|
4926
|
-
}
|
|
4927
|
-
/**
|
|
4928
|
-
*
|
|
4929
|
-
* @export
|
|
4930
|
-
* @interface JsonApiAutomationOutRelationshipsNotificationChannel
|
|
4931
|
-
*/
|
|
4932
|
-
export interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
5189
|
+
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
4933
5190
|
/**
|
|
4934
5191
|
*
|
|
4935
|
-
* @type {
|
|
4936
|
-
* @memberof
|
|
4937
|
-
*/
|
|
4938
|
-
data: JsonApiNotificationChannelToOneLinkage | null;
|
|
4939
|
-
}
|
|
4940
|
-
/**
|
|
4941
|
-
*
|
|
4942
|
-
* @export
|
|
4943
|
-
* @interface JsonApiAutomationOutRelationshipsRecipients
|
|
4944
|
-
*/
|
|
4945
|
-
export interface JsonApiAutomationOutRelationshipsRecipients {
|
|
4946
|
-
/**
|
|
4947
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
4948
|
-
* @type {Array<JsonApiUserLinkage>}
|
|
4949
|
-
* @memberof JsonApiAutomationOutRelationshipsRecipients
|
|
5192
|
+
* @type {JsonApiAutomationPatchRelationshipsRecipients}
|
|
5193
|
+
* @memberof JsonApiAutomationOutRelationships
|
|
4950
5194
|
*/
|
|
4951
|
-
|
|
5195
|
+
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
4952
5196
|
}
|
|
4953
5197
|
/**
|
|
4954
5198
|
*
|
|
@@ -5062,18 +5306,55 @@ export interface JsonApiAutomationPatchAttributes {
|
|
|
5062
5306
|
* @memberof JsonApiAutomationPatchAttributes
|
|
5063
5307
|
*/
|
|
5064
5308
|
areRelationsValid?: boolean;
|
|
5065
|
-
/**
|
|
5066
|
-
*
|
|
5067
|
-
* @type {JsonApiAutomationOutAttributesSchedule}
|
|
5068
|
-
* @memberof JsonApiAutomationPatchAttributes
|
|
5069
|
-
*/
|
|
5070
|
-
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
5071
5309
|
/**
|
|
5072
5310
|
* Additional details to be included in the automated message.
|
|
5073
5311
|
* @type {any}
|
|
5074
5312
|
* @memberof JsonApiAutomationPatchAttributes
|
|
5075
5313
|
*/
|
|
5076
5314
|
details?: any;
|
|
5315
|
+
/**
|
|
5316
|
+
* Additional information for the automation.
|
|
5317
|
+
* @type {object}
|
|
5318
|
+
* @memberof JsonApiAutomationPatchAttributes
|
|
5319
|
+
*/
|
|
5320
|
+
metadata?: object | null;
|
|
5321
|
+
/**
|
|
5322
|
+
*
|
|
5323
|
+
* @type {JsonApiAutomationPatchAttributesSchedule}
|
|
5324
|
+
* @memberof JsonApiAutomationPatchAttributes
|
|
5325
|
+
*/
|
|
5326
|
+
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
5327
|
+
}
|
|
5328
|
+
/**
|
|
5329
|
+
*
|
|
5330
|
+
* @export
|
|
5331
|
+
* @interface JsonApiAutomationPatchAttributesSchedule
|
|
5332
|
+
*/
|
|
5333
|
+
export interface JsonApiAutomationPatchAttributesSchedule {
|
|
5334
|
+
/**
|
|
5335
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
5336
|
+
* @type {string}
|
|
5337
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
5338
|
+
*/
|
|
5339
|
+
cron: string;
|
|
5340
|
+
/**
|
|
5341
|
+
* Human-readable description of the cron expression.
|
|
5342
|
+
* @type {string}
|
|
5343
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
5344
|
+
*/
|
|
5345
|
+
cronDescription?: string;
|
|
5346
|
+
/**
|
|
5347
|
+
* Timezone in which the schedule is defined.
|
|
5348
|
+
* @type {string}
|
|
5349
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
5350
|
+
*/
|
|
5351
|
+
timezone?: string;
|
|
5352
|
+
/**
|
|
5353
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
5354
|
+
* @type {string}
|
|
5355
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
5356
|
+
*/
|
|
5357
|
+
firstRun?: string;
|
|
5077
5358
|
}
|
|
5078
5359
|
/**
|
|
5079
5360
|
*
|
|
@@ -5096,22 +5377,80 @@ export interface JsonApiAutomationPatchDocument {
|
|
|
5096
5377
|
export interface JsonApiAutomationPatchRelationships {
|
|
5097
5378
|
/**
|
|
5098
5379
|
*
|
|
5099
|
-
* @type {
|
|
5380
|
+
* @type {JsonApiAutomationPatchRelationshipsNotificationChannel}
|
|
5381
|
+
* @memberof JsonApiAutomationPatchRelationships
|
|
5382
|
+
*/
|
|
5383
|
+
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
5384
|
+
/**
|
|
5385
|
+
*
|
|
5386
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
5100
5387
|
* @memberof JsonApiAutomationPatchRelationships
|
|
5101
5388
|
*/
|
|
5102
|
-
|
|
5389
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
5103
5390
|
/**
|
|
5104
5391
|
*
|
|
5105
|
-
* @type {
|
|
5392
|
+
* @type {JsonApiAutomationPatchRelationshipsExportDefinitions}
|
|
5106
5393
|
* @memberof JsonApiAutomationPatchRelationships
|
|
5107
5394
|
*/
|
|
5108
|
-
exportDefinitions?:
|
|
5395
|
+
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
5109
5396
|
/**
|
|
5110
5397
|
*
|
|
5111
|
-
* @type {
|
|
5398
|
+
* @type {JsonApiAutomationPatchRelationshipsRecipients}
|
|
5112
5399
|
* @memberof JsonApiAutomationPatchRelationships
|
|
5113
5400
|
*/
|
|
5114
|
-
recipients?:
|
|
5401
|
+
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
5402
|
+
}
|
|
5403
|
+
/**
|
|
5404
|
+
*
|
|
5405
|
+
* @export
|
|
5406
|
+
* @interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard
|
|
5407
|
+
*/
|
|
5408
|
+
export interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard {
|
|
5409
|
+
/**
|
|
5410
|
+
*
|
|
5411
|
+
* @type {JsonApiAnalyticalDashboardToOneLinkage}
|
|
5412
|
+
* @memberof JsonApiAutomationPatchRelationshipsAnalyticalDashboard
|
|
5413
|
+
*/
|
|
5414
|
+
data: JsonApiAnalyticalDashboardToOneLinkage | null;
|
|
5415
|
+
}
|
|
5416
|
+
/**
|
|
5417
|
+
*
|
|
5418
|
+
* @export
|
|
5419
|
+
* @interface JsonApiAutomationPatchRelationshipsExportDefinitions
|
|
5420
|
+
*/
|
|
5421
|
+
export interface JsonApiAutomationPatchRelationshipsExportDefinitions {
|
|
5422
|
+
/**
|
|
5423
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5424
|
+
* @type {Array<JsonApiExportDefinitionLinkage>}
|
|
5425
|
+
* @memberof JsonApiAutomationPatchRelationshipsExportDefinitions
|
|
5426
|
+
*/
|
|
5427
|
+
data: Array<JsonApiExportDefinitionLinkage>;
|
|
5428
|
+
}
|
|
5429
|
+
/**
|
|
5430
|
+
*
|
|
5431
|
+
* @export
|
|
5432
|
+
* @interface JsonApiAutomationPatchRelationshipsNotificationChannel
|
|
5433
|
+
*/
|
|
5434
|
+
export interface JsonApiAutomationPatchRelationshipsNotificationChannel {
|
|
5435
|
+
/**
|
|
5436
|
+
*
|
|
5437
|
+
* @type {JsonApiNotificationChannelToOneLinkage}
|
|
5438
|
+
* @memberof JsonApiAutomationPatchRelationshipsNotificationChannel
|
|
5439
|
+
*/
|
|
5440
|
+
data: JsonApiNotificationChannelToOneLinkage | null;
|
|
5441
|
+
}
|
|
5442
|
+
/**
|
|
5443
|
+
*
|
|
5444
|
+
* @export
|
|
5445
|
+
* @interface JsonApiAutomationPatchRelationshipsRecipients
|
|
5446
|
+
*/
|
|
5447
|
+
export interface JsonApiAutomationPatchRelationshipsRecipients {
|
|
5448
|
+
/**
|
|
5449
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5450
|
+
* @type {Array<JsonApiUserLinkage>}
|
|
5451
|
+
* @memberof JsonApiAutomationPatchRelationshipsRecipients
|
|
5452
|
+
*/
|
|
5453
|
+
data: Array<JsonApiUserLinkage>;
|
|
5115
5454
|
}
|
|
5116
5455
|
/**
|
|
5117
5456
|
* JSON:API representation of colorPalette entity.
|
|
@@ -5376,10 +5715,10 @@ export interface JsonApiCookieSecurityConfigurationIn {
|
|
|
5376
5715
|
id: string;
|
|
5377
5716
|
/**
|
|
5378
5717
|
*
|
|
5379
|
-
* @type {
|
|
5718
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
5380
5719
|
* @memberof JsonApiCookieSecurityConfigurationIn
|
|
5381
5720
|
*/
|
|
5382
|
-
attributes?:
|
|
5721
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
5383
5722
|
}
|
|
5384
5723
|
export declare const JsonApiCookieSecurityConfigurationInTypeEnum: {
|
|
5385
5724
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
@@ -5418,15 +5757,34 @@ export interface JsonApiCookieSecurityConfigurationOut {
|
|
|
5418
5757
|
id: string;
|
|
5419
5758
|
/**
|
|
5420
5759
|
*
|
|
5421
|
-
* @type {
|
|
5760
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
5422
5761
|
* @memberof JsonApiCookieSecurityConfigurationOut
|
|
5423
5762
|
*/
|
|
5424
|
-
attributes?:
|
|
5763
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
5425
5764
|
}
|
|
5426
5765
|
export declare const JsonApiCookieSecurityConfigurationOutTypeEnum: {
|
|
5427
5766
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
5428
5767
|
};
|
|
5429
5768
|
export type JsonApiCookieSecurityConfigurationOutTypeEnum = typeof JsonApiCookieSecurityConfigurationOutTypeEnum[keyof typeof JsonApiCookieSecurityConfigurationOutTypeEnum];
|
|
5769
|
+
/**
|
|
5770
|
+
*
|
|
5771
|
+
* @export
|
|
5772
|
+
* @interface JsonApiCookieSecurityConfigurationOutAttributes
|
|
5773
|
+
*/
|
|
5774
|
+
export interface JsonApiCookieSecurityConfigurationOutAttributes {
|
|
5775
|
+
/**
|
|
5776
|
+
*
|
|
5777
|
+
* @type {string}
|
|
5778
|
+
* @memberof JsonApiCookieSecurityConfigurationOutAttributes
|
|
5779
|
+
*/
|
|
5780
|
+
lastRotation?: string;
|
|
5781
|
+
/**
|
|
5782
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
5783
|
+
* @type {string}
|
|
5784
|
+
* @memberof JsonApiCookieSecurityConfigurationOutAttributes
|
|
5785
|
+
*/
|
|
5786
|
+
rotationInterval?: string;
|
|
5787
|
+
}
|
|
5430
5788
|
/**
|
|
5431
5789
|
*
|
|
5432
5790
|
* @export
|
|
@@ -5466,34 +5824,15 @@ export interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
5466
5824
|
id: string;
|
|
5467
5825
|
/**
|
|
5468
5826
|
*
|
|
5469
|
-
* @type {
|
|
5827
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
5470
5828
|
* @memberof JsonApiCookieSecurityConfigurationPatch
|
|
5471
5829
|
*/
|
|
5472
|
-
attributes?:
|
|
5830
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
5473
5831
|
}
|
|
5474
5832
|
export declare const JsonApiCookieSecurityConfigurationPatchTypeEnum: {
|
|
5475
5833
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
5476
5834
|
};
|
|
5477
5835
|
export type JsonApiCookieSecurityConfigurationPatchTypeEnum = typeof JsonApiCookieSecurityConfigurationPatchTypeEnum[keyof typeof JsonApiCookieSecurityConfigurationPatchTypeEnum];
|
|
5478
|
-
/**
|
|
5479
|
-
*
|
|
5480
|
-
* @export
|
|
5481
|
-
* @interface JsonApiCookieSecurityConfigurationPatchAttributes
|
|
5482
|
-
*/
|
|
5483
|
-
export interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
5484
|
-
/**
|
|
5485
|
-
*
|
|
5486
|
-
* @type {string}
|
|
5487
|
-
* @memberof JsonApiCookieSecurityConfigurationPatchAttributes
|
|
5488
|
-
*/
|
|
5489
|
-
lastRotation?: string;
|
|
5490
|
-
/**
|
|
5491
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
5492
|
-
* @type {string}
|
|
5493
|
-
* @memberof JsonApiCookieSecurityConfigurationPatchAttributes
|
|
5494
|
-
*/
|
|
5495
|
-
rotationInterval?: string;
|
|
5496
|
-
}
|
|
5497
5836
|
/**
|
|
5498
5837
|
*
|
|
5499
5838
|
* @export
|
|
@@ -7502,10 +7841,10 @@ export interface JsonApiDatasetOutRelationships {
|
|
|
7502
7841
|
attributes?: JsonApiAttributeHierarchyOutRelationshipsAttributes;
|
|
7503
7842
|
/**
|
|
7504
7843
|
*
|
|
7505
|
-
* @type {
|
|
7844
|
+
* @type {JsonApiMetricOutRelationshipsFacts}
|
|
7506
7845
|
* @memberof JsonApiDatasetOutRelationships
|
|
7507
7846
|
*/
|
|
7508
|
-
facts?:
|
|
7847
|
+
facts?: JsonApiMetricOutRelationshipsFacts;
|
|
7509
7848
|
/**
|
|
7510
7849
|
*
|
|
7511
7850
|
* @type {JsonApiAnalyticalDashboardOutRelationshipsDatasets}
|
|
@@ -7519,19 +7858,6 @@ export interface JsonApiDatasetOutRelationships {
|
|
|
7519
7858
|
*/
|
|
7520
7859
|
workspaceDataFilters?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
7521
7860
|
}
|
|
7522
|
-
/**
|
|
7523
|
-
*
|
|
7524
|
-
* @export
|
|
7525
|
-
* @interface JsonApiDatasetOutRelationshipsFacts
|
|
7526
|
-
*/
|
|
7527
|
-
export interface JsonApiDatasetOutRelationshipsFacts {
|
|
7528
|
-
/**
|
|
7529
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7530
|
-
* @type {Array<JsonApiFactLinkage>}
|
|
7531
|
-
* @memberof JsonApiDatasetOutRelationshipsFacts
|
|
7532
|
-
*/
|
|
7533
|
-
data: Array<JsonApiFactLinkage>;
|
|
7534
|
-
}
|
|
7535
7861
|
/**
|
|
7536
7862
|
*
|
|
7537
7863
|
* @export
|
|
@@ -7863,10 +8189,10 @@ export interface JsonApiExportDefinitionOutAttributes {
|
|
|
7863
8189
|
tags?: Array<string>;
|
|
7864
8190
|
/**
|
|
7865
8191
|
* JSON content to be used as export request payload for /export/tabular and /export/visual endpoints.
|
|
7866
|
-
* @type {
|
|
8192
|
+
* @type {VisualExportRequest | TabularExportRequest}
|
|
7867
8193
|
* @memberof JsonApiExportDefinitionOutAttributes
|
|
7868
8194
|
*/
|
|
7869
|
-
requestPayload?:
|
|
8195
|
+
requestPayload?: VisualExportRequest | TabularExportRequest;
|
|
7870
8196
|
/**
|
|
7871
8197
|
*
|
|
7872
8198
|
* @type {boolean}
|
|
@@ -7955,16 +8281,16 @@ export interface JsonApiExportDefinitionOutList {
|
|
|
7955
8281
|
export interface JsonApiExportDefinitionOutRelationships {
|
|
7956
8282
|
/**
|
|
7957
8283
|
*
|
|
7958
|
-
* @type {
|
|
8284
|
+
* @type {JsonApiExportDefinitionPatchRelationshipsVisualizationObject}
|
|
7959
8285
|
* @memberof JsonApiExportDefinitionOutRelationships
|
|
7960
8286
|
*/
|
|
7961
|
-
visualizationObject?:
|
|
8287
|
+
visualizationObject?: JsonApiExportDefinitionPatchRelationshipsVisualizationObject;
|
|
7962
8288
|
/**
|
|
7963
8289
|
*
|
|
7964
|
-
* @type {
|
|
8290
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
7965
8291
|
* @memberof JsonApiExportDefinitionOutRelationships
|
|
7966
8292
|
*/
|
|
7967
|
-
analyticalDashboard?:
|
|
8293
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
7968
8294
|
/**
|
|
7969
8295
|
*
|
|
7970
8296
|
* @type {JsonApiAnalyticalDashboardOutRelationshipsCreatedBy}
|
|
@@ -7978,32 +8304,6 @@ export interface JsonApiExportDefinitionOutRelationships {
|
|
|
7978
8304
|
*/
|
|
7979
8305
|
modifiedBy?: JsonApiAnalyticalDashboardOutRelationshipsCreatedBy;
|
|
7980
8306
|
}
|
|
7981
|
-
/**
|
|
7982
|
-
*
|
|
7983
|
-
* @export
|
|
7984
|
-
* @interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard
|
|
7985
|
-
*/
|
|
7986
|
-
export interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
7987
|
-
/**
|
|
7988
|
-
*
|
|
7989
|
-
* @type {JsonApiAnalyticalDashboardToOneLinkage}
|
|
7990
|
-
* @memberof JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard
|
|
7991
|
-
*/
|
|
7992
|
-
data: JsonApiAnalyticalDashboardToOneLinkage | null;
|
|
7993
|
-
}
|
|
7994
|
-
/**
|
|
7995
|
-
*
|
|
7996
|
-
* @export
|
|
7997
|
-
* @interface JsonApiExportDefinitionOutRelationshipsVisualizationObject
|
|
7998
|
-
*/
|
|
7999
|
-
export interface JsonApiExportDefinitionOutRelationshipsVisualizationObject {
|
|
8000
|
-
/**
|
|
8001
|
-
*
|
|
8002
|
-
* @type {JsonApiVisualizationObjectToOneLinkage}
|
|
8003
|
-
* @memberof JsonApiExportDefinitionOutRelationshipsVisualizationObject
|
|
8004
|
-
*/
|
|
8005
|
-
data: JsonApiVisualizationObjectToOneLinkage | null;
|
|
8006
|
-
}
|
|
8007
8307
|
/**
|
|
8008
8308
|
*
|
|
8009
8309
|
* @export
|
|
@@ -8112,10 +8412,10 @@ export interface JsonApiExportDefinitionPatchAttributes {
|
|
|
8112
8412
|
tags?: Array<string>;
|
|
8113
8413
|
/**
|
|
8114
8414
|
* JSON content to be used as export request payload for /export/tabular and /export/visual endpoints.
|
|
8115
|
-
* @type {
|
|
8415
|
+
* @type {VisualExportRequest | TabularExportRequest}
|
|
8116
8416
|
* @memberof JsonApiExportDefinitionPatchAttributes
|
|
8117
8417
|
*/
|
|
8118
|
-
requestPayload?:
|
|
8418
|
+
requestPayload?: VisualExportRequest | TabularExportRequest;
|
|
8119
8419
|
/**
|
|
8120
8420
|
*
|
|
8121
8421
|
* @type {boolean}
|
|
@@ -8144,16 +8444,29 @@ export interface JsonApiExportDefinitionPatchDocument {
|
|
|
8144
8444
|
export interface JsonApiExportDefinitionPatchRelationships {
|
|
8145
8445
|
/**
|
|
8146
8446
|
*
|
|
8147
|
-
* @type {
|
|
8447
|
+
* @type {JsonApiExportDefinitionPatchRelationshipsVisualizationObject}
|
|
8148
8448
|
* @memberof JsonApiExportDefinitionPatchRelationships
|
|
8149
8449
|
*/
|
|
8150
|
-
visualizationObject?:
|
|
8450
|
+
visualizationObject?: JsonApiExportDefinitionPatchRelationshipsVisualizationObject;
|
|
8151
8451
|
/**
|
|
8152
8452
|
*
|
|
8153
|
-
* @type {
|
|
8453
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
8154
8454
|
* @memberof JsonApiExportDefinitionPatchRelationships
|
|
8155
8455
|
*/
|
|
8156
|
-
analyticalDashboard?:
|
|
8456
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
8457
|
+
}
|
|
8458
|
+
/**
|
|
8459
|
+
*
|
|
8460
|
+
* @export
|
|
8461
|
+
* @interface JsonApiExportDefinitionPatchRelationshipsVisualizationObject
|
|
8462
|
+
*/
|
|
8463
|
+
export interface JsonApiExportDefinitionPatchRelationshipsVisualizationObject {
|
|
8464
|
+
/**
|
|
8465
|
+
*
|
|
8466
|
+
* @type {JsonApiVisualizationObjectToOneLinkage}
|
|
8467
|
+
* @memberof JsonApiExportDefinitionPatchRelationshipsVisualizationObject
|
|
8468
|
+
*/
|
|
8469
|
+
data: JsonApiVisualizationObjectToOneLinkage | null;
|
|
8157
8470
|
}
|
|
8158
8471
|
/**
|
|
8159
8472
|
* JSON:API representation of exportDefinition entity.
|
|
@@ -9294,52 +9607,15 @@ export interface JsonApiMetricIn {
|
|
|
9294
9607
|
id: string;
|
|
9295
9608
|
/**
|
|
9296
9609
|
*
|
|
9297
|
-
* @type {
|
|
9610
|
+
* @type {JsonApiMetricPostOptionalIdAttributes}
|
|
9298
9611
|
* @memberof JsonApiMetricIn
|
|
9299
9612
|
*/
|
|
9300
|
-
attributes:
|
|
9613
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
9301
9614
|
}
|
|
9302
9615
|
export declare const JsonApiMetricInTypeEnum: {
|
|
9303
9616
|
readonly METRIC: "metric";
|
|
9304
9617
|
};
|
|
9305
9618
|
export type JsonApiMetricInTypeEnum = typeof JsonApiMetricInTypeEnum[keyof typeof JsonApiMetricInTypeEnum];
|
|
9306
|
-
/**
|
|
9307
|
-
*
|
|
9308
|
-
* @export
|
|
9309
|
-
* @interface JsonApiMetricInAttributes
|
|
9310
|
-
*/
|
|
9311
|
-
export interface JsonApiMetricInAttributes {
|
|
9312
|
-
/**
|
|
9313
|
-
*
|
|
9314
|
-
* @type {string}
|
|
9315
|
-
* @memberof JsonApiMetricInAttributes
|
|
9316
|
-
*/
|
|
9317
|
-
title?: string;
|
|
9318
|
-
/**
|
|
9319
|
-
*
|
|
9320
|
-
* @type {string}
|
|
9321
|
-
* @memberof JsonApiMetricInAttributes
|
|
9322
|
-
*/
|
|
9323
|
-
description?: string;
|
|
9324
|
-
/**
|
|
9325
|
-
*
|
|
9326
|
-
* @type {Array<string>}
|
|
9327
|
-
* @memberof JsonApiMetricInAttributes
|
|
9328
|
-
*/
|
|
9329
|
-
tags?: Array<string>;
|
|
9330
|
-
/**
|
|
9331
|
-
*
|
|
9332
|
-
* @type {boolean}
|
|
9333
|
-
* @memberof JsonApiMetricInAttributes
|
|
9334
|
-
*/
|
|
9335
|
-
areRelationsValid?: boolean;
|
|
9336
|
-
/**
|
|
9337
|
-
*
|
|
9338
|
-
* @type {JsonApiMetricOutAttributesContent}
|
|
9339
|
-
* @memberof JsonApiMetricInAttributes
|
|
9340
|
-
*/
|
|
9341
|
-
content: JsonApiMetricOutAttributesContent;
|
|
9342
|
-
}
|
|
9343
9619
|
/**
|
|
9344
9620
|
*
|
|
9345
9621
|
* @export
|
|
@@ -9449,10 +9725,10 @@ export interface JsonApiMetricOutAttributes {
|
|
|
9449
9725
|
areRelationsValid?: boolean;
|
|
9450
9726
|
/**
|
|
9451
9727
|
*
|
|
9452
|
-
* @type {
|
|
9728
|
+
* @type {JsonApiMetricPatchAttributesContent}
|
|
9453
9729
|
* @memberof JsonApiMetricOutAttributes
|
|
9454
9730
|
*/
|
|
9455
|
-
content:
|
|
9731
|
+
content: JsonApiMetricPatchAttributesContent;
|
|
9456
9732
|
/**
|
|
9457
9733
|
*
|
|
9458
9734
|
* @type {string}
|
|
@@ -9466,25 +9742,6 @@ export interface JsonApiMetricOutAttributes {
|
|
|
9466
9742
|
*/
|
|
9467
9743
|
modifiedAt?: string;
|
|
9468
9744
|
}
|
|
9469
|
-
/**
|
|
9470
|
-
*
|
|
9471
|
-
* @export
|
|
9472
|
-
* @interface JsonApiMetricOutAttributesContent
|
|
9473
|
-
*/
|
|
9474
|
-
export interface JsonApiMetricOutAttributesContent {
|
|
9475
|
-
/**
|
|
9476
|
-
*
|
|
9477
|
-
* @type {string}
|
|
9478
|
-
* @memberof JsonApiMetricOutAttributesContent
|
|
9479
|
-
*/
|
|
9480
|
-
format?: string;
|
|
9481
|
-
/**
|
|
9482
|
-
*
|
|
9483
|
-
* @type {string}
|
|
9484
|
-
* @memberof JsonApiMetricOutAttributesContent
|
|
9485
|
-
*/
|
|
9486
|
-
maql: string;
|
|
9487
|
-
}
|
|
9488
9745
|
/**
|
|
9489
9746
|
*
|
|
9490
9747
|
* @export
|
|
@@ -9566,10 +9823,10 @@ export interface JsonApiMetricOutRelationships {
|
|
|
9566
9823
|
modifiedBy?: JsonApiAnalyticalDashboardOutRelationshipsCreatedBy;
|
|
9567
9824
|
/**
|
|
9568
9825
|
*
|
|
9569
|
-
* @type {
|
|
9826
|
+
* @type {JsonApiMetricOutRelationshipsFacts}
|
|
9570
9827
|
* @memberof JsonApiMetricOutRelationships
|
|
9571
9828
|
*/
|
|
9572
|
-
facts?:
|
|
9829
|
+
facts?: JsonApiMetricOutRelationshipsFacts;
|
|
9573
9830
|
/**
|
|
9574
9831
|
*
|
|
9575
9832
|
* @type {JsonApiAttributeHierarchyOutRelationshipsAttributes}
|
|
@@ -9595,6 +9852,19 @@ export interface JsonApiMetricOutRelationships {
|
|
|
9595
9852
|
*/
|
|
9596
9853
|
datasets?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
9597
9854
|
}
|
|
9855
|
+
/**
|
|
9856
|
+
*
|
|
9857
|
+
* @export
|
|
9858
|
+
* @interface JsonApiMetricOutRelationshipsFacts
|
|
9859
|
+
*/
|
|
9860
|
+
export interface JsonApiMetricOutRelationshipsFacts {
|
|
9861
|
+
/**
|
|
9862
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
9863
|
+
* @type {Array<JsonApiFactLinkage>}
|
|
9864
|
+
* @memberof JsonApiMetricOutRelationshipsFacts
|
|
9865
|
+
*/
|
|
9866
|
+
data: Array<JsonApiFactLinkage>;
|
|
9867
|
+
}
|
|
9598
9868
|
/**
|
|
9599
9869
|
*
|
|
9600
9870
|
* @export
|
|
@@ -9703,10 +9973,29 @@ export interface JsonApiMetricPatchAttributes {
|
|
|
9703
9973
|
areRelationsValid?: boolean;
|
|
9704
9974
|
/**
|
|
9705
9975
|
*
|
|
9706
|
-
* @type {
|
|
9976
|
+
* @type {JsonApiMetricPatchAttributesContent}
|
|
9707
9977
|
* @memberof JsonApiMetricPatchAttributes
|
|
9708
9978
|
*/
|
|
9709
|
-
content?:
|
|
9979
|
+
content?: JsonApiMetricPatchAttributesContent;
|
|
9980
|
+
}
|
|
9981
|
+
/**
|
|
9982
|
+
*
|
|
9983
|
+
* @export
|
|
9984
|
+
* @interface JsonApiMetricPatchAttributesContent
|
|
9985
|
+
*/
|
|
9986
|
+
export interface JsonApiMetricPatchAttributesContent {
|
|
9987
|
+
/**
|
|
9988
|
+
*
|
|
9989
|
+
* @type {string}
|
|
9990
|
+
* @memberof JsonApiMetricPatchAttributesContent
|
|
9991
|
+
*/
|
|
9992
|
+
format?: string;
|
|
9993
|
+
/**
|
|
9994
|
+
*
|
|
9995
|
+
* @type {string}
|
|
9996
|
+
* @memberof JsonApiMetricPatchAttributesContent
|
|
9997
|
+
*/
|
|
9998
|
+
maql: string;
|
|
9710
9999
|
}
|
|
9711
10000
|
/**
|
|
9712
10001
|
*
|
|
@@ -9741,15 +10030,52 @@ export interface JsonApiMetricPostOptionalId {
|
|
|
9741
10030
|
id?: string;
|
|
9742
10031
|
/**
|
|
9743
10032
|
*
|
|
9744
|
-
* @type {
|
|
10033
|
+
* @type {JsonApiMetricPostOptionalIdAttributes}
|
|
9745
10034
|
* @memberof JsonApiMetricPostOptionalId
|
|
9746
10035
|
*/
|
|
9747
|
-
attributes:
|
|
10036
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
9748
10037
|
}
|
|
9749
10038
|
export declare const JsonApiMetricPostOptionalIdTypeEnum: {
|
|
9750
10039
|
readonly METRIC: "metric";
|
|
9751
10040
|
};
|
|
9752
10041
|
export type JsonApiMetricPostOptionalIdTypeEnum = typeof JsonApiMetricPostOptionalIdTypeEnum[keyof typeof JsonApiMetricPostOptionalIdTypeEnum];
|
|
10042
|
+
/**
|
|
10043
|
+
*
|
|
10044
|
+
* @export
|
|
10045
|
+
* @interface JsonApiMetricPostOptionalIdAttributes
|
|
10046
|
+
*/
|
|
10047
|
+
export interface JsonApiMetricPostOptionalIdAttributes {
|
|
10048
|
+
/**
|
|
10049
|
+
*
|
|
10050
|
+
* @type {string}
|
|
10051
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
10052
|
+
*/
|
|
10053
|
+
title?: string;
|
|
10054
|
+
/**
|
|
10055
|
+
*
|
|
10056
|
+
* @type {string}
|
|
10057
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
10058
|
+
*/
|
|
10059
|
+
description?: string;
|
|
10060
|
+
/**
|
|
10061
|
+
*
|
|
10062
|
+
* @type {Array<string>}
|
|
10063
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
10064
|
+
*/
|
|
10065
|
+
tags?: Array<string>;
|
|
10066
|
+
/**
|
|
10067
|
+
*
|
|
10068
|
+
* @type {boolean}
|
|
10069
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
10070
|
+
*/
|
|
10071
|
+
areRelationsValid?: boolean;
|
|
10072
|
+
/**
|
|
10073
|
+
*
|
|
10074
|
+
* @type {JsonApiMetricPatchAttributesContent}
|
|
10075
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
10076
|
+
*/
|
|
10077
|
+
content: JsonApiMetricPatchAttributesContent;
|
|
10078
|
+
}
|
|
9753
10079
|
/**
|
|
9754
10080
|
*
|
|
9755
10081
|
* @export
|
|
@@ -9810,12 +10136,18 @@ export interface JsonApiNotificationChannelInAttributes {
|
|
|
9810
10136
|
* @memberof JsonApiNotificationChannelInAttributes
|
|
9811
10137
|
*/
|
|
9812
10138
|
description?: string | null;
|
|
10139
|
+
/**
|
|
10140
|
+
* The destination where the notifications are to be sent.
|
|
10141
|
+
* @type {Webhook}
|
|
10142
|
+
* @memberof JsonApiNotificationChannelInAttributes
|
|
10143
|
+
*/
|
|
10144
|
+
destination?: Webhook;
|
|
9813
10145
|
/**
|
|
9814
10146
|
*
|
|
9815
|
-
* @type {
|
|
10147
|
+
* @type {string}
|
|
9816
10148
|
* @memberof JsonApiNotificationChannelInAttributes
|
|
9817
10149
|
*/
|
|
9818
|
-
|
|
10150
|
+
destinationType?: JsonApiNotificationChannelInAttributesDestinationTypeEnum;
|
|
9819
10151
|
/**
|
|
9820
10152
|
* The triggers that are to be used to send notifications to the channel.
|
|
9821
10153
|
* @type {Array<JsonApiNotificationChannelInAttributesTriggers>}
|
|
@@ -9823,6 +10155,10 @@ export interface JsonApiNotificationChannelInAttributes {
|
|
|
9823
10155
|
*/
|
|
9824
10156
|
triggers?: Array<JsonApiNotificationChannelInAttributesTriggers>;
|
|
9825
10157
|
}
|
|
10158
|
+
export declare const JsonApiNotificationChannelInAttributesDestinationTypeEnum: {
|
|
10159
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
10160
|
+
};
|
|
10161
|
+
export type JsonApiNotificationChannelInAttributesDestinationTypeEnum = typeof JsonApiNotificationChannelInAttributesDestinationTypeEnum[keyof typeof JsonApiNotificationChannelInAttributesDestinationTypeEnum];
|
|
9826
10162
|
/**
|
|
9827
10163
|
*
|
|
9828
10164
|
* @export
|
|
@@ -9847,31 +10183,6 @@ export declare const JsonApiNotificationChannelInAttributesTriggersTypeEnum: {
|
|
|
9847
10183
|
readonly ALERT: "ALERT";
|
|
9848
10184
|
};
|
|
9849
10185
|
export type JsonApiNotificationChannelInAttributesTriggersTypeEnum = typeof JsonApiNotificationChannelInAttributesTriggersTypeEnum[keyof typeof JsonApiNotificationChannelInAttributesTriggersTypeEnum];
|
|
9850
|
-
/**
|
|
9851
|
-
*
|
|
9852
|
-
* @export
|
|
9853
|
-
* @interface JsonApiNotificationChannelInAttributesWebhook
|
|
9854
|
-
*/
|
|
9855
|
-
export interface JsonApiNotificationChannelInAttributesWebhook {
|
|
9856
|
-
/**
|
|
9857
|
-
* The webhook URL.
|
|
9858
|
-
* @type {string}
|
|
9859
|
-
* @memberof JsonApiNotificationChannelInAttributesWebhook
|
|
9860
|
-
*/
|
|
9861
|
-
url: string;
|
|
9862
|
-
/**
|
|
9863
|
-
* Bearer token for the webhook.
|
|
9864
|
-
* @type {string}
|
|
9865
|
-
* @memberof JsonApiNotificationChannelInAttributesWebhook
|
|
9866
|
-
*/
|
|
9867
|
-
token?: string | null;
|
|
9868
|
-
/**
|
|
9869
|
-
*
|
|
9870
|
-
* @type {boolean}
|
|
9871
|
-
* @memberof JsonApiNotificationChannelInAttributesWebhook
|
|
9872
|
-
*/
|
|
9873
|
-
hasToken?: boolean;
|
|
9874
|
-
}
|
|
9875
10186
|
/**
|
|
9876
10187
|
*
|
|
9877
10188
|
* @export
|
|
@@ -10343,16 +10654,42 @@ export type JsonApiOrganizationOutMetaPermissionsEnum = typeof JsonApiOrganizati
|
|
|
10343
10654
|
export interface JsonApiOrganizationOutRelationships {
|
|
10344
10655
|
/**
|
|
10345
10656
|
*
|
|
10346
|
-
* @type {
|
|
10657
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
10347
10658
|
* @memberof JsonApiOrganizationOutRelationships
|
|
10348
10659
|
*/
|
|
10349
|
-
bootstrapUser?:
|
|
10660
|
+
bootstrapUser?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
10350
10661
|
/**
|
|
10351
10662
|
*
|
|
10352
|
-
* @type {
|
|
10663
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
10353
10664
|
* @memberof JsonApiOrganizationOutRelationships
|
|
10354
10665
|
*/
|
|
10355
|
-
bootstrapUserGroup?:
|
|
10666
|
+
bootstrapUserGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
10667
|
+
}
|
|
10668
|
+
/**
|
|
10669
|
+
*
|
|
10670
|
+
* @export
|
|
10671
|
+
* @interface JsonApiOrganizationOutRelationshipsBootstrapUser
|
|
10672
|
+
*/
|
|
10673
|
+
export interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
10674
|
+
/**
|
|
10675
|
+
*
|
|
10676
|
+
* @type {JsonApiUserToOneLinkage}
|
|
10677
|
+
* @memberof JsonApiOrganizationOutRelationshipsBootstrapUser
|
|
10678
|
+
*/
|
|
10679
|
+
data: JsonApiUserToOneLinkage | null;
|
|
10680
|
+
}
|
|
10681
|
+
/**
|
|
10682
|
+
*
|
|
10683
|
+
* @export
|
|
10684
|
+
* @interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup
|
|
10685
|
+
*/
|
|
10686
|
+
export interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
10687
|
+
/**
|
|
10688
|
+
*
|
|
10689
|
+
* @type {JsonApiUserGroupToOneLinkage}
|
|
10690
|
+
* @memberof JsonApiOrganizationOutRelationshipsBootstrapUserGroup
|
|
10691
|
+
*/
|
|
10692
|
+
data: JsonApiUserGroupToOneLinkage | null;
|
|
10356
10693
|
}
|
|
10357
10694
|
/**
|
|
10358
10695
|
* JSON:API representation of patching organization entity.
|
|
@@ -10490,15 +10827,51 @@ export interface JsonApiOrganizationSettingIn {
|
|
|
10490
10827
|
id: string;
|
|
10491
10828
|
/**
|
|
10492
10829
|
*
|
|
10493
|
-
* @type {
|
|
10830
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
10494
10831
|
* @memberof JsonApiOrganizationSettingIn
|
|
10495
10832
|
*/
|
|
10496
|
-
attributes?:
|
|
10833
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
10497
10834
|
}
|
|
10498
10835
|
export declare const JsonApiOrganizationSettingInTypeEnum: {
|
|
10499
10836
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
10500
10837
|
};
|
|
10501
10838
|
export type JsonApiOrganizationSettingInTypeEnum = typeof JsonApiOrganizationSettingInTypeEnum[keyof typeof JsonApiOrganizationSettingInTypeEnum];
|
|
10839
|
+
/**
|
|
10840
|
+
*
|
|
10841
|
+
* @export
|
|
10842
|
+
* @interface JsonApiOrganizationSettingInAttributes
|
|
10843
|
+
*/
|
|
10844
|
+
export interface JsonApiOrganizationSettingInAttributes {
|
|
10845
|
+
/**
|
|
10846
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
10847
|
+
* @type {object}
|
|
10848
|
+
* @memberof JsonApiOrganizationSettingInAttributes
|
|
10849
|
+
*/
|
|
10850
|
+
content?: object;
|
|
10851
|
+
/**
|
|
10852
|
+
*
|
|
10853
|
+
* @type {string}
|
|
10854
|
+
* @memberof JsonApiOrganizationSettingInAttributes
|
|
10855
|
+
*/
|
|
10856
|
+
type?: JsonApiOrganizationSettingInAttributesTypeEnum;
|
|
10857
|
+
}
|
|
10858
|
+
export declare const JsonApiOrganizationSettingInAttributesTypeEnum: {
|
|
10859
|
+
readonly TIMEZONE: "TIMEZONE";
|
|
10860
|
+
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
10861
|
+
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
10862
|
+
readonly WHITE_LABELING: "WHITE_LABELING";
|
|
10863
|
+
readonly LOCALE: "LOCALE";
|
|
10864
|
+
readonly METADATA_LOCALE: "METADATA_LOCALE";
|
|
10865
|
+
readonly FORMAT_LOCALE: "FORMAT_LOCALE";
|
|
10866
|
+
readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
|
|
10867
|
+
readonly WEEK_START: "WEEK_START";
|
|
10868
|
+
readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
|
|
10869
|
+
readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
|
|
10870
|
+
readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
|
|
10871
|
+
readonly OPENAI_CONFIG: "OPENAI_CONFIG";
|
|
10872
|
+
readonly ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS";
|
|
10873
|
+
};
|
|
10874
|
+
export type JsonApiOrganizationSettingInAttributesTypeEnum = typeof JsonApiOrganizationSettingInAttributesTypeEnum[keyof typeof JsonApiOrganizationSettingInAttributesTypeEnum];
|
|
10502
10875
|
/**
|
|
10503
10876
|
*
|
|
10504
10877
|
* @export
|
|
@@ -10532,10 +10905,10 @@ export interface JsonApiOrganizationSettingOut {
|
|
|
10532
10905
|
id: string;
|
|
10533
10906
|
/**
|
|
10534
10907
|
*
|
|
10535
|
-
* @type {
|
|
10908
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
10536
10909
|
* @memberof JsonApiOrganizationSettingOut
|
|
10537
10910
|
*/
|
|
10538
|
-
attributes?:
|
|
10911
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
10539
10912
|
}
|
|
10540
10913
|
export declare const JsonApiOrganizationSettingOutTypeEnum: {
|
|
10541
10914
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
@@ -10605,10 +10978,10 @@ export interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
10605
10978
|
id: string;
|
|
10606
10979
|
/**
|
|
10607
10980
|
*
|
|
10608
|
-
* @type {
|
|
10981
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
10609
10982
|
* @memberof JsonApiOrganizationSettingOutWithLinks
|
|
10610
10983
|
*/
|
|
10611
|
-
attributes?:
|
|
10984
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
10612
10985
|
/**
|
|
10613
10986
|
*
|
|
10614
10987
|
* @type {ObjectLinks}
|
|
@@ -10640,10 +11013,10 @@ export interface JsonApiOrganizationSettingPatch {
|
|
|
10640
11013
|
id: string;
|
|
10641
11014
|
/**
|
|
10642
11015
|
*
|
|
10643
|
-
* @type {
|
|
11016
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
10644
11017
|
* @memberof JsonApiOrganizationSettingPatch
|
|
10645
11018
|
*/
|
|
10646
|
-
attributes?:
|
|
11019
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
10647
11020
|
}
|
|
10648
11021
|
export declare const JsonApiOrganizationSettingPatchTypeEnum: {
|
|
10649
11022
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
@@ -11049,22 +11422,22 @@ export interface JsonApiUserDataFilterOutList {
|
|
|
11049
11422
|
export interface JsonApiUserDataFilterOutRelationships {
|
|
11050
11423
|
/**
|
|
11051
11424
|
*
|
|
11052
|
-
* @type {
|
|
11425
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
11053
11426
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
11054
11427
|
*/
|
|
11055
|
-
user?:
|
|
11428
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
11056
11429
|
/**
|
|
11057
11430
|
*
|
|
11058
|
-
* @type {
|
|
11431
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
11059
11432
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
11060
11433
|
*/
|
|
11061
|
-
userGroup?:
|
|
11434
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
11062
11435
|
/**
|
|
11063
11436
|
*
|
|
11064
|
-
* @type {
|
|
11437
|
+
* @type {JsonApiMetricOutRelationshipsFacts}
|
|
11065
11438
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
11066
11439
|
*/
|
|
11067
|
-
facts?:
|
|
11440
|
+
facts?: JsonApiMetricOutRelationshipsFacts;
|
|
11068
11441
|
/**
|
|
11069
11442
|
*
|
|
11070
11443
|
* @type {JsonApiAttributeHierarchyOutRelationshipsAttributes}
|
|
@@ -11090,32 +11463,6 @@ export interface JsonApiUserDataFilterOutRelationships {
|
|
|
11090
11463
|
*/
|
|
11091
11464
|
datasets?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
11092
11465
|
}
|
|
11093
|
-
/**
|
|
11094
|
-
*
|
|
11095
|
-
* @export
|
|
11096
|
-
* @interface JsonApiUserDataFilterOutRelationshipsUser
|
|
11097
|
-
*/
|
|
11098
|
-
export interface JsonApiUserDataFilterOutRelationshipsUser {
|
|
11099
|
-
/**
|
|
11100
|
-
*
|
|
11101
|
-
* @type {JsonApiUserToOneLinkage}
|
|
11102
|
-
* @memberof JsonApiUserDataFilterOutRelationshipsUser
|
|
11103
|
-
*/
|
|
11104
|
-
data: JsonApiUserToOneLinkage | null;
|
|
11105
|
-
}
|
|
11106
|
-
/**
|
|
11107
|
-
*
|
|
11108
|
-
* @export
|
|
11109
|
-
* @interface JsonApiUserDataFilterOutRelationshipsUserGroup
|
|
11110
|
-
*/
|
|
11111
|
-
export interface JsonApiUserDataFilterOutRelationshipsUserGroup {
|
|
11112
|
-
/**
|
|
11113
|
-
*
|
|
11114
|
-
* @type {JsonApiUserGroupToOneLinkage}
|
|
11115
|
-
* @memberof JsonApiUserDataFilterOutRelationshipsUserGroup
|
|
11116
|
-
*/
|
|
11117
|
-
data: JsonApiUserGroupToOneLinkage | null;
|
|
11118
|
-
}
|
|
11119
11466
|
/**
|
|
11120
11467
|
*
|
|
11121
11468
|
* @export
|
|
@@ -11256,16 +11603,16 @@ export interface JsonApiUserDataFilterPatchDocument {
|
|
|
11256
11603
|
export interface JsonApiUserDataFilterPatchRelationships {
|
|
11257
11604
|
/**
|
|
11258
11605
|
*
|
|
11259
|
-
* @type {
|
|
11606
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
11260
11607
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
11261
11608
|
*/
|
|
11262
|
-
user?:
|
|
11609
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
11263
11610
|
/**
|
|
11264
11611
|
*
|
|
11265
|
-
* @type {
|
|
11612
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
11266
11613
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
11267
11614
|
*/
|
|
11268
|
-
userGroup?:
|
|
11615
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
11269
11616
|
}
|
|
11270
11617
|
/**
|
|
11271
11618
|
* JSON:API representation of userDataFilter entity.
|
|
@@ -12088,10 +12435,10 @@ export interface JsonApiUserSettingIn {
|
|
|
12088
12435
|
id: string;
|
|
12089
12436
|
/**
|
|
12090
12437
|
*
|
|
12091
|
-
* @type {
|
|
12438
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
12092
12439
|
* @memberof JsonApiUserSettingIn
|
|
12093
12440
|
*/
|
|
12094
|
-
attributes?:
|
|
12441
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
12095
12442
|
}
|
|
12096
12443
|
export declare const JsonApiUserSettingInTypeEnum: {
|
|
12097
12444
|
readonly USER_SETTING: "userSetting";
|
|
@@ -12130,10 +12477,10 @@ export interface JsonApiUserSettingOut {
|
|
|
12130
12477
|
id: string;
|
|
12131
12478
|
/**
|
|
12132
12479
|
*
|
|
12133
|
-
* @type {
|
|
12480
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
12134
12481
|
* @memberof JsonApiUserSettingOut
|
|
12135
12482
|
*/
|
|
12136
|
-
attributes?:
|
|
12483
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
12137
12484
|
}
|
|
12138
12485
|
export declare const JsonApiUserSettingOutTypeEnum: {
|
|
12139
12486
|
readonly USER_SETTING: "userSetting";
|
|
@@ -12203,10 +12550,10 @@ export interface JsonApiUserSettingOutWithLinks {
|
|
|
12203
12550
|
id: string;
|
|
12204
12551
|
/**
|
|
12205
12552
|
*
|
|
12206
|
-
* @type {
|
|
12553
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
12207
12554
|
* @memberof JsonApiUserSettingOutWithLinks
|
|
12208
12555
|
*/
|
|
12209
|
-
attributes?:
|
|
12556
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
12210
12557
|
/**
|
|
12211
12558
|
*
|
|
12212
12559
|
* @type {ObjectLinks}
|
|
@@ -12543,16 +12890,16 @@ export interface JsonApiWorkspaceDataFilterIn {
|
|
|
12543
12890
|
id: string;
|
|
12544
12891
|
/**
|
|
12545
12892
|
*
|
|
12546
|
-
* @type {
|
|
12893
|
+
* @type {JsonApiWorkspaceDataFilterPatchAttributes}
|
|
12547
12894
|
* @memberof JsonApiWorkspaceDataFilterIn
|
|
12548
12895
|
*/
|
|
12549
|
-
attributes?:
|
|
12896
|
+
attributes?: JsonApiWorkspaceDataFilterPatchAttributes;
|
|
12550
12897
|
/**
|
|
12551
12898
|
*
|
|
12552
|
-
* @type {
|
|
12899
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationships}
|
|
12553
12900
|
* @memberof JsonApiWorkspaceDataFilterIn
|
|
12554
12901
|
*/
|
|
12555
|
-
relationships?:
|
|
12902
|
+
relationships?: JsonApiWorkspaceDataFilterPatchRelationships;
|
|
12556
12903
|
}
|
|
12557
12904
|
export declare const JsonApiWorkspaceDataFilterInTypeEnum: {
|
|
12558
12905
|
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
@@ -12620,46 +12967,21 @@ export interface JsonApiWorkspaceDataFilterOut {
|
|
|
12620
12967
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
12621
12968
|
/**
|
|
12622
12969
|
*
|
|
12623
|
-
* @type {
|
|
12970
|
+
* @type {JsonApiWorkspaceDataFilterPatchAttributes}
|
|
12624
12971
|
* @memberof JsonApiWorkspaceDataFilterOut
|
|
12625
12972
|
*/
|
|
12626
|
-
attributes?:
|
|
12973
|
+
attributes?: JsonApiWorkspaceDataFilterPatchAttributes;
|
|
12627
12974
|
/**
|
|
12628
12975
|
*
|
|
12629
|
-
* @type {
|
|
12976
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationships}
|
|
12630
12977
|
* @memberof JsonApiWorkspaceDataFilterOut
|
|
12631
12978
|
*/
|
|
12632
|
-
relationships?:
|
|
12979
|
+
relationships?: JsonApiWorkspaceDataFilterPatchRelationships;
|
|
12633
12980
|
}
|
|
12634
12981
|
export declare const JsonApiWorkspaceDataFilterOutTypeEnum: {
|
|
12635
12982
|
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
12636
12983
|
};
|
|
12637
12984
|
export type JsonApiWorkspaceDataFilterOutTypeEnum = typeof JsonApiWorkspaceDataFilterOutTypeEnum[keyof typeof JsonApiWorkspaceDataFilterOutTypeEnum];
|
|
12638
|
-
/**
|
|
12639
|
-
*
|
|
12640
|
-
* @export
|
|
12641
|
-
* @interface JsonApiWorkspaceDataFilterOutAttributes
|
|
12642
|
-
*/
|
|
12643
|
-
export interface JsonApiWorkspaceDataFilterOutAttributes {
|
|
12644
|
-
/**
|
|
12645
|
-
*
|
|
12646
|
-
* @type {string}
|
|
12647
|
-
* @memberof JsonApiWorkspaceDataFilterOutAttributes
|
|
12648
|
-
*/
|
|
12649
|
-
title?: string;
|
|
12650
|
-
/**
|
|
12651
|
-
*
|
|
12652
|
-
* @type {string}
|
|
12653
|
-
* @memberof JsonApiWorkspaceDataFilterOutAttributes
|
|
12654
|
-
*/
|
|
12655
|
-
description?: string;
|
|
12656
|
-
/**
|
|
12657
|
-
*
|
|
12658
|
-
* @type {string}
|
|
12659
|
-
* @memberof JsonApiWorkspaceDataFilterOutAttributes
|
|
12660
|
-
*/
|
|
12661
|
-
columnName?: string;
|
|
12662
|
-
}
|
|
12663
12985
|
/**
|
|
12664
12986
|
*
|
|
12665
12987
|
* @export
|
|
@@ -12716,32 +13038,6 @@ export interface JsonApiWorkspaceDataFilterOutList {
|
|
|
12716
13038
|
*/
|
|
12717
13039
|
included?: Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>;
|
|
12718
13040
|
}
|
|
12719
|
-
/**
|
|
12720
|
-
*
|
|
12721
|
-
* @export
|
|
12722
|
-
* @interface JsonApiWorkspaceDataFilterOutRelationships
|
|
12723
|
-
*/
|
|
12724
|
-
export interface JsonApiWorkspaceDataFilterOutRelationships {
|
|
12725
|
-
/**
|
|
12726
|
-
*
|
|
12727
|
-
* @type {JsonApiWorkspaceDataFilterOutRelationshipsFilterSettings}
|
|
12728
|
-
* @memberof JsonApiWorkspaceDataFilterOutRelationships
|
|
12729
|
-
*/
|
|
12730
|
-
filterSettings?: JsonApiWorkspaceDataFilterOutRelationshipsFilterSettings;
|
|
12731
|
-
}
|
|
12732
|
-
/**
|
|
12733
|
-
*
|
|
12734
|
-
* @export
|
|
12735
|
-
* @interface JsonApiWorkspaceDataFilterOutRelationshipsFilterSettings
|
|
12736
|
-
*/
|
|
12737
|
-
export interface JsonApiWorkspaceDataFilterOutRelationshipsFilterSettings {
|
|
12738
|
-
/**
|
|
12739
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
12740
|
-
* @type {Array<JsonApiWorkspaceDataFilterSettingLinkage>}
|
|
12741
|
-
* @memberof JsonApiWorkspaceDataFilterOutRelationshipsFilterSettings
|
|
12742
|
-
*/
|
|
12743
|
-
data: Array<JsonApiWorkspaceDataFilterSettingLinkage>;
|
|
12744
|
-
}
|
|
12745
13041
|
/**
|
|
12746
13042
|
*
|
|
12747
13043
|
* @export
|
|
@@ -12768,16 +13064,16 @@ export interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
|
12768
13064
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
12769
13065
|
/**
|
|
12770
13066
|
*
|
|
12771
|
-
* @type {
|
|
13067
|
+
* @type {JsonApiWorkspaceDataFilterPatchAttributes}
|
|
12772
13068
|
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
12773
13069
|
*/
|
|
12774
|
-
attributes?:
|
|
13070
|
+
attributes?: JsonApiWorkspaceDataFilterPatchAttributes;
|
|
12775
13071
|
/**
|
|
12776
13072
|
*
|
|
12777
|
-
* @type {
|
|
13073
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationships}
|
|
12778
13074
|
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
12779
13075
|
*/
|
|
12780
|
-
relationships?:
|
|
13076
|
+
relationships?: JsonApiWorkspaceDataFilterPatchRelationships;
|
|
12781
13077
|
/**
|
|
12782
13078
|
*
|
|
12783
13079
|
* @type {ObjectLinks}
|
|
@@ -12809,21 +13105,46 @@ export interface JsonApiWorkspaceDataFilterPatch {
|
|
|
12809
13105
|
id: string;
|
|
12810
13106
|
/**
|
|
12811
13107
|
*
|
|
12812
|
-
* @type {
|
|
13108
|
+
* @type {JsonApiWorkspaceDataFilterPatchAttributes}
|
|
12813
13109
|
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
12814
13110
|
*/
|
|
12815
|
-
attributes?:
|
|
13111
|
+
attributes?: JsonApiWorkspaceDataFilterPatchAttributes;
|
|
12816
13112
|
/**
|
|
12817
13113
|
*
|
|
12818
|
-
* @type {
|
|
13114
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationships}
|
|
12819
13115
|
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
12820
13116
|
*/
|
|
12821
|
-
relationships?:
|
|
13117
|
+
relationships?: JsonApiWorkspaceDataFilterPatchRelationships;
|
|
12822
13118
|
}
|
|
12823
13119
|
export declare const JsonApiWorkspaceDataFilterPatchTypeEnum: {
|
|
12824
13120
|
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
12825
13121
|
};
|
|
12826
13122
|
export type JsonApiWorkspaceDataFilterPatchTypeEnum = typeof JsonApiWorkspaceDataFilterPatchTypeEnum[keyof typeof JsonApiWorkspaceDataFilterPatchTypeEnum];
|
|
13123
|
+
/**
|
|
13124
|
+
*
|
|
13125
|
+
* @export
|
|
13126
|
+
* @interface JsonApiWorkspaceDataFilterPatchAttributes
|
|
13127
|
+
*/
|
|
13128
|
+
export interface JsonApiWorkspaceDataFilterPatchAttributes {
|
|
13129
|
+
/**
|
|
13130
|
+
*
|
|
13131
|
+
* @type {string}
|
|
13132
|
+
* @memberof JsonApiWorkspaceDataFilterPatchAttributes
|
|
13133
|
+
*/
|
|
13134
|
+
title?: string;
|
|
13135
|
+
/**
|
|
13136
|
+
*
|
|
13137
|
+
* @type {string}
|
|
13138
|
+
* @memberof JsonApiWorkspaceDataFilterPatchAttributes
|
|
13139
|
+
*/
|
|
13140
|
+
description?: string;
|
|
13141
|
+
/**
|
|
13142
|
+
*
|
|
13143
|
+
* @type {string}
|
|
13144
|
+
* @memberof JsonApiWorkspaceDataFilterPatchAttributes
|
|
13145
|
+
*/
|
|
13146
|
+
columnName?: string;
|
|
13147
|
+
}
|
|
12827
13148
|
/**
|
|
12828
13149
|
*
|
|
12829
13150
|
* @export
|
|
@@ -12837,6 +13158,32 @@ export interface JsonApiWorkspaceDataFilterPatchDocument {
|
|
|
12837
13158
|
*/
|
|
12838
13159
|
data: JsonApiWorkspaceDataFilterPatch;
|
|
12839
13160
|
}
|
|
13161
|
+
/**
|
|
13162
|
+
*
|
|
13163
|
+
* @export
|
|
13164
|
+
* @interface JsonApiWorkspaceDataFilterPatchRelationships
|
|
13165
|
+
*/
|
|
13166
|
+
export interface JsonApiWorkspaceDataFilterPatchRelationships {
|
|
13167
|
+
/**
|
|
13168
|
+
*
|
|
13169
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings}
|
|
13170
|
+
* @memberof JsonApiWorkspaceDataFilterPatchRelationships
|
|
13171
|
+
*/
|
|
13172
|
+
filterSettings?: JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings;
|
|
13173
|
+
}
|
|
13174
|
+
/**
|
|
13175
|
+
*
|
|
13176
|
+
* @export
|
|
13177
|
+
* @interface JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings
|
|
13178
|
+
*/
|
|
13179
|
+
export interface JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings {
|
|
13180
|
+
/**
|
|
13181
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
13182
|
+
* @type {Array<JsonApiWorkspaceDataFilterSettingLinkage>}
|
|
13183
|
+
* @memberof JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings
|
|
13184
|
+
*/
|
|
13185
|
+
data: Array<JsonApiWorkspaceDataFilterSettingLinkage>;
|
|
13186
|
+
}
|
|
12840
13187
|
/**
|
|
12841
13188
|
* JSON:API representation of workspaceDataFilterSetting entity.
|
|
12842
13189
|
* @export
|
|
@@ -12857,16 +13204,16 @@ export interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
12857
13204
|
id: string;
|
|
12858
13205
|
/**
|
|
12859
13206
|
*
|
|
12860
|
-
* @type {
|
|
13207
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
12861
13208
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
12862
13209
|
*/
|
|
12863
|
-
attributes?:
|
|
13210
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
12864
13211
|
/**
|
|
12865
13212
|
*
|
|
12866
|
-
* @type {
|
|
13213
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
12867
13214
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
12868
13215
|
*/
|
|
12869
|
-
relationships?:
|
|
13216
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
12870
13217
|
}
|
|
12871
13218
|
export declare const JsonApiWorkspaceDataFilterSettingInTypeEnum: {
|
|
12872
13219
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
@@ -12934,46 +13281,21 @@ export interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
12934
13281
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
12935
13282
|
/**
|
|
12936
13283
|
*
|
|
12937
|
-
* @type {
|
|
13284
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
12938
13285
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
12939
13286
|
*/
|
|
12940
|
-
attributes?:
|
|
13287
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
12941
13288
|
/**
|
|
12942
13289
|
*
|
|
12943
|
-
* @type {
|
|
13290
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
12944
13291
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
12945
13292
|
*/
|
|
12946
|
-
relationships?:
|
|
13293
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
12947
13294
|
}
|
|
12948
13295
|
export declare const JsonApiWorkspaceDataFilterSettingOutTypeEnum: {
|
|
12949
13296
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
12950
13297
|
};
|
|
12951
13298
|
export type JsonApiWorkspaceDataFilterSettingOutTypeEnum = typeof JsonApiWorkspaceDataFilterSettingOutTypeEnum[keyof typeof JsonApiWorkspaceDataFilterSettingOutTypeEnum];
|
|
12952
|
-
/**
|
|
12953
|
-
*
|
|
12954
|
-
* @export
|
|
12955
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
12956
|
-
*/
|
|
12957
|
-
export interface JsonApiWorkspaceDataFilterSettingOutAttributes {
|
|
12958
|
-
/**
|
|
12959
|
-
*
|
|
12960
|
-
* @type {string}
|
|
12961
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
12962
|
-
*/
|
|
12963
|
-
title?: string;
|
|
12964
|
-
/**
|
|
12965
|
-
*
|
|
12966
|
-
* @type {string}
|
|
12967
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
12968
|
-
*/
|
|
12969
|
-
description?: string;
|
|
12970
|
-
/**
|
|
12971
|
-
*
|
|
12972
|
-
* @type {Array<string>}
|
|
12973
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
12974
|
-
*/
|
|
12975
|
-
filterValues?: Array<string>;
|
|
12976
|
-
}
|
|
12977
13299
|
/**
|
|
12978
13300
|
*
|
|
12979
13301
|
* @export
|
|
@@ -13030,32 +13352,6 @@ export interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
|
13030
13352
|
*/
|
|
13031
13353
|
included?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
13032
13354
|
}
|
|
13033
|
-
/**
|
|
13034
|
-
*
|
|
13035
|
-
* @export
|
|
13036
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutRelationships
|
|
13037
|
-
*/
|
|
13038
|
-
export interface JsonApiWorkspaceDataFilterSettingOutRelationships {
|
|
13039
|
-
/**
|
|
13040
|
-
*
|
|
13041
|
-
* @type {JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter}
|
|
13042
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutRelationships
|
|
13043
|
-
*/
|
|
13044
|
-
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter;
|
|
13045
|
-
}
|
|
13046
|
-
/**
|
|
13047
|
-
*
|
|
13048
|
-
* @export
|
|
13049
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter
|
|
13050
|
-
*/
|
|
13051
|
-
export interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter {
|
|
13052
|
-
/**
|
|
13053
|
-
*
|
|
13054
|
-
* @type {JsonApiWorkspaceDataFilterToOneLinkage}
|
|
13055
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter
|
|
13056
|
-
*/
|
|
13057
|
-
data: JsonApiWorkspaceDataFilterToOneLinkage | null;
|
|
13058
|
-
}
|
|
13059
13355
|
/**
|
|
13060
13356
|
*
|
|
13061
13357
|
* @export
|
|
@@ -13082,16 +13378,16 @@ export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
13082
13378
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
13083
13379
|
/**
|
|
13084
13380
|
*
|
|
13085
|
-
* @type {
|
|
13381
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
13086
13382
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
13087
13383
|
*/
|
|
13088
|
-
attributes?:
|
|
13384
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
13089
13385
|
/**
|
|
13090
13386
|
*
|
|
13091
|
-
* @type {
|
|
13387
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
13092
13388
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
13093
13389
|
*/
|
|
13094
|
-
relationships?:
|
|
13390
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
13095
13391
|
/**
|
|
13096
13392
|
*
|
|
13097
13393
|
* @type {ObjectLinks}
|
|
@@ -13123,21 +13419,46 @@ export interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
13123
13419
|
id: string;
|
|
13124
13420
|
/**
|
|
13125
13421
|
*
|
|
13126
|
-
* @type {
|
|
13422
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
13127
13423
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
13128
13424
|
*/
|
|
13129
|
-
attributes?:
|
|
13425
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
13130
13426
|
/**
|
|
13131
13427
|
*
|
|
13132
|
-
* @type {
|
|
13428
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
13133
13429
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
13134
13430
|
*/
|
|
13135
|
-
relationships?:
|
|
13431
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
13136
13432
|
}
|
|
13137
13433
|
export declare const JsonApiWorkspaceDataFilterSettingPatchTypeEnum: {
|
|
13138
13434
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
13139
13435
|
};
|
|
13140
13436
|
export type JsonApiWorkspaceDataFilterSettingPatchTypeEnum = typeof JsonApiWorkspaceDataFilterSettingPatchTypeEnum[keyof typeof JsonApiWorkspaceDataFilterSettingPatchTypeEnum];
|
|
13437
|
+
/**
|
|
13438
|
+
*
|
|
13439
|
+
* @export
|
|
13440
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
13441
|
+
*/
|
|
13442
|
+
export interface JsonApiWorkspaceDataFilterSettingPatchAttributes {
|
|
13443
|
+
/**
|
|
13444
|
+
*
|
|
13445
|
+
* @type {string}
|
|
13446
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
13447
|
+
*/
|
|
13448
|
+
title?: string;
|
|
13449
|
+
/**
|
|
13450
|
+
*
|
|
13451
|
+
* @type {string}
|
|
13452
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
13453
|
+
*/
|
|
13454
|
+
description?: string;
|
|
13455
|
+
/**
|
|
13456
|
+
*
|
|
13457
|
+
* @type {Array<string>}
|
|
13458
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
13459
|
+
*/
|
|
13460
|
+
filterValues?: Array<string>;
|
|
13461
|
+
}
|
|
13141
13462
|
/**
|
|
13142
13463
|
*
|
|
13143
13464
|
* @export
|
|
@@ -13151,6 +13472,32 @@ export interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
|
13151
13472
|
*/
|
|
13152
13473
|
data: JsonApiWorkspaceDataFilterSettingPatch;
|
|
13153
13474
|
}
|
|
13475
|
+
/**
|
|
13476
|
+
*
|
|
13477
|
+
* @export
|
|
13478
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchRelationships
|
|
13479
|
+
*/
|
|
13480
|
+
export interface JsonApiWorkspaceDataFilterSettingPatchRelationships {
|
|
13481
|
+
/**
|
|
13482
|
+
*
|
|
13483
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter}
|
|
13484
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchRelationships
|
|
13485
|
+
*/
|
|
13486
|
+
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter;
|
|
13487
|
+
}
|
|
13488
|
+
/**
|
|
13489
|
+
*
|
|
13490
|
+
* @export
|
|
13491
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter
|
|
13492
|
+
*/
|
|
13493
|
+
export interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter {
|
|
13494
|
+
/**
|
|
13495
|
+
*
|
|
13496
|
+
* @type {JsonApiWorkspaceDataFilterToOneLinkage}
|
|
13497
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter
|
|
13498
|
+
*/
|
|
13499
|
+
data: JsonApiWorkspaceDataFilterToOneLinkage | null;
|
|
13500
|
+
}
|
|
13154
13501
|
/**
|
|
13155
13502
|
* @type JsonApiWorkspaceDataFilterToOneLinkage
|
|
13156
13503
|
* References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -13626,10 +13973,10 @@ export interface JsonApiWorkspaceSettingIn {
|
|
|
13626
13973
|
id: string;
|
|
13627
13974
|
/**
|
|
13628
13975
|
*
|
|
13629
|
-
* @type {
|
|
13976
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
13630
13977
|
* @memberof JsonApiWorkspaceSettingIn
|
|
13631
13978
|
*/
|
|
13632
|
-
attributes?:
|
|
13979
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
13633
13980
|
}
|
|
13634
13981
|
export declare const JsonApiWorkspaceSettingInTypeEnum: {
|
|
13635
13982
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
@@ -13674,51 +14021,15 @@ export interface JsonApiWorkspaceSettingOut {
|
|
|
13674
14021
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
13675
14022
|
/**
|
|
13676
14023
|
*
|
|
13677
|
-
* @type {
|
|
14024
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
13678
14025
|
* @memberof JsonApiWorkspaceSettingOut
|
|
13679
14026
|
*/
|
|
13680
|
-
attributes?:
|
|
14027
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
13681
14028
|
}
|
|
13682
14029
|
export declare const JsonApiWorkspaceSettingOutTypeEnum: {
|
|
13683
14030
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
13684
14031
|
};
|
|
13685
14032
|
export type JsonApiWorkspaceSettingOutTypeEnum = typeof JsonApiWorkspaceSettingOutTypeEnum[keyof typeof JsonApiWorkspaceSettingOutTypeEnum];
|
|
13686
|
-
/**
|
|
13687
|
-
*
|
|
13688
|
-
* @export
|
|
13689
|
-
* @interface JsonApiWorkspaceSettingOutAttributes
|
|
13690
|
-
*/
|
|
13691
|
-
export interface JsonApiWorkspaceSettingOutAttributes {
|
|
13692
|
-
/**
|
|
13693
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
13694
|
-
* @type {object}
|
|
13695
|
-
* @memberof JsonApiWorkspaceSettingOutAttributes
|
|
13696
|
-
*/
|
|
13697
|
-
content?: object;
|
|
13698
|
-
/**
|
|
13699
|
-
*
|
|
13700
|
-
* @type {string}
|
|
13701
|
-
* @memberof JsonApiWorkspaceSettingOutAttributes
|
|
13702
|
-
*/
|
|
13703
|
-
type?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
13704
|
-
}
|
|
13705
|
-
export declare const JsonApiWorkspaceSettingOutAttributesTypeEnum: {
|
|
13706
|
-
readonly TIMEZONE: "TIMEZONE";
|
|
13707
|
-
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
13708
|
-
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
13709
|
-
readonly WHITE_LABELING: "WHITE_LABELING";
|
|
13710
|
-
readonly LOCALE: "LOCALE";
|
|
13711
|
-
readonly METADATA_LOCALE: "METADATA_LOCALE";
|
|
13712
|
-
readonly FORMAT_LOCALE: "FORMAT_LOCALE";
|
|
13713
|
-
readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
|
|
13714
|
-
readonly WEEK_START: "WEEK_START";
|
|
13715
|
-
readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
|
|
13716
|
-
readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
|
|
13717
|
-
readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
|
|
13718
|
-
readonly OPENAI_CONFIG: "OPENAI_CONFIG";
|
|
13719
|
-
readonly ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS";
|
|
13720
|
-
};
|
|
13721
|
-
export type JsonApiWorkspaceSettingOutAttributesTypeEnum = typeof JsonApiWorkspaceSettingOutAttributesTypeEnum[keyof typeof JsonApiWorkspaceSettingOutAttributesTypeEnum];
|
|
13722
14033
|
/**
|
|
13723
14034
|
*
|
|
13724
14035
|
* @export
|
|
@@ -13789,10 +14100,10 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
13789
14100
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
13790
14101
|
/**
|
|
13791
14102
|
*
|
|
13792
|
-
* @type {
|
|
14103
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
13793
14104
|
* @memberof JsonApiWorkspaceSettingOutWithLinks
|
|
13794
14105
|
*/
|
|
13795
|
-
attributes?:
|
|
14106
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
13796
14107
|
/**
|
|
13797
14108
|
*
|
|
13798
14109
|
* @type {ObjectLinks}
|
|
@@ -13824,10 +14135,10 @@ export interface JsonApiWorkspaceSettingPatch {
|
|
|
13824
14135
|
id: string;
|
|
13825
14136
|
/**
|
|
13826
14137
|
*
|
|
13827
|
-
* @type {
|
|
14138
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
13828
14139
|
* @memberof JsonApiWorkspaceSettingPatch
|
|
13829
14140
|
*/
|
|
13830
|
-
attributes?:
|
|
14141
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
13831
14142
|
}
|
|
13832
14143
|
export declare const JsonApiWorkspaceSettingPatchTypeEnum: {
|
|
13833
14144
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
@@ -13866,10 +14177,10 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
13866
14177
|
id?: string;
|
|
13867
14178
|
/**
|
|
13868
14179
|
*
|
|
13869
|
-
* @type {
|
|
14180
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
13870
14181
|
* @memberof JsonApiWorkspaceSettingPostOptionalId
|
|
13871
14182
|
*/
|
|
13872
|
-
attributes?:
|
|
14183
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
13873
14184
|
}
|
|
13874
14185
|
export declare const JsonApiWorkspaceSettingPostOptionalIdTypeEnum: {
|
|
13875
14186
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
@@ -14128,6 +14439,47 @@ export interface Notes {
|
|
|
14128
14439
|
*/
|
|
14129
14440
|
note: Array<Note>;
|
|
14130
14441
|
}
|
|
14442
|
+
/**
|
|
14443
|
+
*
|
|
14444
|
+
* @export
|
|
14445
|
+
* @interface NotificationChannelDestination
|
|
14446
|
+
*/
|
|
14447
|
+
export interface NotificationChannelDestination {
|
|
14448
|
+
/**
|
|
14449
|
+
*
|
|
14450
|
+
* @type {string}
|
|
14451
|
+
* @memberof NotificationChannelDestination
|
|
14452
|
+
*/
|
|
14453
|
+
type: NotificationChannelDestinationTypeEnum;
|
|
14454
|
+
}
|
|
14455
|
+
export declare const NotificationChannelDestinationTypeEnum: {
|
|
14456
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
14457
|
+
};
|
|
14458
|
+
export type NotificationChannelDestinationTypeEnum = typeof NotificationChannelDestinationTypeEnum[keyof typeof NotificationChannelDestinationTypeEnum];
|
|
14459
|
+
/**
|
|
14460
|
+
*
|
|
14461
|
+
* @export
|
|
14462
|
+
* @interface NotificationTrigger
|
|
14463
|
+
*/
|
|
14464
|
+
export interface NotificationTrigger {
|
|
14465
|
+
/**
|
|
14466
|
+
* The notification trigger type.
|
|
14467
|
+
* @type {string}
|
|
14468
|
+
* @memberof NotificationTrigger
|
|
14469
|
+
*/
|
|
14470
|
+
type: NotificationTriggerTypeEnum;
|
|
14471
|
+
/**
|
|
14472
|
+
* Free-form JSON object
|
|
14473
|
+
* @type {object}
|
|
14474
|
+
* @memberof NotificationTrigger
|
|
14475
|
+
*/
|
|
14476
|
+
metadata?: object | null;
|
|
14477
|
+
}
|
|
14478
|
+
export declare const NotificationTriggerTypeEnum: {
|
|
14479
|
+
readonly SCHEDULE: "SCHEDULE";
|
|
14480
|
+
readonly ALERT: "ALERT";
|
|
14481
|
+
};
|
|
14482
|
+
export type NotificationTriggerTypeEnum = typeof NotificationTriggerTypeEnum[keyof typeof NotificationTriggerTypeEnum];
|
|
14131
14483
|
/**
|
|
14132
14484
|
*
|
|
14133
14485
|
* @export
|
|
@@ -14733,6 +15085,74 @@ export declare const SqlColumnDataTypeEnum: {
|
|
|
14733
15085
|
readonly BOOLEAN: "BOOLEAN";
|
|
14734
15086
|
};
|
|
14735
15087
|
export type SqlColumnDataTypeEnum = typeof SqlColumnDataTypeEnum[keyof typeof SqlColumnDataTypeEnum];
|
|
15088
|
+
/**
|
|
15089
|
+
* Export request object describing the export properties and overrides for tabular exports.
|
|
15090
|
+
* @export
|
|
15091
|
+
* @interface TabularExportRequest
|
|
15092
|
+
*/
|
|
15093
|
+
export interface TabularExportRequest {
|
|
15094
|
+
/**
|
|
15095
|
+
* Expected file format.
|
|
15096
|
+
* @type {string}
|
|
15097
|
+
* @memberof TabularExportRequest
|
|
15098
|
+
*/
|
|
15099
|
+
format: TabularExportRequestFormatEnum;
|
|
15100
|
+
/**
|
|
15101
|
+
* Execution result identifier.
|
|
15102
|
+
* @type {string}
|
|
15103
|
+
* @memberof TabularExportRequest
|
|
15104
|
+
*/
|
|
15105
|
+
executionResult?: string;
|
|
15106
|
+
/**
|
|
15107
|
+
* Filename of downloaded file without extension.
|
|
15108
|
+
* @type {string}
|
|
15109
|
+
* @memberof TabularExportRequest
|
|
15110
|
+
*/
|
|
15111
|
+
fileName: string;
|
|
15112
|
+
/**
|
|
15113
|
+
*
|
|
15114
|
+
* @type {Settings}
|
|
15115
|
+
* @memberof TabularExportRequest
|
|
15116
|
+
*/
|
|
15117
|
+
settings?: Settings;
|
|
15118
|
+
/**
|
|
15119
|
+
*
|
|
15120
|
+
* @type {CustomOverride}
|
|
15121
|
+
* @memberof TabularExportRequest
|
|
15122
|
+
*/
|
|
15123
|
+
customOverride?: CustomOverride;
|
|
15124
|
+
/**
|
|
15125
|
+
* Visualization object identifier. Alternative to executionResult property.
|
|
15126
|
+
* @type {string}
|
|
15127
|
+
* @memberof TabularExportRequest
|
|
15128
|
+
*/
|
|
15129
|
+
visualizationObject?: string;
|
|
15130
|
+
/**
|
|
15131
|
+
* Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (HTML/PDF only)
|
|
15132
|
+
* @type {Array<object>}
|
|
15133
|
+
* @memberof TabularExportRequest
|
|
15134
|
+
*/
|
|
15135
|
+
visualizationObjectCustomFilters?: Array<object>;
|
|
15136
|
+
/**
|
|
15137
|
+
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
15138
|
+
* @type {string}
|
|
15139
|
+
* @memberof TabularExportRequest
|
|
15140
|
+
*/
|
|
15141
|
+
relatedDashboardId?: string;
|
|
15142
|
+
/**
|
|
15143
|
+
* Free-form JSON object
|
|
15144
|
+
* @type {object}
|
|
15145
|
+
* @memberof TabularExportRequest
|
|
15146
|
+
*/
|
|
15147
|
+
metadata?: object | null;
|
|
15148
|
+
}
|
|
15149
|
+
export declare const TabularExportRequestFormatEnum: {
|
|
15150
|
+
readonly CSV: "CSV";
|
|
15151
|
+
readonly XLSX: "XLSX";
|
|
15152
|
+
readonly HTML: "HTML";
|
|
15153
|
+
readonly PDF: "PDF";
|
|
15154
|
+
};
|
|
15155
|
+
export type TabularExportRequestFormatEnum = typeof TabularExportRequestFormatEnum[keyof typeof TabularExportRequestFormatEnum];
|
|
14736
15156
|
/**
|
|
14737
15157
|
* List of users
|
|
14738
15158
|
* @export
|
|
@@ -15112,6 +15532,101 @@ export interface UserPermission {
|
|
|
15112
15532
|
*/
|
|
15113
15533
|
permissions?: Array<GrantedPermission>;
|
|
15114
15534
|
}
|
|
15535
|
+
/**
|
|
15536
|
+
* Export request object describing the export properties and metadata for dashboard PDF exports.
|
|
15537
|
+
* @export
|
|
15538
|
+
* @interface VisualExportRequest
|
|
15539
|
+
*/
|
|
15540
|
+
export interface VisualExportRequest {
|
|
15541
|
+
/**
|
|
15542
|
+
* File name to be used for retrieving the pdf document.
|
|
15543
|
+
* @type {string}
|
|
15544
|
+
* @memberof VisualExportRequest
|
|
15545
|
+
*/
|
|
15546
|
+
fileName: string;
|
|
15547
|
+
/**
|
|
15548
|
+
* Dashboard identifier
|
|
15549
|
+
* @type {string}
|
|
15550
|
+
* @memberof VisualExportRequest
|
|
15551
|
+
*/
|
|
15552
|
+
dashboardId: string;
|
|
15553
|
+
/**
|
|
15554
|
+
* Metadata definition in free-form JSON format.
|
|
15555
|
+
* @type {object}
|
|
15556
|
+
* @memberof VisualExportRequest
|
|
15557
|
+
*/
|
|
15558
|
+
metadata?: object;
|
|
15559
|
+
}
|
|
15560
|
+
/**
|
|
15561
|
+
* Webhook destination for notifications.
|
|
15562
|
+
* @export
|
|
15563
|
+
* @interface Webhook
|
|
15564
|
+
*/
|
|
15565
|
+
export interface Webhook {
|
|
15566
|
+
/**
|
|
15567
|
+
* The webhook URL.
|
|
15568
|
+
* @type {string}
|
|
15569
|
+
* @memberof Webhook
|
|
15570
|
+
*/
|
|
15571
|
+
url: string;
|
|
15572
|
+
/**
|
|
15573
|
+
* Bearer token for the webhook.
|
|
15574
|
+
* @type {string}
|
|
15575
|
+
* @memberof Webhook
|
|
15576
|
+
*/
|
|
15577
|
+
token?: string | null;
|
|
15578
|
+
/**
|
|
15579
|
+
* Flag indicating if webhook has a token.
|
|
15580
|
+
* @type {boolean}
|
|
15581
|
+
* @memberof Webhook
|
|
15582
|
+
*/
|
|
15583
|
+
hasToken?: boolean | null;
|
|
15584
|
+
/**
|
|
15585
|
+
* The destination type.
|
|
15586
|
+
* @type {string}
|
|
15587
|
+
* @memberof Webhook
|
|
15588
|
+
*/
|
|
15589
|
+
type: WebhookTypeEnum;
|
|
15590
|
+
}
|
|
15591
|
+
export declare const WebhookTypeEnum: {
|
|
15592
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
15593
|
+
};
|
|
15594
|
+
export type WebhookTypeEnum = typeof WebhookTypeEnum[keyof typeof WebhookTypeEnum];
|
|
15595
|
+
/**
|
|
15596
|
+
*
|
|
15597
|
+
* @export
|
|
15598
|
+
* @interface WebhookAllOf
|
|
15599
|
+
*/
|
|
15600
|
+
export interface WebhookAllOf {
|
|
15601
|
+
/**
|
|
15602
|
+
* The webhook URL.
|
|
15603
|
+
* @type {string}
|
|
15604
|
+
* @memberof WebhookAllOf
|
|
15605
|
+
*/
|
|
15606
|
+
url?: string;
|
|
15607
|
+
/**
|
|
15608
|
+
* Bearer token for the webhook.
|
|
15609
|
+
* @type {string}
|
|
15610
|
+
* @memberof WebhookAllOf
|
|
15611
|
+
*/
|
|
15612
|
+
token?: string | null;
|
|
15613
|
+
/**
|
|
15614
|
+
* Flag indicating if webhook has a token.
|
|
15615
|
+
* @type {boolean}
|
|
15616
|
+
* @memberof WebhookAllOf
|
|
15617
|
+
*/
|
|
15618
|
+
hasToken?: boolean | null;
|
|
15619
|
+
/**
|
|
15620
|
+
* The destination type.
|
|
15621
|
+
* @type {string}
|
|
15622
|
+
* @memberof WebhookAllOf
|
|
15623
|
+
*/
|
|
15624
|
+
type?: WebhookAllOfTypeEnum;
|
|
15625
|
+
}
|
|
15626
|
+
export declare const WebhookAllOfTypeEnum: {
|
|
15627
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
15628
|
+
};
|
|
15629
|
+
export type WebhookAllOfTypeEnum = typeof WebhookAllOfTypeEnum[keyof typeof WebhookAllOfTypeEnum];
|
|
15115
15630
|
/**
|
|
15116
15631
|
* The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
|
|
15117
15632
|
* @export
|
|
@@ -19301,12 +19816,12 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configura
|
|
|
19301
19816
|
* @summary Post Automations
|
|
19302
19817
|
* @param {string} workspaceId
|
|
19303
19818
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
19304
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19819
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19305
19820
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
19306
19821
|
* @param {*} [options] Override http request option.
|
|
19307
19822
|
* @throws {RequiredError}
|
|
19308
19823
|
*/
|
|
19309
|
-
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19824
|
+
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19310
19825
|
/**
|
|
19311
19826
|
*
|
|
19312
19827
|
* @summary Delete an Automation
|
|
@@ -19323,7 +19838,7 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configura
|
|
|
19323
19838
|
* @param {string} workspaceId
|
|
19324
19839
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
19325
19840
|
* @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\').
|
|
19326
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19841
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19327
19842
|
* @param {number} [page] Zero-based page index (0..N)
|
|
19328
19843
|
* @param {number} [size] The size of the page to be returned
|
|
19329
19844
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -19332,20 +19847,20 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configura
|
|
|
19332
19847
|
* @param {*} [options] Override http request option.
|
|
19333
19848
|
* @throws {RequiredError}
|
|
19334
19849
|
*/
|
|
19335
|
-
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19850
|
+
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19336
19851
|
/**
|
|
19337
19852
|
*
|
|
19338
19853
|
* @summary Get an Automation
|
|
19339
19854
|
* @param {string} workspaceId
|
|
19340
19855
|
* @param {string} objectId
|
|
19341
19856
|
* @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\').
|
|
19342
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19857
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19343
19858
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
19344
19859
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
19345
19860
|
* @param {*} [options] Override http request option.
|
|
19346
19861
|
* @throws {RequiredError}
|
|
19347
19862
|
*/
|
|
19348
|
-
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19863
|
+
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19349
19864
|
/**
|
|
19350
19865
|
*
|
|
19351
19866
|
* @summary Patch an Automation
|
|
@@ -19353,11 +19868,11 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configura
|
|
|
19353
19868
|
* @param {string} objectId
|
|
19354
19869
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
19355
19870
|
* @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\').
|
|
19356
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19871
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19357
19872
|
* @param {*} [options] Override http request option.
|
|
19358
19873
|
* @throws {RequiredError}
|
|
19359
19874
|
*/
|
|
19360
|
-
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19875
|
+
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19361
19876
|
/**
|
|
19362
19877
|
*
|
|
19363
19878
|
* @summary Put an Automation
|
|
@@ -19365,11 +19880,11 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configura
|
|
|
19365
19880
|
* @param {string} objectId
|
|
19366
19881
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
19367
19882
|
* @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\').
|
|
19368
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19883
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19369
19884
|
* @param {*} [options] Override http request option.
|
|
19370
19885
|
* @throws {RequiredError}
|
|
19371
19886
|
*/
|
|
19372
|
-
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19887
|
+
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19373
19888
|
};
|
|
19374
19889
|
/**
|
|
19375
19890
|
* AutomationsApi - functional programming interface
|
|
@@ -19381,12 +19896,12 @@ export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
|
19381
19896
|
* @summary Post Automations
|
|
19382
19897
|
* @param {string} workspaceId
|
|
19383
19898
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
19384
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19899
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19385
19900
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
19386
19901
|
* @param {*} [options] Override http request option.
|
|
19387
19902
|
* @throws {RequiredError}
|
|
19388
19903
|
*/
|
|
19389
|
-
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
19904
|
+
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
19390
19905
|
/**
|
|
19391
19906
|
*
|
|
19392
19907
|
* @summary Delete an Automation
|
|
@@ -19403,7 +19918,7 @@ export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
|
19403
19918
|
* @param {string} workspaceId
|
|
19404
19919
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
19405
19920
|
* @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\').
|
|
19406
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19921
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19407
19922
|
* @param {number} [page] Zero-based page index (0..N)
|
|
19408
19923
|
* @param {number} [size] The size of the page to be returned
|
|
19409
19924
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -19412,20 +19927,20 @@ export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
|
19412
19927
|
* @param {*} [options] Override http request option.
|
|
19413
19928
|
* @throws {RequiredError}
|
|
19414
19929
|
*/
|
|
19415
|
-
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
19930
|
+
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
19416
19931
|
/**
|
|
19417
19932
|
*
|
|
19418
19933
|
* @summary Get an Automation
|
|
19419
19934
|
* @param {string} workspaceId
|
|
19420
19935
|
* @param {string} objectId
|
|
19421
19936
|
* @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\').
|
|
19422
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19937
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19423
19938
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
19424
19939
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
19425
19940
|
* @param {*} [options] Override http request option.
|
|
19426
19941
|
* @throws {RequiredError}
|
|
19427
19942
|
*/
|
|
19428
|
-
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
19943
|
+
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
19429
19944
|
/**
|
|
19430
19945
|
*
|
|
19431
19946
|
* @summary Patch an Automation
|
|
@@ -19433,11 +19948,11 @@ export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
|
19433
19948
|
* @param {string} objectId
|
|
19434
19949
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
19435
19950
|
* @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\').
|
|
19436
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19951
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19437
19952
|
* @param {*} [options] Override http request option.
|
|
19438
19953
|
* @throws {RequiredError}
|
|
19439
19954
|
*/
|
|
19440
|
-
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
19955
|
+
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
19441
19956
|
/**
|
|
19442
19957
|
*
|
|
19443
19958
|
* @summary Put an Automation
|
|
@@ -19445,11 +19960,11 @@ export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
|
19445
19960
|
* @param {string} objectId
|
|
19446
19961
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
19447
19962
|
* @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\').
|
|
19448
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
19963
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
19449
19964
|
* @param {*} [options] Override http request option.
|
|
19450
19965
|
* @throws {RequiredError}
|
|
19451
19966
|
*/
|
|
19452
|
-
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
19967
|
+
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
19453
19968
|
};
|
|
19454
19969
|
/**
|
|
19455
19970
|
* AutomationsApi - factory interface
|
|
@@ -19586,10 +20101,10 @@ export interface AutomationsApiCreateEntityAutomationsRequest {
|
|
|
19586
20101
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
19587
20102
|
/**
|
|
19588
20103
|
* 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.
|
|
19589
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
20104
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
19590
20105
|
* @memberof AutomationsApiCreateEntityAutomations
|
|
19591
20106
|
*/
|
|
19592
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
20107
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
19593
20108
|
/**
|
|
19594
20109
|
* Include Meta objects.
|
|
19595
20110
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -19648,10 +20163,10 @@ export interface AutomationsApiGetAllEntitiesAutomationsRequest {
|
|
|
19648
20163
|
readonly filter?: string;
|
|
19649
20164
|
/**
|
|
19650
20165
|
* 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.
|
|
19651
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
20166
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
19652
20167
|
* @memberof AutomationsApiGetAllEntitiesAutomations
|
|
19653
20168
|
*/
|
|
19654
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
20169
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
19655
20170
|
/**
|
|
19656
20171
|
* Zero-based page index (0..N)
|
|
19657
20172
|
* @type {number}
|
|
@@ -19709,10 +20224,10 @@ export interface AutomationsApiGetEntityAutomationsRequest {
|
|
|
19709
20224
|
readonly filter?: string;
|
|
19710
20225
|
/**
|
|
19711
20226
|
* 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.
|
|
19712
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
20227
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
19713
20228
|
* @memberof AutomationsApiGetEntityAutomations
|
|
19714
20229
|
*/
|
|
19715
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
20230
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
19716
20231
|
/**
|
|
19717
20232
|
*
|
|
19718
20233
|
* @type {boolean}
|
|
@@ -19758,10 +20273,10 @@ export interface AutomationsApiPatchEntityAutomationsRequest {
|
|
|
19758
20273
|
readonly filter?: string;
|
|
19759
20274
|
/**
|
|
19760
20275
|
* 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.
|
|
19761
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
20276
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
19762
20277
|
* @memberof AutomationsApiPatchEntityAutomations
|
|
19763
20278
|
*/
|
|
19764
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
20279
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
19765
20280
|
}
|
|
19766
20281
|
/**
|
|
19767
20282
|
* Request parameters for updateEntityAutomations operation in AutomationsApi.
|
|
@@ -19795,10 +20310,10 @@ export interface AutomationsApiUpdateEntityAutomationsRequest {
|
|
|
19795
20310
|
readonly filter?: string;
|
|
19796
20311
|
/**
|
|
19797
20312
|
* 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.
|
|
19798
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
20313
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
19799
20314
|
* @memberof AutomationsApiUpdateEntityAutomations
|
|
19800
20315
|
*/
|
|
19801
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
20316
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
19802
20317
|
}
|
|
19803
20318
|
/**
|
|
19804
20319
|
* AutomationsApi - object-oriented interface
|
|
@@ -24683,12 +25198,12 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
24683
25198
|
* @summary Post Automations
|
|
24684
25199
|
* @param {string} workspaceId
|
|
24685
25200
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
24686
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
25201
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
24687
25202
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24688
25203
|
* @param {*} [options] Override http request option.
|
|
24689
25204
|
* @throws {RequiredError}
|
|
24690
25205
|
*/
|
|
24691
|
-
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25206
|
+
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24692
25207
|
/**
|
|
24693
25208
|
*
|
|
24694
25209
|
* @summary Post Color Pallettes
|
|
@@ -25197,7 +25712,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
25197
25712
|
* @param {string} workspaceId
|
|
25198
25713
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
25199
25714
|
* @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\').
|
|
25200
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
25715
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
25201
25716
|
* @param {number} [page] Zero-based page index (0..N)
|
|
25202
25717
|
* @param {number} [size] The size of the page to be returned
|
|
25203
25718
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -25206,7 +25721,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
25206
25721
|
* @param {*} [options] Override http request option.
|
|
25207
25722
|
* @throws {RequiredError}
|
|
25208
25723
|
*/
|
|
25209
|
-
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25724
|
+
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25210
25725
|
/**
|
|
25211
25726
|
*
|
|
25212
25727
|
* @summary Get all Color Pallettes
|
|
@@ -25654,13 +26169,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
25654
26169
|
* @param {string} workspaceId
|
|
25655
26170
|
* @param {string} objectId
|
|
25656
26171
|
* @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\').
|
|
25657
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
26172
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
25658
26173
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
25659
26174
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
25660
26175
|
* @param {*} [options] Override http request option.
|
|
25661
26176
|
* @throws {RequiredError}
|
|
25662
26177
|
*/
|
|
25663
|
-
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26178
|
+
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25664
26179
|
/**
|
|
25665
26180
|
*
|
|
25666
26181
|
* @summary Get Color Pallette
|
|
@@ -26020,11 +26535,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
26020
26535
|
* @param {string} objectId
|
|
26021
26536
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
26022
26537
|
* @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\').
|
|
26023
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
26538
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
26024
26539
|
* @param {*} [options] Override http request option.
|
|
26025
26540
|
* @throws {RequiredError}
|
|
26026
26541
|
*/
|
|
26027
|
-
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26542
|
+
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26028
26543
|
/**
|
|
26029
26544
|
*
|
|
26030
26545
|
* @summary Patch Color Pallette
|
|
@@ -26298,11 +26813,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
26298
26813
|
* @param {string} objectId
|
|
26299
26814
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
26300
26815
|
* @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\').
|
|
26301
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
26816
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
26302
26817
|
* @param {*} [options] Override http request option.
|
|
26303
26818
|
* @throws {RequiredError}
|
|
26304
26819
|
*/
|
|
26305
|
-
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26820
|
+
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26306
26821
|
/**
|
|
26307
26822
|
*
|
|
26308
26823
|
* @summary Put Color Pallette
|
|
@@ -26598,12 +27113,12 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
26598
27113
|
* @summary Post Automations
|
|
26599
27114
|
* @param {string} workspaceId
|
|
26600
27115
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
26601
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
27116
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
26602
27117
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
26603
27118
|
* @param {*} [options] Override http request option.
|
|
26604
27119
|
* @throws {RequiredError}
|
|
26605
27120
|
*/
|
|
26606
|
-
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
27121
|
+
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
26607
27122
|
/**
|
|
26608
27123
|
*
|
|
26609
27124
|
* @summary Post Color Pallettes
|
|
@@ -27112,7 +27627,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
27112
27627
|
* @param {string} workspaceId
|
|
27113
27628
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
27114
27629
|
* @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\').
|
|
27115
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
27630
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
27116
27631
|
* @param {number} [page] Zero-based page index (0..N)
|
|
27117
27632
|
* @param {number} [size] The size of the page to be returned
|
|
27118
27633
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -27121,7 +27636,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
27121
27636
|
* @param {*} [options] Override http request option.
|
|
27122
27637
|
* @throws {RequiredError}
|
|
27123
27638
|
*/
|
|
27124
|
-
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
27639
|
+
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
27125
27640
|
/**
|
|
27126
27641
|
*
|
|
27127
27642
|
* @summary Get all Color Pallettes
|
|
@@ -27571,13 +28086,13 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
27571
28086
|
* @param {string} workspaceId
|
|
27572
28087
|
* @param {string} objectId
|
|
27573
28088
|
* @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\').
|
|
27574
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
28089
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
27575
28090
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
27576
28091
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
27577
28092
|
* @param {*} [options] Override http request option.
|
|
27578
28093
|
* @throws {RequiredError}
|
|
27579
28094
|
*/
|
|
27580
|
-
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
28095
|
+
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
27581
28096
|
/**
|
|
27582
28097
|
*
|
|
27583
28098
|
* @summary Get Color Pallette
|
|
@@ -27937,11 +28452,11 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
27937
28452
|
* @param {string} objectId
|
|
27938
28453
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
27939
28454
|
* @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\').
|
|
27940
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
28455
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
27941
28456
|
* @param {*} [options] Override http request option.
|
|
27942
28457
|
* @throws {RequiredError}
|
|
27943
28458
|
*/
|
|
27944
|
-
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
28459
|
+
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
27945
28460
|
/**
|
|
27946
28461
|
*
|
|
27947
28462
|
* @summary Patch Color Pallette
|
|
@@ -28215,11 +28730,11 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
28215
28730
|
* @param {string} objectId
|
|
28216
28731
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
28217
28732
|
* @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\').
|
|
28218
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
28733
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
28219
28734
|
* @param {*} [options] Override http request option.
|
|
28220
28735
|
* @throws {RequiredError}
|
|
28221
28736
|
*/
|
|
28222
|
-
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
28737
|
+
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
28223
28738
|
/**
|
|
28224
28739
|
*
|
|
28225
28740
|
* @summary Put Color Pallette
|
|
@@ -31476,10 +31991,10 @@ export interface EntitiesApiCreateEntityAutomationsRequest {
|
|
|
31476
31991
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
31477
31992
|
/**
|
|
31478
31993
|
* 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.
|
|
31479
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
31994
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
31480
31995
|
* @memberof EntitiesApiCreateEntityAutomations
|
|
31481
31996
|
*/
|
|
31482
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
31997
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
31483
31998
|
/**
|
|
31484
31999
|
* Include Meta objects.
|
|
31485
32000
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -32781,10 +33296,10 @@ export interface EntitiesApiGetAllEntitiesAutomationsRequest {
|
|
|
32781
33296
|
readonly filter?: string;
|
|
32782
33297
|
/**
|
|
32783
33298
|
* 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.
|
|
32784
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
33299
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
32785
33300
|
* @memberof EntitiesApiGetAllEntitiesAutomations
|
|
32786
33301
|
*/
|
|
32787
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
33302
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
32788
33303
|
/**
|
|
32789
33304
|
* Zero-based page index (0..N)
|
|
32790
33305
|
* @type {number}
|
|
@@ -34319,10 +34834,10 @@ export interface EntitiesApiGetEntityAutomationsRequest {
|
|
|
34319
34834
|
readonly filter?: string;
|
|
34320
34835
|
/**
|
|
34321
34836
|
* 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.
|
|
34322
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
34837
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
34323
34838
|
* @memberof EntitiesApiGetEntityAutomations
|
|
34324
34839
|
*/
|
|
34325
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
34840
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
34326
34841
|
/**
|
|
34327
34842
|
*
|
|
34328
34843
|
* @type {boolean}
|
|
@@ -35360,10 +35875,10 @@ export interface EntitiesApiPatchEntityAutomationsRequest {
|
|
|
35360
35875
|
readonly filter?: string;
|
|
35361
35876
|
/**
|
|
35362
35877
|
* 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.
|
|
35363
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
35878
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
35364
35879
|
* @memberof EntitiesApiPatchEntityAutomations
|
|
35365
35880
|
*/
|
|
35366
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
35881
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
35367
35882
|
}
|
|
35368
35883
|
/**
|
|
35369
35884
|
* Request parameters for patchEntityColorPalettes operation in EntitiesApi.
|
|
@@ -36153,10 +36668,10 @@ export interface EntitiesApiUpdateEntityAutomationsRequest {
|
|
|
36153
36668
|
readonly filter?: string;
|
|
36154
36669
|
/**
|
|
36155
36670
|
* 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.
|
|
36156
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
36671
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
36157
36672
|
* @memberof EntitiesApiUpdateEntityAutomations
|
|
36158
36673
|
*/
|
|
36159
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
36674
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
36160
36675
|
}
|
|
36161
36676
|
/**
|
|
36162
36677
|
* Request parameters for updateEntityColorPalettes operation in EntitiesApi.
|
|
@@ -55799,12 +56314,12 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
55799
56314
|
* @summary Post Automations
|
|
55800
56315
|
* @param {string} workspaceId
|
|
55801
56316
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
55802
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
56317
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
55803
56318
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
55804
56319
|
* @param {*} [options] Override http request option.
|
|
55805
56320
|
* @throws {RequiredError}
|
|
55806
56321
|
*/
|
|
55807
|
-
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56322
|
+
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55808
56323
|
/**
|
|
55809
56324
|
*
|
|
55810
56325
|
* @summary Post Custom Application Settings
|
|
@@ -56097,7 +56612,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
56097
56612
|
* @param {string} workspaceId
|
|
56098
56613
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
56099
56614
|
* @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\').
|
|
56100
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
56615
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
56101
56616
|
* @param {number} [page] Zero-based page index (0..N)
|
|
56102
56617
|
* @param {number} [size] The size of the page to be returned
|
|
56103
56618
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -56106,7 +56621,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
56106
56621
|
* @param {*} [options] Override http request option.
|
|
56107
56622
|
* @throws {RequiredError}
|
|
56108
56623
|
*/
|
|
56109
|
-
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56624
|
+
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56110
56625
|
/**
|
|
56111
56626
|
*
|
|
56112
56627
|
* @summary Get all Custom Application Settings
|
|
@@ -56358,13 +56873,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
56358
56873
|
* @param {string} workspaceId
|
|
56359
56874
|
* @param {string} objectId
|
|
56360
56875
|
* @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\').
|
|
56361
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
56876
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
56362
56877
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
56363
56878
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
56364
56879
|
* @param {*} [options] Override http request option.
|
|
56365
56880
|
* @throws {RequiredError}
|
|
56366
56881
|
*/
|
|
56367
|
-
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56882
|
+
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56368
56883
|
/**
|
|
56369
56884
|
*
|
|
56370
56885
|
* @summary Get a Custom Application Setting
|
|
@@ -56563,11 +57078,11 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
56563
57078
|
* @param {string} objectId
|
|
56564
57079
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
56565
57080
|
* @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\').
|
|
56566
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
57081
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
56567
57082
|
* @param {*} [options] Override http request option.
|
|
56568
57083
|
* @throws {RequiredError}
|
|
56569
57084
|
*/
|
|
56570
|
-
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57085
|
+
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56571
57086
|
/**
|
|
56572
57087
|
*
|
|
56573
57088
|
* @summary Patch a Custom Application Setting
|
|
@@ -56717,11 +57232,11 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
56717
57232
|
* @param {string} objectId
|
|
56718
57233
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
56719
57234
|
* @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\').
|
|
56720
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
57235
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
56721
57236
|
* @param {*} [options] Override http request option.
|
|
56722
57237
|
* @throws {RequiredError}
|
|
56723
57238
|
*/
|
|
56724
|
-
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57239
|
+
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56725
57240
|
/**
|
|
56726
57241
|
*
|
|
56727
57242
|
* @summary Put a Custom Application Setting
|
|
@@ -56873,12 +57388,12 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
56873
57388
|
* @summary Post Automations
|
|
56874
57389
|
* @param {string} workspaceId
|
|
56875
57390
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
56876
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
57391
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
56877
57392
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
56878
57393
|
* @param {*} [options] Override http request option.
|
|
56879
57394
|
* @throws {RequiredError}
|
|
56880
57395
|
*/
|
|
56881
|
-
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
57396
|
+
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
56882
57397
|
/**
|
|
56883
57398
|
*
|
|
56884
57399
|
* @summary Post Custom Application Settings
|
|
@@ -57171,7 +57686,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
57171
57686
|
* @param {string} workspaceId
|
|
57172
57687
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
57173
57688
|
* @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\').
|
|
57174
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
57689
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
57175
57690
|
* @param {number} [page] Zero-based page index (0..N)
|
|
57176
57691
|
* @param {number} [size] The size of the page to be returned
|
|
57177
57692
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -57180,7 +57695,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
57180
57695
|
* @param {*} [options] Override http request option.
|
|
57181
57696
|
* @throws {RequiredError}
|
|
57182
57697
|
*/
|
|
57183
|
-
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
57698
|
+
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
57184
57699
|
/**
|
|
57185
57700
|
*
|
|
57186
57701
|
* @summary Get all Custom Application Settings
|
|
@@ -57432,13 +57947,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
57432
57947
|
* @param {string} workspaceId
|
|
57433
57948
|
* @param {string} objectId
|
|
57434
57949
|
* @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\').
|
|
57435
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
57950
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
57436
57951
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
57437
57952
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
57438
57953
|
* @param {*} [options] Override http request option.
|
|
57439
57954
|
* @throws {RequiredError}
|
|
57440
57955
|
*/
|
|
57441
|
-
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
57956
|
+
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
57442
57957
|
/**
|
|
57443
57958
|
*
|
|
57444
57959
|
* @summary Get a Custom Application Setting
|
|
@@ -57637,11 +58152,11 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
57637
58152
|
* @param {string} objectId
|
|
57638
58153
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
57639
58154
|
* @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\').
|
|
57640
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
58155
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
57641
58156
|
* @param {*} [options] Override http request option.
|
|
57642
58157
|
* @throws {RequiredError}
|
|
57643
58158
|
*/
|
|
57644
|
-
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
58159
|
+
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
57645
58160
|
/**
|
|
57646
58161
|
*
|
|
57647
58162
|
* @summary Patch a Custom Application Setting
|
|
@@ -57791,11 +58306,11 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
57791
58306
|
* @param {string} objectId
|
|
57792
58307
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
57793
58308
|
* @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\').
|
|
57794
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | '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.
|
|
58309
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | '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.
|
|
57795
58310
|
* @param {*} [options] Override http request option.
|
|
57796
58311
|
* @throws {RequiredError}
|
|
57797
58312
|
*/
|
|
57798
|
-
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
58313
|
+
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
57799
58314
|
/**
|
|
57800
58315
|
*
|
|
57801
58316
|
* @summary Put a Custom Application Setting
|
|
@@ -59472,10 +59987,10 @@ export interface WorkspaceObjectControllerApiCreateEntityAutomationsRequest {
|
|
|
59472
59987
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
59473
59988
|
/**
|
|
59474
59989
|
* 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.
|
|
59475
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
59990
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
59476
59991
|
* @memberof WorkspaceObjectControllerApiCreateEntityAutomations
|
|
59477
59992
|
*/
|
|
59478
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
59993
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
59479
59994
|
/**
|
|
59480
59995
|
* Include Meta objects.
|
|
59481
59996
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -60315,10 +60830,10 @@ export interface WorkspaceObjectControllerApiGetAllEntitiesAutomationsRequest {
|
|
|
60315
60830
|
readonly filter?: string;
|
|
60316
60831
|
/**
|
|
60317
60832
|
* 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.
|
|
60318
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
60833
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
60319
60834
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAutomations
|
|
60320
60835
|
*/
|
|
60321
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
60836
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
60322
60837
|
/**
|
|
60323
60838
|
* Zero-based page index (0..N)
|
|
60324
60839
|
* @type {number}
|
|
@@ -61286,10 +61801,10 @@ export interface WorkspaceObjectControllerApiGetEntityAutomationsRequest {
|
|
|
61286
61801
|
readonly filter?: string;
|
|
61287
61802
|
/**
|
|
61288
61803
|
* 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.
|
|
61289
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
61804
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
61290
61805
|
* @memberof WorkspaceObjectControllerApiGetEntityAutomations
|
|
61291
61806
|
*/
|
|
61292
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
61807
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
61293
61808
|
/**
|
|
61294
61809
|
*
|
|
61295
61810
|
* @type {boolean}
|
|
@@ -61956,10 +62471,10 @@ export interface WorkspaceObjectControllerApiPatchEntityAutomationsRequest {
|
|
|
61956
62471
|
readonly filter?: string;
|
|
61957
62472
|
/**
|
|
61958
62473
|
* 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.
|
|
61959
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
62474
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
61960
62475
|
* @memberof WorkspaceObjectControllerApiPatchEntityAutomations
|
|
61961
62476
|
*/
|
|
61962
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
62477
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
61963
62478
|
}
|
|
61964
62479
|
/**
|
|
61965
62480
|
* Request parameters for patchEntityCustomApplicationSettings operation in WorkspaceObjectControllerApi.
|
|
@@ -62425,10 +62940,10 @@ export interface WorkspaceObjectControllerApiUpdateEntityAutomationsRequest {
|
|
|
62425
62940
|
readonly filter?: string;
|
|
62426
62941
|
/**
|
|
62427
62942
|
* 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.
|
|
62428
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
62943
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
62429
62944
|
* @memberof WorkspaceObjectControllerApiUpdateEntityAutomations
|
|
62430
62945
|
*/
|
|
62431
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
62946
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
62432
62947
|
}
|
|
62433
62948
|
/**
|
|
62434
62949
|
* Request parameters for updateEntityCustomApplicationSettings operation in WorkspaceObjectControllerApi.
|