@gooddata/api-client-tiger 10.8.0-alpha.9 → 10.8.0-beta.1
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 +1538 -722
- 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 +125 -4
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +124 -6
- 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
|
@@ -149,6 +149,9 @@ export const DeclarativeDateDatasetGranularitiesEnum = {
|
|
|
149
149
|
MONTH_OF_YEAR: "MONTH_OF_YEAR",
|
|
150
150
|
QUARTER_OF_YEAR: "QUARTER_OF_YEAR",
|
|
151
151
|
};
|
|
152
|
+
export const DeclarativeExportDefinitionIdentifierTypeEnum = {
|
|
153
|
+
EXPORT_DEFINITION: "exportDefinition",
|
|
154
|
+
};
|
|
152
155
|
export const DeclarativeFactSourceColumnDataTypeEnum = {
|
|
153
156
|
INT: "INT",
|
|
154
157
|
STRING: "STRING",
|
|
@@ -175,6 +178,12 @@ export const DeclarativeLabelValueTypeEnum = {
|
|
|
175
178
|
GEO_LATITUDE: "GEO_LATITUDE",
|
|
176
179
|
IMAGE: "IMAGE",
|
|
177
180
|
};
|
|
181
|
+
export const DeclarativeNotificationChannelDestinationTypeEnum = {
|
|
182
|
+
WEBHOOK: "WEBHOOK",
|
|
183
|
+
};
|
|
184
|
+
export const DeclarativeNotificationChannelIdentifierTypeEnum = {
|
|
185
|
+
NOTIFICATION_CHANNEL: "notificationChannel",
|
|
186
|
+
};
|
|
178
187
|
export const DeclarativeOrganizationPermissionNameEnum = {
|
|
179
188
|
MANAGE: "MANAGE",
|
|
180
189
|
SELF_CREATE_TOKEN: "SELF_CREATE_TOKEN",
|
|
@@ -823,6 +832,9 @@ export const JsonApiMetricPostOptionalIdTypeEnum = {
|
|
|
823
832
|
export const JsonApiNotificationChannelInTypeEnum = {
|
|
824
833
|
NOTIFICATION_CHANNEL: "notificationChannel",
|
|
825
834
|
};
|
|
835
|
+
export const JsonApiNotificationChannelInAttributesDestinationTypeEnum = {
|
|
836
|
+
WEBHOOK: "WEBHOOK",
|
|
837
|
+
};
|
|
826
838
|
export const JsonApiNotificationChannelInAttributesTriggersTypeEnum = {
|
|
827
839
|
SCHEDULE: "SCHEDULE",
|
|
828
840
|
ALERT: "ALERT",
|
|
@@ -862,6 +874,22 @@ export const JsonApiOrganizationPatchTypeEnum = {
|
|
|
862
874
|
export const JsonApiOrganizationSettingInTypeEnum = {
|
|
863
875
|
ORGANIZATION_SETTING: "organizationSetting",
|
|
864
876
|
};
|
|
877
|
+
export const JsonApiOrganizationSettingInAttributesTypeEnum = {
|
|
878
|
+
TIMEZONE: "TIMEZONE",
|
|
879
|
+
ACTIVE_THEME: "ACTIVE_THEME",
|
|
880
|
+
ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE",
|
|
881
|
+
WHITE_LABELING: "WHITE_LABELING",
|
|
882
|
+
LOCALE: "LOCALE",
|
|
883
|
+
METADATA_LOCALE: "METADATA_LOCALE",
|
|
884
|
+
FORMAT_LOCALE: "FORMAT_LOCALE",
|
|
885
|
+
MAPBOX_TOKEN: "MAPBOX_TOKEN",
|
|
886
|
+
WEEK_START: "WEEK_START",
|
|
887
|
+
SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS",
|
|
888
|
+
OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES",
|
|
889
|
+
TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED",
|
|
890
|
+
OPENAI_CONFIG: "OPENAI_CONFIG",
|
|
891
|
+
ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS",
|
|
892
|
+
};
|
|
865
893
|
export const JsonApiOrganizationSettingOutTypeEnum = {
|
|
866
894
|
ORGANIZATION_SETTING: "organizationSetting",
|
|
867
895
|
};
|
|
@@ -1023,22 +1051,6 @@ export const JsonApiWorkspaceSettingInTypeEnum = {
|
|
|
1023
1051
|
export const JsonApiWorkspaceSettingOutTypeEnum = {
|
|
1024
1052
|
WORKSPACE_SETTING: "workspaceSetting",
|
|
1025
1053
|
};
|
|
1026
|
-
export const JsonApiWorkspaceSettingOutAttributesTypeEnum = {
|
|
1027
|
-
TIMEZONE: "TIMEZONE",
|
|
1028
|
-
ACTIVE_THEME: "ACTIVE_THEME",
|
|
1029
|
-
ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE",
|
|
1030
|
-
WHITE_LABELING: "WHITE_LABELING",
|
|
1031
|
-
LOCALE: "LOCALE",
|
|
1032
|
-
METADATA_LOCALE: "METADATA_LOCALE",
|
|
1033
|
-
FORMAT_LOCALE: "FORMAT_LOCALE",
|
|
1034
|
-
MAPBOX_TOKEN: "MAPBOX_TOKEN",
|
|
1035
|
-
WEEK_START: "WEEK_START",
|
|
1036
|
-
SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS",
|
|
1037
|
-
OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES",
|
|
1038
|
-
TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED",
|
|
1039
|
-
OPENAI_CONFIG: "OPENAI_CONFIG",
|
|
1040
|
-
ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS",
|
|
1041
|
-
};
|
|
1042
1054
|
export const JsonApiWorkspaceSettingOutWithLinksTypeEnum = {
|
|
1043
1055
|
WORKSPACE_SETTING: "workspaceSetting",
|
|
1044
1056
|
};
|
|
@@ -1073,6 +1085,13 @@ export const NoteAppliesToEnum = {
|
|
|
1073
1085
|
SOURCE: "SOURCE",
|
|
1074
1086
|
TARGET: "TARGET",
|
|
1075
1087
|
};
|
|
1088
|
+
export const NotificationChannelDestinationTypeEnum = {
|
|
1089
|
+
WEBHOOK: "WEBHOOK",
|
|
1090
|
+
};
|
|
1091
|
+
export const NotificationTriggerTypeEnum = {
|
|
1092
|
+
SCHEDULE: "SCHEDULE",
|
|
1093
|
+
ALERT: "ALERT",
|
|
1094
|
+
};
|
|
1076
1095
|
export const OrganizationPermissionAssignmentPermissionsEnum = {
|
|
1077
1096
|
MANAGE: "MANAGE",
|
|
1078
1097
|
SELF_CREATE_TOKEN: "SELF_CREATE_TOKEN",
|
|
@@ -1143,6 +1162,12 @@ export const SqlColumnDataTypeEnum = {
|
|
|
1143
1162
|
TIMESTAMP_TZ: "TIMESTAMP_TZ",
|
|
1144
1163
|
BOOLEAN: "BOOLEAN",
|
|
1145
1164
|
};
|
|
1165
|
+
export const TabularExportRequestFormatEnum = {
|
|
1166
|
+
CSV: "CSV",
|
|
1167
|
+
XLSX: "XLSX",
|
|
1168
|
+
HTML: "HTML",
|
|
1169
|
+
PDF: "PDF",
|
|
1170
|
+
};
|
|
1146
1171
|
export const UserManagementDataSourcePermissionAssignmentPermissionsEnum = {
|
|
1147
1172
|
MANAGE: "MANAGE",
|
|
1148
1173
|
USE: "USE",
|
|
@@ -1163,6 +1188,12 @@ export const UserManagementWorkspacePermissionAssignmentHierarchyPermissionsEnum
|
|
|
1163
1188
|
EXPORT_PDF: "EXPORT_PDF",
|
|
1164
1189
|
VIEW: "VIEW",
|
|
1165
1190
|
};
|
|
1191
|
+
export const WebhookTypeEnum = {
|
|
1192
|
+
WEBHOOK: "WEBHOOK",
|
|
1193
|
+
};
|
|
1194
|
+
export const WebhookAllOfTypeEnum = {
|
|
1195
|
+
WEBHOOK: "WEBHOOK",
|
|
1196
|
+
};
|
|
1166
1197
|
export const WorkspaceIdentifierTypeEnum = {
|
|
1167
1198
|
WORKSPACE: "workspace",
|
|
1168
1199
|
};
|
|
@@ -5810,7 +5841,7 @@ export const AutomationsApiAxiosParamCreator = function (configuration) {
|
|
|
5810
5841
|
* @summary Post Automations
|
|
5811
5842
|
* @param {string} workspaceId
|
|
5812
5843
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
5813
|
-
* @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.
|
|
5844
|
+
* @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.
|
|
5814
5845
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
5815
5846
|
* @param {*} [options] Override http request option.
|
|
5816
5847
|
* @throws {RequiredError}
|
|
@@ -5901,7 +5932,7 @@ export const AutomationsApiAxiosParamCreator = function (configuration) {
|
|
|
5901
5932
|
* @param {string} workspaceId
|
|
5902
5933
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
5903
5934
|
* @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\').
|
|
5904
|
-
* @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.
|
|
5935
|
+
* @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.
|
|
5905
5936
|
* @param {number} [page] Zero-based page index (0..N)
|
|
5906
5937
|
* @param {number} [size] The size of the page to be returned
|
|
5907
5938
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -5965,7 +5996,7 @@ export const AutomationsApiAxiosParamCreator = function (configuration) {
|
|
|
5965
5996
|
* @param {string} workspaceId
|
|
5966
5997
|
* @param {string} objectId
|
|
5967
5998
|
* @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\').
|
|
5968
|
-
* @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.
|
|
5999
|
+
* @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.
|
|
5969
6000
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
5970
6001
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
5971
6002
|
* @param {*} [options] Override http request option.
|
|
@@ -6019,7 +6050,7 @@ export const AutomationsApiAxiosParamCreator = function (configuration) {
|
|
|
6019
6050
|
* @param {string} objectId
|
|
6020
6051
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
6021
6052
|
* @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\').
|
|
6022
|
-
* @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.
|
|
6053
|
+
* @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.
|
|
6023
6054
|
* @param {*} [options] Override http request option.
|
|
6024
6055
|
* @throws {RequiredError}
|
|
6025
6056
|
*/
|
|
@@ -6073,7 +6104,7 @@ export const AutomationsApiAxiosParamCreator = function (configuration) {
|
|
|
6073
6104
|
* @param {string} objectId
|
|
6074
6105
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
6075
6106
|
* @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\').
|
|
6076
|
-
* @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.
|
|
6107
|
+
* @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.
|
|
6077
6108
|
* @param {*} [options] Override http request option.
|
|
6078
6109
|
* @throws {RequiredError}
|
|
6079
6110
|
*/
|
|
@@ -6134,7 +6165,7 @@ export const AutomationsApiFp = function (configuration) {
|
|
|
6134
6165
|
* @summary Post Automations
|
|
6135
6166
|
* @param {string} workspaceId
|
|
6136
6167
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
6137
|
-
* @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.
|
|
6168
|
+
* @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.
|
|
6138
6169
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
6139
6170
|
* @param {*} [options] Override http request option.
|
|
6140
6171
|
* @throws {RequiredError}
|
|
@@ -6162,7 +6193,7 @@ export const AutomationsApiFp = function (configuration) {
|
|
|
6162
6193
|
* @param {string} workspaceId
|
|
6163
6194
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
6164
6195
|
* @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\').
|
|
6165
|
-
* @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.
|
|
6196
|
+
* @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.
|
|
6166
6197
|
* @param {number} [page] Zero-based page index (0..N)
|
|
6167
6198
|
* @param {number} [size] The size of the page to be returned
|
|
6168
6199
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -6181,7 +6212,7 @@ export const AutomationsApiFp = function (configuration) {
|
|
|
6181
6212
|
* @param {string} workspaceId
|
|
6182
6213
|
* @param {string} objectId
|
|
6183
6214
|
* @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\').
|
|
6184
|
-
* @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.
|
|
6215
|
+
* @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.
|
|
6185
6216
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
6186
6217
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
6187
6218
|
* @param {*} [options] Override http request option.
|
|
@@ -6198,7 +6229,7 @@ export const AutomationsApiFp = function (configuration) {
|
|
|
6198
6229
|
* @param {string} objectId
|
|
6199
6230
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
6200
6231
|
* @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\').
|
|
6201
|
-
* @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.
|
|
6232
|
+
* @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.
|
|
6202
6233
|
* @param {*} [options] Override http request option.
|
|
6203
6234
|
* @throws {RequiredError}
|
|
6204
6235
|
*/
|
|
@@ -6213,7 +6244,7 @@ export const AutomationsApiFp = function (configuration) {
|
|
|
6213
6244
|
* @param {string} objectId
|
|
6214
6245
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
6215
6246
|
* @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\').
|
|
6216
|
-
* @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.
|
|
6247
|
+
* @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.
|
|
6217
6248
|
* @param {*} [options] Override http request option.
|
|
6218
6249
|
* @throws {RequiredError}
|
|
6219
6250
|
*/
|
|
@@ -11743,7 +11774,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
11743
11774
|
* @summary Post Automations
|
|
11744
11775
|
* @param {string} workspaceId
|
|
11745
11776
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
11746
|
-
* @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.
|
|
11777
|
+
* @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.
|
|
11747
11778
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
11748
11779
|
* @param {*} [options] Override http request option.
|
|
11749
11780
|
* @throws {RequiredError}
|
|
@@ -13958,7 +13989,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
13958
13989
|
* @param {string} workspaceId
|
|
13959
13990
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
13960
13991
|
* @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\').
|
|
13961
|
-
* @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.
|
|
13992
|
+
* @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.
|
|
13962
13993
|
* @param {number} [page] Zero-based page index (0..N)
|
|
13963
13994
|
* @param {number} [size] The size of the page to be returned
|
|
13964
13995
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -15805,7 +15836,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
15805
15836
|
* @param {string} workspaceId
|
|
15806
15837
|
* @param {string} objectId
|
|
15807
15838
|
* @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\').
|
|
15808
|
-
* @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.
|
|
15839
|
+
* @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.
|
|
15809
15840
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
15810
15841
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
15811
15842
|
* @param {*} [options] Override http request option.
|
|
@@ -17298,7 +17329,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
17298
17329
|
* @param {string} objectId
|
|
17299
17330
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
17300
17331
|
* @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\').
|
|
17301
|
-
* @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.
|
|
17332
|
+
* @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.
|
|
17302
17333
|
* @param {*} [options] Override http request option.
|
|
17303
17334
|
* @throws {RequiredError}
|
|
17304
17335
|
*/
|
|
@@ -18576,7 +18607,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
18576
18607
|
* @param {string} objectId
|
|
18577
18608
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
18578
18609
|
* @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\').
|
|
18579
|
-
* @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.
|
|
18610
|
+
* @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.
|
|
18580
18611
|
* @param {*} [options] Override http request option.
|
|
18581
18612
|
* @throws {RequiredError}
|
|
18582
18613
|
*/
|
|
@@ -19833,7 +19864,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
19833
19864
|
* @summary Post Automations
|
|
19834
19865
|
* @param {string} workspaceId
|
|
19835
19866
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
19836
|
-
* @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.
|
|
19867
|
+
* @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.
|
|
19837
19868
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
19838
19869
|
* @param {*} [options] Override http request option.
|
|
19839
19870
|
* @throws {RequiredError}
|
|
@@ -20500,7 +20531,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
20500
20531
|
* @param {string} workspaceId
|
|
20501
20532
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
20502
20533
|
* @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\').
|
|
20503
|
-
* @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.
|
|
20534
|
+
* @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.
|
|
20504
20535
|
* @param {number} [page] Zero-based page index (0..N)
|
|
20505
20536
|
* @param {number} [size] The size of the page to be returned
|
|
20506
20537
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -21059,7 +21090,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
21059
21090
|
* @param {string} workspaceId
|
|
21060
21091
|
* @param {string} objectId
|
|
21061
21092
|
* @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\').
|
|
21062
|
-
* @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.
|
|
21093
|
+
* @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.
|
|
21063
21094
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
21064
21095
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
21065
21096
|
* @param {*} [options] Override http request option.
|
|
@@ -21524,7 +21555,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
21524
21555
|
* @param {string} objectId
|
|
21525
21556
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
21526
21557
|
* @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\').
|
|
21527
|
-
* @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.
|
|
21558
|
+
* @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.
|
|
21528
21559
|
* @param {*} [options] Override http request option.
|
|
21529
21560
|
* @throws {RequiredError}
|
|
21530
21561
|
*/
|
|
@@ -21877,7 +21908,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
21877
21908
|
* @param {string} objectId
|
|
21878
21909
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
21879
21910
|
* @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\').
|
|
21880
|
-
* @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.
|
|
21911
|
+
* @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.
|
|
21881
21912
|
* @param {*} [options] Override http request option.
|
|
21882
21913
|
* @throws {RequiredError}
|
|
21883
21914
|
*/
|
|
@@ -46641,7 +46672,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
46641
46672
|
* @summary Post Automations
|
|
46642
46673
|
* @param {string} workspaceId
|
|
46643
46674
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
46644
|
-
* @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.
|
|
46675
|
+
* @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.
|
|
46645
46676
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46646
46677
|
* @param {*} [options] Override http request option.
|
|
46647
46678
|
* @throws {RequiredError}
|
|
@@ -47918,7 +47949,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
47918
47949
|
* @param {string} workspaceId
|
|
47919
47950
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
47920
47951
|
* @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\').
|
|
47921
|
-
* @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.
|
|
47952
|
+
* @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.
|
|
47922
47953
|
* @param {number} [page] Zero-based page index (0..N)
|
|
47923
47954
|
* @param {number} [size] The size of the page to be returned
|
|
47924
47955
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -48965,7 +48996,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
48965
48996
|
* @param {string} workspaceId
|
|
48966
48997
|
* @param {string} objectId
|
|
48967
48998
|
* @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\').
|
|
48968
|
-
* @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.
|
|
48999
|
+
* @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.
|
|
48969
49000
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
48970
49001
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
48971
49002
|
* @param {*} [options] Override http request option.
|
|
@@ -49812,7 +49843,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
49812
49843
|
* @param {string} objectId
|
|
49813
49844
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
49814
49845
|
* @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\').
|
|
49815
|
-
* @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.
|
|
49846
|
+
* @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.
|
|
49816
49847
|
* @param {*} [options] Override http request option.
|
|
49817
49848
|
* @throws {RequiredError}
|
|
49818
49849
|
*/
|
|
@@ -50528,7 +50559,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
50528
50559
|
* @param {string} objectId
|
|
50529
50560
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
50530
50561
|
* @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\').
|
|
50531
|
-
* @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.
|
|
50562
|
+
* @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.
|
|
50532
50563
|
* @param {*} [options] Override http request option.
|
|
50533
50564
|
* @throws {RequiredError}
|
|
50534
50565
|
*/
|
|
@@ -51161,7 +51192,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
51161
51192
|
* @summary Post Automations
|
|
51162
51193
|
* @param {string} workspaceId
|
|
51163
51194
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
51164
|
-
* @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.
|
|
51195
|
+
* @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.
|
|
51165
51196
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
51166
51197
|
* @param {*} [options] Override http request option.
|
|
51167
51198
|
* @throws {RequiredError}
|
|
@@ -51540,7 +51571,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
51540
51571
|
* @param {string} workspaceId
|
|
51541
51572
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
51542
51573
|
* @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\').
|
|
51543
|
-
* @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.
|
|
51574
|
+
* @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.
|
|
51544
51575
|
* @param {number} [page] Zero-based page index (0..N)
|
|
51545
51576
|
* @param {number} [size] The size of the page to be returned
|
|
51546
51577
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -51852,7 +51883,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
51852
51883
|
* @param {string} workspaceId
|
|
51853
51884
|
* @param {string} objectId
|
|
51854
51885
|
* @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\').
|
|
51855
|
-
* @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.
|
|
51886
|
+
* @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.
|
|
51856
51887
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
51857
51888
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
51858
51889
|
* @param {*} [options] Override http request option.
|
|
@@ -52105,7 +52136,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
52105
52136
|
* @param {string} objectId
|
|
52106
52137
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
52107
52138
|
* @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\').
|
|
52108
|
-
* @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.
|
|
52139
|
+
* @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.
|
|
52109
52140
|
* @param {*} [options] Override http request option.
|
|
52110
52141
|
* @throws {RequiredError}
|
|
52111
52142
|
*/
|
|
@@ -52298,7 +52329,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
52298
52329
|
* @param {string} objectId
|
|
52299
52330
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
52300
52331
|
* @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\').
|
|
52301
|
-
* @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.
|
|
52332
|
+
* @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.
|
|
52302
52333
|
* @param {*} [options] Override http request option.
|
|
52303
52334
|
* @throws {RequiredError}
|
|
52304
52335
|
*/
|