@gooddata/api-client-tiger 11.10.0-alpha.5 → 11.10.0-alpha.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/actions.d.ts.map +1 -1
- package/esm/actions.js +2 -2
- package/esm/actions.js.map +1 -1
- package/esm/api-client-tiger.d.ts +52852 -62434
- package/esm/api-endpoints/actions/index.d.ts +2 -0
- package/esm/api-endpoints/actions/index.d.ts.map +1 -0
- package/esm/api-endpoints/actions/index.js +4 -0
- package/esm/api-endpoints/actions/index.js.map +1 -0
- package/esm/api-endpoints/authActions/index.d.ts +2 -0
- package/esm/api-endpoints/authActions/index.d.ts.map +1 -0
- package/esm/api-endpoints/authActions/index.js +4 -0
- package/esm/api-endpoints/authActions/index.js.map +1 -0
- package/esm/api-endpoints/automation/index.d.ts +2 -0
- package/esm/api-endpoints/automation/index.d.ts.map +1 -0
- package/esm/api-endpoints/automation/index.js +4 -0
- package/esm/api-endpoints/automation/index.js.map +1 -0
- package/esm/api-endpoints/entitiesObjects/index.d.ts +33 -0
- package/esm/api-endpoints/entitiesObjects/index.d.ts.map +1 -0
- package/esm/api-endpoints/entitiesObjects/index.js +66 -0
- package/esm/api-endpoints/entitiesObjects/index.js.map +1 -0
- package/esm/api-endpoints/execution/index.d.ts +3 -0
- package/esm/api-endpoints/execution/index.d.ts.map +1 -0
- package/esm/api-endpoints/execution/index.js +6 -0
- package/esm/api-endpoints/execution/index.js.map +1 -0
- package/esm/api-endpoints/explain/index.d.ts +2 -0
- package/esm/api-endpoints/explain/index.d.ts.map +1 -0
- package/esm/api-endpoints/explain/index.js +4 -0
- package/esm/api-endpoints/explain/index.js.map +1 -0
- package/esm/api-endpoints/export/index.d.ts +2 -0
- package/esm/api-endpoints/export/index.d.ts.map +1 -0
- package/esm/api-endpoints/export/index.js +4 -0
- package/esm/api-endpoints/export/index.js.map +1 -0
- package/esm/api-endpoints/genAI/index.d.ts +2 -0
- package/esm/api-endpoints/genAI/index.d.ts.map +1 -0
- package/esm/api-endpoints/genAI/index.js +4 -0
- package/esm/api-endpoints/genAI/index.js.map +1 -0
- package/esm/api-endpoints/labelElements/index.d.ts +2 -0
- package/esm/api-endpoints/labelElements/index.d.ts.map +1 -0
- package/esm/api-endpoints/labelElements/index.js +4 -0
- package/esm/api-endpoints/labelElements/index.js.map +1 -0
- package/esm/api-endpoints/layout/index.d.ts +2 -0
- package/esm/api-endpoints/layout/index.d.ts.map +1 -0
- package/esm/api-endpoints/layout/index.js +4 -0
- package/esm/api-endpoints/layout/index.js.map +1 -0
- package/esm/api-endpoints/profile/index.d.ts +3 -0
- package/esm/api-endpoints/profile/index.d.ts.map +1 -0
- package/esm/api-endpoints/profile/index.js +3 -0
- package/esm/api-endpoints/profile/index.js.map +1 -0
- package/esm/api-endpoints/result/index.d.ts +2 -0
- package/esm/api-endpoints/result/index.d.ts.map +1 -0
- package/esm/api-endpoints/result/index.js +4 -0
- package/esm/api-endpoints/result/index.js.map +1 -0
- package/esm/api-endpoints/scanModel/index.d.ts +2 -0
- package/esm/api-endpoints/scanModel/index.d.ts.map +1 -0
- package/esm/api-endpoints/scanModel/index.js +4 -0
- package/esm/api-endpoints/scanModel/index.js.map +1 -0
- package/esm/api-endpoints/smartFunctions/index.d.ts +2 -0
- package/esm/api-endpoints/smartFunctions/index.d.ts.map +1 -0
- package/esm/api-endpoints/smartFunctions/index.js +4 -0
- package/esm/api-endpoints/smartFunctions/index.js.map +1 -0
- package/esm/api-endpoints/userManagement/index.d.ts +2 -0
- package/esm/api-endpoints/userManagement/index.d.ts.map +1 -0
- package/esm/api-endpoints/userManagement/index.js +4 -0
- package/esm/api-endpoints/userManagement/index.js.map +1 -0
- package/esm/api-endpoints/validDescendants/index.d.ts +2 -0
- package/esm/api-endpoints/validDescendants/index.d.ts.map +1 -0
- package/esm/api-endpoints/validDescendants/index.js +4 -0
- package/esm/api-endpoints/validDescendants/index.js.map +1 -0
- package/esm/api-endpoints/validObjects/index.d.ts +2 -0
- package/esm/api-endpoints/validObjects/index.d.ts.map +1 -0
- package/esm/api-endpoints/validObjects/index.js +4 -0
- package/esm/api-endpoints/validObjects/index.js.map +1 -0
- package/esm/authActions.d.ts.map +1 -1
- package/esm/authActions.js +2 -2
- package/esm/authActions.js.map +1 -1
- package/esm/client.d.ts +26 -2
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +21 -1
- package/esm/client.js.map +1 -1
- package/esm/entitiesObjects.d.ts.map +1 -1
- package/esm/entitiesObjects.js +2 -2
- package/esm/entitiesObjects.js.map +1 -1
- package/esm/gd-tiger-model/typeGuards.d.ts.map +1 -1
- package/esm/gd-tiger-model/typeGuards.js +8 -11
- package/esm/gd-tiger-model/typeGuards.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +2527 -3252
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +3700 -4690
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/base.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/base.js +13 -1
- package/esm/generated/afm-rest-api/base.js.map +1 -1
- package/esm/generated/afm-rest-api/configuration.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/configuration.js +13 -1
- package/esm/generated/afm-rest-api/configuration.js.map +1 -1
- package/esm/generated/auth-json-api/api.d.ts +283 -395
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/auth-json-api/api.js +703 -880
- package/esm/generated/auth-json-api/api.js.map +1 -1
- package/esm/generated/auth-json-api/base.d.ts.map +1 -1
- package/esm/generated/auth-json-api/base.js +13 -1
- package/esm/generated/auth-json-api/base.js.map +1 -1
- package/esm/generated/auth-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/auth-json-api/configuration.js +13 -1
- package/esm/generated/auth-json-api/configuration.js.map +1 -1
- package/esm/generated/auth-json-api/template.d.ts +102 -0
- package/esm/generated/auth-json-api/template.d.ts.map +1 -0
- package/esm/generated/auth-json-api/template.js +154 -0
- package/esm/generated/auth-json-api/template.js.map +1 -0
- package/esm/generated/automation-json-api/api.d.ts +347 -757
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +768 -1251
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/base.d.ts.map +1 -1
- package/esm/generated/automation-json-api/base.js +13 -1
- package/esm/generated/automation-json-api/base.js.map +1 -1
- package/esm/generated/automation-json-api/common.d.ts.map +1 -1
- package/esm/generated/automation-json-api/common.js +13 -1
- package/esm/generated/automation-json-api/common.js.map +1 -1
- package/esm/generated/automation-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/automation-json-api/configuration.js +13 -1
- package/esm/generated/automation-json-api/configuration.js.map +1 -1
- package/esm/generated/automation-json-api/index.d.ts.map +1 -1
- package/esm/generated/automation-json-api/index.js +1 -1
- package/esm/generated/automation-json-api/index.js.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +662 -1134
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +1556 -2181
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/base.d.ts.map +1 -1
- package/esm/generated/export-json-api/base.js +13 -1
- package/esm/generated/export-json-api/base.js.map +1 -1
- package/esm/generated/export-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/export-json-api/configuration.js +13 -1
- package/esm/generated/export-json-api/configuration.js.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +35920 -44004
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +54041 -65836
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/base.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/base.js +13 -1
- package/esm/generated/metadata-json-api/base.js.map +1 -1
- package/esm/generated/metadata-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/configuration.js +13 -1
- package/esm/generated/metadata-json-api/configuration.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +10318 -10318
- package/esm/generated/result-json-api/api.d.ts +290 -524
- package/esm/generated/result-json-api/api.d.ts.map +1 -1
- package/esm/generated/result-json-api/api.js +784 -1135
- package/esm/generated/result-json-api/api.js.map +1 -1
- package/esm/generated/result-json-api/base.d.ts.map +1 -1
- package/esm/generated/result-json-api/base.js +13 -1
- package/esm/generated/result-json-api/base.js.map +1 -1
- package/esm/generated/result-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/result-json-api/configuration.js +13 -1
- package/esm/generated/result-json-api/configuration.js.map +1 -1
- package/esm/generated/scan-json-api/api.d.ts +243 -441
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js +655 -922
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/base.d.ts.map +1 -1
- package/esm/generated/scan-json-api/base.js +13 -1
- package/esm/generated/scan-json-api/base.js.map +1 -1
- package/esm/generated/scan-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/scan-json-api/configuration.js +13 -1
- package/esm/generated/scan-json-api/configuration.js.map +1 -1
- package/esm/generated/scan-json-api/openapi-spec.json +1 -1
- package/esm/index.d.ts +4 -5
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +0 -5
- package/esm/index.js.map +1 -1
- package/esm/metadataUtilities.d.ts +21 -4
- package/esm/metadataUtilities.d.ts.map +1 -1
- package/esm/metadataUtilities.js +83 -12
- package/esm/metadataUtilities.js.map +1 -1
- package/esm/organizationUtilities.d.ts +9 -18
- package/esm/organizationUtilities.d.ts.map +1 -1
- package/esm/organizationUtilities.js +1 -17
- package/esm/organizationUtilities.js.map +1 -1
- package/esm/profile.d.ts +34 -0
- package/esm/profile.d.ts.map +1 -1
- package/esm/profile.js +26 -20
- package/esm/profile.js.map +1 -1
- package/esm/scanModel.d.ts.map +1 -1
- package/esm/scanModel.js +2 -2
- package/esm/scanModel.js.map +1 -1
- package/esm/userManagement.d.ts.map +1 -1
- package/esm/userManagement.js +2 -2
- package/esm/userManagement.js.map +1 -1
- package/package.json +25 -6
|
@@ -107,10 +107,7 @@ export interface AutomationAfmObjectIdentifierAttributeIdentifier {
|
|
|
107
107
|
id: string;
|
|
108
108
|
type: AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum;
|
|
109
109
|
}
|
|
110
|
-
export
|
|
111
|
-
readonly ATTRIBUTE: "attribute";
|
|
112
|
-
};
|
|
113
|
-
export type AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum];
|
|
110
|
+
export type AutomationAfmObjectIdentifierAttributeIdentifierTypeEnum = "attribute";
|
|
114
111
|
/**
|
|
115
112
|
* Reference to the metric, fact or attribute object to use for the metric.
|
|
116
113
|
*/
|
|
@@ -121,13 +118,7 @@ export interface AutomationAfmObjectIdentifierCoreIdentifier {
|
|
|
121
118
|
id: string;
|
|
122
119
|
type: AutomationAfmObjectIdentifierCoreIdentifierTypeEnum;
|
|
123
120
|
}
|
|
124
|
-
export
|
|
125
|
-
readonly ATTRIBUTE: "attribute";
|
|
126
|
-
readonly LABEL: "label";
|
|
127
|
-
readonly FACT: "fact";
|
|
128
|
-
readonly METRIC: "metric";
|
|
129
|
-
};
|
|
130
|
-
export type AutomationAfmObjectIdentifierCoreIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierCoreIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierCoreIdentifierTypeEnum];
|
|
121
|
+
export type AutomationAfmObjectIdentifierCoreIdentifierTypeEnum = "attribute" | "label" | "fact" | "metric";
|
|
131
122
|
/**
|
|
132
123
|
* Reference to the date dataset to which the filter should be applied.
|
|
133
124
|
*/
|
|
@@ -138,27 +129,12 @@ export interface AutomationAfmObjectIdentifierDatasetIdentifier {
|
|
|
138
129
|
id: string;
|
|
139
130
|
type: AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum;
|
|
140
131
|
}
|
|
141
|
-
export
|
|
142
|
-
readonly DATASET: "dataset";
|
|
143
|
-
};
|
|
144
|
-
export type AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum];
|
|
132
|
+
export type AutomationAfmObjectIdentifierDatasetIdentifierTypeEnum = "dataset";
|
|
145
133
|
export interface AutomationAfmObjectIdentifierIdentifier {
|
|
146
134
|
type: AutomationAfmObjectIdentifierIdentifierTypeEnum;
|
|
147
135
|
id: string;
|
|
148
136
|
}
|
|
149
|
-
export
|
|
150
|
-
readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
|
|
151
|
-
readonly ATTRIBUTE: "attribute";
|
|
152
|
-
readonly DASHBOARD_PLUGIN: "dashboardPlugin";
|
|
153
|
-
readonly DATASET: "dataset";
|
|
154
|
-
readonly FACT: "fact";
|
|
155
|
-
readonly LABEL: "label";
|
|
156
|
-
readonly METRIC: "metric";
|
|
157
|
-
readonly PROMPT: "prompt";
|
|
158
|
-
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
159
|
-
readonly FILTER_CONTEXT: "filterContext";
|
|
160
|
-
};
|
|
161
|
-
export type AutomationAfmObjectIdentifierIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierIdentifierTypeEnum];
|
|
137
|
+
export type AutomationAfmObjectIdentifierIdentifierTypeEnum = "analyticalDashboard" | "attribute" | "dashboardPlugin" | "dataset" | "fact" | "label" | "metric" | "prompt" | "visualizationObject" | "filterContext";
|
|
162
138
|
export interface AutomationAfmObjectIdentifierLabel {
|
|
163
139
|
identifier: AutomationAfmObjectIdentifierLabelIdentifier;
|
|
164
140
|
}
|
|
@@ -166,10 +142,7 @@ export interface AutomationAfmObjectIdentifierLabelIdentifier {
|
|
|
166
142
|
type: AutomationAfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
167
143
|
id: string;
|
|
168
144
|
}
|
|
169
|
-
export
|
|
170
|
-
readonly LABEL: "label";
|
|
171
|
-
};
|
|
172
|
-
export type AutomationAfmObjectIdentifierLabelIdentifierTypeEnum = (typeof AutomationAfmObjectIdentifierLabelIdentifierTypeEnum)[keyof typeof AutomationAfmObjectIdentifierLabelIdentifierTypeEnum];
|
|
145
|
+
export type AutomationAfmObjectIdentifierLabelIdentifierTypeEnum = "label";
|
|
173
146
|
export interface AutomationAlertAfm {
|
|
174
147
|
/**
|
|
175
148
|
* Attributes to be used in the computation.
|
|
@@ -215,13 +188,7 @@ export interface AutomationAlertDescription {
|
|
|
215
188
|
errorMessage?: string;
|
|
216
189
|
traceId?: string;
|
|
217
190
|
}
|
|
218
|
-
export
|
|
219
|
-
readonly SUCCESS: "SUCCESS";
|
|
220
|
-
readonly ERROR: "ERROR";
|
|
221
|
-
readonly INTERNAL_ERROR: "INTERNAL_ERROR";
|
|
222
|
-
readonly TIMEOUT: "TIMEOUT";
|
|
223
|
-
};
|
|
224
|
-
export type AutomationAlertDescriptionStatusEnum = (typeof AutomationAlertDescriptionStatusEnum)[keyof typeof AutomationAlertDescriptionStatusEnum];
|
|
191
|
+
export type AutomationAlertDescriptionStatusEnum = "SUCCESS" | "ERROR" | "INTERNAL_ERROR" | "TIMEOUT";
|
|
225
192
|
export interface AutomationAlertEvaluationRow {
|
|
226
193
|
primaryMetric?: AutomationMetricRecord;
|
|
227
194
|
secondaryMetric?: AutomationMetricRecord;
|
|
@@ -236,11 +203,7 @@ export interface AutomationArithmeticMeasure {
|
|
|
236
203
|
left: AutomationLocalIdentifier;
|
|
237
204
|
right: AutomationLocalIdentifier;
|
|
238
205
|
}
|
|
239
|
-
export
|
|
240
|
-
readonly DIFFERENCE: "DIFFERENCE";
|
|
241
|
-
readonly CHANGE: "CHANGE";
|
|
242
|
-
};
|
|
243
|
-
export type AutomationArithmeticMeasureOperatorEnum = (typeof AutomationArithmeticMeasureOperatorEnum)[keyof typeof AutomationArithmeticMeasureOperatorEnum];
|
|
206
|
+
export type AutomationArithmeticMeasureOperatorEnum = "DIFFERENCE" | "CHANGE";
|
|
244
207
|
/**
|
|
245
208
|
* Metric representing arithmetics between other metrics.
|
|
246
209
|
*/
|
|
@@ -257,14 +220,7 @@ export interface AutomationArithmeticMeasureDefinitionArithmeticMeasure {
|
|
|
257
220
|
*/
|
|
258
221
|
operator: AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
|
|
259
222
|
}
|
|
260
|
-
export
|
|
261
|
-
readonly SUM: "SUM";
|
|
262
|
-
readonly DIFFERENCE: "DIFFERENCE";
|
|
263
|
-
readonly MULTIPLICATION: "MULTIPLICATION";
|
|
264
|
-
readonly RATIO: "RATIO";
|
|
265
|
-
readonly CHANGE: "CHANGE";
|
|
266
|
-
};
|
|
267
|
-
export type AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = (typeof AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum)[keyof typeof AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum];
|
|
223
|
+
export type AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = "SUM" | "DIFFERENCE" | "MULTIPLICATION" | "RATIO" | "CHANGE";
|
|
268
224
|
/**
|
|
269
225
|
* @type AutomationAttributeElements
|
|
270
226
|
*/
|
|
@@ -322,11 +278,7 @@ export interface AutomationAutomationAlert {
|
|
|
322
278
|
*/
|
|
323
279
|
trigger?: AutomationAutomationAlertTriggerEnum;
|
|
324
280
|
}
|
|
325
|
-
export
|
|
326
|
-
readonly ALWAYS: "ALWAYS";
|
|
327
|
-
readonly ONCE: "ONCE";
|
|
328
|
-
};
|
|
329
|
-
export type AutomationAutomationAlertTriggerEnum = (typeof AutomationAutomationAlertTriggerEnum)[keyof typeof AutomationAutomationAlertTriggerEnum];
|
|
281
|
+
export type AutomationAutomationAlertTriggerEnum = "ALWAYS" | "ONCE";
|
|
330
282
|
/**
|
|
331
283
|
* @type AutomationAutomationAlertCondition
|
|
332
284
|
*/
|
|
@@ -383,39 +335,13 @@ export interface AutomationBoundedFilter {
|
|
|
383
335
|
*/
|
|
384
336
|
to?: number | null;
|
|
385
337
|
}
|
|
386
|
-
export
|
|
387
|
-
readonly MINUTE: "MINUTE";
|
|
388
|
-
readonly HOUR: "HOUR";
|
|
389
|
-
readonly DAY: "DAY";
|
|
390
|
-
readonly WEEK: "WEEK";
|
|
391
|
-
readonly MONTH: "MONTH";
|
|
392
|
-
readonly QUARTER: "QUARTER";
|
|
393
|
-
readonly YEAR: "YEAR";
|
|
394
|
-
readonly MINUTE_OF_HOUR: "MINUTE_OF_HOUR";
|
|
395
|
-
readonly HOUR_OF_DAY: "HOUR_OF_DAY";
|
|
396
|
-
readonly DAY_OF_WEEK: "DAY_OF_WEEK";
|
|
397
|
-
readonly DAY_OF_MONTH: "DAY_OF_MONTH";
|
|
398
|
-
readonly DAY_OF_QUARTER: "DAY_OF_QUARTER";
|
|
399
|
-
readonly DAY_OF_YEAR: "DAY_OF_YEAR";
|
|
400
|
-
readonly WEEK_OF_YEAR: "WEEK_OF_YEAR";
|
|
401
|
-
readonly MONTH_OF_YEAR: "MONTH_OF_YEAR";
|
|
402
|
-
readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
|
|
403
|
-
};
|
|
404
|
-
export type AutomationBoundedFilterGranularityEnum = (typeof AutomationBoundedFilterGranularityEnum)[keyof typeof AutomationBoundedFilterGranularityEnum];
|
|
338
|
+
export type AutomationBoundedFilterGranularityEnum = "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_QUARTER" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR";
|
|
405
339
|
export interface AutomationComparison {
|
|
406
340
|
operator: AutomationComparisonOperatorEnum;
|
|
407
341
|
left: AutomationLocalIdentifier;
|
|
408
342
|
right: AutomationAlertConditionOperand;
|
|
409
343
|
}
|
|
410
|
-
export
|
|
411
|
-
readonly GREATER_THAN: "GREATER_THAN";
|
|
412
|
-
readonly GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO";
|
|
413
|
-
readonly LESS_THAN: "LESS_THAN";
|
|
414
|
-
readonly LESS_THAN_OR_EQUAL_TO: "LESS_THAN_OR_EQUAL_TO";
|
|
415
|
-
readonly EQUAL_TO: "EQUAL_TO";
|
|
416
|
-
readonly NOT_EQUAL_TO: "NOT_EQUAL_TO";
|
|
417
|
-
};
|
|
418
|
-
export type AutomationComparisonOperatorEnum = (typeof AutomationComparisonOperatorEnum)[keyof typeof AutomationComparisonOperatorEnum];
|
|
344
|
+
export type AutomationComparisonOperatorEnum = "GREATER_THAN" | "GREATER_THAN_OR_EQUAL_TO" | "LESS_THAN" | "LESS_THAN_OR_EQUAL_TO" | "EQUAL_TO" | "NOT_EQUAL_TO";
|
|
419
345
|
/**
|
|
420
346
|
* Filter the result by comparing specified metric to given constant value, using given comparison operator.
|
|
421
347
|
*/
|
|
@@ -437,15 +363,7 @@ export interface AutomationComparisonMeasureValueFilterComparisonMeasureValueFil
|
|
|
437
363
|
applyOnResult?: boolean;
|
|
438
364
|
measure: AutomationAfmIdentifier;
|
|
439
365
|
}
|
|
440
|
-
export
|
|
441
|
-
readonly GREATER_THAN: "GREATER_THAN";
|
|
442
|
-
readonly GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO";
|
|
443
|
-
readonly LESS_THAN: "LESS_THAN";
|
|
444
|
-
readonly LESS_THAN_OR_EQUAL_TO: "LESS_THAN_OR_EQUAL_TO";
|
|
445
|
-
readonly EQUAL_TO: "EQUAL_TO";
|
|
446
|
-
readonly NOT_EQUAL_TO: "NOT_EQUAL_TO";
|
|
447
|
-
};
|
|
448
|
-
export type AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = (typeof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum)[keyof typeof AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum];
|
|
366
|
+
export type AutomationComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = "GREATER_THAN" | "GREATER_THAN_OR_EQUAL_TO" | "LESS_THAN" | "LESS_THAN_OR_EQUAL_TO" | "EQUAL_TO" | "NOT_EQUAL_TO";
|
|
449
367
|
export interface AutomationComparisonWrapper {
|
|
450
368
|
comparison: AutomationComparison;
|
|
451
369
|
}
|
|
@@ -502,11 +420,7 @@ export interface AutomationDashboardAttributeFilterAttributeFilter {
|
|
|
502
420
|
selectionMode?: AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum;
|
|
503
421
|
localIdentifier?: string;
|
|
504
422
|
}
|
|
505
|
-
export
|
|
506
|
-
readonly SINGLE: "single";
|
|
507
|
-
readonly MULTI: "multi";
|
|
508
|
-
};
|
|
509
|
-
export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = (typeof AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum)[keyof typeof AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum];
|
|
423
|
+
export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = "single" | "multi";
|
|
510
424
|
export interface AutomationDashboardDateFilter {
|
|
511
425
|
dateFilter: AutomationDashboardDateFilterDateFilter;
|
|
512
426
|
}
|
|
@@ -520,37 +434,8 @@ export interface AutomationDashboardDateFilterDateFilter {
|
|
|
520
434
|
boundedFilter?: AutomationRelativeBoundedDateFilter;
|
|
521
435
|
localIdentifier?: string;
|
|
522
436
|
}
|
|
523
|
-
export
|
|
524
|
-
|
|
525
|
-
readonly ABSOLUTE: "absolute";
|
|
526
|
-
};
|
|
527
|
-
export type AutomationDashboardDateFilterDateFilterTypeEnum = (typeof AutomationDashboardDateFilterDateFilterTypeEnum)[keyof typeof AutomationDashboardDateFilterDateFilterTypeEnum];
|
|
528
|
-
export declare const AutomationDashboardDateFilterDateFilterGranularityEnum: {
|
|
529
|
-
readonly ALL_TIME_GRANULARITY: "ALL_TIME_GRANULARITY";
|
|
530
|
-
readonly GDC_TIME_YEAR: "GDC.time.year";
|
|
531
|
-
readonly GDC_TIME_WEEK_US: "GDC.time.week_us";
|
|
532
|
-
readonly GDC_TIME_WEEK_IN_YEAR: "GDC.time.week_in_year";
|
|
533
|
-
readonly GDC_TIME_WEEK_IN_QUARTER: "GDC.time.week_in_quarter";
|
|
534
|
-
readonly GDC_TIME_WEEK: "GDC.time.week";
|
|
535
|
-
readonly GDC_TIME_EUWEEK_IN_YEAR: "GDC.time.euweek_in_year";
|
|
536
|
-
readonly GDC_TIME_EUWEEK_IN_QUARTER: "GDC.time.euweek_in_quarter";
|
|
537
|
-
readonly GDC_TIME_QUARTER: "GDC.time.quarter";
|
|
538
|
-
readonly GDC_TIME_QUARTER_IN_YEAR: "GDC.time.quarter_in_year";
|
|
539
|
-
readonly GDC_TIME_MONTH: "GDC.time.month";
|
|
540
|
-
readonly GDC_TIME_MONTH_IN_QUARTER: "GDC.time.month_in_quarter";
|
|
541
|
-
readonly GDC_TIME_MONTH_IN_YEAR: "GDC.time.month_in_year";
|
|
542
|
-
readonly GDC_TIME_DAY_IN_YEAR: "GDC.time.day_in_year";
|
|
543
|
-
readonly GDC_TIME_DAY_IN_QUARTER: "GDC.time.day_in_quarter";
|
|
544
|
-
readonly GDC_TIME_DAY_IN_MONTH: "GDC.time.day_in_month";
|
|
545
|
-
readonly GDC_TIME_DAY_IN_WEEK: "GDC.time.day_in_week";
|
|
546
|
-
readonly GDC_TIME_DAY_IN_EUWEEK: "GDC.time.day_in_euweek";
|
|
547
|
-
readonly GDC_TIME_DATE: "GDC.time.date";
|
|
548
|
-
readonly GDC_TIME_HOUR: "GDC.time.hour";
|
|
549
|
-
readonly GDC_TIME_HOUR_IN_DAY: "GDC.time.hour_in_day";
|
|
550
|
-
readonly GDC_TIME_MINUTE: "GDC.time.minute";
|
|
551
|
-
readonly GDC_TIME_MINUTE_IN_HOUR: "GDC.time.minute_in_hour";
|
|
552
|
-
};
|
|
553
|
-
export type AutomationDashboardDateFilterDateFilterGranularityEnum = (typeof AutomationDashboardDateFilterDateFilterGranularityEnum)[keyof typeof AutomationDashboardDateFilterDateFilterGranularityEnum];
|
|
437
|
+
export type AutomationDashboardDateFilterDateFilterTypeEnum = "relative" | "absolute";
|
|
438
|
+
export type AutomationDashboardDateFilterDateFilterGranularityEnum = "ALL_TIME_GRANULARITY" | "GDC.time.year" | "GDC.time.week_us" | "GDC.time.week_in_year" | "GDC.time.week_in_quarter" | "GDC.time.week" | "GDC.time.euweek_in_year" | "GDC.time.euweek_in_quarter" | "GDC.time.quarter" | "GDC.time.quarter_in_year" | "GDC.time.month" | "GDC.time.month_in_quarter" | "GDC.time.month_in_year" | "GDC.time.day_in_year" | "GDC.time.day_in_quarter" | "GDC.time.day_in_month" | "GDC.time.day_in_week" | "GDC.time.day_in_euweek" | "GDC.time.date" | "GDC.time.hour" | "GDC.time.hour_in_day" | "GDC.time.minute" | "GDC.time.minute_in_hour";
|
|
554
439
|
/**
|
|
555
440
|
* @type AutomationDashboardDateFilterDateFilterFrom
|
|
556
441
|
*/
|
|
@@ -576,17 +461,8 @@ export interface AutomationDashboardExportSettings {
|
|
|
576
461
|
*/
|
|
577
462
|
pageOrientation?: AutomationDashboardExportSettingsPageOrientationEnum;
|
|
578
463
|
}
|
|
579
|
-
export
|
|
580
|
-
|
|
581
|
-
readonly A4: "A4";
|
|
582
|
-
readonly LETTER: "LETTER";
|
|
583
|
-
};
|
|
584
|
-
export type AutomationDashboardExportSettingsPageSizeEnum = (typeof AutomationDashboardExportSettingsPageSizeEnum)[keyof typeof AutomationDashboardExportSettingsPageSizeEnum];
|
|
585
|
-
export declare const AutomationDashboardExportSettingsPageOrientationEnum: {
|
|
586
|
-
readonly PORTRAIT: "PORTRAIT";
|
|
587
|
-
readonly LANDSCAPE: "LANDSCAPE";
|
|
588
|
-
};
|
|
589
|
-
export type AutomationDashboardExportSettingsPageOrientationEnum = (typeof AutomationDashboardExportSettingsPageOrientationEnum)[keyof typeof AutomationDashboardExportSettingsPageOrientationEnum];
|
|
464
|
+
export type AutomationDashboardExportSettingsPageSizeEnum = "A3" | "A4" | "LETTER";
|
|
465
|
+
export type AutomationDashboardExportSettingsPageOrientationEnum = "PORTRAIT" | "LANDSCAPE";
|
|
590
466
|
/**
|
|
591
467
|
* @type AutomationDashboardFilter
|
|
592
468
|
*/
|
|
@@ -623,11 +499,7 @@ export interface AutomationDashboardTabularExportRequestV2 {
|
|
|
623
499
|
widgetIds?: Array<string>;
|
|
624
500
|
settings?: AutomationDashboardExportSettings;
|
|
625
501
|
}
|
|
626
|
-
export
|
|
627
|
-
readonly XLSX: "XLSX";
|
|
628
|
-
readonly PDF: "PDF";
|
|
629
|
-
};
|
|
630
|
-
export type AutomationDashboardTabularExportRequestV2FormatEnum = (typeof AutomationDashboardTabularExportRequestV2FormatEnum)[keyof typeof AutomationDashboardTabularExportRequestV2FormatEnum];
|
|
502
|
+
export type AutomationDashboardTabularExportRequestV2FormatEnum = "XLSX" | "PDF";
|
|
631
503
|
/**
|
|
632
504
|
* @type AutomationDateFilter
|
|
633
505
|
* Abstract filter definition type for dates.
|
|
@@ -649,10 +521,7 @@ export interface AutomationDeclarativeAnalyticalDashboardIdentifier {
|
|
|
649
521
|
*/
|
|
650
522
|
type: AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum;
|
|
651
523
|
}
|
|
652
|
-
export
|
|
653
|
-
readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
|
|
654
|
-
};
|
|
655
|
-
export type AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum = (typeof AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum)[keyof typeof AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum];
|
|
524
|
+
export type AutomationDeclarativeAnalyticalDashboardIdentifierTypeEnum = "analyticalDashboard";
|
|
656
525
|
/**
|
|
657
526
|
* A notification channel identifier.
|
|
658
527
|
*/
|
|
@@ -666,10 +535,7 @@ export interface AutomationDeclarativeNotificationChannelIdentifier {
|
|
|
666
535
|
*/
|
|
667
536
|
type: AutomationDeclarativeNotificationChannelIdentifierTypeEnum;
|
|
668
537
|
}
|
|
669
|
-
export
|
|
670
|
-
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
671
|
-
};
|
|
672
|
-
export type AutomationDeclarativeNotificationChannelIdentifierTypeEnum = (typeof AutomationDeclarativeNotificationChannelIdentifierTypeEnum)[keyof typeof AutomationDeclarativeNotificationChannelIdentifierTypeEnum];
|
|
538
|
+
export type AutomationDeclarativeNotificationChannelIdentifierTypeEnum = "notificationChannel";
|
|
673
539
|
/**
|
|
674
540
|
* A user identifier.
|
|
675
541
|
*/
|
|
@@ -683,10 +549,7 @@ export interface AutomationDeclarativeUserIdentifier {
|
|
|
683
549
|
*/
|
|
684
550
|
type: AutomationDeclarativeUserIdentifierTypeEnum;
|
|
685
551
|
}
|
|
686
|
-
export
|
|
687
|
-
readonly USER: "user";
|
|
688
|
-
};
|
|
689
|
-
export type AutomationDeclarativeUserIdentifierTypeEnum = (typeof AutomationDeclarativeUserIdentifierTypeEnum)[keyof typeof AutomationDeclarativeUserIdentifierTypeEnum];
|
|
552
|
+
export type AutomationDeclarativeUserIdentifierTypeEnum = "user";
|
|
690
553
|
/**
|
|
691
554
|
* Default SMTP destination for notifications.
|
|
692
555
|
*/
|
|
@@ -704,10 +567,7 @@ export interface AutomationDefaultSmtp {
|
|
|
704
567
|
*/
|
|
705
568
|
type: AutomationDefaultSmtpTypeEnum;
|
|
706
569
|
}
|
|
707
|
-
export
|
|
708
|
-
readonly DEFAULT_SMTP: "DEFAULT_SMTP";
|
|
709
|
-
};
|
|
710
|
-
export type AutomationDefaultSmtpTypeEnum = (typeof AutomationDefaultSmtpTypeEnum)[keyof typeof AutomationDefaultSmtpTypeEnum];
|
|
570
|
+
export type AutomationDefaultSmtpTypeEnum = "DEFAULT_SMTP";
|
|
711
571
|
/**
|
|
712
572
|
* Various settings affecting the process of AFM execution or its result
|
|
713
573
|
*/
|
|
@@ -732,13 +592,7 @@ export interface AutomationExportResult {
|
|
|
732
592
|
traceId?: string;
|
|
733
593
|
triggeredAt?: string;
|
|
734
594
|
}
|
|
735
|
-
export
|
|
736
|
-
readonly SUCCESS: "SUCCESS";
|
|
737
|
-
readonly ERROR: "ERROR";
|
|
738
|
-
readonly INTERNAL_ERROR: "INTERNAL_ERROR";
|
|
739
|
-
readonly TIMEOUT: "TIMEOUT";
|
|
740
|
-
};
|
|
741
|
-
export type AutomationExportResultStatusEnum = (typeof AutomationExportResultStatusEnum)[keyof typeof AutomationExportResultStatusEnum];
|
|
595
|
+
export type AutomationExportResultStatusEnum = "SUCCESS" | "ERROR" | "INTERNAL_ERROR" | "TIMEOUT";
|
|
742
596
|
/**
|
|
743
597
|
* @type AutomationFilterDefinition
|
|
744
598
|
* Abstract filter definition type
|
|
@@ -756,31 +610,7 @@ export interface AutomationIdentifierRefIdentifier {
|
|
|
756
610
|
id: string;
|
|
757
611
|
type: AutomationIdentifierRefIdentifierTypeEnum;
|
|
758
612
|
}
|
|
759
|
-
export
|
|
760
|
-
readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
|
|
761
|
-
readonly ATTRIBUTE: "attribute";
|
|
762
|
-
readonly ATTRIBUTE_HIERARCHY: "attributeHierarchy";
|
|
763
|
-
readonly DASHBOARD_PLUGIN: "dashboardPlugin";
|
|
764
|
-
readonly DATASET: "dataset";
|
|
765
|
-
readonly FACT: "fact";
|
|
766
|
-
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
767
|
-
readonly LABEL: "label";
|
|
768
|
-
readonly METRIC: "metric";
|
|
769
|
-
readonly USER_DATA_FILTER: "userDataFilter";
|
|
770
|
-
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
771
|
-
readonly AUTOMATION: "automation";
|
|
772
|
-
readonly AUTOMATION_RESULT: "automationResult";
|
|
773
|
-
readonly MEMORY_ITEM: "memoryItem";
|
|
774
|
-
readonly PROMPT: "prompt";
|
|
775
|
-
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
776
|
-
readonly FILTER_CONTEXT: "filterContext";
|
|
777
|
-
readonly WORKSPACE_SETTINGS: "workspaceSettings";
|
|
778
|
-
readonly CUSTOM_APPLICATION_SETTING: "customApplicationSetting";
|
|
779
|
-
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
780
|
-
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
781
|
-
readonly FILTER_VIEW: "filterView";
|
|
782
|
-
};
|
|
783
|
-
export type AutomationIdentifierRefIdentifierTypeEnum = (typeof AutomationIdentifierRefIdentifierTypeEnum)[keyof typeof AutomationIdentifierRefIdentifierTypeEnum];
|
|
613
|
+
export type AutomationIdentifierRefIdentifierTypeEnum = "analyticalDashboard" | "attribute" | "attributeHierarchy" | "dashboardPlugin" | "dataset" | "fact" | "aggregatedFact" | "label" | "metric" | "userDataFilter" | "exportDefinition" | "automation" | "automationResult" | "memoryItem" | "prompt" | "visualizationObject" | "filterContext" | "workspaceSettings" | "customApplicationSetting" | "workspaceDataFilter" | "workspaceDataFilterSetting" | "filterView";
|
|
784
614
|
/**
|
|
785
615
|
* Export request object describing the export properties and metadata for image exports.
|
|
786
616
|
*/
|
|
@@ -806,10 +636,7 @@ export interface AutomationImageExportRequest {
|
|
|
806
636
|
*/
|
|
807
637
|
metadata?: object | null;
|
|
808
638
|
}
|
|
809
|
-
export
|
|
810
|
-
readonly PNG: "PNG";
|
|
811
|
-
};
|
|
812
|
-
export type AutomationImageExportRequestFormatEnum = (typeof AutomationImageExportRequestFormatEnum)[keyof typeof AutomationImageExportRequestFormatEnum];
|
|
639
|
+
export type AutomationImageExportRequestFormatEnum = "PNG";
|
|
813
640
|
/**
|
|
814
641
|
* In-platform destination for notifications.
|
|
815
642
|
*/
|
|
@@ -819,10 +646,7 @@ export interface AutomationInPlatform {
|
|
|
819
646
|
*/
|
|
820
647
|
type: AutomationInPlatformTypeEnum;
|
|
821
648
|
}
|
|
822
|
-
export
|
|
823
|
-
readonly IN_PLATFORM: "IN_PLATFORM";
|
|
824
|
-
};
|
|
825
|
-
export type AutomationInPlatformTypeEnum = (typeof AutomationInPlatformTypeEnum)[keyof typeof AutomationInPlatformTypeEnum];
|
|
649
|
+
export type AutomationInPlatformTypeEnum = "IN_PLATFORM";
|
|
826
650
|
/**
|
|
827
651
|
* Filter in form of direct MAQL query.
|
|
828
652
|
*/
|
|
@@ -1034,11 +858,7 @@ export interface AutomationRange {
|
|
|
1034
858
|
from: AutomationValue;
|
|
1035
859
|
to: AutomationValue;
|
|
1036
860
|
}
|
|
1037
|
-
export
|
|
1038
|
-
readonly BETWEEN: "BETWEEN";
|
|
1039
|
-
readonly NOT_BETWEEN: "NOT_BETWEEN";
|
|
1040
|
-
};
|
|
1041
|
-
export type AutomationRangeOperatorEnum = (typeof AutomationRangeOperatorEnum)[keyof typeof AutomationRangeOperatorEnum];
|
|
861
|
+
export type AutomationRangeOperatorEnum = "BETWEEN" | "NOT_BETWEEN";
|
|
1042
862
|
/**
|
|
1043
863
|
* Filter the result by comparing specified metric to given range of values.
|
|
1044
864
|
*/
|
|
@@ -1061,11 +881,7 @@ export interface AutomationRangeMeasureValueFilterRangeMeasureValueFilter {
|
|
|
1061
881
|
applyOnResult?: boolean;
|
|
1062
882
|
measure: AutomationAfmIdentifier;
|
|
1063
883
|
}
|
|
1064
|
-
export
|
|
1065
|
-
readonly BETWEEN: "BETWEEN";
|
|
1066
|
-
readonly NOT_BETWEEN: "NOT_BETWEEN";
|
|
1067
|
-
};
|
|
1068
|
-
export type AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = (typeof AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum)[keyof typeof AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum];
|
|
884
|
+
export type AutomationRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = "BETWEEN" | "NOT_BETWEEN";
|
|
1069
885
|
export interface AutomationRangeWrapper {
|
|
1070
886
|
range: AutomationRange;
|
|
1071
887
|
}
|
|
@@ -1095,11 +911,7 @@ export interface AutomationRankingFilterRankingFilter {
|
|
|
1095
911
|
localIdentifier?: string;
|
|
1096
912
|
applyOnResult?: boolean;
|
|
1097
913
|
}
|
|
1098
|
-
export
|
|
1099
|
-
readonly TOP: "TOP";
|
|
1100
|
-
readonly BOTTOM: "BOTTOM";
|
|
1101
|
-
};
|
|
1102
|
-
export type AutomationRankingFilterRankingFilterOperatorEnum = (typeof AutomationRankingFilterRankingFilterOperatorEnum)[keyof typeof AutomationRankingFilterRankingFilterOperatorEnum];
|
|
914
|
+
export type AutomationRankingFilterRankingFilterOperatorEnum = "TOP" | "BOTTOM";
|
|
1103
915
|
/**
|
|
1104
916
|
* Custom label object override.
|
|
1105
917
|
*/
|
|
@@ -1155,12 +967,7 @@ export interface AutomationRawExportAutomationRequest {
|
|
|
1155
967
|
*/
|
|
1156
968
|
metadata?: object | null;
|
|
1157
969
|
}
|
|
1158
|
-
export
|
|
1159
|
-
readonly ARROW_FILE: "ARROW_FILE";
|
|
1160
|
-
readonly ARROW_STREAM: "ARROW_STREAM";
|
|
1161
|
-
readonly CSV: "CSV";
|
|
1162
|
-
};
|
|
1163
|
-
export type AutomationRawExportAutomationRequestFormatEnum = (typeof AutomationRawExportAutomationRequestFormatEnum)[keyof typeof AutomationRawExportAutomationRequestFormatEnum];
|
|
970
|
+
export type AutomationRawExportAutomationRequestFormatEnum = "ARROW_FILE" | "ARROW_STREAM" | "CSV";
|
|
1164
971
|
export interface AutomationRelative {
|
|
1165
972
|
/**
|
|
1166
973
|
* Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value.
|
|
@@ -1169,43 +976,13 @@ export interface AutomationRelative {
|
|
|
1169
976
|
measure: AutomationArithmeticMeasure;
|
|
1170
977
|
threshold: AutomationValue;
|
|
1171
978
|
}
|
|
1172
|
-
export
|
|
1173
|
-
readonly INCREASES_BY: "INCREASES_BY";
|
|
1174
|
-
readonly DECREASES_BY: "DECREASES_BY";
|
|
1175
|
-
readonly CHANGES_BY: "CHANGES_BY";
|
|
1176
|
-
};
|
|
1177
|
-
export type AutomationRelativeOperatorEnum = (typeof AutomationRelativeOperatorEnum)[keyof typeof AutomationRelativeOperatorEnum];
|
|
979
|
+
export type AutomationRelativeOperatorEnum = "INCREASES_BY" | "DECREASES_BY" | "CHANGES_BY";
|
|
1178
980
|
export interface AutomationRelativeBoundedDateFilter {
|
|
1179
981
|
granularity: AutomationRelativeBoundedDateFilterGranularityEnum;
|
|
1180
982
|
from?: number;
|
|
1181
983
|
to?: number;
|
|
1182
984
|
}
|
|
1183
|
-
export
|
|
1184
|
-
readonly ALL_TIME_GRANULARITY: "ALL_TIME_GRANULARITY";
|
|
1185
|
-
readonly GDC_TIME_YEAR: "GDC.time.year";
|
|
1186
|
-
readonly GDC_TIME_WEEK_US: "GDC.time.week_us";
|
|
1187
|
-
readonly GDC_TIME_WEEK_IN_YEAR: "GDC.time.week_in_year";
|
|
1188
|
-
readonly GDC_TIME_WEEK_IN_QUARTER: "GDC.time.week_in_quarter";
|
|
1189
|
-
readonly GDC_TIME_WEEK: "GDC.time.week";
|
|
1190
|
-
readonly GDC_TIME_EUWEEK_IN_YEAR: "GDC.time.euweek_in_year";
|
|
1191
|
-
readonly GDC_TIME_EUWEEK_IN_QUARTER: "GDC.time.euweek_in_quarter";
|
|
1192
|
-
readonly GDC_TIME_QUARTER: "GDC.time.quarter";
|
|
1193
|
-
readonly GDC_TIME_QUARTER_IN_YEAR: "GDC.time.quarter_in_year";
|
|
1194
|
-
readonly GDC_TIME_MONTH: "GDC.time.month";
|
|
1195
|
-
readonly GDC_TIME_MONTH_IN_QUARTER: "GDC.time.month_in_quarter";
|
|
1196
|
-
readonly GDC_TIME_MONTH_IN_YEAR: "GDC.time.month_in_year";
|
|
1197
|
-
readonly GDC_TIME_DAY_IN_YEAR: "GDC.time.day_in_year";
|
|
1198
|
-
readonly GDC_TIME_DAY_IN_QUARTER: "GDC.time.day_in_quarter";
|
|
1199
|
-
readonly GDC_TIME_DAY_IN_MONTH: "GDC.time.day_in_month";
|
|
1200
|
-
readonly GDC_TIME_DAY_IN_WEEK: "GDC.time.day_in_week";
|
|
1201
|
-
readonly GDC_TIME_DAY_IN_EUWEEK: "GDC.time.day_in_euweek";
|
|
1202
|
-
readonly GDC_TIME_DATE: "GDC.time.date";
|
|
1203
|
-
readonly GDC_TIME_HOUR: "GDC.time.hour";
|
|
1204
|
-
readonly GDC_TIME_HOUR_IN_DAY: "GDC.time.hour_in_day";
|
|
1205
|
-
readonly GDC_TIME_MINUTE: "GDC.time.minute";
|
|
1206
|
-
readonly GDC_TIME_MINUTE_IN_HOUR: "GDC.time.minute_in_hour";
|
|
1207
|
-
};
|
|
1208
|
-
export type AutomationRelativeBoundedDateFilterGranularityEnum = (typeof AutomationRelativeBoundedDateFilterGranularityEnum)[keyof typeof AutomationRelativeBoundedDateFilterGranularityEnum];
|
|
985
|
+
export type AutomationRelativeBoundedDateFilterGranularityEnum = "ALL_TIME_GRANULARITY" | "GDC.time.year" | "GDC.time.week_us" | "GDC.time.week_in_year" | "GDC.time.week_in_quarter" | "GDC.time.week" | "GDC.time.euweek_in_year" | "GDC.time.euweek_in_quarter" | "GDC.time.quarter" | "GDC.time.quarter_in_year" | "GDC.time.month" | "GDC.time.month_in_quarter" | "GDC.time.month_in_year" | "GDC.time.day_in_year" | "GDC.time.day_in_quarter" | "GDC.time.day_in_month" | "GDC.time.day_in_week" | "GDC.time.day_in_euweek" | "GDC.time.date" | "GDC.time.hour" | "GDC.time.hour_in_day" | "GDC.time.minute" | "GDC.time.minute_in_hour";
|
|
1209
986
|
/**
|
|
1210
987
|
* A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The \'from\' and \'to\' properties mark the boundaries of the interval. If \'from\' is omitted, all values earlier than \'to\' are included. If \'to\' is omitted, all values later than \'from\' are included. It is not allowed to omit both.
|
|
1211
988
|
*/
|
|
@@ -1230,25 +1007,7 @@ export interface AutomationRelativeDateFilterRelativeDateFilter {
|
|
|
1230
1007
|
boundedFilter?: AutomationBoundedFilter;
|
|
1231
1008
|
dataset: AutomationAfmObjectIdentifierDataset;
|
|
1232
1009
|
}
|
|
1233
|
-
export
|
|
1234
|
-
readonly MINUTE: "MINUTE";
|
|
1235
|
-
readonly HOUR: "HOUR";
|
|
1236
|
-
readonly DAY: "DAY";
|
|
1237
|
-
readonly WEEK: "WEEK";
|
|
1238
|
-
readonly MONTH: "MONTH";
|
|
1239
|
-
readonly QUARTER: "QUARTER";
|
|
1240
|
-
readonly YEAR: "YEAR";
|
|
1241
|
-
readonly MINUTE_OF_HOUR: "MINUTE_OF_HOUR";
|
|
1242
|
-
readonly HOUR_OF_DAY: "HOUR_OF_DAY";
|
|
1243
|
-
readonly DAY_OF_WEEK: "DAY_OF_WEEK";
|
|
1244
|
-
readonly DAY_OF_MONTH: "DAY_OF_MONTH";
|
|
1245
|
-
readonly DAY_OF_QUARTER: "DAY_OF_QUARTER";
|
|
1246
|
-
readonly DAY_OF_YEAR: "DAY_OF_YEAR";
|
|
1247
|
-
readonly WEEK_OF_YEAR: "WEEK_OF_YEAR";
|
|
1248
|
-
readonly MONTH_OF_YEAR: "MONTH_OF_YEAR";
|
|
1249
|
-
readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
|
|
1250
|
-
};
|
|
1251
|
-
export type AutomationRelativeDateFilterRelativeDateFilterGranularityEnum = (typeof AutomationRelativeDateFilterRelativeDateFilterGranularityEnum)[keyof typeof AutomationRelativeDateFilterRelativeDateFilterGranularityEnum];
|
|
1010
|
+
export type AutomationRelativeDateFilterRelativeDateFilterGranularityEnum = "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_QUARTER" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR";
|
|
1252
1011
|
export interface AutomationRelativeWrapper {
|
|
1253
1012
|
relative: AutomationRelative;
|
|
1254
1013
|
}
|
|
@@ -1298,17 +1057,8 @@ export interface AutomationSettings {
|
|
|
1298
1057
|
*/
|
|
1299
1058
|
pageOrientation?: AutomationSettingsPageOrientationEnum;
|
|
1300
1059
|
}
|
|
1301
|
-
export
|
|
1302
|
-
|
|
1303
|
-
readonly A4: "A4";
|
|
1304
|
-
readonly LETTER: "LETTER";
|
|
1305
|
-
};
|
|
1306
|
-
export type AutomationSettingsPageSizeEnum = (typeof AutomationSettingsPageSizeEnum)[keyof typeof AutomationSettingsPageSizeEnum];
|
|
1307
|
-
export declare const AutomationSettingsPageOrientationEnum: {
|
|
1308
|
-
readonly PORTRAIT: "PORTRAIT";
|
|
1309
|
-
readonly LANDSCAPE: "LANDSCAPE";
|
|
1310
|
-
};
|
|
1311
|
-
export type AutomationSettingsPageOrientationEnum = (typeof AutomationSettingsPageOrientationEnum)[keyof typeof AutomationSettingsPageOrientationEnum];
|
|
1060
|
+
export type AutomationSettingsPageSizeEnum = "A3" | "A4" | "LETTER";
|
|
1061
|
+
export type AutomationSettingsPageOrientationEnum = "PORTRAIT" | "LANDSCAPE";
|
|
1312
1062
|
/**
|
|
1313
1063
|
* Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
|
|
1314
1064
|
*/
|
|
@@ -1330,17 +1080,7 @@ export interface AutomationSimpleMeasureDefinitionMeasure {
|
|
|
1330
1080
|
*/
|
|
1331
1081
|
filters?: Array<AutomationFilterDefinitionForSimpleMeasure>;
|
|
1332
1082
|
}
|
|
1333
|
-
export
|
|
1334
|
-
readonly SUM: "SUM";
|
|
1335
|
-
readonly COUNT: "COUNT";
|
|
1336
|
-
readonly AVG: "AVG";
|
|
1337
|
-
readonly MIN: "MIN";
|
|
1338
|
-
readonly MAX: "MAX";
|
|
1339
|
-
readonly MEDIAN: "MEDIAN";
|
|
1340
|
-
readonly RUNSUM: "RUNSUM";
|
|
1341
|
-
readonly APPROXIMATE_COUNT: "APPROXIMATE_COUNT";
|
|
1342
|
-
};
|
|
1343
|
-
export type AutomationSimpleMeasureDefinitionMeasureAggregationEnum = (typeof AutomationSimpleMeasureDefinitionMeasureAggregationEnum)[keyof typeof AutomationSimpleMeasureDefinitionMeasureAggregationEnum];
|
|
1083
|
+
export type AutomationSimpleMeasureDefinitionMeasureAggregationEnum = "SUM" | "COUNT" | "AVG" | "MIN" | "MAX" | "MEDIAN" | "RUNSUM" | "APPROXIMATE_COUNT";
|
|
1344
1084
|
/**
|
|
1345
1085
|
* Export request object describing the export properties and metadata for slides exports.
|
|
1346
1086
|
*/
|
|
@@ -1374,11 +1114,7 @@ export interface AutomationSlidesExportRequest {
|
|
|
1374
1114
|
*/
|
|
1375
1115
|
templateId?: string | null;
|
|
1376
1116
|
}
|
|
1377
|
-
export
|
|
1378
|
-
readonly PDF: "PDF";
|
|
1379
|
-
readonly PPTX: "PPTX";
|
|
1380
|
-
};
|
|
1381
|
-
export type AutomationSlidesExportRequestFormatEnum = (typeof AutomationSlidesExportRequestFormatEnum)[keyof typeof AutomationSlidesExportRequestFormatEnum];
|
|
1117
|
+
export type AutomationSlidesExportRequestFormatEnum = "PDF" | "PPTX";
|
|
1382
1118
|
/**
|
|
1383
1119
|
* Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update
|
|
1384
1120
|
*/
|
|
@@ -1412,17 +1148,8 @@ export interface AutomationSmtp {
|
|
|
1412
1148
|
*/
|
|
1413
1149
|
type: AutomationSmtpTypeEnum;
|
|
1414
1150
|
}
|
|
1415
|
-
export
|
|
1416
|
-
|
|
1417
|
-
readonly NUMBER_465: 465;
|
|
1418
|
-
readonly NUMBER_587: 587;
|
|
1419
|
-
readonly NUMBER_2525: 2525;
|
|
1420
|
-
};
|
|
1421
|
-
export type AutomationSmtpPortEnum = (typeof AutomationSmtpPortEnum)[keyof typeof AutomationSmtpPortEnum];
|
|
1422
|
-
export declare const AutomationSmtpTypeEnum: {
|
|
1423
|
-
readonly SMTP: "SMTP";
|
|
1424
|
-
};
|
|
1425
|
-
export type AutomationSmtpTypeEnum = (typeof AutomationSmtpTypeEnum)[keyof typeof AutomationSmtpTypeEnum];
|
|
1151
|
+
export type AutomationSmtpPortEnum = 25 | 465 | 587 | 2525;
|
|
1152
|
+
export type AutomationSmtpTypeEnum = "SMTP";
|
|
1426
1153
|
/**
|
|
1427
1154
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
1428
1155
|
*/
|
|
@@ -1458,13 +1185,7 @@ export interface AutomationTabularExportRequest {
|
|
|
1458
1185
|
*/
|
|
1459
1186
|
metadata?: object | null;
|
|
1460
1187
|
}
|
|
1461
|
-
export
|
|
1462
|
-
readonly CSV: "CSV";
|
|
1463
|
-
readonly XLSX: "XLSX";
|
|
1464
|
-
readonly HTML: "HTML";
|
|
1465
|
-
readonly PDF: "PDF";
|
|
1466
|
-
};
|
|
1467
|
-
export type AutomationTabularExportRequestFormatEnum = (typeof AutomationTabularExportRequestFormatEnum)[keyof typeof AutomationTabularExportRequestFormatEnum];
|
|
1188
|
+
export type AutomationTabularExportRequestFormatEnum = "CSV" | "XLSX" | "HTML" | "PDF";
|
|
1468
1189
|
/**
|
|
1469
1190
|
* Request body with notification channel destination to test.
|
|
1470
1191
|
*/
|
|
@@ -1550,10 +1271,7 @@ export interface AutomationWebhook {
|
|
|
1550
1271
|
*/
|
|
1551
1272
|
type: AutomationWebhookTypeEnum;
|
|
1552
1273
|
}
|
|
1553
|
-
export
|
|
1554
|
-
readonly WEBHOOK: "WEBHOOK";
|
|
1555
|
-
};
|
|
1556
|
-
export type AutomationWebhookTypeEnum = (typeof AutomationWebhookTypeEnum)[keyof typeof AutomationWebhookTypeEnum];
|
|
1274
|
+
export type AutomationWebhookTypeEnum = "WEBHOOK";
|
|
1557
1275
|
export interface AutomationWebhookAutomationInfo {
|
|
1558
1276
|
id: string;
|
|
1559
1277
|
title?: string;
|
|
@@ -1566,11 +1284,7 @@ export interface AutomationWebhookMessage {
|
|
|
1566
1284
|
data: AutomationWebhookMessageData;
|
|
1567
1285
|
type: AutomationWebhookMessageTypeEnum;
|
|
1568
1286
|
}
|
|
1569
|
-
export
|
|
1570
|
-
readonly AUTOMATION_TASK_COMPLETED: "automation-task.completed";
|
|
1571
|
-
readonly AUTOMATION_TASK_LIMIT_EXCEEDED: "automation-task.limit-exceeded";
|
|
1572
|
-
};
|
|
1573
|
-
export type AutomationWebhookMessageTypeEnum = (typeof AutomationWebhookMessageTypeEnum)[keyof typeof AutomationWebhookMessageTypeEnum];
|
|
1287
|
+
export type AutomationWebhookMessageTypeEnum = "automation-task.completed" | "automation-task.limit-exceeded";
|
|
1574
1288
|
export interface AutomationWebhookMessageData {
|
|
1575
1289
|
automation: AutomationWebhookAutomationInfo;
|
|
1576
1290
|
recipients?: Array<AutomationWebhookRecipient>;
|
|
@@ -1593,205 +1307,152 @@ export interface AutomationWebhookRecipient {
|
|
|
1593
1307
|
email: string;
|
|
1594
1308
|
}
|
|
1595
1309
|
/**
|
|
1596
|
-
*
|
|
1597
|
-
* @
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
*
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
|
-
|
|
1672
|
-
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1734
|
-
*
|
|
1735
|
-
* @
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
* @param {*} [options] Override http request option.
|
|
1743
|
-
* @throws {RequiredError}
|
|
1744
|
-
*/
|
|
1745
|
-
getNotifications(requestParameters: ActionsAutomationGetNotificationsRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationNotifications>;
|
|
1746
|
-
/**
|
|
1747
|
-
* Mark in-platform notification by its ID as read.
|
|
1748
|
-
* @summary Mark notification as read.
|
|
1749
|
-
* @param {ActionsAutomationMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
1750
|
-
* @param {*} [options] Override http request option.
|
|
1751
|
-
* @throws {RequiredError}
|
|
1752
|
-
*/
|
|
1753
|
-
markAsReadNotification(requestParameters: ActionsAutomationMarkAsReadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1754
|
-
/**
|
|
1755
|
-
* Mark all user in-platform notifications as read.
|
|
1756
|
-
* @summary Mark all notifications as read.
|
|
1757
|
-
* @param {ActionsAutomationMarkAsReadNotificationAllRequest} requestParameters Request parameters.
|
|
1758
|
-
* @param {*} [options] Override http request option.
|
|
1759
|
-
* @throws {RequiredError}
|
|
1760
|
-
*/
|
|
1761
|
-
markAsReadNotificationAll(requestParameters: ActionsAutomationMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1762
|
-
/**
|
|
1763
|
-
* Tests the existing notification channel by sending a test notification.
|
|
1764
|
-
* @summary Test existing notification channel.
|
|
1765
|
-
* @param {ActionsAutomationTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
1766
|
-
* @param {*} [options] Override http request option.
|
|
1767
|
-
* @throws {RequiredError}
|
|
1768
|
-
*/
|
|
1769
|
-
testExistingNotificationChannel(requestParameters: ActionsAutomationTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationTestResponse>;
|
|
1770
|
-
/**
|
|
1771
|
-
* Tests the notification channel by sending a test notification.
|
|
1772
|
-
* @summary Test notification channel.
|
|
1773
|
-
* @param {ActionsAutomationTestNotificationChannelRequest} requestParameters Request parameters.
|
|
1774
|
-
* @param {*} [options] Override http request option.
|
|
1775
|
-
* @throws {RequiredError}
|
|
1776
|
-
*/
|
|
1777
|
-
testNotificationChannel(requestParameters: ActionsAutomationTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationTestResponse>;
|
|
1778
|
-
/**
|
|
1779
|
-
* Trigger the automation in the request.
|
|
1780
|
-
* @summary Trigger automation.
|
|
1781
|
-
* @param {ActionsAutomationTriggerAutomationRequest} requestParameters Request parameters.
|
|
1782
|
-
* @param {*} [options] Override http request option.
|
|
1783
|
-
* @throws {RequiredError}
|
|
1784
|
-
*/
|
|
1785
|
-
triggerAutomation(requestParameters: ActionsAutomationTriggerAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1786
|
-
/**
|
|
1787
|
-
* Trigger the existing automation to execute immediately.
|
|
1788
|
-
* @summary Trigger existing automation.
|
|
1789
|
-
* @param {ActionsAutomationTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1790
|
-
* @param {*} [options] Override http request option.
|
|
1791
|
-
* @throws {RequiredError}
|
|
1792
|
-
*/
|
|
1793
|
-
triggerExistingAutomation(requestParameters: ActionsAutomationTriggerExistingAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1794
|
-
};
|
|
1310
|
+
* Get latest in-platform notifications for the current user.
|
|
1311
|
+
* @summary Get latest notifications.
|
|
1312
|
+
* @param {string} [workspaceId] Workspace ID to filter notifications by.
|
|
1313
|
+
* @param {boolean} [isRead] Filter notifications by read status.
|
|
1314
|
+
* @param {string} [page] Zero-based page index (0..N)
|
|
1315
|
+
* @param {string} [size] The size of the page to be returned.
|
|
1316
|
+
* @param {Array<'total' | 'ALL'>} [metaInclude] Additional meta information to include in the response.
|
|
1317
|
+
* @param {*} [options] Override http request option.
|
|
1318
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1319
|
+
* @throws {RequiredError}
|
|
1320
|
+
*/
|
|
1321
|
+
export declare function ActionsAutomationAxiosParamCreator_GetNotifications(workspaceId?: string, isRead?: boolean, page?: string, size?: string, metaInclude?: Array<"total" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1322
|
+
/**
|
|
1323
|
+
* Mark in-platform notification by its ID as read.
|
|
1324
|
+
* @summary Mark notification as read.
|
|
1325
|
+
* @param {string} notificationId Notification ID to mark as read.
|
|
1326
|
+
* @param {*} [options] Override http request option.
|
|
1327
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1328
|
+
* @throws {RequiredError}
|
|
1329
|
+
*/
|
|
1330
|
+
export declare function ActionsAutomationAxiosParamCreator_MarkAsReadNotification(notificationId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Mark all user in-platform notifications as read.
|
|
1333
|
+
* @summary Mark all notifications as read.
|
|
1334
|
+
* @param {string} [workspaceId] Workspace ID where to mark notifications as read.
|
|
1335
|
+
* @param {*} [options] Override http request option.
|
|
1336
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1337
|
+
* @throws {RequiredError}
|
|
1338
|
+
*/
|
|
1339
|
+
export declare function ActionsAutomationAxiosParamCreator_MarkAsReadNotificationAll(workspaceId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1340
|
+
/**
|
|
1341
|
+
* Tests the existing notification channel by sending a test notification.
|
|
1342
|
+
* @summary Test existing notification channel.
|
|
1343
|
+
* @param {string} notificationChannelId
|
|
1344
|
+
* @param {AutomationTestDestinationRequest} [automationTestDestinationRequest]
|
|
1345
|
+
* @param {*} [options] Override http request option.
|
|
1346
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1347
|
+
* @throws {RequiredError}
|
|
1348
|
+
*/
|
|
1349
|
+
export declare function ActionsAutomationAxiosParamCreator_TestExistingNotificationChannel(notificationChannelId: string, automationTestDestinationRequest?: AutomationTestDestinationRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1350
|
+
/**
|
|
1351
|
+
* Tests the notification channel by sending a test notification.
|
|
1352
|
+
* @summary Test notification channel.
|
|
1353
|
+
* @param {AutomationTestDestinationRequest} automationTestDestinationRequest
|
|
1354
|
+
* @param {*} [options] Override http request option.
|
|
1355
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1356
|
+
* @throws {RequiredError}
|
|
1357
|
+
*/
|
|
1358
|
+
export declare function ActionsAutomationAxiosParamCreator_TestNotificationChannel(automationTestDestinationRequest: AutomationTestDestinationRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1359
|
+
/**
|
|
1360
|
+
* Trigger the automation in the request.
|
|
1361
|
+
* @summary Trigger automation.
|
|
1362
|
+
* @param {string} workspaceId
|
|
1363
|
+
* @param {AutomationTriggerAutomationRequest} automationTriggerAutomationRequest
|
|
1364
|
+
* @param {*} [options] Override http request option.
|
|
1365
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1366
|
+
* @throws {RequiredError}
|
|
1367
|
+
*/
|
|
1368
|
+
export declare function ActionsAutomationAxiosParamCreator_TriggerAutomation(workspaceId: string, automationTriggerAutomationRequest: AutomationTriggerAutomationRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1369
|
+
/**
|
|
1370
|
+
* Trigger the existing automation to execute immediately.
|
|
1371
|
+
* @summary Trigger existing automation.
|
|
1372
|
+
* @param {string} workspaceId
|
|
1373
|
+
* @param {string} automationId
|
|
1374
|
+
* @param {*} [options] Override http request option.
|
|
1375
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1376
|
+
* @throws {RequiredError}
|
|
1377
|
+
*/
|
|
1378
|
+
export declare function ActionsAutomationAxiosParamCreator_TriggerExistingAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1379
|
+
/**
|
|
1380
|
+
* Get latest in-platform notifications for the current user.
|
|
1381
|
+
* @summary Get latest notifications.
|
|
1382
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1383
|
+
* @param {string} basePath Base path.
|
|
1384
|
+
* @param {ActionsAutomationGetNotificationsRequest} requestParameters Request parameters.
|
|
1385
|
+
* @param {*} [options] Override http request option.
|
|
1386
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1387
|
+
* @throws {RequiredError}
|
|
1388
|
+
*/
|
|
1389
|
+
export declare function ActionsAutomation_GetNotifications(axios: AxiosInstance, basePath: string, requestParameters: ActionsAutomationGetNotificationsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AutomationNotifications>;
|
|
1390
|
+
/**
|
|
1391
|
+
* Mark in-platform notification by its ID as read.
|
|
1392
|
+
* @summary Mark notification as read.
|
|
1393
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1394
|
+
* @param {string} basePath Base path.
|
|
1395
|
+
* @param {ActionsAutomationMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
1396
|
+
* @param {*} [options] Override http request option.
|
|
1397
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1398
|
+
* @throws {RequiredError}
|
|
1399
|
+
*/
|
|
1400
|
+
export declare function ActionsAutomation_MarkAsReadNotification(axios: AxiosInstance, basePath: string, requestParameters: ActionsAutomationMarkAsReadNotificationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
1401
|
+
/**
|
|
1402
|
+
* Mark all user in-platform notifications as read.
|
|
1403
|
+
* @summary Mark all notifications as read.
|
|
1404
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1405
|
+
* @param {string} basePath Base path.
|
|
1406
|
+
* @param {ActionsAutomationMarkAsReadNotificationAllRequest} requestParameters Request parameters.
|
|
1407
|
+
* @param {*} [options] Override http request option.
|
|
1408
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1409
|
+
* @throws {RequiredError}
|
|
1410
|
+
*/
|
|
1411
|
+
export declare function ActionsAutomation_MarkAsReadNotificationAll(axios: AxiosInstance, basePath: string, requestParameters: ActionsAutomationMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
1412
|
+
/**
|
|
1413
|
+
* Tests the existing notification channel by sending a test notification.
|
|
1414
|
+
* @summary Test existing notification channel.
|
|
1415
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1416
|
+
* @param {string} basePath Base path.
|
|
1417
|
+
* @param {ActionsAutomationTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
1418
|
+
* @param {*} [options] Override http request option.
|
|
1419
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1420
|
+
* @throws {RequiredError}
|
|
1421
|
+
*/
|
|
1422
|
+
export declare function ActionsAutomation_TestExistingNotificationChannel(axios: AxiosInstance, basePath: string, requestParameters: ActionsAutomationTestExistingNotificationChannelRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AutomationTestResponse>;
|
|
1423
|
+
/**
|
|
1424
|
+
* Tests the notification channel by sending a test notification.
|
|
1425
|
+
* @summary Test notification channel.
|
|
1426
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1427
|
+
* @param {string} basePath Base path.
|
|
1428
|
+
* @param {ActionsAutomationTestNotificationChannelRequest} requestParameters Request parameters.
|
|
1429
|
+
* @param {*} [options] Override http request option.
|
|
1430
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1431
|
+
* @throws {RequiredError}
|
|
1432
|
+
*/
|
|
1433
|
+
export declare function ActionsAutomation_TestNotificationChannel(axios: AxiosInstance, basePath: string, requestParameters: ActionsAutomationTestNotificationChannelRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AutomationTestResponse>;
|
|
1434
|
+
/**
|
|
1435
|
+
* Trigger the automation in the request.
|
|
1436
|
+
* @summary Trigger automation.
|
|
1437
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1438
|
+
* @param {string} basePath Base path.
|
|
1439
|
+
* @param {ActionsAutomationTriggerAutomationRequest} requestParameters Request parameters.
|
|
1440
|
+
* @param {*} [options] Override http request option.
|
|
1441
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1442
|
+
* @throws {RequiredError}
|
|
1443
|
+
*/
|
|
1444
|
+
export declare function ActionsAutomation_TriggerAutomation(axios: AxiosInstance, basePath: string, requestParameters: ActionsAutomationTriggerAutomationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
1445
|
+
/**
|
|
1446
|
+
* Trigger the existing automation to execute immediately.
|
|
1447
|
+
* @summary Trigger existing automation.
|
|
1448
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1449
|
+
* @param {string} basePath Base path.
|
|
1450
|
+
* @param {ActionsAutomationTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1451
|
+
* @param {*} [options] Override http request option.
|
|
1452
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1453
|
+
* @throws {RequiredError}
|
|
1454
|
+
*/
|
|
1455
|
+
export declare function ActionsAutomation_TriggerExistingAutomation(axios: AxiosInstance, basePath: string, requestParameters: ActionsAutomationTriggerExistingAutomationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
1795
1456
|
/**
|
|
1796
1457
|
* ActionsAutomation - interface
|
|
1797
1458
|
* @export
|
|
@@ -2010,7 +1671,7 @@ export declare class ActionsAutomation extends BaseAPI implements ActionsAutomat
|
|
|
2010
1671
|
* @throws {RequiredError}
|
|
2011
1672
|
* @memberof ActionsAutomation
|
|
2012
1673
|
*/
|
|
2013
|
-
getNotifications(requestParameters?: ActionsAutomationGetNotificationsRequest, options?: AxiosRequestConfig):
|
|
1674
|
+
getNotifications(requestParameters?: ActionsAutomationGetNotificationsRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationNotifications>;
|
|
2014
1675
|
/**
|
|
2015
1676
|
* Mark in-platform notification by its ID as read.
|
|
2016
1677
|
* @summary Mark notification as read.
|
|
@@ -2019,7 +1680,7 @@ export declare class ActionsAutomation extends BaseAPI implements ActionsAutomat
|
|
|
2019
1680
|
* @throws {RequiredError}
|
|
2020
1681
|
* @memberof ActionsAutomation
|
|
2021
1682
|
*/
|
|
2022
|
-
markAsReadNotification(requestParameters: ActionsAutomationMarkAsReadNotificationRequest, options?: AxiosRequestConfig):
|
|
1683
|
+
markAsReadNotification(requestParameters: ActionsAutomationMarkAsReadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2023
1684
|
/**
|
|
2024
1685
|
* Mark all user in-platform notifications as read.
|
|
2025
1686
|
* @summary Mark all notifications as read.
|
|
@@ -2028,7 +1689,7 @@ export declare class ActionsAutomation extends BaseAPI implements ActionsAutomat
|
|
|
2028
1689
|
* @throws {RequiredError}
|
|
2029
1690
|
* @memberof ActionsAutomation
|
|
2030
1691
|
*/
|
|
2031
|
-
markAsReadNotificationAll(requestParameters?: ActionsAutomationMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig):
|
|
1692
|
+
markAsReadNotificationAll(requestParameters?: ActionsAutomationMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2032
1693
|
/**
|
|
2033
1694
|
* Tests the existing notification channel by sending a test notification.
|
|
2034
1695
|
* @summary Test existing notification channel.
|
|
@@ -2037,7 +1698,7 @@ export declare class ActionsAutomation extends BaseAPI implements ActionsAutomat
|
|
|
2037
1698
|
* @throws {RequiredError}
|
|
2038
1699
|
* @memberof ActionsAutomation
|
|
2039
1700
|
*/
|
|
2040
|
-
testExistingNotificationChannel(requestParameters: ActionsAutomationTestExistingNotificationChannelRequest, options?: AxiosRequestConfig):
|
|
1701
|
+
testExistingNotificationChannel(requestParameters: ActionsAutomationTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationTestResponse>;
|
|
2041
1702
|
/**
|
|
2042
1703
|
* Tests the notification channel by sending a test notification.
|
|
2043
1704
|
* @summary Test notification channel.
|
|
@@ -2046,7 +1707,7 @@ export declare class ActionsAutomation extends BaseAPI implements ActionsAutomat
|
|
|
2046
1707
|
* @throws {RequiredError}
|
|
2047
1708
|
* @memberof ActionsAutomation
|
|
2048
1709
|
*/
|
|
2049
|
-
testNotificationChannel(requestParameters: ActionsAutomationTestNotificationChannelRequest, options?: AxiosRequestConfig):
|
|
1710
|
+
testNotificationChannel(requestParameters: ActionsAutomationTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationTestResponse>;
|
|
2050
1711
|
/**
|
|
2051
1712
|
* Trigger the automation in the request.
|
|
2052
1713
|
* @summary Trigger automation.
|
|
@@ -2055,7 +1716,7 @@ export declare class ActionsAutomation extends BaseAPI implements ActionsAutomat
|
|
|
2055
1716
|
* @throws {RequiredError}
|
|
2056
1717
|
* @memberof ActionsAutomation
|
|
2057
1718
|
*/
|
|
2058
|
-
triggerAutomation(requestParameters: ActionsAutomationTriggerAutomationRequest, options?: AxiosRequestConfig):
|
|
1719
|
+
triggerAutomation(requestParameters: ActionsAutomationTriggerAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2059
1720
|
/**
|
|
2060
1721
|
* Trigger the existing automation to execute immediately.
|
|
2061
1722
|
* @summary Trigger existing automation.
|
|
@@ -2064,78 +1725,50 @@ export declare class ActionsAutomation extends BaseAPI implements ActionsAutomat
|
|
|
2064
1725
|
* @throws {RequiredError}
|
|
2065
1726
|
* @memberof ActionsAutomation
|
|
2066
1727
|
*/
|
|
2067
|
-
triggerExistingAutomation(requestParameters: ActionsAutomationTriggerExistingAutomationRequest, options?: AxiosRequestConfig):
|
|
1728
|
+
triggerExistingAutomation(requestParameters: ActionsAutomationTriggerExistingAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2068
1729
|
}
|
|
2069
1730
|
/**
|
|
2070
|
-
*
|
|
2071
|
-
* @
|
|
2072
|
-
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
|
|
2076
|
-
|
|
2077
|
-
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
}
|
|
2093
|
-
|
|
2094
|
-
*
|
|
2095
|
-
* @
|
|
2096
|
-
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
|
|
2104
|
-
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
* @param {string} automationId
|
|
2112
|
-
* @param {*} [options] Override http request option.
|
|
2113
|
-
* @throws {RequiredError}
|
|
2114
|
-
*/
|
|
2115
|
-
triggerExistingAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2116
|
-
};
|
|
2117
|
-
/**
|
|
2118
|
-
* AutomationsAutomation - factory interface
|
|
2119
|
-
* @export
|
|
2120
|
-
*/
|
|
2121
|
-
export declare const AutomationsAutomationFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2122
|
-
/**
|
|
2123
|
-
* Trigger the automation in the request.
|
|
2124
|
-
* @summary Trigger automation.
|
|
2125
|
-
* @param {AutomationsAutomationTriggerAutomationRequest} requestParameters Request parameters.
|
|
2126
|
-
* @param {*} [options] Override http request option.
|
|
2127
|
-
* @throws {RequiredError}
|
|
2128
|
-
*/
|
|
2129
|
-
triggerAutomation(requestParameters: AutomationsAutomationTriggerAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2130
|
-
/**
|
|
2131
|
-
* Trigger the existing automation to execute immediately.
|
|
2132
|
-
* @summary Trigger existing automation.
|
|
2133
|
-
* @param {AutomationsAutomationTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
2134
|
-
* @param {*} [options] Override http request option.
|
|
2135
|
-
* @throws {RequiredError}
|
|
2136
|
-
*/
|
|
2137
|
-
triggerExistingAutomation(requestParameters: AutomationsAutomationTriggerExistingAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2138
|
-
};
|
|
1731
|
+
* Trigger the automation in the request.
|
|
1732
|
+
* @summary Trigger automation.
|
|
1733
|
+
* @param {string} workspaceId
|
|
1734
|
+
* @param {AutomationTriggerAutomationRequest} automationTriggerAutomationRequest
|
|
1735
|
+
* @param {*} [options] Override http request option.
|
|
1736
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1737
|
+
* @throws {RequiredError}
|
|
1738
|
+
*/
|
|
1739
|
+
export declare function AutomationsAutomationAxiosParamCreator_TriggerAutomation(workspaceId: string, automationTriggerAutomationRequest: AutomationTriggerAutomationRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1740
|
+
/**
|
|
1741
|
+
* Trigger the existing automation to execute immediately.
|
|
1742
|
+
* @summary Trigger existing automation.
|
|
1743
|
+
* @param {string} workspaceId
|
|
1744
|
+
* @param {string} automationId
|
|
1745
|
+
* @param {*} [options] Override http request option.
|
|
1746
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1747
|
+
* @throws {RequiredError}
|
|
1748
|
+
*/
|
|
1749
|
+
export declare function AutomationsAutomationAxiosParamCreator_TriggerExistingAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1750
|
+
/**
|
|
1751
|
+
* Trigger the automation in the request.
|
|
1752
|
+
* @summary Trigger automation.
|
|
1753
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1754
|
+
* @param {string} basePath Base path.
|
|
1755
|
+
* @param {AutomationsAutomationTriggerAutomationRequest} requestParameters Request parameters.
|
|
1756
|
+
* @param {*} [options] Override http request option.
|
|
1757
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1758
|
+
* @throws {RequiredError}
|
|
1759
|
+
*/
|
|
1760
|
+
export declare function AutomationsAutomation_TriggerAutomation(axios: AxiosInstance, basePath: string, requestParameters: AutomationsAutomationTriggerAutomationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
1761
|
+
/**
|
|
1762
|
+
* Trigger the existing automation to execute immediately.
|
|
1763
|
+
* @summary Trigger existing automation.
|
|
1764
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1765
|
+
* @param {string} basePath Base path.
|
|
1766
|
+
* @param {AutomationsAutomationTriggerExistingAutomationRequest} requestParameters Request parameters.
|
|
1767
|
+
* @param {*} [options] Override http request option.
|
|
1768
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1769
|
+
* @throws {RequiredError}
|
|
1770
|
+
*/
|
|
1771
|
+
export declare function AutomationsAutomation_TriggerExistingAutomation(axios: AxiosInstance, basePath: string, requestParameters: AutomationsAutomationTriggerExistingAutomationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
2139
1772
|
/**
|
|
2140
1773
|
* AutomationsAutomation - interface
|
|
2141
1774
|
* @export
|
|
@@ -2214,7 +1847,7 @@ export declare class AutomationsAutomation extends BaseAPI implements Automation
|
|
|
2214
1847
|
* @throws {RequiredError}
|
|
2215
1848
|
* @memberof AutomationsAutomation
|
|
2216
1849
|
*/
|
|
2217
|
-
triggerAutomation(requestParameters: AutomationsAutomationTriggerAutomationRequest, options?: AxiosRequestConfig):
|
|
1850
|
+
triggerAutomation(requestParameters: AutomationsAutomationTriggerAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2218
1851
|
/**
|
|
2219
1852
|
* Trigger the existing automation to execute immediately.
|
|
2220
1853
|
* @summary Trigger existing automation.
|
|
@@ -2223,156 +1856,113 @@ export declare class AutomationsAutomation extends BaseAPI implements Automation
|
|
|
2223
1856
|
* @throws {RequiredError}
|
|
2224
1857
|
* @memberof AutomationsAutomation
|
|
2225
1858
|
*/
|
|
2226
|
-
triggerExistingAutomation(requestParameters: AutomationsAutomationTriggerExistingAutomationRequest, options?: AxiosRequestConfig):
|
|
1859
|
+
triggerExistingAutomation(requestParameters: AutomationsAutomationTriggerExistingAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2227
1860
|
}
|
|
2228
1861
|
/**
|
|
2229
|
-
*
|
|
2230
|
-
* @
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
*
|
|
2281
|
-
* @
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
|
-
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
|
|
2311
|
-
|
|
2312
|
-
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
}
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
*/
|
|
2334
|
-
export declare const NotificationChannelsAutomationFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2335
|
-
/**
|
|
2336
|
-
* Get latest in-platform notifications for the current user.
|
|
2337
|
-
* @summary Get latest notifications.
|
|
2338
|
-
* @param {NotificationChannelsAutomationGetNotificationsRequest} requestParameters Request parameters.
|
|
2339
|
-
* @param {*} [options] Override http request option.
|
|
2340
|
-
* @throws {RequiredError}
|
|
2341
|
-
*/
|
|
2342
|
-
getNotifications(requestParameters: NotificationChannelsAutomationGetNotificationsRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationNotifications>;
|
|
2343
|
-
/**
|
|
2344
|
-
* Mark in-platform notification by its ID as read.
|
|
2345
|
-
* @summary Mark notification as read.
|
|
2346
|
-
* @param {NotificationChannelsAutomationMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
2347
|
-
* @param {*} [options] Override http request option.
|
|
2348
|
-
* @throws {RequiredError}
|
|
2349
|
-
*/
|
|
2350
|
-
markAsReadNotification(requestParameters: NotificationChannelsAutomationMarkAsReadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2351
|
-
/**
|
|
2352
|
-
* Mark all user in-platform notifications as read.
|
|
2353
|
-
* @summary Mark all notifications as read.
|
|
2354
|
-
* @param {NotificationChannelsAutomationMarkAsReadNotificationAllRequest} requestParameters Request parameters.
|
|
2355
|
-
* @param {*} [options] Override http request option.
|
|
2356
|
-
* @throws {RequiredError}
|
|
2357
|
-
*/
|
|
2358
|
-
markAsReadNotificationAll(requestParameters: NotificationChannelsAutomationMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2359
|
-
/**
|
|
2360
|
-
* Tests the existing notification channel by sending a test notification.
|
|
2361
|
-
* @summary Test existing notification channel.
|
|
2362
|
-
* @param {NotificationChannelsAutomationTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
2363
|
-
* @param {*} [options] Override http request option.
|
|
2364
|
-
* @throws {RequiredError}
|
|
2365
|
-
*/
|
|
2366
|
-
testExistingNotificationChannel(requestParameters: NotificationChannelsAutomationTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationTestResponse>;
|
|
2367
|
-
/**
|
|
2368
|
-
* Tests the notification channel by sending a test notification.
|
|
2369
|
-
* @summary Test notification channel.
|
|
2370
|
-
* @param {NotificationChannelsAutomationTestNotificationChannelRequest} requestParameters Request parameters.
|
|
2371
|
-
* @param {*} [options] Override http request option.
|
|
2372
|
-
* @throws {RequiredError}
|
|
2373
|
-
*/
|
|
2374
|
-
testNotificationChannel(requestParameters: NotificationChannelsAutomationTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationTestResponse>;
|
|
2375
|
-
};
|
|
1862
|
+
* Get latest in-platform notifications for the current user.
|
|
1863
|
+
* @summary Get latest notifications.
|
|
1864
|
+
* @param {string} [workspaceId] Workspace ID to filter notifications by.
|
|
1865
|
+
* @param {boolean} [isRead] Filter notifications by read status.
|
|
1866
|
+
* @param {string} [page] Zero-based page index (0..N)
|
|
1867
|
+
* @param {string} [size] The size of the page to be returned.
|
|
1868
|
+
* @param {Array<'total' | 'ALL'>} [metaInclude] Additional meta information to include in the response.
|
|
1869
|
+
* @param {*} [options] Override http request option.
|
|
1870
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1871
|
+
* @throws {RequiredError}
|
|
1872
|
+
*/
|
|
1873
|
+
export declare function NotificationChannelsAutomationAxiosParamCreator_GetNotifications(workspaceId?: string, isRead?: boolean, page?: string, size?: string, metaInclude?: Array<"total" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1874
|
+
/**
|
|
1875
|
+
* Mark in-platform notification by its ID as read.
|
|
1876
|
+
* @summary Mark notification as read.
|
|
1877
|
+
* @param {string} notificationId Notification ID to mark as read.
|
|
1878
|
+
* @param {*} [options] Override http request option.
|
|
1879
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1880
|
+
* @throws {RequiredError}
|
|
1881
|
+
*/
|
|
1882
|
+
export declare function NotificationChannelsAutomationAxiosParamCreator_MarkAsReadNotification(notificationId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1883
|
+
/**
|
|
1884
|
+
* Mark all user in-platform notifications as read.
|
|
1885
|
+
* @summary Mark all notifications as read.
|
|
1886
|
+
* @param {string} [workspaceId] Workspace ID where to mark notifications as read.
|
|
1887
|
+
* @param {*} [options] Override http request option.
|
|
1888
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1889
|
+
* @throws {RequiredError}
|
|
1890
|
+
*/
|
|
1891
|
+
export declare function NotificationChannelsAutomationAxiosParamCreator_MarkAsReadNotificationAll(workspaceId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1892
|
+
/**
|
|
1893
|
+
* Tests the existing notification channel by sending a test notification.
|
|
1894
|
+
* @summary Test existing notification channel.
|
|
1895
|
+
* @param {string} notificationChannelId
|
|
1896
|
+
* @param {AutomationTestDestinationRequest} [automationTestDestinationRequest]
|
|
1897
|
+
* @param {*} [options] Override http request option.
|
|
1898
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1899
|
+
* @throws {RequiredError}
|
|
1900
|
+
*/
|
|
1901
|
+
export declare function NotificationChannelsAutomationAxiosParamCreator_TestExistingNotificationChannel(notificationChannelId: string, automationTestDestinationRequest?: AutomationTestDestinationRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1902
|
+
/**
|
|
1903
|
+
* Tests the notification channel by sending a test notification.
|
|
1904
|
+
* @summary Test notification channel.
|
|
1905
|
+
* @param {AutomationTestDestinationRequest} automationTestDestinationRequest
|
|
1906
|
+
* @param {*} [options] Override http request option.
|
|
1907
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1908
|
+
* @throws {RequiredError}
|
|
1909
|
+
*/
|
|
1910
|
+
export declare function NotificationChannelsAutomationAxiosParamCreator_TestNotificationChannel(automationTestDestinationRequest: AutomationTestDestinationRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1911
|
+
/**
|
|
1912
|
+
* Get latest in-platform notifications for the current user.
|
|
1913
|
+
* @summary Get latest notifications.
|
|
1914
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1915
|
+
* @param {string} basePath Base path.
|
|
1916
|
+
* @param {NotificationChannelsAutomationGetNotificationsRequest} requestParameters Request parameters.
|
|
1917
|
+
* @param {*} [options] Override http request option.
|
|
1918
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1919
|
+
* @throws {RequiredError}
|
|
1920
|
+
*/
|
|
1921
|
+
export declare function NotificationChannelsAutomation_GetNotifications(axios: AxiosInstance, basePath: string, requestParameters: NotificationChannelsAutomationGetNotificationsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AutomationNotifications>;
|
|
1922
|
+
/**
|
|
1923
|
+
* Mark in-platform notification by its ID as read.
|
|
1924
|
+
* @summary Mark notification as read.
|
|
1925
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1926
|
+
* @param {string} basePath Base path.
|
|
1927
|
+
* @param {NotificationChannelsAutomationMarkAsReadNotificationRequest} requestParameters Request parameters.
|
|
1928
|
+
* @param {*} [options] Override http request option.
|
|
1929
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1930
|
+
* @throws {RequiredError}
|
|
1931
|
+
*/
|
|
1932
|
+
export declare function NotificationChannelsAutomation_MarkAsReadNotification(axios: AxiosInstance, basePath: string, requestParameters: NotificationChannelsAutomationMarkAsReadNotificationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
1933
|
+
/**
|
|
1934
|
+
* Mark all user in-platform notifications as read.
|
|
1935
|
+
* @summary Mark all notifications as read.
|
|
1936
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1937
|
+
* @param {string} basePath Base path.
|
|
1938
|
+
* @param {NotificationChannelsAutomationMarkAsReadNotificationAllRequest} requestParameters Request parameters.
|
|
1939
|
+
* @param {*} [options] Override http request option.
|
|
1940
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1941
|
+
* @throws {RequiredError}
|
|
1942
|
+
*/
|
|
1943
|
+
export declare function NotificationChannelsAutomation_MarkAsReadNotificationAll(axios: AxiosInstance, basePath: string, requestParameters: NotificationChannelsAutomationMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
1944
|
+
/**
|
|
1945
|
+
* Tests the existing notification channel by sending a test notification.
|
|
1946
|
+
* @summary Test existing notification channel.
|
|
1947
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1948
|
+
* @param {string} basePath Base path.
|
|
1949
|
+
* @param {NotificationChannelsAutomationTestExistingNotificationChannelRequest} requestParameters Request parameters.
|
|
1950
|
+
* @param {*} [options] Override http request option.
|
|
1951
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1952
|
+
* @throws {RequiredError}
|
|
1953
|
+
*/
|
|
1954
|
+
export declare function NotificationChannelsAutomation_TestExistingNotificationChannel(axios: AxiosInstance, basePath: string, requestParameters: NotificationChannelsAutomationTestExistingNotificationChannelRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AutomationTestResponse>;
|
|
1955
|
+
/**
|
|
1956
|
+
* Tests the notification channel by sending a test notification.
|
|
1957
|
+
* @summary Test notification channel.
|
|
1958
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1959
|
+
* @param {string} basePath Base path.
|
|
1960
|
+
* @param {NotificationChannelsAutomationTestNotificationChannelRequest} requestParameters Request parameters.
|
|
1961
|
+
* @param {*} [options] Override http request option.
|
|
1962
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1963
|
+
* @throws {RequiredError}
|
|
1964
|
+
*/
|
|
1965
|
+
export declare function NotificationChannelsAutomation_TestNotificationChannel(axios: AxiosInstance, basePath: string, requestParameters: NotificationChannelsAutomationTestNotificationChannelRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AutomationTestResponse>;
|
|
2376
1966
|
/**
|
|
2377
1967
|
* NotificationChannelsAutomation - interface
|
|
2378
1968
|
* @export
|
|
@@ -2535,7 +2125,7 @@ export declare class NotificationChannelsAutomation extends BaseAPI implements N
|
|
|
2535
2125
|
* @throws {RequiredError}
|
|
2536
2126
|
* @memberof NotificationChannelsAutomation
|
|
2537
2127
|
*/
|
|
2538
|
-
getNotifications(requestParameters?: NotificationChannelsAutomationGetNotificationsRequest, options?: AxiosRequestConfig):
|
|
2128
|
+
getNotifications(requestParameters?: NotificationChannelsAutomationGetNotificationsRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationNotifications>;
|
|
2539
2129
|
/**
|
|
2540
2130
|
* Mark in-platform notification by its ID as read.
|
|
2541
2131
|
* @summary Mark notification as read.
|
|
@@ -2544,7 +2134,7 @@ export declare class NotificationChannelsAutomation extends BaseAPI implements N
|
|
|
2544
2134
|
* @throws {RequiredError}
|
|
2545
2135
|
* @memberof NotificationChannelsAutomation
|
|
2546
2136
|
*/
|
|
2547
|
-
markAsReadNotification(requestParameters: NotificationChannelsAutomationMarkAsReadNotificationRequest, options?: AxiosRequestConfig):
|
|
2137
|
+
markAsReadNotification(requestParameters: NotificationChannelsAutomationMarkAsReadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2548
2138
|
/**
|
|
2549
2139
|
* Mark all user in-platform notifications as read.
|
|
2550
2140
|
* @summary Mark all notifications as read.
|
|
@@ -2553,7 +2143,7 @@ export declare class NotificationChannelsAutomation extends BaseAPI implements N
|
|
|
2553
2143
|
* @throws {RequiredError}
|
|
2554
2144
|
* @memberof NotificationChannelsAutomation
|
|
2555
2145
|
*/
|
|
2556
|
-
markAsReadNotificationAll(requestParameters?: NotificationChannelsAutomationMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig):
|
|
2146
|
+
markAsReadNotificationAll(requestParameters?: NotificationChannelsAutomationMarkAsReadNotificationAllRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2557
2147
|
/**
|
|
2558
2148
|
* Tests the existing notification channel by sending a test notification.
|
|
2559
2149
|
* @summary Test existing notification channel.
|
|
@@ -2562,7 +2152,7 @@ export declare class NotificationChannelsAutomation extends BaseAPI implements N
|
|
|
2562
2152
|
* @throws {RequiredError}
|
|
2563
2153
|
* @memberof NotificationChannelsAutomation
|
|
2564
2154
|
*/
|
|
2565
|
-
testExistingNotificationChannel(requestParameters: NotificationChannelsAutomationTestExistingNotificationChannelRequest, options?: AxiosRequestConfig):
|
|
2155
|
+
testExistingNotificationChannel(requestParameters: NotificationChannelsAutomationTestExistingNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationTestResponse>;
|
|
2566
2156
|
/**
|
|
2567
2157
|
* Tests the notification channel by sending a test notification.
|
|
2568
2158
|
* @summary Test notification channel.
|
|
@@ -2571,6 +2161,6 @@ export declare class NotificationChannelsAutomation extends BaseAPI implements N
|
|
|
2571
2161
|
* @throws {RequiredError}
|
|
2572
2162
|
* @memberof NotificationChannelsAutomation
|
|
2573
2163
|
*/
|
|
2574
|
-
testNotificationChannel(requestParameters: NotificationChannelsAutomationTestNotificationChannelRequest, options?: AxiosRequestConfig):
|
|
2164
|
+
testNotificationChannel(requestParameters: NotificationChannelsAutomationTestNotificationChannelRequest, options?: AxiosRequestConfig): AxiosPromise<AutomationTestResponse>;
|
|
2575
2165
|
}
|
|
2576
2166
|
//# sourceMappingURL=api.d.ts.map
|