@gooddata/api-client-tiger 10.8.0-alpha.8 → 10.8.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +1538 -722
- package/esm/client.d.ts +2 -2
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +2 -2
- package/esm/client.js.map +1 -1
- package/esm/export.d.ts +2 -2
- package/esm/export.d.ts.map +1 -1
- package/esm/export.js +2 -1
- package/esm/export.js.map +1 -1
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.d.ts +1 -0
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.d.ts.map +1 -1
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +125 -4
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +124 -6
- package/esm/generated/auth-json-api/api.d.ts +19 -0
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/auth-json-api/api.js +1 -12
- package/esm/generated/auth-json-api/api.js.map +1 -1
- package/esm/generated/auth-json-api/openapi-spec.json +14 -0
- package/esm/generated/export-json-api/api.d.ts +7 -1
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +6 -1
- package/esm/generated/metadata-json-api/api.d.ts +1105 -590
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +77 -46
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +5815 -5373
- package/esm/index.d.ts +2 -2
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +0 -1
- package/esm/index.js.map +1 -1
- package/package.json +3 -3
|
@@ -962,7 +962,7 @@ export declare interface ActionsApiCreatePdfExportRequest {
|
|
|
962
962
|
* @type {VisualExportRequest}
|
|
963
963
|
* @memberof ActionsApiCreatePdfExport
|
|
964
964
|
*/
|
|
965
|
-
readonly visualExportRequest:
|
|
965
|
+
readonly visualExportRequest: VisualExportActionsRequest;
|
|
966
966
|
}
|
|
967
967
|
|
|
968
968
|
/**
|
|
@@ -982,7 +982,7 @@ export declare interface ActionsApiCreateTabularExportRequest {
|
|
|
982
982
|
* @type {TabularExportRequest}
|
|
983
983
|
* @memberof ActionsApiCreateTabularExport
|
|
984
984
|
*/
|
|
985
|
-
readonly tabularExportRequest:
|
|
985
|
+
readonly tabularExportRequest: TabularExportActionsRequest;
|
|
986
986
|
}
|
|
987
987
|
|
|
988
988
|
/**
|
|
@@ -6778,12 +6778,12 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: MetadataC
|
|
|
6778
6778
|
* @summary Post Automations
|
|
6779
6779
|
* @param {string} workspaceId
|
|
6780
6780
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
6781
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6781
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6782
6782
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
6783
6783
|
* @param {*} [options] Override http request option.
|
|
6784
6784
|
* @throws {RequiredError}
|
|
6785
6785
|
*/
|
|
6786
|
-
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6786
|
+
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6787
6787
|
/**
|
|
6788
6788
|
*
|
|
6789
6789
|
* @summary Delete an Automation
|
|
@@ -6800,7 +6800,7 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: MetadataC
|
|
|
6800
6800
|
* @param {string} workspaceId
|
|
6801
6801
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
6802
6802
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
6803
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6803
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6804
6804
|
* @param {number} [page] Zero-based page index (0..N)
|
|
6805
6805
|
* @param {number} [size] The size of the page to be returned
|
|
6806
6806
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -6809,20 +6809,20 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: MetadataC
|
|
|
6809
6809
|
* @param {*} [options] Override http request option.
|
|
6810
6810
|
* @throws {RequiredError}
|
|
6811
6811
|
*/
|
|
6812
|
-
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6812
|
+
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6813
6813
|
/**
|
|
6814
6814
|
*
|
|
6815
6815
|
* @summary Get an Automation
|
|
6816
6816
|
* @param {string} workspaceId
|
|
6817
6817
|
* @param {string} objectId
|
|
6818
6818
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
6819
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6819
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6820
6820
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
6821
6821
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
6822
6822
|
* @param {*} [options] Override http request option.
|
|
6823
6823
|
* @throws {RequiredError}
|
|
6824
6824
|
*/
|
|
6825
|
-
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6825
|
+
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6826
6826
|
/**
|
|
6827
6827
|
*
|
|
6828
6828
|
* @summary Patch an Automation
|
|
@@ -6830,11 +6830,11 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: MetadataC
|
|
|
6830
6830
|
* @param {string} objectId
|
|
6831
6831
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
6832
6832
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
6833
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6833
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6834
6834
|
* @param {*} [options] Override http request option.
|
|
6835
6835
|
* @throws {RequiredError}
|
|
6836
6836
|
*/
|
|
6837
|
-
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6837
|
+
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6838
6838
|
/**
|
|
6839
6839
|
*
|
|
6840
6840
|
* @summary Put an Automation
|
|
@@ -6842,11 +6842,11 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: MetadataC
|
|
|
6842
6842
|
* @param {string} objectId
|
|
6843
6843
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
6844
6844
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
6845
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6845
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6846
6846
|
* @param {*} [options] Override http request option.
|
|
6847
6847
|
* @throws {RequiredError}
|
|
6848
6848
|
*/
|
|
6849
|
-
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6849
|
+
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
6850
6850
|
};
|
|
6851
6851
|
|
|
6852
6852
|
/**
|
|
@@ -6869,10 +6869,10 @@ export declare interface AutomationsApiCreateEntityAutomationsRequest {
|
|
|
6869
6869
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
6870
6870
|
/**
|
|
6871
6871
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6872
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
6872
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
6873
6873
|
* @memberof AutomationsApiCreateEntityAutomations
|
|
6874
6874
|
*/
|
|
6875
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
6875
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
6876
6876
|
/**
|
|
6877
6877
|
* Include Meta objects.
|
|
6878
6878
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -6972,12 +6972,12 @@ export declare const AutomationsApiFp: (configuration?: MetadataConfiguration) =
|
|
|
6972
6972
|
* @summary Post Automations
|
|
6973
6973
|
* @param {string} workspaceId
|
|
6974
6974
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
6975
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6975
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6976
6976
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
6977
6977
|
* @param {*} [options] Override http request option.
|
|
6978
6978
|
* @throws {RequiredError}
|
|
6979
6979
|
*/
|
|
6980
|
-
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
6980
|
+
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
6981
6981
|
/**
|
|
6982
6982
|
*
|
|
6983
6983
|
* @summary Delete an Automation
|
|
@@ -6994,7 +6994,7 @@ export declare const AutomationsApiFp: (configuration?: MetadataConfiguration) =
|
|
|
6994
6994
|
* @param {string} workspaceId
|
|
6995
6995
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
6996
6996
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
6997
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6997
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
6998
6998
|
* @param {number} [page] Zero-based page index (0..N)
|
|
6999
6999
|
* @param {number} [size] The size of the page to be returned
|
|
7000
7000
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -7003,20 +7003,20 @@ export declare const AutomationsApiFp: (configuration?: MetadataConfiguration) =
|
|
|
7003
7003
|
* @param {*} [options] Override http request option.
|
|
7004
7004
|
* @throws {RequiredError}
|
|
7005
7005
|
*/
|
|
7006
|
-
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
7006
|
+
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
7007
7007
|
/**
|
|
7008
7008
|
*
|
|
7009
7009
|
* @summary Get an Automation
|
|
7010
7010
|
* @param {string} workspaceId
|
|
7011
7011
|
* @param {string} objectId
|
|
7012
7012
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
7013
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7013
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7014
7014
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
7015
7015
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
7016
7016
|
* @param {*} [options] Override http request option.
|
|
7017
7017
|
* @throws {RequiredError}
|
|
7018
7018
|
*/
|
|
7019
|
-
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
7019
|
+
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
7020
7020
|
/**
|
|
7021
7021
|
*
|
|
7022
7022
|
* @summary Patch an Automation
|
|
@@ -7024,11 +7024,11 @@ export declare const AutomationsApiFp: (configuration?: MetadataConfiguration) =
|
|
|
7024
7024
|
* @param {string} objectId
|
|
7025
7025
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
7026
7026
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
7027
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7027
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7028
7028
|
* @param {*} [options] Override http request option.
|
|
7029
7029
|
* @throws {RequiredError}
|
|
7030
7030
|
*/
|
|
7031
|
-
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
7031
|
+
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
7032
7032
|
/**
|
|
7033
7033
|
*
|
|
7034
7034
|
* @summary Put an Automation
|
|
@@ -7036,11 +7036,11 @@ export declare const AutomationsApiFp: (configuration?: MetadataConfiguration) =
|
|
|
7036
7036
|
* @param {string} objectId
|
|
7037
7037
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
7038
7038
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
7039
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7039
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7040
7040
|
* @param {*} [options] Override http request option.
|
|
7041
7041
|
* @throws {RequiredError}
|
|
7042
7042
|
*/
|
|
7043
|
-
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
7043
|
+
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
7044
7044
|
};
|
|
7045
7045
|
|
|
7046
7046
|
/**
|
|
@@ -7069,10 +7069,10 @@ export declare interface AutomationsApiGetAllEntitiesAutomationsRequest {
|
|
|
7069
7069
|
readonly filter?: string;
|
|
7070
7070
|
/**
|
|
7071
7071
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7072
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
7072
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
7073
7073
|
* @memberof AutomationsApiGetAllEntitiesAutomations
|
|
7074
7074
|
*/
|
|
7075
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
7075
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
7076
7076
|
/**
|
|
7077
7077
|
* Zero-based page index (0..N)
|
|
7078
7078
|
* @type {number}
|
|
@@ -7131,10 +7131,10 @@ export declare interface AutomationsApiGetEntityAutomationsRequest {
|
|
|
7131
7131
|
readonly filter?: string;
|
|
7132
7132
|
/**
|
|
7133
7133
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7134
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
7134
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
7135
7135
|
* @memberof AutomationsApiGetEntityAutomations
|
|
7136
7136
|
*/
|
|
7137
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
7137
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
7138
7138
|
/**
|
|
7139
7139
|
*
|
|
7140
7140
|
* @type {boolean}
|
|
@@ -7243,10 +7243,10 @@ export declare interface AutomationsApiPatchEntityAutomationsRequest {
|
|
|
7243
7243
|
readonly filter?: string;
|
|
7244
7244
|
/**
|
|
7245
7245
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7246
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
7246
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
7247
7247
|
* @memberof AutomationsApiPatchEntityAutomations
|
|
7248
7248
|
*/
|
|
7249
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
7249
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
7250
7250
|
}
|
|
7251
7251
|
|
|
7252
7252
|
/**
|
|
@@ -7281,10 +7281,42 @@ export declare interface AutomationsApiUpdateEntityAutomationsRequest {
|
|
|
7281
7281
|
readonly filter?: string;
|
|
7282
7282
|
/**
|
|
7283
7283
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
7284
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
7284
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
7285
7285
|
* @memberof AutomationsApiUpdateEntityAutomations
|
|
7286
7286
|
*/
|
|
7287
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
7287
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
7288
|
+
}
|
|
7289
|
+
|
|
7290
|
+
/**
|
|
7291
|
+
*
|
|
7292
|
+
* @export
|
|
7293
|
+
* @interface AutomationSchedule
|
|
7294
|
+
*/
|
|
7295
|
+
export declare interface AutomationSchedule {
|
|
7296
|
+
/**
|
|
7297
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
7298
|
+
* @type {string}
|
|
7299
|
+
* @memberof AutomationSchedule
|
|
7300
|
+
*/
|
|
7301
|
+
cron: string;
|
|
7302
|
+
/**
|
|
7303
|
+
* Human-readable description of the cron expression.
|
|
7304
|
+
* @type {string}
|
|
7305
|
+
* @memberof AutomationSchedule
|
|
7306
|
+
*/
|
|
7307
|
+
cronDescription?: string;
|
|
7308
|
+
/**
|
|
7309
|
+
* Timezone in which the schedule is defined.
|
|
7310
|
+
* @type {string}
|
|
7311
|
+
* @memberof AutomationSchedule
|
|
7312
|
+
*/
|
|
7313
|
+
timezone?: string;
|
|
7314
|
+
/**
|
|
7315
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
7316
|
+
* @type {string}
|
|
7317
|
+
* @memberof AutomationSchedule
|
|
7318
|
+
*/
|
|
7319
|
+
firstRun?: string;
|
|
7288
7320
|
}
|
|
7289
7321
|
|
|
7290
7322
|
/**
|
|
@@ -13277,6 +13309,12 @@ export declare interface DeclarativeAnalyticsLayer {
|
|
|
13277
13309
|
* @memberof DeclarativeAnalyticsLayer
|
|
13278
13310
|
*/
|
|
13279
13311
|
attributeHierarchies?: Array<DeclarativeAttributeHierarchy>;
|
|
13312
|
+
/**
|
|
13313
|
+
* A list of export definitions.
|
|
13314
|
+
* @type {Array<DeclarativeExportDefinition>}
|
|
13315
|
+
* @memberof DeclarativeAnalyticsLayer
|
|
13316
|
+
*/
|
|
13317
|
+
exportDefinitions?: Array<DeclarativeExportDefinition>;
|
|
13280
13318
|
}
|
|
13281
13319
|
|
|
13282
13320
|
/**
|
|
@@ -13428,6 +13466,100 @@ export declare const DeclarativeAttributeSourceColumnDataTypeEnum: {
|
|
|
13428
13466
|
|
|
13429
13467
|
export declare type DeclarativeAttributeSourceColumnDataTypeEnum = typeof DeclarativeAttributeSourceColumnDataTypeEnum[keyof typeof DeclarativeAttributeSourceColumnDataTypeEnum];
|
|
13430
13468
|
|
|
13469
|
+
/**
|
|
13470
|
+
*
|
|
13471
|
+
* @export
|
|
13472
|
+
* @interface DeclarativeAutomation
|
|
13473
|
+
*/
|
|
13474
|
+
export declare interface DeclarativeAutomation {
|
|
13475
|
+
/**
|
|
13476
|
+
*
|
|
13477
|
+
* @type {string}
|
|
13478
|
+
* @memberof DeclarativeAutomation
|
|
13479
|
+
*/
|
|
13480
|
+
id: string;
|
|
13481
|
+
/**
|
|
13482
|
+
*
|
|
13483
|
+
* @type {string}
|
|
13484
|
+
* @memberof DeclarativeAutomation
|
|
13485
|
+
*/
|
|
13486
|
+
title?: string;
|
|
13487
|
+
/**
|
|
13488
|
+
*
|
|
13489
|
+
* @type {string}
|
|
13490
|
+
* @memberof DeclarativeAutomation
|
|
13491
|
+
*/
|
|
13492
|
+
description?: string;
|
|
13493
|
+
/**
|
|
13494
|
+
* A list of tags.
|
|
13495
|
+
* @type {Array<string>}
|
|
13496
|
+
* @memberof DeclarativeAutomation
|
|
13497
|
+
*/
|
|
13498
|
+
tags?: Array<string>;
|
|
13499
|
+
/**
|
|
13500
|
+
*
|
|
13501
|
+
* @type {AutomationSchedule}
|
|
13502
|
+
* @memberof DeclarativeAutomation
|
|
13503
|
+
*/
|
|
13504
|
+
schedule?: AutomationSchedule;
|
|
13505
|
+
/**
|
|
13506
|
+
*
|
|
13507
|
+
* @type {DeclarativeNotificationChannelIdentifier}
|
|
13508
|
+
* @memberof DeclarativeAutomation
|
|
13509
|
+
*/
|
|
13510
|
+
notificationChannel?: DeclarativeNotificationChannelIdentifier;
|
|
13511
|
+
/**
|
|
13512
|
+
*
|
|
13513
|
+
* @type {Array<DeclarativeExportDefinitionIdentifier>}
|
|
13514
|
+
* @memberof DeclarativeAutomation
|
|
13515
|
+
*/
|
|
13516
|
+
exportDefinitions?: Array<DeclarativeExportDefinitionIdentifier>;
|
|
13517
|
+
/**
|
|
13518
|
+
*
|
|
13519
|
+
* @type {Array<DeclarativeUserIdentifier>}
|
|
13520
|
+
* @memberof DeclarativeAutomation
|
|
13521
|
+
*/
|
|
13522
|
+
recipients?: Array<DeclarativeUserIdentifier>;
|
|
13523
|
+
/**
|
|
13524
|
+
* TODO
|
|
13525
|
+
* @type {{ [key: string]: string; }}
|
|
13526
|
+
* @memberof DeclarativeAutomation
|
|
13527
|
+
*/
|
|
13528
|
+
details?: {
|
|
13529
|
+
[key: string]: string;
|
|
13530
|
+
};
|
|
13531
|
+
/**
|
|
13532
|
+
* Free-form JSON object
|
|
13533
|
+
* @type {object}
|
|
13534
|
+
* @memberof DeclarativeAutomation
|
|
13535
|
+
*/
|
|
13536
|
+
metadata?: object | null;
|
|
13537
|
+
/**
|
|
13538
|
+
*
|
|
13539
|
+
* @type {DeclarativeUserIdentifier}
|
|
13540
|
+
* @memberof DeclarativeAutomation
|
|
13541
|
+
*/
|
|
13542
|
+
createdBy?: DeclarativeUserIdentifier;
|
|
13543
|
+
/**
|
|
13544
|
+
*
|
|
13545
|
+
* @type {DeclarativeUserIdentifier}
|
|
13546
|
+
* @memberof DeclarativeAutomation
|
|
13547
|
+
*/
|
|
13548
|
+
modifiedBy?: DeclarativeUserIdentifier;
|
|
13549
|
+
/**
|
|
13550
|
+
* Time of the last entity modification.
|
|
13551
|
+
* @type {string}
|
|
13552
|
+
* @memberof DeclarativeAutomation
|
|
13553
|
+
*/
|
|
13554
|
+
modifiedAt?: string | null;
|
|
13555
|
+
/**
|
|
13556
|
+
* Time of the entity creation.
|
|
13557
|
+
* @type {string}
|
|
13558
|
+
* @memberof DeclarativeAutomation
|
|
13559
|
+
*/
|
|
13560
|
+
createdAt?: string | null;
|
|
13561
|
+
}
|
|
13562
|
+
|
|
13431
13563
|
/**
|
|
13432
13564
|
* Color palette and its properties.
|
|
13433
13565
|
* @export
|
|
@@ -13978,6 +14110,94 @@ export declare const DeclarativeDateDatasetGranularitiesEnum: {
|
|
|
13978
14110
|
|
|
13979
14111
|
export declare type DeclarativeDateDatasetGranularitiesEnum = typeof DeclarativeDateDatasetGranularitiesEnum[keyof typeof DeclarativeDateDatasetGranularitiesEnum];
|
|
13980
14112
|
|
|
14113
|
+
/**
|
|
14114
|
+
*
|
|
14115
|
+
* @export
|
|
14116
|
+
* @interface DeclarativeExportDefinition
|
|
14117
|
+
*/
|
|
14118
|
+
export declare interface DeclarativeExportDefinition {
|
|
14119
|
+
/**
|
|
14120
|
+
* Export definition id.
|
|
14121
|
+
* @type {string}
|
|
14122
|
+
* @memberof DeclarativeExportDefinition
|
|
14123
|
+
*/
|
|
14124
|
+
id: string;
|
|
14125
|
+
/**
|
|
14126
|
+
* Export definition object title.
|
|
14127
|
+
* @type {string}
|
|
14128
|
+
* @memberof DeclarativeExportDefinition
|
|
14129
|
+
*/
|
|
14130
|
+
title: string;
|
|
14131
|
+
/**
|
|
14132
|
+
* Export definition object description.
|
|
14133
|
+
* @type {string}
|
|
14134
|
+
* @memberof DeclarativeExportDefinition
|
|
14135
|
+
*/
|
|
14136
|
+
description?: string;
|
|
14137
|
+
/**
|
|
14138
|
+
* A list of tags.
|
|
14139
|
+
* @type {Array<string>}
|
|
14140
|
+
* @memberof DeclarativeExportDefinition
|
|
14141
|
+
*/
|
|
14142
|
+
tags?: Array<string>;
|
|
14143
|
+
/**
|
|
14144
|
+
*
|
|
14145
|
+
* @type {TabularExportRequest | VisualExportRequest}
|
|
14146
|
+
* @memberof DeclarativeExportDefinition
|
|
14147
|
+
*/
|
|
14148
|
+
requestPayload?: TabularExportRequest | VisualExportRequest;
|
|
14149
|
+
/**
|
|
14150
|
+
*
|
|
14151
|
+
* @type {DeclarativeUserIdentifier}
|
|
14152
|
+
* @memberof DeclarativeExportDefinition
|
|
14153
|
+
*/
|
|
14154
|
+
createdBy?: DeclarativeUserIdentifier;
|
|
14155
|
+
/**
|
|
14156
|
+
*
|
|
14157
|
+
* @type {DeclarativeUserIdentifier}
|
|
14158
|
+
* @memberof DeclarativeExportDefinition
|
|
14159
|
+
*/
|
|
14160
|
+
modifiedBy?: DeclarativeUserIdentifier;
|
|
14161
|
+
/**
|
|
14162
|
+
* Time of the last entity modification.
|
|
14163
|
+
* @type {string}
|
|
14164
|
+
* @memberof DeclarativeExportDefinition
|
|
14165
|
+
*/
|
|
14166
|
+
modifiedAt?: string | null;
|
|
14167
|
+
/**
|
|
14168
|
+
* Time of the entity creation.
|
|
14169
|
+
* @type {string}
|
|
14170
|
+
* @memberof DeclarativeExportDefinition
|
|
14171
|
+
*/
|
|
14172
|
+
createdAt?: string | null;
|
|
14173
|
+
}
|
|
14174
|
+
|
|
14175
|
+
/**
|
|
14176
|
+
* An export definition identifier.
|
|
14177
|
+
* @export
|
|
14178
|
+
* @interface DeclarativeExportDefinitionIdentifier
|
|
14179
|
+
*/
|
|
14180
|
+
export declare interface DeclarativeExportDefinitionIdentifier {
|
|
14181
|
+
/**
|
|
14182
|
+
* Export definition identifier.
|
|
14183
|
+
* @type {string}
|
|
14184
|
+
* @memberof DeclarativeExportDefinitionIdentifier
|
|
14185
|
+
*/
|
|
14186
|
+
id: string;
|
|
14187
|
+
/**
|
|
14188
|
+
* A type.
|
|
14189
|
+
* @type {string}
|
|
14190
|
+
* @memberof DeclarativeExportDefinitionIdentifier
|
|
14191
|
+
*/
|
|
14192
|
+
type: DeclarativeExportDefinitionIdentifierTypeEnum;
|
|
14193
|
+
}
|
|
14194
|
+
|
|
14195
|
+
export declare const DeclarativeExportDefinitionIdentifierTypeEnum: {
|
|
14196
|
+
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
14197
|
+
};
|
|
14198
|
+
|
|
14199
|
+
export declare type DeclarativeExportDefinitionIdentifierTypeEnum = typeof DeclarativeExportDefinitionIdentifierTypeEnum[keyof typeof DeclarativeExportDefinitionIdentifierTypeEnum];
|
|
14200
|
+
|
|
13981
14201
|
/**
|
|
13982
14202
|
* A dataset fact.
|
|
13983
14203
|
* @export
|
|
@@ -14274,6 +14494,82 @@ export declare interface DeclarativeModel {
|
|
|
14274
14494
|
ldm?: DeclarativeLdm;
|
|
14275
14495
|
}
|
|
14276
14496
|
|
|
14497
|
+
/**
|
|
14498
|
+
* A declarative form of a particular notification channel.
|
|
14499
|
+
* @export
|
|
14500
|
+
* @interface DeclarativeNotificationChannel
|
|
14501
|
+
*/
|
|
14502
|
+
export declare interface DeclarativeNotificationChannel {
|
|
14503
|
+
/**
|
|
14504
|
+
* Identifier of a notification channel
|
|
14505
|
+
* @type {string}
|
|
14506
|
+
* @memberof DeclarativeNotificationChannel
|
|
14507
|
+
*/
|
|
14508
|
+
id: string;
|
|
14509
|
+
/**
|
|
14510
|
+
* Name of a notification channel.
|
|
14511
|
+
* @type {string}
|
|
14512
|
+
* @memberof DeclarativeNotificationChannel
|
|
14513
|
+
*/
|
|
14514
|
+
name?: string;
|
|
14515
|
+
/**
|
|
14516
|
+
* Description of a notification channel.
|
|
14517
|
+
* @type {string}
|
|
14518
|
+
* @memberof DeclarativeNotificationChannel
|
|
14519
|
+
*/
|
|
14520
|
+
description?: string;
|
|
14521
|
+
/**
|
|
14522
|
+
*
|
|
14523
|
+
* @type {Webhook}
|
|
14524
|
+
* @memberof DeclarativeNotificationChannel
|
|
14525
|
+
*/
|
|
14526
|
+
destination?: Webhook;
|
|
14527
|
+
/**
|
|
14528
|
+
*
|
|
14529
|
+
* @type {string}
|
|
14530
|
+
* @memberof DeclarativeNotificationChannel
|
|
14531
|
+
*/
|
|
14532
|
+
destinationType?: DeclarativeNotificationChannelDestinationTypeEnum;
|
|
14533
|
+
/**
|
|
14534
|
+
* The triggers that are to be used to send notifications to the channel.
|
|
14535
|
+
* @type {Array<NotificationTrigger>}
|
|
14536
|
+
* @memberof DeclarativeNotificationChannel
|
|
14537
|
+
*/
|
|
14538
|
+
triggers?: Array<NotificationTrigger>;
|
|
14539
|
+
}
|
|
14540
|
+
|
|
14541
|
+
export declare const DeclarativeNotificationChannelDestinationTypeEnum: {
|
|
14542
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
14543
|
+
};
|
|
14544
|
+
|
|
14545
|
+
export declare type DeclarativeNotificationChannelDestinationTypeEnum = typeof DeclarativeNotificationChannelDestinationTypeEnum[keyof typeof DeclarativeNotificationChannelDestinationTypeEnum];
|
|
14546
|
+
|
|
14547
|
+
/**
|
|
14548
|
+
* A notification channel identifier.
|
|
14549
|
+
* @export
|
|
14550
|
+
* @interface DeclarativeNotificationChannelIdentifier
|
|
14551
|
+
*/
|
|
14552
|
+
export declare interface DeclarativeNotificationChannelIdentifier {
|
|
14553
|
+
/**
|
|
14554
|
+
* Notification channel identifier.
|
|
14555
|
+
* @type {string}
|
|
14556
|
+
* @memberof DeclarativeNotificationChannelIdentifier
|
|
14557
|
+
*/
|
|
14558
|
+
id: string;
|
|
14559
|
+
/**
|
|
14560
|
+
* A type.
|
|
14561
|
+
* @type {string}
|
|
14562
|
+
* @memberof DeclarativeNotificationChannelIdentifier
|
|
14563
|
+
*/
|
|
14564
|
+
type: DeclarativeNotificationChannelIdentifierTypeEnum;
|
|
14565
|
+
}
|
|
14566
|
+
|
|
14567
|
+
export declare const DeclarativeNotificationChannelIdentifierTypeEnum: {
|
|
14568
|
+
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
14569
|
+
};
|
|
14570
|
+
|
|
14571
|
+
export declare type DeclarativeNotificationChannelIdentifierTypeEnum = typeof DeclarativeNotificationChannelIdentifierTypeEnum[keyof typeof DeclarativeNotificationChannelIdentifierTypeEnum];
|
|
14572
|
+
|
|
14277
14573
|
/**
|
|
14278
14574
|
* Complete definition of an organization in a declarative form.
|
|
14279
14575
|
* @export
|
|
@@ -14322,6 +14618,12 @@ export declare interface DeclarativeOrganization {
|
|
|
14322
14618
|
* @memberof DeclarativeOrganization
|
|
14323
14619
|
*/
|
|
14324
14620
|
jwks?: Array<DeclarativeJwk>;
|
|
14621
|
+
/**
|
|
14622
|
+
*
|
|
14623
|
+
* @type {Array<DeclarativeNotificationChannel>}
|
|
14624
|
+
* @memberof DeclarativeOrganization
|
|
14625
|
+
*/
|
|
14626
|
+
notificationChannels?: Array<DeclarativeNotificationChannel>;
|
|
14325
14627
|
}
|
|
14326
14628
|
|
|
14327
14629
|
/**
|
|
@@ -15253,6 +15555,12 @@ export declare interface DeclarativeWorkspace {
|
|
|
15253
15555
|
* @memberof DeclarativeWorkspace
|
|
15254
15556
|
*/
|
|
15255
15557
|
dataSource?: WorkspaceDataSource;
|
|
15558
|
+
/**
|
|
15559
|
+
*
|
|
15560
|
+
* @type {Array<DeclarativeAutomation>}
|
|
15561
|
+
* @memberof DeclarativeWorkspace
|
|
15562
|
+
*/
|
|
15563
|
+
automations?: Array<DeclarativeAutomation>;
|
|
15256
15564
|
}
|
|
15257
15565
|
|
|
15258
15566
|
/**
|
|
@@ -17603,12 +17911,12 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
17603
17911
|
* @summary Post Automations
|
|
17604
17912
|
* @param {string} workspaceId
|
|
17605
17913
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
17606
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
17914
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
17607
17915
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
17608
17916
|
* @param {*} [options] Override http request option.
|
|
17609
17917
|
* @throws {RequiredError}
|
|
17610
17918
|
*/
|
|
17611
|
-
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
17919
|
+
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
17612
17920
|
/**
|
|
17613
17921
|
*
|
|
17614
17922
|
* @summary Post Color Pallettes
|
|
@@ -18117,7 +18425,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
18117
18425
|
* @param {string} workspaceId
|
|
18118
18426
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
18119
18427
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
18120
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
18428
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
18121
18429
|
* @param {number} [page] Zero-based page index (0..N)
|
|
18122
18430
|
* @param {number} [size] The size of the page to be returned
|
|
18123
18431
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -18126,7 +18434,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
18126
18434
|
* @param {*} [options] Override http request option.
|
|
18127
18435
|
* @throws {RequiredError}
|
|
18128
18436
|
*/
|
|
18129
|
-
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
18437
|
+
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
18130
18438
|
/**
|
|
18131
18439
|
*
|
|
18132
18440
|
* @summary Get all Color Pallettes
|
|
@@ -18574,13 +18882,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
18574
18882
|
* @param {string} workspaceId
|
|
18575
18883
|
* @param {string} objectId
|
|
18576
18884
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
18577
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
18885
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
18578
18886
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
18579
18887
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
18580
18888
|
* @param {*} [options] Override http request option.
|
|
18581
18889
|
* @throws {RequiredError}
|
|
18582
18890
|
*/
|
|
18583
|
-
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
18891
|
+
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
18584
18892
|
/**
|
|
18585
18893
|
*
|
|
18586
18894
|
* @summary Get Color Pallette
|
|
@@ -18940,11 +19248,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
18940
19248
|
* @param {string} objectId
|
|
18941
19249
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
18942
19250
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
18943
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
19251
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
18944
19252
|
* @param {*} [options] Override http request option.
|
|
18945
19253
|
* @throws {RequiredError}
|
|
18946
19254
|
*/
|
|
18947
|
-
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
19255
|
+
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
18948
19256
|
/**
|
|
18949
19257
|
*
|
|
18950
19258
|
* @summary Patch Color Pallette
|
|
@@ -19218,11 +19526,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
19218
19526
|
* @param {string} objectId
|
|
19219
19527
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
19220
19528
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
19221
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
19529
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
19222
19530
|
* @param {*} [options] Override http request option.
|
|
19223
19531
|
* @throws {RequiredError}
|
|
19224
19532
|
*/
|
|
19225
|
-
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
19533
|
+
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
19226
19534
|
/**
|
|
19227
19535
|
*
|
|
19228
19536
|
* @summary Put Color Pallette
|
|
@@ -19582,10 +19890,10 @@ export declare interface EntitiesApiCreateEntityAutomationsRequest {
|
|
|
19582
19890
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
19583
19891
|
/**
|
|
19584
19892
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
19585
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
19893
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
19586
19894
|
* @memberof EntitiesApiCreateEntityAutomations
|
|
19587
19895
|
*/
|
|
19588
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
19896
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
19589
19897
|
/**
|
|
19590
19898
|
* Include Meta objects.
|
|
19591
19899
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -22089,12 +22397,12 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
22089
22397
|
* @summary Post Automations
|
|
22090
22398
|
* @param {string} workspaceId
|
|
22091
22399
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
22092
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
22400
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
22093
22401
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
22094
22402
|
* @param {*} [options] Override http request option.
|
|
22095
22403
|
* @throws {RequiredError}
|
|
22096
22404
|
*/
|
|
22097
|
-
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
22405
|
+
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
22098
22406
|
/**
|
|
22099
22407
|
*
|
|
22100
22408
|
* @summary Post Color Pallettes
|
|
@@ -22603,7 +22911,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
22603
22911
|
* @param {string} workspaceId
|
|
22604
22912
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
22605
22913
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
22606
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
22914
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
22607
22915
|
* @param {number} [page] Zero-based page index (0..N)
|
|
22608
22916
|
* @param {number} [size] The size of the page to be returned
|
|
22609
22917
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -22612,7 +22920,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
22612
22920
|
* @param {*} [options] Override http request option.
|
|
22613
22921
|
* @throws {RequiredError}
|
|
22614
22922
|
*/
|
|
22615
|
-
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
22923
|
+
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
22616
22924
|
/**
|
|
22617
22925
|
*
|
|
22618
22926
|
* @summary Get all Color Pallettes
|
|
@@ -23062,13 +23370,13 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
23062
23370
|
* @param {string} workspaceId
|
|
23063
23371
|
* @param {string} objectId
|
|
23064
23372
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
23065
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
23373
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
23066
23374
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
23067
23375
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
23068
23376
|
* @param {*} [options] Override http request option.
|
|
23069
23377
|
* @throws {RequiredError}
|
|
23070
23378
|
*/
|
|
23071
|
-
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
23379
|
+
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
23072
23380
|
/**
|
|
23073
23381
|
*
|
|
23074
23382
|
* @summary Get Color Pallette
|
|
@@ -23428,11 +23736,11 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
23428
23736
|
* @param {string} objectId
|
|
23429
23737
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
23430
23738
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
23431
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
23739
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
23432
23740
|
* @param {*} [options] Override http request option.
|
|
23433
23741
|
* @throws {RequiredError}
|
|
23434
23742
|
*/
|
|
23435
|
-
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
23743
|
+
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
23436
23744
|
/**
|
|
23437
23745
|
*
|
|
23438
23746
|
* @summary Patch Color Pallette
|
|
@@ -23706,11 +24014,11 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
23706
24014
|
* @param {string} objectId
|
|
23707
24015
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
23708
24016
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
23709
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24017
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
23710
24018
|
* @param {*} [options] Override http request option.
|
|
23711
24019
|
* @throws {RequiredError}
|
|
23712
24020
|
*/
|
|
23713
|
-
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
24021
|
+
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
23714
24022
|
/**
|
|
23715
24023
|
*
|
|
23716
24024
|
* @summary Put Color Pallette
|
|
@@ -24222,10 +24530,10 @@ export declare interface EntitiesApiGetAllEntitiesAutomationsRequest {
|
|
|
24222
24530
|
readonly filter?: string;
|
|
24223
24531
|
/**
|
|
24224
24532
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24225
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24533
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
24226
24534
|
* @memberof EntitiesApiGetAllEntitiesAutomations
|
|
24227
24535
|
*/
|
|
24228
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
24536
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
24229
24537
|
/**
|
|
24230
24538
|
* Zero-based page index (0..N)
|
|
24231
24539
|
* @type {number}
|
|
@@ -25792,10 +26100,10 @@ export declare interface EntitiesApiGetEntityAutomationsRequest {
|
|
|
25792
26100
|
readonly filter?: string;
|
|
25793
26101
|
/**
|
|
25794
26102
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
25795
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
26103
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
25796
26104
|
* @memberof EntitiesApiGetEntityAutomations
|
|
25797
26105
|
*/
|
|
25798
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
26106
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
25799
26107
|
/**
|
|
25800
26108
|
*
|
|
25801
26109
|
* @type {boolean}
|
|
@@ -28403,10 +28711,10 @@ export declare interface EntitiesApiPatchEntityAutomationsRequest {
|
|
|
28403
28711
|
readonly filter?: string;
|
|
28404
28712
|
/**
|
|
28405
28713
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
28406
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
28714
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
28407
28715
|
* @memberof EntitiesApiPatchEntityAutomations
|
|
28408
28716
|
*/
|
|
28409
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
28717
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
28410
28718
|
}
|
|
28411
28719
|
|
|
28412
28720
|
/**
|
|
@@ -29221,10 +29529,10 @@ export declare interface EntitiesApiUpdateEntityAutomationsRequest {
|
|
|
29221
29529
|
readonly filter?: string;
|
|
29222
29530
|
/**
|
|
29223
29531
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
29224
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
29532
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
29225
29533
|
* @memberof EntitiesApiUpdateEntityAutomations
|
|
29226
29534
|
*/
|
|
29227
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
29535
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
29228
29536
|
}
|
|
29229
29537
|
|
|
29230
29538
|
/**
|
|
@@ -30516,6 +30824,148 @@ export declare interface ExportActionsApiInterface {
|
|
|
30516
30824
|
getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
30517
30825
|
}
|
|
30518
30826
|
|
|
30827
|
+
/**
|
|
30828
|
+
* Custom label object override.
|
|
30829
|
+
* @export
|
|
30830
|
+
* @interface CustomLabel
|
|
30831
|
+
*/
|
|
30832
|
+
export declare interface ExportActionsCustomLabel {
|
|
30833
|
+
/**
|
|
30834
|
+
* Override value.
|
|
30835
|
+
* @type {string}
|
|
30836
|
+
* @memberof CustomLabel
|
|
30837
|
+
*/
|
|
30838
|
+
title: string;
|
|
30839
|
+
}
|
|
30840
|
+
|
|
30841
|
+
/**
|
|
30842
|
+
* Custom metric object override.
|
|
30843
|
+
* @export
|
|
30844
|
+
* @interface CustomMetric
|
|
30845
|
+
*/
|
|
30846
|
+
export declare interface ExportActionsCustomMetric {
|
|
30847
|
+
/**
|
|
30848
|
+
* Metric title override.
|
|
30849
|
+
* @type {string}
|
|
30850
|
+
* @memberof CustomMetric
|
|
30851
|
+
*/
|
|
30852
|
+
title: string;
|
|
30853
|
+
/**
|
|
30854
|
+
* Format override.
|
|
30855
|
+
* @type {string}
|
|
30856
|
+
* @memberof CustomMetric
|
|
30857
|
+
*/
|
|
30858
|
+
format: string;
|
|
30859
|
+
}
|
|
30860
|
+
|
|
30861
|
+
/**
|
|
30862
|
+
* Custom cell value overrides (IDs will be replaced with specified values).
|
|
30863
|
+
* @export
|
|
30864
|
+
* @interface CustomOverride
|
|
30865
|
+
*/
|
|
30866
|
+
export declare interface ExportActionsCustomOverride {
|
|
30867
|
+
/**
|
|
30868
|
+
* Map of CustomLabels with keys used as placeholders in document.
|
|
30869
|
+
* @type {{ [key: string]: CustomLabel; }}
|
|
30870
|
+
* @memberof CustomOverride
|
|
30871
|
+
*/
|
|
30872
|
+
labels?: {
|
|
30873
|
+
[key: string]: ExportActionsCustomLabel;
|
|
30874
|
+
};
|
|
30875
|
+
/**
|
|
30876
|
+
* Map of CustomMetrics with keys used as placeholders in document.
|
|
30877
|
+
* @type {{ [key: string]: CustomMetric; }}
|
|
30878
|
+
* @memberof CustomOverride
|
|
30879
|
+
*/
|
|
30880
|
+
metrics?: {
|
|
30881
|
+
[key: string]: ExportActionsCustomMetric;
|
|
30882
|
+
};
|
|
30883
|
+
}
|
|
30884
|
+
|
|
30885
|
+
/**
|
|
30886
|
+
* Custom CSS styles for the table. (PDF, HTML)
|
|
30887
|
+
* @export
|
|
30888
|
+
* @interface PdfTableStyle
|
|
30889
|
+
*/
|
|
30890
|
+
export declare interface ExportActionsPdfTableStyle {
|
|
30891
|
+
/**
|
|
30892
|
+
* CSS selector where to apply given properties.
|
|
30893
|
+
* @type {string}
|
|
30894
|
+
* @memberof PdfTableStyle
|
|
30895
|
+
*/
|
|
30896
|
+
selector: string;
|
|
30897
|
+
/**
|
|
30898
|
+
* List of CSS properties.
|
|
30899
|
+
* @type {Array<PdfTableStyleProperty>}
|
|
30900
|
+
* @memberof PdfTableStyle
|
|
30901
|
+
*/
|
|
30902
|
+
properties?: Array<ExportActionsPdfTableStyleProperty>;
|
|
30903
|
+
}
|
|
30904
|
+
|
|
30905
|
+
/**
|
|
30906
|
+
* CSS property.
|
|
30907
|
+
* @export
|
|
30908
|
+
* @interface PdfTableStyleProperty
|
|
30909
|
+
*/
|
|
30910
|
+
export declare interface ExportActionsPdfTableStyleProperty {
|
|
30911
|
+
/**
|
|
30912
|
+
* CSS property key.
|
|
30913
|
+
* @type {string}
|
|
30914
|
+
* @memberof PdfTableStyleProperty
|
|
30915
|
+
*/
|
|
30916
|
+
key: string;
|
|
30917
|
+
/**
|
|
30918
|
+
* CSS property value.
|
|
30919
|
+
* @type {string}
|
|
30920
|
+
* @memberof PdfTableStyleProperty
|
|
30921
|
+
*/
|
|
30922
|
+
value: string;
|
|
30923
|
+
}
|
|
30924
|
+
|
|
30925
|
+
/**
|
|
30926
|
+
* Additional settings.
|
|
30927
|
+
* @export
|
|
30928
|
+
* @interface Settings
|
|
30929
|
+
*/
|
|
30930
|
+
export declare interface ExportActionsSettings {
|
|
30931
|
+
/**
|
|
30932
|
+
* Merge equal headers in neighbouring cells. (XLSX)
|
|
30933
|
+
* @type {boolean}
|
|
30934
|
+
* @memberof Settings
|
|
30935
|
+
*/
|
|
30936
|
+
mergeHeaders?: boolean;
|
|
30937
|
+
/**
|
|
30938
|
+
* Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
|
|
30939
|
+
* @type {boolean}
|
|
30940
|
+
* @memberof Settings
|
|
30941
|
+
*/
|
|
30942
|
+
showFilters?: boolean;
|
|
30943
|
+
/**
|
|
30944
|
+
* Page size and orientation. (PDF)
|
|
30945
|
+
* @type {string}
|
|
30946
|
+
* @memberof Settings
|
|
30947
|
+
*/
|
|
30948
|
+
pdfPageSize?: string;
|
|
30949
|
+
/**
|
|
30950
|
+
* Custom CSS styles for the table. (PDF, HTML)
|
|
30951
|
+
* @type {Array<PdfTableStyle>}
|
|
30952
|
+
* @memberof Settings
|
|
30953
|
+
*/
|
|
30954
|
+
pdfTableStyle?: Array<ExportActionsPdfTableStyle>;
|
|
30955
|
+
/**
|
|
30956
|
+
* Top left header content. (PDF)
|
|
30957
|
+
* @type {string}
|
|
30958
|
+
* @memberof Settings
|
|
30959
|
+
*/
|
|
30960
|
+
pdfTopLeftContent?: string;
|
|
30961
|
+
/**
|
|
30962
|
+
* Top right header content. (PDF)
|
|
30963
|
+
* @type {string}
|
|
30964
|
+
* @memberof Settings
|
|
30965
|
+
*/
|
|
30966
|
+
pdfTopRightContent?: string;
|
|
30967
|
+
}
|
|
30968
|
+
|
|
30519
30969
|
/**
|
|
30520
30970
|
* ExportDefinitionsApi - object-oriented interface
|
|
30521
30971
|
* @export
|
|
@@ -31098,6 +31548,13 @@ export declare interface ExportDefinitionsApiUpdateEntityExportDefinitionsReques
|
|
|
31098
31548
|
readonly include?: Array<"visualizationObjects" | "analyticalDashboards" | "userIdentifiers" | "visualizationObject" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "ALL">;
|
|
31099
31549
|
}
|
|
31100
31550
|
|
|
31551
|
+
/**
|
|
31552
|
+
* @type ExportRequest
|
|
31553
|
+
* JSON content to be used as export request payload for /export/tabular and /export/visual endpoints.
|
|
31554
|
+
* @export
|
|
31555
|
+
*/
|
|
31556
|
+
export declare type ExportRequest = TabularExportRequest | VisualExportRequest;
|
|
31557
|
+
|
|
31101
31558
|
/**
|
|
31102
31559
|
*
|
|
31103
31560
|
* @export
|
|
@@ -32238,6 +32695,7 @@ declare interface IAnalyticalDashboard_2 {
|
|
|
32238
32695
|
disableCrossFiltering?: boolean;
|
|
32239
32696
|
disableUserFilterReset?: boolean;
|
|
32240
32697
|
disableUserFilterSave?: boolean;
|
|
32698
|
+
disableFilterViews?: boolean;
|
|
32241
32699
|
}
|
|
32242
32700
|
|
|
32243
32701
|
/**
|
|
@@ -33583,7 +34041,7 @@ export declare interface JsonApiApiTokenOut {
|
|
|
33583
34041
|
*/
|
|
33584
34042
|
export declare interface JsonApiApiTokenOutAttributes {
|
|
33585
34043
|
/**
|
|
33586
|
-
*
|
|
34044
|
+
* The value of the Bearer token. It is only returned when the API token is created.
|
|
33587
34045
|
* @type {string}
|
|
33588
34046
|
* @memberof JsonApiApiTokenOutAttributes
|
|
33589
34047
|
*/
|
|
@@ -34584,12 +35042,6 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
34584
35042
|
* @memberof JsonApiAutomationOutAttributes
|
|
34585
35043
|
*/
|
|
34586
35044
|
areRelationsValid?: boolean;
|
|
34587
|
-
/**
|
|
34588
|
-
*
|
|
34589
|
-
* @type {JsonApiAutomationOutAttributesSchedule}
|
|
34590
|
-
* @memberof JsonApiAutomationOutAttributes
|
|
34591
|
-
*/
|
|
34592
|
-
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
34593
35045
|
/**
|
|
34594
35046
|
* Additional details to be included in the automated message.
|
|
34595
35047
|
* @type {any}
|
|
@@ -34597,49 +35049,29 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
34597
35049
|
*/
|
|
34598
35050
|
details?: any;
|
|
34599
35051
|
/**
|
|
34600
|
-
*
|
|
34601
|
-
* @type {
|
|
35052
|
+
* Additional information for the automation.
|
|
35053
|
+
* @type {object}
|
|
34602
35054
|
* @memberof JsonApiAutomationOutAttributes
|
|
34603
35055
|
*/
|
|
34604
|
-
|
|
35056
|
+
metadata?: object | null;
|
|
34605
35057
|
/**
|
|
34606
35058
|
*
|
|
34607
|
-
* @type {
|
|
35059
|
+
* @type {JsonApiAutomationPatchAttributesSchedule}
|
|
34608
35060
|
* @memberof JsonApiAutomationOutAttributes
|
|
34609
35061
|
*/
|
|
34610
|
-
|
|
34611
|
-
}
|
|
34612
|
-
|
|
34613
|
-
/**
|
|
34614
|
-
*
|
|
34615
|
-
* @export
|
|
34616
|
-
* @interface JsonApiAutomationOutAttributesSchedule
|
|
34617
|
-
*/
|
|
34618
|
-
export declare interface JsonApiAutomationOutAttributesSchedule {
|
|
35062
|
+
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
34619
35063
|
/**
|
|
34620
|
-
*
|
|
34621
|
-
* @type {string}
|
|
34622
|
-
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
34623
|
-
*/
|
|
34624
|
-
cron: string;
|
|
34625
|
-
/**
|
|
34626
|
-
* Human-readable description of the cron expression.
|
|
34627
|
-
* @type {string}
|
|
34628
|
-
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
34629
|
-
*/
|
|
34630
|
-
cronDescription?: string;
|
|
34631
|
-
/**
|
|
34632
|
-
* Timezone in which the schedule is defined.
|
|
35064
|
+
*
|
|
34633
35065
|
* @type {string}
|
|
34634
|
-
* @memberof
|
|
35066
|
+
* @memberof JsonApiAutomationOutAttributes
|
|
34635
35067
|
*/
|
|
34636
|
-
|
|
35068
|
+
createdAt?: string;
|
|
34637
35069
|
/**
|
|
34638
|
-
*
|
|
35070
|
+
*
|
|
34639
35071
|
* @type {string}
|
|
34640
|
-
* @memberof
|
|
35072
|
+
* @memberof JsonApiAutomationOutAttributes
|
|
34641
35073
|
*/
|
|
34642
|
-
|
|
35074
|
+
modifiedAt?: string;
|
|
34643
35075
|
}
|
|
34644
35076
|
|
|
34645
35077
|
/**
|
|
@@ -34672,7 +35104,7 @@ export declare interface JsonApiAutomationOutDocument {
|
|
|
34672
35104
|
* @type JsonApiAutomationOutIncludes
|
|
34673
35105
|
* @export
|
|
34674
35106
|
*/
|
|
34675
|
-
export declare type JsonApiAutomationOutIncludes = JsonApiExportDefinitionOutWithLinks | JsonApiNotificationChannelOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiUserOutWithLinks;
|
|
35107
|
+
export declare type JsonApiAutomationOutIncludes = JsonApiAnalyticalDashboardOutWithLinks | JsonApiExportDefinitionOutWithLinks | JsonApiNotificationChannelOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiUserOutWithLinks;
|
|
34676
35108
|
|
|
34677
35109
|
/**
|
|
34678
35110
|
* A JSON:API document with a list of resources
|
|
@@ -34714,10 +35146,16 @@ export declare interface JsonApiAutomationOutList {
|
|
|
34714
35146
|
export declare interface JsonApiAutomationOutRelationships {
|
|
34715
35147
|
/**
|
|
34716
35148
|
*
|
|
34717
|
-
* @type {
|
|
35149
|
+
* @type {JsonApiAutomationPatchRelationshipsNotificationChannel}
|
|
35150
|
+
* @memberof JsonApiAutomationOutRelationships
|
|
35151
|
+
*/
|
|
35152
|
+
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
35153
|
+
/**
|
|
35154
|
+
*
|
|
35155
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
34718
35156
|
* @memberof JsonApiAutomationOutRelationships
|
|
34719
35157
|
*/
|
|
34720
|
-
|
|
35158
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
34721
35159
|
/**
|
|
34722
35160
|
*
|
|
34723
35161
|
* @type {JsonApiAnalyticalDashboardOutRelationshipsCreatedBy}
|
|
@@ -34732,58 +35170,16 @@ export declare interface JsonApiAutomationOutRelationships {
|
|
|
34732
35170
|
modifiedBy?: JsonApiAnalyticalDashboardOutRelationshipsCreatedBy;
|
|
34733
35171
|
/**
|
|
34734
35172
|
*
|
|
34735
|
-
* @type {
|
|
35173
|
+
* @type {JsonApiAutomationPatchRelationshipsExportDefinitions}
|
|
34736
35174
|
* @memberof JsonApiAutomationOutRelationships
|
|
34737
35175
|
*/
|
|
34738
|
-
exportDefinitions?:
|
|
35176
|
+
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
34739
35177
|
/**
|
|
34740
35178
|
*
|
|
34741
|
-
* @type {
|
|
35179
|
+
* @type {JsonApiAutomationPatchRelationshipsRecipients}
|
|
34742
35180
|
* @memberof JsonApiAutomationOutRelationships
|
|
34743
35181
|
*/
|
|
34744
|
-
recipients?:
|
|
34745
|
-
}
|
|
34746
|
-
|
|
34747
|
-
/**
|
|
34748
|
-
*
|
|
34749
|
-
* @export
|
|
34750
|
-
* @interface JsonApiAutomationOutRelationshipsExportDefinitions
|
|
34751
|
-
*/
|
|
34752
|
-
export declare interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
34753
|
-
/**
|
|
34754
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
34755
|
-
* @type {Array<JsonApiExportDefinitionLinkage>}
|
|
34756
|
-
* @memberof JsonApiAutomationOutRelationshipsExportDefinitions
|
|
34757
|
-
*/
|
|
34758
|
-
data: Array<JsonApiExportDefinitionLinkage>;
|
|
34759
|
-
}
|
|
34760
|
-
|
|
34761
|
-
/**
|
|
34762
|
-
*
|
|
34763
|
-
* @export
|
|
34764
|
-
* @interface JsonApiAutomationOutRelationshipsNotificationChannel
|
|
34765
|
-
*/
|
|
34766
|
-
export declare interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
34767
|
-
/**
|
|
34768
|
-
*
|
|
34769
|
-
* @type {JsonApiNotificationChannelToOneLinkage}
|
|
34770
|
-
* @memberof JsonApiAutomationOutRelationshipsNotificationChannel
|
|
34771
|
-
*/
|
|
34772
|
-
data: JsonApiNotificationChannelToOneLinkage | null;
|
|
34773
|
-
}
|
|
34774
|
-
|
|
34775
|
-
/**
|
|
34776
|
-
*
|
|
34777
|
-
* @export
|
|
34778
|
-
* @interface JsonApiAutomationOutRelationshipsRecipients
|
|
34779
|
-
*/
|
|
34780
|
-
export declare interface JsonApiAutomationOutRelationshipsRecipients {
|
|
34781
|
-
/**
|
|
34782
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
34783
|
-
* @type {Array<JsonApiUserLinkage>}
|
|
34784
|
-
* @memberof JsonApiAutomationOutRelationshipsRecipients
|
|
34785
|
-
*/
|
|
34786
|
-
data: Array<JsonApiUserLinkage>;
|
|
35182
|
+
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
34787
35183
|
}
|
|
34788
35184
|
|
|
34789
35185
|
export declare const JsonApiAutomationOutTypeEnum: {
|
|
@@ -34904,18 +35300,56 @@ export declare interface JsonApiAutomationPatchAttributes {
|
|
|
34904
35300
|
* @memberof JsonApiAutomationPatchAttributes
|
|
34905
35301
|
*/
|
|
34906
35302
|
areRelationsValid?: boolean;
|
|
34907
|
-
/**
|
|
34908
|
-
*
|
|
34909
|
-
* @type {JsonApiAutomationOutAttributesSchedule}
|
|
34910
|
-
* @memberof JsonApiAutomationPatchAttributes
|
|
34911
|
-
*/
|
|
34912
|
-
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
34913
35303
|
/**
|
|
34914
35304
|
* Additional details to be included in the automated message.
|
|
34915
35305
|
* @type {any}
|
|
34916
35306
|
* @memberof JsonApiAutomationPatchAttributes
|
|
34917
35307
|
*/
|
|
34918
35308
|
details?: any;
|
|
35309
|
+
/**
|
|
35310
|
+
* Additional information for the automation.
|
|
35311
|
+
* @type {object}
|
|
35312
|
+
* @memberof JsonApiAutomationPatchAttributes
|
|
35313
|
+
*/
|
|
35314
|
+
metadata?: object | null;
|
|
35315
|
+
/**
|
|
35316
|
+
*
|
|
35317
|
+
* @type {JsonApiAutomationPatchAttributesSchedule}
|
|
35318
|
+
* @memberof JsonApiAutomationPatchAttributes
|
|
35319
|
+
*/
|
|
35320
|
+
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
35321
|
+
}
|
|
35322
|
+
|
|
35323
|
+
/**
|
|
35324
|
+
*
|
|
35325
|
+
* @export
|
|
35326
|
+
* @interface JsonApiAutomationPatchAttributesSchedule
|
|
35327
|
+
*/
|
|
35328
|
+
export declare interface JsonApiAutomationPatchAttributesSchedule {
|
|
35329
|
+
/**
|
|
35330
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
35331
|
+
* @type {string}
|
|
35332
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
35333
|
+
*/
|
|
35334
|
+
cron: string;
|
|
35335
|
+
/**
|
|
35336
|
+
* Human-readable description of the cron expression.
|
|
35337
|
+
* @type {string}
|
|
35338
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
35339
|
+
*/
|
|
35340
|
+
cronDescription?: string;
|
|
35341
|
+
/**
|
|
35342
|
+
* Timezone in which the schedule is defined.
|
|
35343
|
+
* @type {string}
|
|
35344
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
35345
|
+
*/
|
|
35346
|
+
timezone?: string;
|
|
35347
|
+
/**
|
|
35348
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
35349
|
+
* @type {string}
|
|
35350
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
35351
|
+
*/
|
|
35352
|
+
firstRun?: string;
|
|
34919
35353
|
}
|
|
34920
35354
|
|
|
34921
35355
|
/**
|
|
@@ -34940,22 +35374,84 @@ export declare interface JsonApiAutomationPatchDocument {
|
|
|
34940
35374
|
export declare interface JsonApiAutomationPatchRelationships {
|
|
34941
35375
|
/**
|
|
34942
35376
|
*
|
|
34943
|
-
* @type {
|
|
35377
|
+
* @type {JsonApiAutomationPatchRelationshipsNotificationChannel}
|
|
34944
35378
|
* @memberof JsonApiAutomationPatchRelationships
|
|
34945
35379
|
*/
|
|
34946
|
-
notificationChannel?:
|
|
35380
|
+
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
34947
35381
|
/**
|
|
34948
35382
|
*
|
|
34949
|
-
* @type {
|
|
35383
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
34950
35384
|
* @memberof JsonApiAutomationPatchRelationships
|
|
34951
35385
|
*/
|
|
34952
|
-
|
|
35386
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
34953
35387
|
/**
|
|
34954
35388
|
*
|
|
34955
|
-
* @type {
|
|
35389
|
+
* @type {JsonApiAutomationPatchRelationshipsExportDefinitions}
|
|
34956
35390
|
* @memberof JsonApiAutomationPatchRelationships
|
|
34957
35391
|
*/
|
|
34958
|
-
|
|
35392
|
+
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
35393
|
+
/**
|
|
35394
|
+
*
|
|
35395
|
+
* @type {JsonApiAutomationPatchRelationshipsRecipients}
|
|
35396
|
+
* @memberof JsonApiAutomationPatchRelationships
|
|
35397
|
+
*/
|
|
35398
|
+
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
35399
|
+
}
|
|
35400
|
+
|
|
35401
|
+
/**
|
|
35402
|
+
*
|
|
35403
|
+
* @export
|
|
35404
|
+
* @interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard
|
|
35405
|
+
*/
|
|
35406
|
+
export declare interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard {
|
|
35407
|
+
/**
|
|
35408
|
+
*
|
|
35409
|
+
* @type {JsonApiAnalyticalDashboardToOneLinkage}
|
|
35410
|
+
* @memberof JsonApiAutomationPatchRelationshipsAnalyticalDashboard
|
|
35411
|
+
*/
|
|
35412
|
+
data: JsonApiAnalyticalDashboardToOneLinkage | null;
|
|
35413
|
+
}
|
|
35414
|
+
|
|
35415
|
+
/**
|
|
35416
|
+
*
|
|
35417
|
+
* @export
|
|
35418
|
+
* @interface JsonApiAutomationPatchRelationshipsExportDefinitions
|
|
35419
|
+
*/
|
|
35420
|
+
export declare interface JsonApiAutomationPatchRelationshipsExportDefinitions {
|
|
35421
|
+
/**
|
|
35422
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
35423
|
+
* @type {Array<JsonApiExportDefinitionLinkage>}
|
|
35424
|
+
* @memberof JsonApiAutomationPatchRelationshipsExportDefinitions
|
|
35425
|
+
*/
|
|
35426
|
+
data: Array<JsonApiExportDefinitionLinkage>;
|
|
35427
|
+
}
|
|
35428
|
+
|
|
35429
|
+
/**
|
|
35430
|
+
*
|
|
35431
|
+
* @export
|
|
35432
|
+
* @interface JsonApiAutomationPatchRelationshipsNotificationChannel
|
|
35433
|
+
*/
|
|
35434
|
+
export declare interface JsonApiAutomationPatchRelationshipsNotificationChannel {
|
|
35435
|
+
/**
|
|
35436
|
+
*
|
|
35437
|
+
* @type {JsonApiNotificationChannelToOneLinkage}
|
|
35438
|
+
* @memberof JsonApiAutomationPatchRelationshipsNotificationChannel
|
|
35439
|
+
*/
|
|
35440
|
+
data: JsonApiNotificationChannelToOneLinkage | null;
|
|
35441
|
+
}
|
|
35442
|
+
|
|
35443
|
+
/**
|
|
35444
|
+
*
|
|
35445
|
+
* @export
|
|
35446
|
+
* @interface JsonApiAutomationPatchRelationshipsRecipients
|
|
35447
|
+
*/
|
|
35448
|
+
export declare interface JsonApiAutomationPatchRelationshipsRecipients {
|
|
35449
|
+
/**
|
|
35450
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
35451
|
+
* @type {Array<JsonApiUserLinkage>}
|
|
35452
|
+
* @memberof JsonApiAutomationPatchRelationshipsRecipients
|
|
35453
|
+
*/
|
|
35454
|
+
data: Array<JsonApiUserLinkage>;
|
|
34959
35455
|
}
|
|
34960
35456
|
|
|
34961
35457
|
export declare const JsonApiAutomationPatchTypeEnum: {
|
|
@@ -35246,10 +35742,10 @@ export declare interface JsonApiCookieSecurityConfigurationIn {
|
|
|
35246
35742
|
id: string;
|
|
35247
35743
|
/**
|
|
35248
35744
|
*
|
|
35249
|
-
* @type {
|
|
35745
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
35250
35746
|
* @memberof JsonApiCookieSecurityConfigurationIn
|
|
35251
35747
|
*/
|
|
35252
|
-
attributes?:
|
|
35748
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
35253
35749
|
}
|
|
35254
35750
|
|
|
35255
35751
|
/**
|
|
@@ -35292,10 +35788,30 @@ export declare interface JsonApiCookieSecurityConfigurationOut {
|
|
|
35292
35788
|
id: string;
|
|
35293
35789
|
/**
|
|
35294
35790
|
*
|
|
35295
|
-
* @type {
|
|
35791
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
35296
35792
|
* @memberof JsonApiCookieSecurityConfigurationOut
|
|
35297
35793
|
*/
|
|
35298
|
-
attributes?:
|
|
35794
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
35795
|
+
}
|
|
35796
|
+
|
|
35797
|
+
/**
|
|
35798
|
+
*
|
|
35799
|
+
* @export
|
|
35800
|
+
* @interface JsonApiCookieSecurityConfigurationOutAttributes
|
|
35801
|
+
*/
|
|
35802
|
+
export declare interface JsonApiCookieSecurityConfigurationOutAttributes {
|
|
35803
|
+
/**
|
|
35804
|
+
*
|
|
35805
|
+
* @type {string}
|
|
35806
|
+
* @memberof JsonApiCookieSecurityConfigurationOutAttributes
|
|
35807
|
+
*/
|
|
35808
|
+
lastRotation?: string;
|
|
35809
|
+
/**
|
|
35810
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
35811
|
+
* @type {string}
|
|
35812
|
+
* @memberof JsonApiCookieSecurityConfigurationOutAttributes
|
|
35813
|
+
*/
|
|
35814
|
+
rotationInterval?: string;
|
|
35299
35815
|
}
|
|
35300
35816
|
|
|
35301
35817
|
/**
|
|
@@ -35344,30 +35860,10 @@ export declare interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
35344
35860
|
id: string;
|
|
35345
35861
|
/**
|
|
35346
35862
|
*
|
|
35347
|
-
* @type {
|
|
35863
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
35348
35864
|
* @memberof JsonApiCookieSecurityConfigurationPatch
|
|
35349
35865
|
*/
|
|
35350
|
-
attributes?:
|
|
35351
|
-
}
|
|
35352
|
-
|
|
35353
|
-
/**
|
|
35354
|
-
*
|
|
35355
|
-
* @export
|
|
35356
|
-
* @interface JsonApiCookieSecurityConfigurationPatchAttributes
|
|
35357
|
-
*/
|
|
35358
|
-
export declare interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
35359
|
-
/**
|
|
35360
|
-
*
|
|
35361
|
-
* @type {string}
|
|
35362
|
-
* @memberof JsonApiCookieSecurityConfigurationPatchAttributes
|
|
35363
|
-
*/
|
|
35364
|
-
lastRotation?: string;
|
|
35365
|
-
/**
|
|
35366
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
35367
|
-
* @type {string}
|
|
35368
|
-
* @memberof JsonApiCookieSecurityConfigurationPatchAttributes
|
|
35369
|
-
*/
|
|
35370
|
-
rotationInterval?: string;
|
|
35866
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
35371
35867
|
}
|
|
35372
35868
|
|
|
35373
35869
|
/**
|
|
@@ -36752,10 +37248,10 @@ export declare interface JsonApiDatasetOutRelationships {
|
|
|
36752
37248
|
attributes?: JsonApiAttributeHierarchyOutRelationshipsAttributes;
|
|
36753
37249
|
/**
|
|
36754
37250
|
*
|
|
36755
|
-
* @type {
|
|
37251
|
+
* @type {JsonApiMetricOutRelationshipsFacts}
|
|
36756
37252
|
* @memberof JsonApiDatasetOutRelationships
|
|
36757
37253
|
*/
|
|
36758
|
-
facts?:
|
|
37254
|
+
facts?: JsonApiMetricOutRelationshipsFacts;
|
|
36759
37255
|
/**
|
|
36760
37256
|
*
|
|
36761
37257
|
* @type {JsonApiAnalyticalDashboardOutRelationshipsDatasets}
|
|
@@ -36770,20 +37266,6 @@ export declare interface JsonApiDatasetOutRelationships {
|
|
|
36770
37266
|
workspaceDataFilters?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
36771
37267
|
}
|
|
36772
37268
|
|
|
36773
|
-
/**
|
|
36774
|
-
*
|
|
36775
|
-
* @export
|
|
36776
|
-
* @interface JsonApiDatasetOutRelationshipsFacts
|
|
36777
|
-
*/
|
|
36778
|
-
export declare interface JsonApiDatasetOutRelationshipsFacts {
|
|
36779
|
-
/**
|
|
36780
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
36781
|
-
* @type {Array<JsonApiFactLinkage>}
|
|
36782
|
-
* @memberof JsonApiDatasetOutRelationshipsFacts
|
|
36783
|
-
*/
|
|
36784
|
-
data: Array<JsonApiFactLinkage>;
|
|
36785
|
-
}
|
|
36786
|
-
|
|
36787
37269
|
/**
|
|
36788
37270
|
*
|
|
36789
37271
|
* @export
|
|
@@ -37905,10 +38387,10 @@ export declare interface JsonApiExportDefinitionOutAttributes {
|
|
|
37905
38387
|
tags?: Array<string>;
|
|
37906
38388
|
/**
|
|
37907
38389
|
* JSON content to be used as export request payload for /export/tabular and /export/visual endpoints.
|
|
37908
|
-
* @type {
|
|
38390
|
+
* @type {VisualExportRequest | TabularExportRequest}
|
|
37909
38391
|
* @memberof JsonApiExportDefinitionOutAttributes
|
|
37910
38392
|
*/
|
|
37911
|
-
requestPayload?:
|
|
38393
|
+
requestPayload?: VisualExportRequest | TabularExportRequest;
|
|
37912
38394
|
/**
|
|
37913
38395
|
*
|
|
37914
38396
|
* @type {boolean}
|
|
@@ -38001,16 +38483,16 @@ export declare interface JsonApiExportDefinitionOutList {
|
|
|
38001
38483
|
export declare interface JsonApiExportDefinitionOutRelationships {
|
|
38002
38484
|
/**
|
|
38003
38485
|
*
|
|
38004
|
-
* @type {
|
|
38486
|
+
* @type {JsonApiExportDefinitionPatchRelationshipsVisualizationObject}
|
|
38005
38487
|
* @memberof JsonApiExportDefinitionOutRelationships
|
|
38006
38488
|
*/
|
|
38007
|
-
visualizationObject?:
|
|
38489
|
+
visualizationObject?: JsonApiExportDefinitionPatchRelationshipsVisualizationObject;
|
|
38008
38490
|
/**
|
|
38009
38491
|
*
|
|
38010
|
-
* @type {
|
|
38492
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
38011
38493
|
* @memberof JsonApiExportDefinitionOutRelationships
|
|
38012
38494
|
*/
|
|
38013
|
-
analyticalDashboard?:
|
|
38495
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
38014
38496
|
/**
|
|
38015
38497
|
*
|
|
38016
38498
|
* @type {JsonApiAnalyticalDashboardOutRelationshipsCreatedBy}
|
|
@@ -38025,34 +38507,6 @@ export declare interface JsonApiExportDefinitionOutRelationships {
|
|
|
38025
38507
|
modifiedBy?: JsonApiAnalyticalDashboardOutRelationshipsCreatedBy;
|
|
38026
38508
|
}
|
|
38027
38509
|
|
|
38028
|
-
/**
|
|
38029
|
-
*
|
|
38030
|
-
* @export
|
|
38031
|
-
* @interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard
|
|
38032
|
-
*/
|
|
38033
|
-
export declare interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
38034
|
-
/**
|
|
38035
|
-
*
|
|
38036
|
-
* @type {JsonApiAnalyticalDashboardToOneLinkage}
|
|
38037
|
-
* @memberof JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard
|
|
38038
|
-
*/
|
|
38039
|
-
data: JsonApiAnalyticalDashboardToOneLinkage | null;
|
|
38040
|
-
}
|
|
38041
|
-
|
|
38042
|
-
/**
|
|
38043
|
-
*
|
|
38044
|
-
* @export
|
|
38045
|
-
* @interface JsonApiExportDefinitionOutRelationshipsVisualizationObject
|
|
38046
|
-
*/
|
|
38047
|
-
export declare interface JsonApiExportDefinitionOutRelationshipsVisualizationObject {
|
|
38048
|
-
/**
|
|
38049
|
-
*
|
|
38050
|
-
* @type {JsonApiVisualizationObjectToOneLinkage}
|
|
38051
|
-
* @memberof JsonApiExportDefinitionOutRelationshipsVisualizationObject
|
|
38052
|
-
*/
|
|
38053
|
-
data: JsonApiVisualizationObjectToOneLinkage | null;
|
|
38054
|
-
}
|
|
38055
|
-
|
|
38056
38510
|
export declare const JsonApiExportDefinitionOutTypeEnum: {
|
|
38057
38511
|
readonly EXPORT_DEFINITION: "exportDefinition";
|
|
38058
38512
|
};
|
|
@@ -38167,10 +38621,10 @@ export declare interface JsonApiExportDefinitionPatchAttributes {
|
|
|
38167
38621
|
tags?: Array<string>;
|
|
38168
38622
|
/**
|
|
38169
38623
|
* JSON content to be used as export request payload for /export/tabular and /export/visual endpoints.
|
|
38170
|
-
* @type {
|
|
38624
|
+
* @type {VisualExportRequest | TabularExportRequest}
|
|
38171
38625
|
* @memberof JsonApiExportDefinitionPatchAttributes
|
|
38172
38626
|
*/
|
|
38173
|
-
requestPayload?:
|
|
38627
|
+
requestPayload?: VisualExportRequest | TabularExportRequest;
|
|
38174
38628
|
/**
|
|
38175
38629
|
*
|
|
38176
38630
|
* @type {boolean}
|
|
@@ -38201,16 +38655,30 @@ export declare interface JsonApiExportDefinitionPatchDocument {
|
|
|
38201
38655
|
export declare interface JsonApiExportDefinitionPatchRelationships {
|
|
38202
38656
|
/**
|
|
38203
38657
|
*
|
|
38204
|
-
* @type {
|
|
38658
|
+
* @type {JsonApiExportDefinitionPatchRelationshipsVisualizationObject}
|
|
38205
38659
|
* @memberof JsonApiExportDefinitionPatchRelationships
|
|
38206
38660
|
*/
|
|
38207
|
-
visualizationObject?:
|
|
38661
|
+
visualizationObject?: JsonApiExportDefinitionPatchRelationshipsVisualizationObject;
|
|
38208
38662
|
/**
|
|
38209
38663
|
*
|
|
38210
|
-
* @type {
|
|
38664
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
38211
38665
|
* @memberof JsonApiExportDefinitionPatchRelationships
|
|
38212
38666
|
*/
|
|
38213
|
-
analyticalDashboard?:
|
|
38667
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
38668
|
+
}
|
|
38669
|
+
|
|
38670
|
+
/**
|
|
38671
|
+
*
|
|
38672
|
+
* @export
|
|
38673
|
+
* @interface JsonApiExportDefinitionPatchRelationshipsVisualizationObject
|
|
38674
|
+
*/
|
|
38675
|
+
export declare interface JsonApiExportDefinitionPatchRelationshipsVisualizationObject {
|
|
38676
|
+
/**
|
|
38677
|
+
*
|
|
38678
|
+
* @type {JsonApiVisualizationObjectToOneLinkage}
|
|
38679
|
+
* @memberof JsonApiExportDefinitionPatchRelationshipsVisualizationObject
|
|
38680
|
+
*/
|
|
38681
|
+
data: JsonApiVisualizationObjectToOneLinkage | null;
|
|
38214
38682
|
}
|
|
38215
38683
|
|
|
38216
38684
|
export declare const JsonApiExportDefinitionPatchTypeEnum: {
|
|
@@ -39444,48 +39912,10 @@ export declare interface JsonApiMetricIn {
|
|
|
39444
39912
|
id: string;
|
|
39445
39913
|
/**
|
|
39446
39914
|
*
|
|
39447
|
-
* @type {
|
|
39915
|
+
* @type {JsonApiMetricPostOptionalIdAttributes}
|
|
39448
39916
|
* @memberof JsonApiMetricIn
|
|
39449
39917
|
*/
|
|
39450
|
-
attributes:
|
|
39451
|
-
}
|
|
39452
|
-
|
|
39453
|
-
/**
|
|
39454
|
-
*
|
|
39455
|
-
* @export
|
|
39456
|
-
* @interface JsonApiMetricInAttributes
|
|
39457
|
-
*/
|
|
39458
|
-
export declare interface JsonApiMetricInAttributes {
|
|
39459
|
-
/**
|
|
39460
|
-
*
|
|
39461
|
-
* @type {string}
|
|
39462
|
-
* @memberof JsonApiMetricInAttributes
|
|
39463
|
-
*/
|
|
39464
|
-
title?: string;
|
|
39465
|
-
/**
|
|
39466
|
-
*
|
|
39467
|
-
* @type {string}
|
|
39468
|
-
* @memberof JsonApiMetricInAttributes
|
|
39469
|
-
*/
|
|
39470
|
-
description?: string;
|
|
39471
|
-
/**
|
|
39472
|
-
*
|
|
39473
|
-
* @type {Array<string>}
|
|
39474
|
-
* @memberof JsonApiMetricInAttributes
|
|
39475
|
-
*/
|
|
39476
|
-
tags?: Array<string>;
|
|
39477
|
-
/**
|
|
39478
|
-
*
|
|
39479
|
-
* @type {boolean}
|
|
39480
|
-
* @memberof JsonApiMetricInAttributes
|
|
39481
|
-
*/
|
|
39482
|
-
areRelationsValid?: boolean;
|
|
39483
|
-
/**
|
|
39484
|
-
*
|
|
39485
|
-
* @type {JsonApiMetricOutAttributesContent}
|
|
39486
|
-
* @memberof JsonApiMetricInAttributes
|
|
39487
|
-
*/
|
|
39488
|
-
content: JsonApiMetricOutAttributesContent;
|
|
39918
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
39489
39919
|
}
|
|
39490
39920
|
|
|
39491
39921
|
/**
|
|
@@ -39604,10 +40034,10 @@ export declare interface JsonApiMetricOutAttributes {
|
|
|
39604
40034
|
areRelationsValid?: boolean;
|
|
39605
40035
|
/**
|
|
39606
40036
|
*
|
|
39607
|
-
* @type {
|
|
40037
|
+
* @type {JsonApiMetricPatchAttributesContent}
|
|
39608
40038
|
* @memberof JsonApiMetricOutAttributes
|
|
39609
40039
|
*/
|
|
39610
|
-
content:
|
|
40040
|
+
content: JsonApiMetricPatchAttributesContent;
|
|
39611
40041
|
/**
|
|
39612
40042
|
*
|
|
39613
40043
|
* @type {string}
|
|
@@ -39622,26 +40052,6 @@ export declare interface JsonApiMetricOutAttributes {
|
|
|
39622
40052
|
modifiedAt?: string;
|
|
39623
40053
|
}
|
|
39624
40054
|
|
|
39625
|
-
/**
|
|
39626
|
-
*
|
|
39627
|
-
* @export
|
|
39628
|
-
* @interface JsonApiMetricOutAttributesContent
|
|
39629
|
-
*/
|
|
39630
|
-
export declare interface JsonApiMetricOutAttributesContent {
|
|
39631
|
-
/**
|
|
39632
|
-
*
|
|
39633
|
-
* @type {string}
|
|
39634
|
-
* @memberof JsonApiMetricOutAttributesContent
|
|
39635
|
-
*/
|
|
39636
|
-
format?: string;
|
|
39637
|
-
/**
|
|
39638
|
-
*
|
|
39639
|
-
* @type {string}
|
|
39640
|
-
* @memberof JsonApiMetricOutAttributesContent
|
|
39641
|
-
*/
|
|
39642
|
-
maql: string;
|
|
39643
|
-
}
|
|
39644
|
-
|
|
39645
40055
|
/**
|
|
39646
40056
|
*
|
|
39647
40057
|
* @export
|
|
@@ -39726,10 +40136,10 @@ export declare interface JsonApiMetricOutRelationships {
|
|
|
39726
40136
|
modifiedBy?: JsonApiAnalyticalDashboardOutRelationshipsCreatedBy;
|
|
39727
40137
|
/**
|
|
39728
40138
|
*
|
|
39729
|
-
* @type {
|
|
40139
|
+
* @type {JsonApiMetricOutRelationshipsFacts}
|
|
39730
40140
|
* @memberof JsonApiMetricOutRelationships
|
|
39731
40141
|
*/
|
|
39732
|
-
facts?:
|
|
40142
|
+
facts?: JsonApiMetricOutRelationshipsFacts;
|
|
39733
40143
|
/**
|
|
39734
40144
|
*
|
|
39735
40145
|
* @type {JsonApiAttributeHierarchyOutRelationshipsAttributes}
|
|
@@ -39756,6 +40166,20 @@ export declare interface JsonApiMetricOutRelationships {
|
|
|
39756
40166
|
datasets?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
39757
40167
|
}
|
|
39758
40168
|
|
|
40169
|
+
/**
|
|
40170
|
+
*
|
|
40171
|
+
* @export
|
|
40172
|
+
* @interface JsonApiMetricOutRelationshipsFacts
|
|
40173
|
+
*/
|
|
40174
|
+
export declare interface JsonApiMetricOutRelationshipsFacts {
|
|
40175
|
+
/**
|
|
40176
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
40177
|
+
* @type {Array<JsonApiFactLinkage>}
|
|
40178
|
+
* @memberof JsonApiMetricOutRelationshipsFacts
|
|
40179
|
+
*/
|
|
40180
|
+
data: Array<JsonApiFactLinkage>;
|
|
40181
|
+
}
|
|
40182
|
+
|
|
39759
40183
|
export declare const JsonApiMetricOutTypeEnum: {
|
|
39760
40184
|
readonly METRIC: "metric";
|
|
39761
40185
|
};
|
|
@@ -39870,10 +40294,30 @@ export declare interface JsonApiMetricPatchAttributes {
|
|
|
39870
40294
|
areRelationsValid?: boolean;
|
|
39871
40295
|
/**
|
|
39872
40296
|
*
|
|
39873
|
-
* @type {
|
|
40297
|
+
* @type {JsonApiMetricPatchAttributesContent}
|
|
39874
40298
|
* @memberof JsonApiMetricPatchAttributes
|
|
39875
40299
|
*/
|
|
39876
|
-
content?:
|
|
40300
|
+
content?: JsonApiMetricPatchAttributesContent;
|
|
40301
|
+
}
|
|
40302
|
+
|
|
40303
|
+
/**
|
|
40304
|
+
*
|
|
40305
|
+
* @export
|
|
40306
|
+
* @interface JsonApiMetricPatchAttributesContent
|
|
40307
|
+
*/
|
|
40308
|
+
export declare interface JsonApiMetricPatchAttributesContent {
|
|
40309
|
+
/**
|
|
40310
|
+
*
|
|
40311
|
+
* @type {string}
|
|
40312
|
+
* @memberof JsonApiMetricPatchAttributesContent
|
|
40313
|
+
*/
|
|
40314
|
+
format?: string;
|
|
40315
|
+
/**
|
|
40316
|
+
*
|
|
40317
|
+
* @type {string}
|
|
40318
|
+
* @memberof JsonApiMetricPatchAttributesContent
|
|
40319
|
+
*/
|
|
40320
|
+
maql: string;
|
|
39877
40321
|
}
|
|
39878
40322
|
|
|
39879
40323
|
/**
|
|
@@ -39916,10 +40360,48 @@ export declare interface JsonApiMetricPostOptionalId {
|
|
|
39916
40360
|
id?: string;
|
|
39917
40361
|
/**
|
|
39918
40362
|
*
|
|
39919
|
-
* @type {
|
|
40363
|
+
* @type {JsonApiMetricPostOptionalIdAttributes}
|
|
39920
40364
|
* @memberof JsonApiMetricPostOptionalId
|
|
39921
40365
|
*/
|
|
39922
|
-
attributes:
|
|
40366
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
40367
|
+
}
|
|
40368
|
+
|
|
40369
|
+
/**
|
|
40370
|
+
*
|
|
40371
|
+
* @export
|
|
40372
|
+
* @interface JsonApiMetricPostOptionalIdAttributes
|
|
40373
|
+
*/
|
|
40374
|
+
export declare interface JsonApiMetricPostOptionalIdAttributes {
|
|
40375
|
+
/**
|
|
40376
|
+
*
|
|
40377
|
+
* @type {string}
|
|
40378
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
40379
|
+
*/
|
|
40380
|
+
title?: string;
|
|
40381
|
+
/**
|
|
40382
|
+
*
|
|
40383
|
+
* @type {string}
|
|
40384
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
40385
|
+
*/
|
|
40386
|
+
description?: string;
|
|
40387
|
+
/**
|
|
40388
|
+
*
|
|
40389
|
+
* @type {Array<string>}
|
|
40390
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
40391
|
+
*/
|
|
40392
|
+
tags?: Array<string>;
|
|
40393
|
+
/**
|
|
40394
|
+
*
|
|
40395
|
+
* @type {boolean}
|
|
40396
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
40397
|
+
*/
|
|
40398
|
+
areRelationsValid?: boolean;
|
|
40399
|
+
/**
|
|
40400
|
+
*
|
|
40401
|
+
* @type {JsonApiMetricPatchAttributesContent}
|
|
40402
|
+
* @memberof JsonApiMetricPostOptionalIdAttributes
|
|
40403
|
+
*/
|
|
40404
|
+
content: JsonApiMetricPatchAttributesContent;
|
|
39923
40405
|
}
|
|
39924
40406
|
|
|
39925
40407
|
/**
|
|
@@ -39986,12 +40468,18 @@ export declare interface JsonApiNotificationChannelInAttributes {
|
|
|
39986
40468
|
* @memberof JsonApiNotificationChannelInAttributes
|
|
39987
40469
|
*/
|
|
39988
40470
|
description?: string | null;
|
|
40471
|
+
/**
|
|
40472
|
+
* The destination where the notifications are to be sent.
|
|
40473
|
+
* @type {Webhook}
|
|
40474
|
+
* @memberof JsonApiNotificationChannelInAttributes
|
|
40475
|
+
*/
|
|
40476
|
+
destination?: Webhook;
|
|
39989
40477
|
/**
|
|
39990
40478
|
*
|
|
39991
|
-
* @type {
|
|
40479
|
+
* @type {string}
|
|
39992
40480
|
* @memberof JsonApiNotificationChannelInAttributes
|
|
39993
40481
|
*/
|
|
39994
|
-
|
|
40482
|
+
destinationType?: JsonApiNotificationChannelInAttributesDestinationTypeEnum;
|
|
39995
40483
|
/**
|
|
39996
40484
|
* The triggers that are to be used to send notifications to the channel.
|
|
39997
40485
|
* @type {Array<JsonApiNotificationChannelInAttributesTriggers>}
|
|
@@ -40000,6 +40488,12 @@ export declare interface JsonApiNotificationChannelInAttributes {
|
|
|
40000
40488
|
triggers?: Array<JsonApiNotificationChannelInAttributesTriggers>;
|
|
40001
40489
|
}
|
|
40002
40490
|
|
|
40491
|
+
export declare const JsonApiNotificationChannelInAttributesDestinationTypeEnum: {
|
|
40492
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
40493
|
+
};
|
|
40494
|
+
|
|
40495
|
+
export declare type JsonApiNotificationChannelInAttributesDestinationTypeEnum = typeof JsonApiNotificationChannelInAttributesDestinationTypeEnum[keyof typeof JsonApiNotificationChannelInAttributesDestinationTypeEnum];
|
|
40496
|
+
|
|
40003
40497
|
/**
|
|
40004
40498
|
*
|
|
40005
40499
|
* @export
|
|
@@ -40027,32 +40521,6 @@ export declare const JsonApiNotificationChannelInAttributesTriggersTypeEnum: {
|
|
|
40027
40521
|
|
|
40028
40522
|
export declare type JsonApiNotificationChannelInAttributesTriggersTypeEnum = typeof JsonApiNotificationChannelInAttributesTriggersTypeEnum[keyof typeof JsonApiNotificationChannelInAttributesTriggersTypeEnum];
|
|
40029
40523
|
|
|
40030
|
-
/**
|
|
40031
|
-
*
|
|
40032
|
-
* @export
|
|
40033
|
-
* @interface JsonApiNotificationChannelInAttributesWebhook
|
|
40034
|
-
*/
|
|
40035
|
-
export declare interface JsonApiNotificationChannelInAttributesWebhook {
|
|
40036
|
-
/**
|
|
40037
|
-
* The webhook URL.
|
|
40038
|
-
* @type {string}
|
|
40039
|
-
* @memberof JsonApiNotificationChannelInAttributesWebhook
|
|
40040
|
-
*/
|
|
40041
|
-
url: string;
|
|
40042
|
-
/**
|
|
40043
|
-
* Bearer token for the webhook.
|
|
40044
|
-
* @type {string}
|
|
40045
|
-
* @memberof JsonApiNotificationChannelInAttributesWebhook
|
|
40046
|
-
*/
|
|
40047
|
-
token?: string | null;
|
|
40048
|
-
/**
|
|
40049
|
-
*
|
|
40050
|
-
* @type {boolean}
|
|
40051
|
-
* @memberof JsonApiNotificationChannelInAttributesWebhook
|
|
40052
|
-
*/
|
|
40053
|
-
hasToken?: boolean;
|
|
40054
|
-
}
|
|
40055
|
-
|
|
40056
40524
|
/**
|
|
40057
40525
|
*
|
|
40058
40526
|
* @export
|
|
@@ -40561,16 +41029,44 @@ export declare type JsonApiOrganizationOutMetaPermissionsEnum = typeof JsonApiOr
|
|
|
40561
41029
|
export declare interface JsonApiOrganizationOutRelationships {
|
|
40562
41030
|
/**
|
|
40563
41031
|
*
|
|
40564
|
-
* @type {
|
|
41032
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
40565
41033
|
* @memberof JsonApiOrganizationOutRelationships
|
|
40566
41034
|
*/
|
|
40567
|
-
bootstrapUser?:
|
|
41035
|
+
bootstrapUser?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
40568
41036
|
/**
|
|
40569
41037
|
*
|
|
40570
|
-
* @type {
|
|
41038
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
40571
41039
|
* @memberof JsonApiOrganizationOutRelationships
|
|
40572
41040
|
*/
|
|
40573
|
-
bootstrapUserGroup?:
|
|
41041
|
+
bootstrapUserGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
41042
|
+
}
|
|
41043
|
+
|
|
41044
|
+
/**
|
|
41045
|
+
*
|
|
41046
|
+
* @export
|
|
41047
|
+
* @interface JsonApiOrganizationOutRelationshipsBootstrapUser
|
|
41048
|
+
*/
|
|
41049
|
+
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
41050
|
+
/**
|
|
41051
|
+
*
|
|
41052
|
+
* @type {JsonApiUserToOneLinkage}
|
|
41053
|
+
* @memberof JsonApiOrganizationOutRelationshipsBootstrapUser
|
|
41054
|
+
*/
|
|
41055
|
+
data: JsonApiUserToOneLinkage | null;
|
|
41056
|
+
}
|
|
41057
|
+
|
|
41058
|
+
/**
|
|
41059
|
+
*
|
|
41060
|
+
* @export
|
|
41061
|
+
* @interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup
|
|
41062
|
+
*/
|
|
41063
|
+
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
41064
|
+
/**
|
|
41065
|
+
*
|
|
41066
|
+
* @type {JsonApiUserGroupToOneLinkage}
|
|
41067
|
+
* @memberof JsonApiOrganizationOutRelationshipsBootstrapUserGroup
|
|
41068
|
+
*/
|
|
41069
|
+
data: JsonApiUserGroupToOneLinkage | null;
|
|
40574
41070
|
}
|
|
40575
41071
|
|
|
40576
41072
|
export declare const JsonApiOrganizationOutTypeEnum: {
|
|
@@ -40720,12 +41216,51 @@ export declare interface JsonApiOrganizationSettingIn {
|
|
|
40720
41216
|
id: string;
|
|
40721
41217
|
/**
|
|
40722
41218
|
*
|
|
40723
|
-
* @type {
|
|
41219
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
40724
41220
|
* @memberof JsonApiOrganizationSettingIn
|
|
40725
41221
|
*/
|
|
40726
|
-
attributes?:
|
|
41222
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
40727
41223
|
}
|
|
40728
41224
|
|
|
41225
|
+
/**
|
|
41226
|
+
*
|
|
41227
|
+
* @export
|
|
41228
|
+
* @interface JsonApiOrganizationSettingInAttributes
|
|
41229
|
+
*/
|
|
41230
|
+
export declare interface JsonApiOrganizationSettingInAttributes {
|
|
41231
|
+
/**
|
|
41232
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
41233
|
+
* @type {object}
|
|
41234
|
+
* @memberof JsonApiOrganizationSettingInAttributes
|
|
41235
|
+
*/
|
|
41236
|
+
content?: object;
|
|
41237
|
+
/**
|
|
41238
|
+
*
|
|
41239
|
+
* @type {string}
|
|
41240
|
+
* @memberof JsonApiOrganizationSettingInAttributes
|
|
41241
|
+
*/
|
|
41242
|
+
type?: JsonApiOrganizationSettingInAttributesTypeEnum;
|
|
41243
|
+
}
|
|
41244
|
+
|
|
41245
|
+
export declare const JsonApiOrganizationSettingInAttributesTypeEnum: {
|
|
41246
|
+
readonly TIMEZONE: "TIMEZONE";
|
|
41247
|
+
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
41248
|
+
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
41249
|
+
readonly WHITE_LABELING: "WHITE_LABELING";
|
|
41250
|
+
readonly LOCALE: "LOCALE";
|
|
41251
|
+
readonly METADATA_LOCALE: "METADATA_LOCALE";
|
|
41252
|
+
readonly FORMAT_LOCALE: "FORMAT_LOCALE";
|
|
41253
|
+
readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
|
|
41254
|
+
readonly WEEK_START: "WEEK_START";
|
|
41255
|
+
readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
|
|
41256
|
+
readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
|
|
41257
|
+
readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
|
|
41258
|
+
readonly OPENAI_CONFIG: "OPENAI_CONFIG";
|
|
41259
|
+
readonly ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS";
|
|
41260
|
+
};
|
|
41261
|
+
|
|
41262
|
+
export declare type JsonApiOrganizationSettingInAttributesTypeEnum = typeof JsonApiOrganizationSettingInAttributesTypeEnum[keyof typeof JsonApiOrganizationSettingInAttributesTypeEnum];
|
|
41263
|
+
|
|
40729
41264
|
/**
|
|
40730
41265
|
*
|
|
40731
41266
|
* @export
|
|
@@ -40766,10 +41301,10 @@ export declare interface JsonApiOrganizationSettingOut {
|
|
|
40766
41301
|
id: string;
|
|
40767
41302
|
/**
|
|
40768
41303
|
*
|
|
40769
|
-
* @type {
|
|
41304
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
40770
41305
|
* @memberof JsonApiOrganizationSettingOut
|
|
40771
41306
|
*/
|
|
40772
|
-
attributes?:
|
|
41307
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
40773
41308
|
}
|
|
40774
41309
|
|
|
40775
41310
|
/**
|
|
@@ -40844,10 +41379,10 @@ export declare interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
40844
41379
|
id: string;
|
|
40845
41380
|
/**
|
|
40846
41381
|
*
|
|
40847
|
-
* @type {
|
|
41382
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
40848
41383
|
* @memberof JsonApiOrganizationSettingOutWithLinks
|
|
40849
41384
|
*/
|
|
40850
|
-
attributes?:
|
|
41385
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
40851
41386
|
/**
|
|
40852
41387
|
*
|
|
40853
41388
|
* @type {ObjectLinks}
|
|
@@ -40882,10 +41417,10 @@ export declare interface JsonApiOrganizationSettingPatch {
|
|
|
40882
41417
|
id: string;
|
|
40883
41418
|
/**
|
|
40884
41419
|
*
|
|
40885
|
-
* @type {
|
|
41420
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
40886
41421
|
* @memberof JsonApiOrganizationSettingPatch
|
|
40887
41422
|
*/
|
|
40888
|
-
attributes?:
|
|
41423
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
40889
41424
|
}
|
|
40890
41425
|
|
|
40891
41426
|
/**
|
|
@@ -41316,22 +41851,22 @@ export declare interface JsonApiUserDataFilterOutList {
|
|
|
41316
41851
|
export declare interface JsonApiUserDataFilterOutRelationships {
|
|
41317
41852
|
/**
|
|
41318
41853
|
*
|
|
41319
|
-
* @type {
|
|
41854
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
41320
41855
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
41321
41856
|
*/
|
|
41322
|
-
user?:
|
|
41857
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
41323
41858
|
/**
|
|
41324
41859
|
*
|
|
41325
|
-
* @type {
|
|
41860
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
41326
41861
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
41327
41862
|
*/
|
|
41328
|
-
userGroup?:
|
|
41863
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
41329
41864
|
/**
|
|
41330
41865
|
*
|
|
41331
|
-
* @type {
|
|
41866
|
+
* @type {JsonApiMetricOutRelationshipsFacts}
|
|
41332
41867
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
41333
41868
|
*/
|
|
41334
|
-
facts?:
|
|
41869
|
+
facts?: JsonApiMetricOutRelationshipsFacts;
|
|
41335
41870
|
/**
|
|
41336
41871
|
*
|
|
41337
41872
|
* @type {JsonApiAttributeHierarchyOutRelationshipsAttributes}
|
|
@@ -41358,34 +41893,6 @@ export declare interface JsonApiUserDataFilterOutRelationships {
|
|
|
41358
41893
|
datasets?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
41359
41894
|
}
|
|
41360
41895
|
|
|
41361
|
-
/**
|
|
41362
|
-
*
|
|
41363
|
-
* @export
|
|
41364
|
-
* @interface JsonApiUserDataFilterOutRelationshipsUser
|
|
41365
|
-
*/
|
|
41366
|
-
export declare interface JsonApiUserDataFilterOutRelationshipsUser {
|
|
41367
|
-
/**
|
|
41368
|
-
*
|
|
41369
|
-
* @type {JsonApiUserToOneLinkage}
|
|
41370
|
-
* @memberof JsonApiUserDataFilterOutRelationshipsUser
|
|
41371
|
-
*/
|
|
41372
|
-
data: JsonApiUserToOneLinkage | null;
|
|
41373
|
-
}
|
|
41374
|
-
|
|
41375
|
-
/**
|
|
41376
|
-
*
|
|
41377
|
-
* @export
|
|
41378
|
-
* @interface JsonApiUserDataFilterOutRelationshipsUserGroup
|
|
41379
|
-
*/
|
|
41380
|
-
export declare interface JsonApiUserDataFilterOutRelationshipsUserGroup {
|
|
41381
|
-
/**
|
|
41382
|
-
*
|
|
41383
|
-
* @type {JsonApiUserGroupToOneLinkage}
|
|
41384
|
-
* @memberof JsonApiUserDataFilterOutRelationshipsUserGroup
|
|
41385
|
-
*/
|
|
41386
|
-
data: JsonApiUserGroupToOneLinkage | null;
|
|
41387
|
-
}
|
|
41388
|
-
|
|
41389
41896
|
export declare const JsonApiUserDataFilterOutTypeEnum: {
|
|
41390
41897
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
41391
41898
|
};
|
|
@@ -41534,16 +42041,16 @@ export declare interface JsonApiUserDataFilterPatchDocument {
|
|
|
41534
42041
|
export declare interface JsonApiUserDataFilterPatchRelationships {
|
|
41535
42042
|
/**
|
|
41536
42043
|
*
|
|
41537
|
-
* @type {
|
|
42044
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
41538
42045
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
41539
42046
|
*/
|
|
41540
|
-
user?:
|
|
42047
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
41541
42048
|
/**
|
|
41542
42049
|
*
|
|
41543
|
-
* @type {
|
|
42050
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
41544
42051
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
41545
42052
|
*/
|
|
41546
|
-
userGroup?:
|
|
42053
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
41547
42054
|
}
|
|
41548
42055
|
|
|
41549
42056
|
export declare const JsonApiUserDataFilterPatchTypeEnum: {
|
|
@@ -42434,10 +42941,10 @@ export declare interface JsonApiUserSettingIn {
|
|
|
42434
42941
|
id: string;
|
|
42435
42942
|
/**
|
|
42436
42943
|
*
|
|
42437
|
-
* @type {
|
|
42944
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
42438
42945
|
* @memberof JsonApiUserSettingIn
|
|
42439
42946
|
*/
|
|
42440
|
-
attributes?:
|
|
42947
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
42441
42948
|
}
|
|
42442
42949
|
|
|
42443
42950
|
/**
|
|
@@ -42480,10 +42987,10 @@ export declare interface JsonApiUserSettingOut {
|
|
|
42480
42987
|
id: string;
|
|
42481
42988
|
/**
|
|
42482
42989
|
*
|
|
42483
|
-
* @type {
|
|
42990
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
42484
42991
|
* @memberof JsonApiUserSettingOut
|
|
42485
42992
|
*/
|
|
42486
|
-
attributes?:
|
|
42993
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
42487
42994
|
}
|
|
42488
42995
|
|
|
42489
42996
|
/**
|
|
@@ -42558,10 +43065,10 @@ export declare interface JsonApiUserSettingOutWithLinks {
|
|
|
42558
43065
|
id: string;
|
|
42559
43066
|
/**
|
|
42560
43067
|
*
|
|
42561
|
-
* @type {
|
|
43068
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
42562
43069
|
* @memberof JsonApiUserSettingOutWithLinks
|
|
42563
43070
|
*/
|
|
42564
|
-
attributes?:
|
|
43071
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
42565
43072
|
/**
|
|
42566
43073
|
*
|
|
42567
43074
|
* @type {ObjectLinks}
|
|
@@ -42926,16 +43433,16 @@ export declare interface JsonApiWorkspaceDataFilterIn {
|
|
|
42926
43433
|
id: string;
|
|
42927
43434
|
/**
|
|
42928
43435
|
*
|
|
42929
|
-
* @type {
|
|
43436
|
+
* @type {JsonApiWorkspaceDataFilterPatchAttributes}
|
|
42930
43437
|
* @memberof JsonApiWorkspaceDataFilterIn
|
|
42931
43438
|
*/
|
|
42932
|
-
attributes?:
|
|
43439
|
+
attributes?: JsonApiWorkspaceDataFilterPatchAttributes;
|
|
42933
43440
|
/**
|
|
42934
43441
|
*
|
|
42935
|
-
* @type {
|
|
43442
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationships}
|
|
42936
43443
|
* @memberof JsonApiWorkspaceDataFilterIn
|
|
42937
43444
|
*/
|
|
42938
|
-
relationships?:
|
|
43445
|
+
relationships?: JsonApiWorkspaceDataFilterPatchRelationships;
|
|
42939
43446
|
}
|
|
42940
43447
|
|
|
42941
43448
|
/**
|
|
@@ -43010,40 +43517,186 @@ export declare interface JsonApiWorkspaceDataFilterOut {
|
|
|
43010
43517
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
43011
43518
|
/**
|
|
43012
43519
|
*
|
|
43013
|
-
* @type {
|
|
43520
|
+
* @type {JsonApiWorkspaceDataFilterPatchAttributes}
|
|
43014
43521
|
* @memberof JsonApiWorkspaceDataFilterOut
|
|
43015
43522
|
*/
|
|
43016
|
-
attributes?:
|
|
43523
|
+
attributes?: JsonApiWorkspaceDataFilterPatchAttributes;
|
|
43017
43524
|
/**
|
|
43018
43525
|
*
|
|
43019
|
-
* @type {
|
|
43526
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationships}
|
|
43020
43527
|
* @memberof JsonApiWorkspaceDataFilterOut
|
|
43021
43528
|
*/
|
|
43022
|
-
relationships?:
|
|
43529
|
+
relationships?: JsonApiWorkspaceDataFilterPatchRelationships;
|
|
43530
|
+
}
|
|
43531
|
+
|
|
43532
|
+
/**
|
|
43533
|
+
*
|
|
43534
|
+
* @export
|
|
43535
|
+
* @interface JsonApiWorkspaceDataFilterOutDocument
|
|
43536
|
+
*/
|
|
43537
|
+
export declare interface JsonApiWorkspaceDataFilterOutDocument {
|
|
43538
|
+
/**
|
|
43539
|
+
*
|
|
43540
|
+
* @type {JsonApiWorkspaceDataFilterOut}
|
|
43541
|
+
* @memberof JsonApiWorkspaceDataFilterOutDocument
|
|
43542
|
+
*/
|
|
43543
|
+
data: JsonApiWorkspaceDataFilterOut;
|
|
43544
|
+
/**
|
|
43545
|
+
*
|
|
43546
|
+
* @type {ObjectLinks}
|
|
43547
|
+
* @memberof JsonApiWorkspaceDataFilterOutDocument
|
|
43548
|
+
*/
|
|
43549
|
+
links?: ObjectLinks;
|
|
43550
|
+
/**
|
|
43551
|
+
* Included resources
|
|
43552
|
+
* @type {Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>}
|
|
43553
|
+
* @memberof JsonApiWorkspaceDataFilterOutDocument
|
|
43554
|
+
*/
|
|
43555
|
+
included?: Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>;
|
|
43556
|
+
}
|
|
43557
|
+
|
|
43558
|
+
/**
|
|
43559
|
+
* A JSON:API document with a list of resources
|
|
43560
|
+
* @export
|
|
43561
|
+
* @interface JsonApiWorkspaceDataFilterOutList
|
|
43562
|
+
*/
|
|
43563
|
+
export declare interface JsonApiWorkspaceDataFilterOutList {
|
|
43564
|
+
/**
|
|
43565
|
+
*
|
|
43566
|
+
* @type {Array<JsonApiWorkspaceDataFilterOutWithLinks>}
|
|
43567
|
+
* @memberof JsonApiWorkspaceDataFilterOutList
|
|
43568
|
+
*/
|
|
43569
|
+
data: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
43570
|
+
/**
|
|
43571
|
+
*
|
|
43572
|
+
* @type {ListLinks}
|
|
43573
|
+
* @memberof JsonApiWorkspaceDataFilterOutList
|
|
43574
|
+
*/
|
|
43575
|
+
links?: ListLinks;
|
|
43576
|
+
/**
|
|
43577
|
+
*
|
|
43578
|
+
* @type {JsonApiColorPaletteOutListMeta}
|
|
43579
|
+
* @memberof JsonApiWorkspaceDataFilterOutList
|
|
43580
|
+
*/
|
|
43581
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
43582
|
+
/**
|
|
43583
|
+
* Included resources
|
|
43584
|
+
* @type {Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>}
|
|
43585
|
+
* @memberof JsonApiWorkspaceDataFilterOutList
|
|
43586
|
+
*/
|
|
43587
|
+
included?: Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>;
|
|
43588
|
+
}
|
|
43589
|
+
|
|
43590
|
+
export declare const JsonApiWorkspaceDataFilterOutTypeEnum: {
|
|
43591
|
+
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
43592
|
+
};
|
|
43593
|
+
|
|
43594
|
+
export declare type JsonApiWorkspaceDataFilterOutTypeEnum = typeof JsonApiWorkspaceDataFilterOutTypeEnum[keyof typeof JsonApiWorkspaceDataFilterOutTypeEnum];
|
|
43595
|
+
|
|
43596
|
+
/**
|
|
43597
|
+
*
|
|
43598
|
+
* @export
|
|
43599
|
+
* @interface JsonApiWorkspaceDataFilterOutWithLinks
|
|
43600
|
+
*/
|
|
43601
|
+
export declare interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
43602
|
+
/**
|
|
43603
|
+
* Object type
|
|
43604
|
+
* @type {string}
|
|
43605
|
+
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43606
|
+
*/
|
|
43607
|
+
type: JsonApiWorkspaceDataFilterOutWithLinksTypeEnum;
|
|
43608
|
+
/**
|
|
43609
|
+
* API identifier of an object
|
|
43610
|
+
* @type {string}
|
|
43611
|
+
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43612
|
+
*/
|
|
43613
|
+
id: string;
|
|
43614
|
+
/**
|
|
43615
|
+
*
|
|
43616
|
+
* @type {JsonApiAttributeHierarchyOutMeta}
|
|
43617
|
+
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43618
|
+
*/
|
|
43619
|
+
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
43620
|
+
/**
|
|
43621
|
+
*
|
|
43622
|
+
* @type {JsonApiWorkspaceDataFilterPatchAttributes}
|
|
43623
|
+
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43624
|
+
*/
|
|
43625
|
+
attributes?: JsonApiWorkspaceDataFilterPatchAttributes;
|
|
43626
|
+
/**
|
|
43627
|
+
*
|
|
43628
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationships}
|
|
43629
|
+
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43630
|
+
*/
|
|
43631
|
+
relationships?: JsonApiWorkspaceDataFilterPatchRelationships;
|
|
43632
|
+
/**
|
|
43633
|
+
*
|
|
43634
|
+
* @type {ObjectLinks}
|
|
43635
|
+
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43636
|
+
*/
|
|
43637
|
+
links?: ObjectLinks;
|
|
43638
|
+
}
|
|
43639
|
+
|
|
43640
|
+
export declare const JsonApiWorkspaceDataFilterOutWithLinksTypeEnum: {
|
|
43641
|
+
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
43642
|
+
};
|
|
43643
|
+
|
|
43644
|
+
export declare type JsonApiWorkspaceDataFilterOutWithLinksTypeEnum = typeof JsonApiWorkspaceDataFilterOutWithLinksTypeEnum[keyof typeof JsonApiWorkspaceDataFilterOutWithLinksTypeEnum];
|
|
43645
|
+
|
|
43646
|
+
/**
|
|
43647
|
+
* JSON:API representation of patching workspaceDataFilter entity.
|
|
43648
|
+
* @export
|
|
43649
|
+
* @interface JsonApiWorkspaceDataFilterPatch
|
|
43650
|
+
*/
|
|
43651
|
+
export declare interface JsonApiWorkspaceDataFilterPatch {
|
|
43652
|
+
/**
|
|
43653
|
+
* Object type
|
|
43654
|
+
* @type {string}
|
|
43655
|
+
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
43656
|
+
*/
|
|
43657
|
+
type: JsonApiWorkspaceDataFilterPatchTypeEnum;
|
|
43658
|
+
/**
|
|
43659
|
+
* API identifier of an object
|
|
43660
|
+
* @type {string}
|
|
43661
|
+
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
43662
|
+
*/
|
|
43663
|
+
id: string;
|
|
43664
|
+
/**
|
|
43665
|
+
*
|
|
43666
|
+
* @type {JsonApiWorkspaceDataFilterPatchAttributes}
|
|
43667
|
+
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
43668
|
+
*/
|
|
43669
|
+
attributes?: JsonApiWorkspaceDataFilterPatchAttributes;
|
|
43670
|
+
/**
|
|
43671
|
+
*
|
|
43672
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationships}
|
|
43673
|
+
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
43674
|
+
*/
|
|
43675
|
+
relationships?: JsonApiWorkspaceDataFilterPatchRelationships;
|
|
43023
43676
|
}
|
|
43024
43677
|
|
|
43025
43678
|
/**
|
|
43026
43679
|
*
|
|
43027
43680
|
* @export
|
|
43028
|
-
* @interface
|
|
43681
|
+
* @interface JsonApiWorkspaceDataFilterPatchAttributes
|
|
43029
43682
|
*/
|
|
43030
|
-
export declare interface
|
|
43683
|
+
export declare interface JsonApiWorkspaceDataFilterPatchAttributes {
|
|
43031
43684
|
/**
|
|
43032
43685
|
*
|
|
43033
43686
|
* @type {string}
|
|
43034
|
-
* @memberof
|
|
43687
|
+
* @memberof JsonApiWorkspaceDataFilterPatchAttributes
|
|
43035
43688
|
*/
|
|
43036
43689
|
title?: string;
|
|
43037
43690
|
/**
|
|
43038
43691
|
*
|
|
43039
43692
|
* @type {string}
|
|
43040
|
-
* @memberof
|
|
43693
|
+
* @memberof JsonApiWorkspaceDataFilterPatchAttributes
|
|
43041
43694
|
*/
|
|
43042
43695
|
description?: string;
|
|
43043
43696
|
/**
|
|
43044
43697
|
*
|
|
43045
43698
|
* @type {string}
|
|
43046
|
-
* @memberof
|
|
43699
|
+
* @memberof JsonApiWorkspaceDataFilterPatchAttributes
|
|
43047
43700
|
*/
|
|
43048
43701
|
columnName?: string;
|
|
43049
43702
|
}
|
|
@@ -43051,191 +43704,45 @@ export declare interface JsonApiWorkspaceDataFilterOutAttributes {
|
|
|
43051
43704
|
/**
|
|
43052
43705
|
*
|
|
43053
43706
|
* @export
|
|
43054
|
-
* @interface
|
|
43055
|
-
*/
|
|
43056
|
-
export declare interface JsonApiWorkspaceDataFilterOutDocument {
|
|
43057
|
-
/**
|
|
43058
|
-
*
|
|
43059
|
-
* @type {JsonApiWorkspaceDataFilterOut}
|
|
43060
|
-
* @memberof JsonApiWorkspaceDataFilterOutDocument
|
|
43061
|
-
*/
|
|
43062
|
-
data: JsonApiWorkspaceDataFilterOut;
|
|
43063
|
-
/**
|
|
43064
|
-
*
|
|
43065
|
-
* @type {ObjectLinks}
|
|
43066
|
-
* @memberof JsonApiWorkspaceDataFilterOutDocument
|
|
43067
|
-
*/
|
|
43068
|
-
links?: ObjectLinks;
|
|
43069
|
-
/**
|
|
43070
|
-
* Included resources
|
|
43071
|
-
* @type {Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>}
|
|
43072
|
-
* @memberof JsonApiWorkspaceDataFilterOutDocument
|
|
43073
|
-
*/
|
|
43074
|
-
included?: Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>;
|
|
43075
|
-
}
|
|
43076
|
-
|
|
43077
|
-
/**
|
|
43078
|
-
* A JSON:API document with a list of resources
|
|
43079
|
-
* @export
|
|
43080
|
-
* @interface JsonApiWorkspaceDataFilterOutList
|
|
43707
|
+
* @interface JsonApiWorkspaceDataFilterPatchDocument
|
|
43081
43708
|
*/
|
|
43082
|
-
export declare interface
|
|
43083
|
-
/**
|
|
43084
|
-
*
|
|
43085
|
-
* @type {Array<JsonApiWorkspaceDataFilterOutWithLinks>}
|
|
43086
|
-
* @memberof JsonApiWorkspaceDataFilterOutList
|
|
43087
|
-
*/
|
|
43088
|
-
data: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
43089
|
-
/**
|
|
43090
|
-
*
|
|
43091
|
-
* @type {ListLinks}
|
|
43092
|
-
* @memberof JsonApiWorkspaceDataFilterOutList
|
|
43093
|
-
*/
|
|
43094
|
-
links?: ListLinks;
|
|
43709
|
+
export declare interface JsonApiWorkspaceDataFilterPatchDocument {
|
|
43095
43710
|
/**
|
|
43096
43711
|
*
|
|
43097
|
-
* @type {
|
|
43098
|
-
* @memberof
|
|
43099
|
-
*/
|
|
43100
|
-
meta?: JsonApiColorPaletteOutListMeta;
|
|
43101
|
-
/**
|
|
43102
|
-
* Included resources
|
|
43103
|
-
* @type {Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>}
|
|
43104
|
-
* @memberof JsonApiWorkspaceDataFilterOutList
|
|
43712
|
+
* @type {JsonApiWorkspaceDataFilterPatch}
|
|
43713
|
+
* @memberof JsonApiWorkspaceDataFilterPatchDocument
|
|
43105
43714
|
*/
|
|
43106
|
-
|
|
43715
|
+
data: JsonApiWorkspaceDataFilterPatch;
|
|
43107
43716
|
}
|
|
43108
43717
|
|
|
43109
43718
|
/**
|
|
43110
43719
|
*
|
|
43111
43720
|
* @export
|
|
43112
|
-
* @interface
|
|
43721
|
+
* @interface JsonApiWorkspaceDataFilterPatchRelationships
|
|
43113
43722
|
*/
|
|
43114
|
-
export declare interface
|
|
43723
|
+
export declare interface JsonApiWorkspaceDataFilterPatchRelationships {
|
|
43115
43724
|
/**
|
|
43116
43725
|
*
|
|
43117
|
-
* @type {
|
|
43118
|
-
* @memberof
|
|
43726
|
+
* @type {JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings}
|
|
43727
|
+
* @memberof JsonApiWorkspaceDataFilterPatchRelationships
|
|
43119
43728
|
*/
|
|
43120
|
-
filterSettings?:
|
|
43729
|
+
filterSettings?: JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings;
|
|
43121
43730
|
}
|
|
43122
43731
|
|
|
43123
43732
|
/**
|
|
43124
43733
|
*
|
|
43125
43734
|
* @export
|
|
43126
|
-
* @interface
|
|
43735
|
+
* @interface JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings
|
|
43127
43736
|
*/
|
|
43128
|
-
export declare interface
|
|
43737
|
+
export declare interface JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings {
|
|
43129
43738
|
/**
|
|
43130
43739
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
43131
43740
|
* @type {Array<JsonApiWorkspaceDataFilterSettingLinkage>}
|
|
43132
|
-
* @memberof
|
|
43741
|
+
* @memberof JsonApiWorkspaceDataFilterPatchRelationshipsFilterSettings
|
|
43133
43742
|
*/
|
|
43134
43743
|
data: Array<JsonApiWorkspaceDataFilterSettingLinkage>;
|
|
43135
43744
|
}
|
|
43136
43745
|
|
|
43137
|
-
export declare const JsonApiWorkspaceDataFilterOutTypeEnum: {
|
|
43138
|
-
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
43139
|
-
};
|
|
43140
|
-
|
|
43141
|
-
export declare type JsonApiWorkspaceDataFilterOutTypeEnum = typeof JsonApiWorkspaceDataFilterOutTypeEnum[keyof typeof JsonApiWorkspaceDataFilterOutTypeEnum];
|
|
43142
|
-
|
|
43143
|
-
/**
|
|
43144
|
-
*
|
|
43145
|
-
* @export
|
|
43146
|
-
* @interface JsonApiWorkspaceDataFilterOutWithLinks
|
|
43147
|
-
*/
|
|
43148
|
-
export declare interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
43149
|
-
/**
|
|
43150
|
-
* Object type
|
|
43151
|
-
* @type {string}
|
|
43152
|
-
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43153
|
-
*/
|
|
43154
|
-
type: JsonApiWorkspaceDataFilterOutWithLinksTypeEnum;
|
|
43155
|
-
/**
|
|
43156
|
-
* API identifier of an object
|
|
43157
|
-
* @type {string}
|
|
43158
|
-
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43159
|
-
*/
|
|
43160
|
-
id: string;
|
|
43161
|
-
/**
|
|
43162
|
-
*
|
|
43163
|
-
* @type {JsonApiAttributeHierarchyOutMeta}
|
|
43164
|
-
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43165
|
-
*/
|
|
43166
|
-
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
43167
|
-
/**
|
|
43168
|
-
*
|
|
43169
|
-
* @type {JsonApiWorkspaceDataFilterOutAttributes}
|
|
43170
|
-
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43171
|
-
*/
|
|
43172
|
-
attributes?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
43173
|
-
/**
|
|
43174
|
-
*
|
|
43175
|
-
* @type {JsonApiWorkspaceDataFilterOutRelationships}
|
|
43176
|
-
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43177
|
-
*/
|
|
43178
|
-
relationships?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
43179
|
-
/**
|
|
43180
|
-
*
|
|
43181
|
-
* @type {ObjectLinks}
|
|
43182
|
-
* @memberof JsonApiWorkspaceDataFilterOutWithLinks
|
|
43183
|
-
*/
|
|
43184
|
-
links?: ObjectLinks;
|
|
43185
|
-
}
|
|
43186
|
-
|
|
43187
|
-
export declare const JsonApiWorkspaceDataFilterOutWithLinksTypeEnum: {
|
|
43188
|
-
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
43189
|
-
};
|
|
43190
|
-
|
|
43191
|
-
export declare type JsonApiWorkspaceDataFilterOutWithLinksTypeEnum = typeof JsonApiWorkspaceDataFilterOutWithLinksTypeEnum[keyof typeof JsonApiWorkspaceDataFilterOutWithLinksTypeEnum];
|
|
43192
|
-
|
|
43193
|
-
/**
|
|
43194
|
-
* JSON:API representation of patching workspaceDataFilter entity.
|
|
43195
|
-
* @export
|
|
43196
|
-
* @interface JsonApiWorkspaceDataFilterPatch
|
|
43197
|
-
*/
|
|
43198
|
-
export declare interface JsonApiWorkspaceDataFilterPatch {
|
|
43199
|
-
/**
|
|
43200
|
-
* Object type
|
|
43201
|
-
* @type {string}
|
|
43202
|
-
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
43203
|
-
*/
|
|
43204
|
-
type: JsonApiWorkspaceDataFilterPatchTypeEnum;
|
|
43205
|
-
/**
|
|
43206
|
-
* API identifier of an object
|
|
43207
|
-
* @type {string}
|
|
43208
|
-
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
43209
|
-
*/
|
|
43210
|
-
id: string;
|
|
43211
|
-
/**
|
|
43212
|
-
*
|
|
43213
|
-
* @type {JsonApiWorkspaceDataFilterOutAttributes}
|
|
43214
|
-
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
43215
|
-
*/
|
|
43216
|
-
attributes?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
43217
|
-
/**
|
|
43218
|
-
*
|
|
43219
|
-
* @type {JsonApiWorkspaceDataFilterOutRelationships}
|
|
43220
|
-
* @memberof JsonApiWorkspaceDataFilterPatch
|
|
43221
|
-
*/
|
|
43222
|
-
relationships?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
43223
|
-
}
|
|
43224
|
-
|
|
43225
|
-
/**
|
|
43226
|
-
*
|
|
43227
|
-
* @export
|
|
43228
|
-
* @interface JsonApiWorkspaceDataFilterPatchDocument
|
|
43229
|
-
*/
|
|
43230
|
-
export declare interface JsonApiWorkspaceDataFilterPatchDocument {
|
|
43231
|
-
/**
|
|
43232
|
-
*
|
|
43233
|
-
* @type {JsonApiWorkspaceDataFilterPatch}
|
|
43234
|
-
* @memberof JsonApiWorkspaceDataFilterPatchDocument
|
|
43235
|
-
*/
|
|
43236
|
-
data: JsonApiWorkspaceDataFilterPatch;
|
|
43237
|
-
}
|
|
43238
|
-
|
|
43239
43746
|
export declare const JsonApiWorkspaceDataFilterPatchTypeEnum: {
|
|
43240
43747
|
readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
|
|
43241
43748
|
};
|
|
@@ -43262,16 +43769,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
43262
43769
|
id: string;
|
|
43263
43770
|
/**
|
|
43264
43771
|
*
|
|
43265
|
-
* @type {
|
|
43772
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
43266
43773
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
43267
43774
|
*/
|
|
43268
|
-
attributes?:
|
|
43775
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
43269
43776
|
/**
|
|
43270
43777
|
*
|
|
43271
|
-
* @type {
|
|
43778
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
43272
43779
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
43273
43780
|
*/
|
|
43274
|
-
relationships?:
|
|
43781
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
43275
43782
|
}
|
|
43276
43783
|
|
|
43277
43784
|
/**
|
|
@@ -43346,42 +43853,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
43346
43853
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
43347
43854
|
/**
|
|
43348
43855
|
*
|
|
43349
|
-
* @type {
|
|
43856
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
43350
43857
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
43351
43858
|
*/
|
|
43352
|
-
attributes?:
|
|
43859
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
43353
43860
|
/**
|
|
43354
43861
|
*
|
|
43355
|
-
* @type {
|
|
43862
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
43356
43863
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
43357
43864
|
*/
|
|
43358
|
-
relationships?:
|
|
43359
|
-
}
|
|
43360
|
-
|
|
43361
|
-
/**
|
|
43362
|
-
*
|
|
43363
|
-
* @export
|
|
43364
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
43365
|
-
*/
|
|
43366
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutAttributes {
|
|
43367
|
-
/**
|
|
43368
|
-
*
|
|
43369
|
-
* @type {string}
|
|
43370
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
43371
|
-
*/
|
|
43372
|
-
title?: string;
|
|
43373
|
-
/**
|
|
43374
|
-
*
|
|
43375
|
-
* @type {string}
|
|
43376
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
43377
|
-
*/
|
|
43378
|
-
description?: string;
|
|
43379
|
-
/**
|
|
43380
|
-
*
|
|
43381
|
-
* @type {Array<string>}
|
|
43382
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
43383
|
-
*/
|
|
43384
|
-
filterValues?: Array<string>;
|
|
43865
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
43385
43866
|
}
|
|
43386
43867
|
|
|
43387
43868
|
/**
|
|
@@ -43442,34 +43923,6 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
|
43442
43923
|
included?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
43443
43924
|
}
|
|
43444
43925
|
|
|
43445
|
-
/**
|
|
43446
|
-
*
|
|
43447
|
-
* @export
|
|
43448
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutRelationships
|
|
43449
|
-
*/
|
|
43450
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutRelationships {
|
|
43451
|
-
/**
|
|
43452
|
-
*
|
|
43453
|
-
* @type {JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter}
|
|
43454
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutRelationships
|
|
43455
|
-
*/
|
|
43456
|
-
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter;
|
|
43457
|
-
}
|
|
43458
|
-
|
|
43459
|
-
/**
|
|
43460
|
-
*
|
|
43461
|
-
* @export
|
|
43462
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter
|
|
43463
|
-
*/
|
|
43464
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter {
|
|
43465
|
-
/**
|
|
43466
|
-
*
|
|
43467
|
-
* @type {JsonApiWorkspaceDataFilterToOneLinkage}
|
|
43468
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter
|
|
43469
|
-
*/
|
|
43470
|
-
data: JsonApiWorkspaceDataFilterToOneLinkage | null;
|
|
43471
|
-
}
|
|
43472
|
-
|
|
43473
43926
|
export declare const JsonApiWorkspaceDataFilterSettingOutTypeEnum: {
|
|
43474
43927
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
43475
43928
|
};
|
|
@@ -43502,16 +43955,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
43502
43955
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
43503
43956
|
/**
|
|
43504
43957
|
*
|
|
43505
|
-
* @type {
|
|
43958
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
43506
43959
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
43507
43960
|
*/
|
|
43508
|
-
attributes?:
|
|
43961
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
43509
43962
|
/**
|
|
43510
43963
|
*
|
|
43511
|
-
* @type {
|
|
43964
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
43512
43965
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
43513
43966
|
*/
|
|
43514
|
-
relationships?:
|
|
43967
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
43515
43968
|
/**
|
|
43516
43969
|
*
|
|
43517
43970
|
* @type {ObjectLinks}
|
|
@@ -43546,16 +43999,42 @@ export declare interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
43546
43999
|
id: string;
|
|
43547
44000
|
/**
|
|
43548
44001
|
*
|
|
43549
|
-
* @type {
|
|
44002
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
43550
44003
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
43551
44004
|
*/
|
|
43552
|
-
attributes?:
|
|
44005
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
43553
44006
|
/**
|
|
43554
44007
|
*
|
|
43555
|
-
* @type {
|
|
44008
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
43556
44009
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
43557
44010
|
*/
|
|
43558
|
-
relationships?:
|
|
44011
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
44012
|
+
}
|
|
44013
|
+
|
|
44014
|
+
/**
|
|
44015
|
+
*
|
|
44016
|
+
* @export
|
|
44017
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
44018
|
+
*/
|
|
44019
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchAttributes {
|
|
44020
|
+
/**
|
|
44021
|
+
*
|
|
44022
|
+
* @type {string}
|
|
44023
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
44024
|
+
*/
|
|
44025
|
+
title?: string;
|
|
44026
|
+
/**
|
|
44027
|
+
*
|
|
44028
|
+
* @type {string}
|
|
44029
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
44030
|
+
*/
|
|
44031
|
+
description?: string;
|
|
44032
|
+
/**
|
|
44033
|
+
*
|
|
44034
|
+
* @type {Array<string>}
|
|
44035
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
44036
|
+
*/
|
|
44037
|
+
filterValues?: Array<string>;
|
|
43559
44038
|
}
|
|
43560
44039
|
|
|
43561
44040
|
/**
|
|
@@ -43572,6 +44051,34 @@ export declare interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
|
43572
44051
|
data: JsonApiWorkspaceDataFilterSettingPatch;
|
|
43573
44052
|
}
|
|
43574
44053
|
|
|
44054
|
+
/**
|
|
44055
|
+
*
|
|
44056
|
+
* @export
|
|
44057
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchRelationships
|
|
44058
|
+
*/
|
|
44059
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchRelationships {
|
|
44060
|
+
/**
|
|
44061
|
+
*
|
|
44062
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter}
|
|
44063
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchRelationships
|
|
44064
|
+
*/
|
|
44065
|
+
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter;
|
|
44066
|
+
}
|
|
44067
|
+
|
|
44068
|
+
/**
|
|
44069
|
+
*
|
|
44070
|
+
* @export
|
|
44071
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter
|
|
44072
|
+
*/
|
|
44073
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter {
|
|
44074
|
+
/**
|
|
44075
|
+
*
|
|
44076
|
+
* @type {JsonApiWorkspaceDataFilterToOneLinkage}
|
|
44077
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter
|
|
44078
|
+
*/
|
|
44079
|
+
data: JsonApiWorkspaceDataFilterToOneLinkage | null;
|
|
44080
|
+
}
|
|
44081
|
+
|
|
43575
44082
|
export declare const JsonApiWorkspaceDataFilterSettingPatchTypeEnum: {
|
|
43576
44083
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
43577
44084
|
};
|
|
@@ -44083,10 +44590,10 @@ export declare interface JsonApiWorkspaceSettingIn {
|
|
|
44083
44590
|
id: string;
|
|
44084
44591
|
/**
|
|
44085
44592
|
*
|
|
44086
|
-
* @type {
|
|
44593
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
44087
44594
|
* @memberof JsonApiWorkspaceSettingIn
|
|
44088
44595
|
*/
|
|
44089
|
-
attributes?:
|
|
44596
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
44090
44597
|
}
|
|
44091
44598
|
|
|
44092
44599
|
/**
|
|
@@ -44135,51 +44642,12 @@ export declare interface JsonApiWorkspaceSettingOut {
|
|
|
44135
44642
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
44136
44643
|
/**
|
|
44137
44644
|
*
|
|
44138
|
-
* @type {
|
|
44645
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
44139
44646
|
* @memberof JsonApiWorkspaceSettingOut
|
|
44140
44647
|
*/
|
|
44141
|
-
attributes?:
|
|
44648
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
44142
44649
|
}
|
|
44143
44650
|
|
|
44144
|
-
/**
|
|
44145
|
-
*
|
|
44146
|
-
* @export
|
|
44147
|
-
* @interface JsonApiWorkspaceSettingOutAttributes
|
|
44148
|
-
*/
|
|
44149
|
-
export declare interface JsonApiWorkspaceSettingOutAttributes {
|
|
44150
|
-
/**
|
|
44151
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
44152
|
-
* @type {object}
|
|
44153
|
-
* @memberof JsonApiWorkspaceSettingOutAttributes
|
|
44154
|
-
*/
|
|
44155
|
-
content?: object;
|
|
44156
|
-
/**
|
|
44157
|
-
*
|
|
44158
|
-
* @type {string}
|
|
44159
|
-
* @memberof JsonApiWorkspaceSettingOutAttributes
|
|
44160
|
-
*/
|
|
44161
|
-
type?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
44162
|
-
}
|
|
44163
|
-
|
|
44164
|
-
export declare const JsonApiWorkspaceSettingOutAttributesTypeEnum: {
|
|
44165
|
-
readonly TIMEZONE: "TIMEZONE";
|
|
44166
|
-
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
44167
|
-
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
44168
|
-
readonly WHITE_LABELING: "WHITE_LABELING";
|
|
44169
|
-
readonly LOCALE: "LOCALE";
|
|
44170
|
-
readonly METADATA_LOCALE: "METADATA_LOCALE";
|
|
44171
|
-
readonly FORMAT_LOCALE: "FORMAT_LOCALE";
|
|
44172
|
-
readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
|
|
44173
|
-
readonly WEEK_START: "WEEK_START";
|
|
44174
|
-
readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
|
|
44175
|
-
readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
|
|
44176
|
-
readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
|
|
44177
|
-
readonly OPENAI_CONFIG: "OPENAI_CONFIG";
|
|
44178
|
-
readonly ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS";
|
|
44179
|
-
};
|
|
44180
|
-
|
|
44181
|
-
export declare type JsonApiWorkspaceSettingOutAttributesTypeEnum = typeof JsonApiWorkspaceSettingOutAttributesTypeEnum[keyof typeof JsonApiWorkspaceSettingOutAttributesTypeEnum];
|
|
44182
|
-
|
|
44183
44651
|
/**
|
|
44184
44652
|
*
|
|
44185
44653
|
* @export
|
|
@@ -44258,10 +44726,10 @@ export declare interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
44258
44726
|
meta?: JsonApiAttributeHierarchyOutMeta;
|
|
44259
44727
|
/**
|
|
44260
44728
|
*
|
|
44261
|
-
* @type {
|
|
44729
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
44262
44730
|
* @memberof JsonApiWorkspaceSettingOutWithLinks
|
|
44263
44731
|
*/
|
|
44264
|
-
attributes?:
|
|
44732
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
44265
44733
|
/**
|
|
44266
44734
|
*
|
|
44267
44735
|
* @type {ObjectLinks}
|
|
@@ -44296,10 +44764,10 @@ export declare interface JsonApiWorkspaceSettingPatch {
|
|
|
44296
44764
|
id: string;
|
|
44297
44765
|
/**
|
|
44298
44766
|
*
|
|
44299
|
-
* @type {
|
|
44767
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
44300
44768
|
* @memberof JsonApiWorkspaceSettingPatch
|
|
44301
44769
|
*/
|
|
44302
|
-
attributes?:
|
|
44770
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
44303
44771
|
}
|
|
44304
44772
|
|
|
44305
44773
|
/**
|
|
@@ -44342,10 +44810,10 @@ export declare interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
44342
44810
|
id?: string;
|
|
44343
44811
|
/**
|
|
44344
44812
|
*
|
|
44345
|
-
* @type {
|
|
44813
|
+
* @type {JsonApiOrganizationSettingInAttributes}
|
|
44346
44814
|
* @memberof JsonApiWorkspaceSettingPostOptionalId
|
|
44347
44815
|
*/
|
|
44348
|
-
attributes?:
|
|
44816
|
+
attributes?: JsonApiOrganizationSettingInAttributes;
|
|
44349
44817
|
}
|
|
44350
44818
|
|
|
44351
44819
|
/**
|
|
@@ -48537,6 +49005,26 @@ export declare interface Notes {
|
|
|
48537
49005
|
note: Array<Note>;
|
|
48538
49006
|
}
|
|
48539
49007
|
|
|
49008
|
+
/**
|
|
49009
|
+
*
|
|
49010
|
+
* @export
|
|
49011
|
+
* @interface NotificationChannelDestination
|
|
49012
|
+
*/
|
|
49013
|
+
export declare interface NotificationChannelDestination {
|
|
49014
|
+
/**
|
|
49015
|
+
*
|
|
49016
|
+
* @type {string}
|
|
49017
|
+
* @memberof NotificationChannelDestination
|
|
49018
|
+
*/
|
|
49019
|
+
type: NotificationChannelDestinationTypeEnum;
|
|
49020
|
+
}
|
|
49021
|
+
|
|
49022
|
+
export declare const NotificationChannelDestinationTypeEnum: {
|
|
49023
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
49024
|
+
};
|
|
49025
|
+
|
|
49026
|
+
export declare type NotificationChannelDestinationTypeEnum = typeof NotificationChannelDestinationTypeEnum[keyof typeof NotificationChannelDestinationTypeEnum];
|
|
49027
|
+
|
|
48540
49028
|
/**
|
|
48541
49029
|
* NotificationChannelsApi - object-oriented interface
|
|
48542
49030
|
* @export
|
|
@@ -48986,6 +49474,33 @@ export declare interface NotificationChannelsApiUpdateEntityNotificationChannels
|
|
|
48986
49474
|
readonly filter?: string;
|
|
48987
49475
|
}
|
|
48988
49476
|
|
|
49477
|
+
/**
|
|
49478
|
+
*
|
|
49479
|
+
* @export
|
|
49480
|
+
* @interface NotificationTrigger
|
|
49481
|
+
*/
|
|
49482
|
+
export declare interface NotificationTrigger {
|
|
49483
|
+
/**
|
|
49484
|
+
* The notification trigger type.
|
|
49485
|
+
* @type {string}
|
|
49486
|
+
* @memberof NotificationTrigger
|
|
49487
|
+
*/
|
|
49488
|
+
type: NotificationTriggerTypeEnum;
|
|
49489
|
+
/**
|
|
49490
|
+
* Free-form JSON object
|
|
49491
|
+
* @type {object}
|
|
49492
|
+
* @memberof NotificationTrigger
|
|
49493
|
+
*/
|
|
49494
|
+
metadata?: object | null;
|
|
49495
|
+
}
|
|
49496
|
+
|
|
49497
|
+
export declare const NotificationTriggerTypeEnum: {
|
|
49498
|
+
readonly SCHEDULE: "SCHEDULE";
|
|
49499
|
+
readonly ALERT: "ALERT";
|
|
49500
|
+
};
|
|
49501
|
+
|
|
49502
|
+
export declare type NotificationTriggerTypeEnum = typeof NotificationTriggerTypeEnum[keyof typeof NotificationTriggerTypeEnum];
|
|
49503
|
+
|
|
48989
49504
|
/**
|
|
48990
49505
|
*
|
|
48991
49506
|
* @export
|
|
@@ -58544,6 +59059,62 @@ export declare interface ScanSqlResponse {
|
|
|
58544
59059
|
dataPreview?: Array<Array<string>>;
|
|
58545
59060
|
}
|
|
58546
59061
|
|
|
59062
|
+
/**
|
|
59063
|
+
*
|
|
59064
|
+
* @export
|
|
59065
|
+
* @interface SearchRelationshipObject
|
|
59066
|
+
*/
|
|
59067
|
+
export declare interface SearchRelationshipObject {
|
|
59068
|
+
/**
|
|
59069
|
+
* Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.
|
|
59070
|
+
* @type {string}
|
|
59071
|
+
* @memberof SearchRelationshipObject
|
|
59072
|
+
*/
|
|
59073
|
+
sourceWorkspaceId: string;
|
|
59074
|
+
/**
|
|
59075
|
+
* Source object ID.
|
|
59076
|
+
* @type {string}
|
|
59077
|
+
* @memberof SearchRelationshipObject
|
|
59078
|
+
*/
|
|
59079
|
+
sourceObjectId: string;
|
|
59080
|
+
/**
|
|
59081
|
+
* Source object type, e.g. dashboard.
|
|
59082
|
+
* @type {string}
|
|
59083
|
+
* @memberof SearchRelationshipObject
|
|
59084
|
+
*/
|
|
59085
|
+
sourceObjectType: string;
|
|
59086
|
+
/**
|
|
59087
|
+
* Source object title.
|
|
59088
|
+
* @type {string}
|
|
59089
|
+
* @memberof SearchRelationshipObject
|
|
59090
|
+
*/
|
|
59091
|
+
sourceObjectTitle: string;
|
|
59092
|
+
/**
|
|
59093
|
+
* Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.
|
|
59094
|
+
* @type {string}
|
|
59095
|
+
* @memberof SearchRelationshipObject
|
|
59096
|
+
*/
|
|
59097
|
+
targetWorkspaceId: string;
|
|
59098
|
+
/**
|
|
59099
|
+
* Target object ID.
|
|
59100
|
+
* @type {string}
|
|
59101
|
+
* @memberof SearchRelationshipObject
|
|
59102
|
+
*/
|
|
59103
|
+
targetObjectId: string;
|
|
59104
|
+
/**
|
|
59105
|
+
* Target object type, e.g. visualization.
|
|
59106
|
+
* @type {string}
|
|
59107
|
+
* @memberof SearchRelationshipObject
|
|
59108
|
+
*/
|
|
59109
|
+
targetObjectType: string;
|
|
59110
|
+
/**
|
|
59111
|
+
* Target object title.
|
|
59112
|
+
* @type {string}
|
|
59113
|
+
* @memberof SearchRelationshipObject
|
|
59114
|
+
*/
|
|
59115
|
+
targetObjectTitle: string;
|
|
59116
|
+
}
|
|
59117
|
+
|
|
58547
59118
|
/**
|
|
58548
59119
|
*
|
|
58549
59120
|
* @export
|
|
@@ -58568,6 +59139,18 @@ export declare interface SearchRequest {
|
|
|
58568
59139
|
* @memberof SearchRequest
|
|
58569
59140
|
*/
|
|
58570
59141
|
deepSearch?: boolean;
|
|
59142
|
+
/**
|
|
59143
|
+
* Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested.
|
|
59144
|
+
* @type {number}
|
|
59145
|
+
* @memberof SearchRequest
|
|
59146
|
+
*/
|
|
59147
|
+
limit?: number;
|
|
59148
|
+
/**
|
|
59149
|
+
* Temporary for experiments. Ratio of title score to descriptor score.
|
|
59150
|
+
* @type {number}
|
|
59151
|
+
* @memberof SearchRequest
|
|
59152
|
+
*/
|
|
59153
|
+
titleToDescriptorRatio?: number;
|
|
58571
59154
|
}
|
|
58572
59155
|
|
|
58573
59156
|
export declare const SearchRequestObjectTypesEnum: {
|
|
@@ -58595,6 +59178,12 @@ export declare interface SearchResult {
|
|
|
58595
59178
|
* @memberof SearchResult
|
|
58596
59179
|
*/
|
|
58597
59180
|
results: Array<SearchResultObject>;
|
|
59181
|
+
/**
|
|
59182
|
+
*
|
|
59183
|
+
* @type {Array<SearchRelationshipObject>}
|
|
59184
|
+
* @memberof SearchResult
|
|
59185
|
+
*/
|
|
59186
|
+
relationships: Array<SearchRelationshipObject>;
|
|
58598
59187
|
}
|
|
58599
59188
|
|
|
58600
59189
|
/**
|
|
@@ -58604,29 +59193,77 @@ export declare interface SearchResult {
|
|
|
58604
59193
|
*/
|
|
58605
59194
|
export declare interface SearchResultObject {
|
|
58606
59195
|
/**
|
|
58607
|
-
*
|
|
59196
|
+
* Object ID.
|
|
58608
59197
|
* @type {string}
|
|
58609
59198
|
* @memberof SearchResultObject
|
|
58610
59199
|
*/
|
|
58611
59200
|
id: string;
|
|
58612
59201
|
/**
|
|
58613
|
-
*
|
|
59202
|
+
* Object type, e.g. dashboard.
|
|
58614
59203
|
* @type {string}
|
|
58615
59204
|
* @memberof SearchResultObject
|
|
58616
59205
|
*/
|
|
58617
59206
|
type: string;
|
|
58618
59207
|
/**
|
|
58619
|
-
*
|
|
59208
|
+
* Object title.
|
|
58620
59209
|
* @type {string}
|
|
58621
59210
|
* @memberof SearchResultObject
|
|
58622
59211
|
*/
|
|
58623
59212
|
title: string;
|
|
58624
59213
|
/**
|
|
58625
|
-
*
|
|
59214
|
+
* Object description.
|
|
58626
59215
|
* @type {string}
|
|
58627
59216
|
* @memberof SearchResultObject
|
|
58628
59217
|
*/
|
|
58629
59218
|
description: string;
|
|
59219
|
+
/**
|
|
59220
|
+
*
|
|
59221
|
+
* @type {Array<string>}
|
|
59222
|
+
* @memberof SearchResultObject
|
|
59223
|
+
*/
|
|
59224
|
+
tags?: Array<string>;
|
|
59225
|
+
/**
|
|
59226
|
+
* Timestamp when object was created.
|
|
59227
|
+
* @type {string}
|
|
59228
|
+
* @memberof SearchResultObject
|
|
59229
|
+
*/
|
|
59230
|
+
createdAt?: string;
|
|
59231
|
+
/**
|
|
59232
|
+
* Timestamp when object was last modified.
|
|
59233
|
+
* @type {string}
|
|
59234
|
+
* @memberof SearchResultObject
|
|
59235
|
+
*/
|
|
59236
|
+
modifiedAt?: string;
|
|
59237
|
+
/**
|
|
59238
|
+
* If the object is visualization, this field defines the type of visualization.
|
|
59239
|
+
* @type {string}
|
|
59240
|
+
* @memberof SearchResultObject
|
|
59241
|
+
*/
|
|
59242
|
+
visualizationUrl?: string;
|
|
59243
|
+
/**
|
|
59244
|
+
* Result score calculated by a similarity search algorithm (cosine_distance).
|
|
59245
|
+
* @type {number}
|
|
59246
|
+
* @memberof SearchResultObject
|
|
59247
|
+
*/
|
|
59248
|
+
score: number;
|
|
59249
|
+
/**
|
|
59250
|
+
* Result score for object title.
|
|
59251
|
+
* @type {number}
|
|
59252
|
+
* @memberof SearchResultObject
|
|
59253
|
+
*/
|
|
59254
|
+
scoreTitle: number;
|
|
59255
|
+
/**
|
|
59256
|
+
* Result score for descriptor containing(now) description and tags.
|
|
59257
|
+
* @type {number}
|
|
59258
|
+
* @memberof SearchResultObject
|
|
59259
|
+
*/
|
|
59260
|
+
scoreDescriptor: number;
|
|
59261
|
+
/**
|
|
59262
|
+
* Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.
|
|
59263
|
+
* @type {number}
|
|
59264
|
+
* @memberof SearchResultObject
|
|
59265
|
+
*/
|
|
59266
|
+
scoreExactMatch: number;
|
|
58630
59267
|
}
|
|
58631
59268
|
|
|
58632
59269
|
/**
|
|
@@ -59034,6 +59671,77 @@ export declare interface TableWarning {
|
|
|
59034
59671
|
columns: Array<ColumnWarning>;
|
|
59035
59672
|
}
|
|
59036
59673
|
|
|
59674
|
+
/**
|
|
59675
|
+
* Export request object describing the export properties and overrides for tabular exports.
|
|
59676
|
+
* @export
|
|
59677
|
+
* @interface TabularExportRequest
|
|
59678
|
+
*/
|
|
59679
|
+
export declare interface TabularExportActionsRequest {
|
|
59680
|
+
/**
|
|
59681
|
+
* Expected file format.
|
|
59682
|
+
* @type {string}
|
|
59683
|
+
* @memberof TabularExportRequest
|
|
59684
|
+
*/
|
|
59685
|
+
format: TabularExportActionsRequestFormatEnum;
|
|
59686
|
+
/**
|
|
59687
|
+
* Execution result identifier.
|
|
59688
|
+
* @type {string}
|
|
59689
|
+
* @memberof TabularExportRequest
|
|
59690
|
+
*/
|
|
59691
|
+
executionResult?: string;
|
|
59692
|
+
/**
|
|
59693
|
+
* Filename of downloaded file without extension.
|
|
59694
|
+
* @type {string}
|
|
59695
|
+
* @memberof TabularExportRequest
|
|
59696
|
+
*/
|
|
59697
|
+
fileName: string;
|
|
59698
|
+
/**
|
|
59699
|
+
*
|
|
59700
|
+
* @type {Settings}
|
|
59701
|
+
* @memberof TabularExportRequest
|
|
59702
|
+
*/
|
|
59703
|
+
settings?: ExportActionsSettings;
|
|
59704
|
+
/**
|
|
59705
|
+
*
|
|
59706
|
+
* @type {CustomOverride}
|
|
59707
|
+
* @memberof TabularExportRequest
|
|
59708
|
+
*/
|
|
59709
|
+
customOverride?: ExportActionsCustomOverride;
|
|
59710
|
+
/**
|
|
59711
|
+
* Visualization object identifier. Alternative to executionResult property.
|
|
59712
|
+
* @type {string}
|
|
59713
|
+
* @memberof TabularExportRequest
|
|
59714
|
+
*/
|
|
59715
|
+
visualizationObject?: string;
|
|
59716
|
+
/**
|
|
59717
|
+
* Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (HTML/PDF only)
|
|
59718
|
+
* @type {Array<object>}
|
|
59719
|
+
* @memberof TabularExportRequest
|
|
59720
|
+
*/
|
|
59721
|
+
visualizationObjectCustomFilters?: Array<object>;
|
|
59722
|
+
/**
|
|
59723
|
+
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
59724
|
+
* @type {string}
|
|
59725
|
+
* @memberof TabularExportRequest
|
|
59726
|
+
*/
|
|
59727
|
+
relatedDashboardId?: string;
|
|
59728
|
+
/**
|
|
59729
|
+
* Metadata definition in free-form JSON format.
|
|
59730
|
+
* @type {object}
|
|
59731
|
+
* @memberof TabularExportRequest
|
|
59732
|
+
*/
|
|
59733
|
+
metadata?: object | null;
|
|
59734
|
+
}
|
|
59735
|
+
|
|
59736
|
+
export declare const TabularExportActionsRequestFormatEnum: {
|
|
59737
|
+
readonly CSV: "CSV";
|
|
59738
|
+
readonly XLSX: "XLSX";
|
|
59739
|
+
readonly HTML: "HTML";
|
|
59740
|
+
readonly PDF: "PDF";
|
|
59741
|
+
};
|
|
59742
|
+
|
|
59743
|
+
export declare type TabularExportActionsRequestFormatEnum = typeof TabularExportActionsRequestFormatEnum[keyof typeof TabularExportActionsRequestFormatEnum];
|
|
59744
|
+
|
|
59037
59745
|
/**
|
|
59038
59746
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
59039
59747
|
* @export
|
|
@@ -59071,7 +59779,7 @@ export declare interface TabularExportRequest {
|
|
|
59071
59779
|
*/
|
|
59072
59780
|
customOverride?: CustomOverride;
|
|
59073
59781
|
/**
|
|
59074
|
-
* Visualization object identifier. Alternative to executionResult property.
|
|
59782
|
+
* Visualization object identifier. Alternative to executionResult property.
|
|
59075
59783
|
* @type {string}
|
|
59076
59784
|
* @memberof TabularExportRequest
|
|
59077
59785
|
*/
|
|
@@ -59083,7 +59791,13 @@ export declare interface TabularExportRequest {
|
|
|
59083
59791
|
*/
|
|
59084
59792
|
visualizationObjectCustomFilters?: Array<object>;
|
|
59085
59793
|
/**
|
|
59086
|
-
*
|
|
59794
|
+
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
59795
|
+
* @type {string}
|
|
59796
|
+
* @memberof TabularExportRequest
|
|
59797
|
+
*/
|
|
59798
|
+
relatedDashboardId?: string;
|
|
59799
|
+
/**
|
|
59800
|
+
* Free-form JSON object
|
|
59087
59801
|
* @type {object}
|
|
59088
59802
|
* @memberof TabularExportRequest
|
|
59089
59803
|
*/
|
|
@@ -63883,6 +64597,32 @@ export declare const ValidateRelationsHeader: {
|
|
|
63883
64597
|
"X-GDC-VALIDATE-RELATIONS": string;
|
|
63884
64598
|
};
|
|
63885
64599
|
|
|
64600
|
+
/**
|
|
64601
|
+
* Export request object describing the export properties and metadata for dashboard PDF exports.
|
|
64602
|
+
* @export
|
|
64603
|
+
* @interface VisualExportRequest
|
|
64604
|
+
*/
|
|
64605
|
+
export declare interface VisualExportActionsRequest {
|
|
64606
|
+
/**
|
|
64607
|
+
* File name to be used for retrieving the pdf document.
|
|
64608
|
+
* @type {string}
|
|
64609
|
+
* @memberof VisualExportRequest
|
|
64610
|
+
*/
|
|
64611
|
+
fileName: string;
|
|
64612
|
+
/**
|
|
64613
|
+
* Dashboard identifier
|
|
64614
|
+
* @type {string}
|
|
64615
|
+
* @memberof VisualExportRequest
|
|
64616
|
+
*/
|
|
64617
|
+
dashboardId: string;
|
|
64618
|
+
/**
|
|
64619
|
+
* Metadata definition in free-form JSON format.
|
|
64620
|
+
* @type {object}
|
|
64621
|
+
* @memberof VisualExportRequest
|
|
64622
|
+
*/
|
|
64623
|
+
metadata?: object;
|
|
64624
|
+
}
|
|
64625
|
+
|
|
63886
64626
|
/**
|
|
63887
64627
|
* Export request object describing the export properties and metadata for dashboard PDF exports.
|
|
63888
64628
|
* @export
|
|
@@ -64514,6 +65254,82 @@ declare namespace VisualizationObjectModelV2 {
|
|
|
64514
65254
|
}
|
|
64515
65255
|
export { VisualizationObjectModelV2 }
|
|
64516
65256
|
|
|
65257
|
+
/**
|
|
65258
|
+
* Webhook destination for notifications.
|
|
65259
|
+
* @export
|
|
65260
|
+
* @interface Webhook
|
|
65261
|
+
*/
|
|
65262
|
+
export declare interface Webhook {
|
|
65263
|
+
/**
|
|
65264
|
+
* The webhook URL.
|
|
65265
|
+
* @type {string}
|
|
65266
|
+
* @memberof Webhook
|
|
65267
|
+
*/
|
|
65268
|
+
url: string;
|
|
65269
|
+
/**
|
|
65270
|
+
* Bearer token for the webhook.
|
|
65271
|
+
* @type {string}
|
|
65272
|
+
* @memberof Webhook
|
|
65273
|
+
*/
|
|
65274
|
+
token?: string | null;
|
|
65275
|
+
/**
|
|
65276
|
+
* Flag indicating if webhook has a token.
|
|
65277
|
+
* @type {boolean}
|
|
65278
|
+
* @memberof Webhook
|
|
65279
|
+
*/
|
|
65280
|
+
hasToken?: boolean | null;
|
|
65281
|
+
/**
|
|
65282
|
+
* The destination type.
|
|
65283
|
+
* @type {string}
|
|
65284
|
+
* @memberof Webhook
|
|
65285
|
+
*/
|
|
65286
|
+
type: WebhookTypeEnum;
|
|
65287
|
+
}
|
|
65288
|
+
|
|
65289
|
+
/**
|
|
65290
|
+
*
|
|
65291
|
+
* @export
|
|
65292
|
+
* @interface WebhookAllOf
|
|
65293
|
+
*/
|
|
65294
|
+
export declare interface WebhookAllOf {
|
|
65295
|
+
/**
|
|
65296
|
+
* The webhook URL.
|
|
65297
|
+
* @type {string}
|
|
65298
|
+
* @memberof WebhookAllOf
|
|
65299
|
+
*/
|
|
65300
|
+
url?: string;
|
|
65301
|
+
/**
|
|
65302
|
+
* Bearer token for the webhook.
|
|
65303
|
+
* @type {string}
|
|
65304
|
+
* @memberof WebhookAllOf
|
|
65305
|
+
*/
|
|
65306
|
+
token?: string | null;
|
|
65307
|
+
/**
|
|
65308
|
+
* Flag indicating if webhook has a token.
|
|
65309
|
+
* @type {boolean}
|
|
65310
|
+
* @memberof WebhookAllOf
|
|
65311
|
+
*/
|
|
65312
|
+
hasToken?: boolean | null;
|
|
65313
|
+
/**
|
|
65314
|
+
* The destination type.
|
|
65315
|
+
* @type {string}
|
|
65316
|
+
* @memberof WebhookAllOf
|
|
65317
|
+
*/
|
|
65318
|
+
type?: WebhookAllOfTypeEnum;
|
|
65319
|
+
}
|
|
65320
|
+
|
|
65321
|
+
export declare const WebhookAllOfTypeEnum: {
|
|
65322
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
65323
|
+
};
|
|
65324
|
+
|
|
65325
|
+
export declare type WebhookAllOfTypeEnum = typeof WebhookAllOfTypeEnum[keyof typeof WebhookAllOfTypeEnum];
|
|
65326
|
+
|
|
65327
|
+
export declare const WebhookTypeEnum: {
|
|
65328
|
+
readonly WEBHOOK: "WEBHOOK";
|
|
65329
|
+
};
|
|
65330
|
+
|
|
65331
|
+
export declare type WebhookTypeEnum = typeof WebhookTypeEnum[keyof typeof WebhookTypeEnum];
|
|
65332
|
+
|
|
64517
65333
|
/**
|
|
64518
65334
|
* Cache settings for the workspace.
|
|
64519
65335
|
* @export
|
|
@@ -65447,12 +66263,12 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
65447
66263
|
* @summary Post Automations
|
|
65448
66264
|
* @param {string} workspaceId
|
|
65449
66265
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
65450
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
66266
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
65451
66267
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
65452
66268
|
* @param {*} [options] Override http request option.
|
|
65453
66269
|
* @throws {RequiredError}
|
|
65454
66270
|
*/
|
|
65455
|
-
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66271
|
+
createEntityAutomations: (workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
65456
66272
|
/**
|
|
65457
66273
|
*
|
|
65458
66274
|
* @summary Post Custom Application Settings
|
|
@@ -65745,7 +66561,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
65745
66561
|
* @param {string} workspaceId
|
|
65746
66562
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
65747
66563
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
65748
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
66564
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
65749
66565
|
* @param {number} [page] Zero-based page index (0..N)
|
|
65750
66566
|
* @param {number} [size] The size of the page to be returned
|
|
65751
66567
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -65754,7 +66570,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
65754
66570
|
* @param {*} [options] Override http request option.
|
|
65755
66571
|
* @throws {RequiredError}
|
|
65756
66572
|
*/
|
|
65757
|
-
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66573
|
+
getAllEntitiesAutomations: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
65758
66574
|
/**
|
|
65759
66575
|
*
|
|
65760
66576
|
* @summary Get all Custom Application Settings
|
|
@@ -66006,13 +66822,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
66006
66822
|
* @param {string} workspaceId
|
|
66007
66823
|
* @param {string} objectId
|
|
66008
66824
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
66009
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
66825
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
66010
66826
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
66011
66827
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
66012
66828
|
* @param {*} [options] Override http request option.
|
|
66013
66829
|
* @throws {RequiredError}
|
|
66014
66830
|
*/
|
|
66015
|
-
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66831
|
+
getEntityAutomations: (workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66016
66832
|
/**
|
|
66017
66833
|
*
|
|
66018
66834
|
* @summary Get a Custom Application Setting
|
|
@@ -66211,11 +67027,11 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
66211
67027
|
* @param {string} objectId
|
|
66212
67028
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
66213
67029
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
66214
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
67030
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
66215
67031
|
* @param {*} [options] Override http request option.
|
|
66216
67032
|
* @throws {RequiredError}
|
|
66217
67033
|
*/
|
|
66218
|
-
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
67034
|
+
patchEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66219
67035
|
/**
|
|
66220
67036
|
*
|
|
66221
67037
|
* @summary Patch a Custom Application Setting
|
|
@@ -66365,11 +67181,11 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
66365
67181
|
* @param {string} objectId
|
|
66366
67182
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
66367
67183
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
66368
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
67184
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
66369
67185
|
* @param {*} [options] Override http request option.
|
|
66370
67186
|
* @throws {RequiredError}
|
|
66371
67187
|
*/
|
|
66372
|
-
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
67188
|
+
updateEntityAutomations: (workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66373
67189
|
/**
|
|
66374
67190
|
*
|
|
66375
67191
|
* @summary Put a Custom Application Setting
|
|
@@ -66574,10 +67390,10 @@ export declare interface WorkspaceObjectControllerApiCreateEntityAutomationsRequ
|
|
|
66574
67390
|
readonly jsonApiAutomationInDocument: JsonApiAutomationInDocument;
|
|
66575
67391
|
/**
|
|
66576
67392
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
66577
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
67393
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
66578
67394
|
* @memberof WorkspaceObjectControllerApiCreateEntityAutomations
|
|
66579
67395
|
*/
|
|
66580
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
67396
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
66581
67397
|
/**
|
|
66582
67398
|
* Include Meta objects.
|
|
66583
67399
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -67959,12 +68775,12 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
67959
68775
|
* @summary Post Automations
|
|
67960
68776
|
* @param {string} workspaceId
|
|
67961
68777
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
67962
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68778
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
67963
68779
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
67964
68780
|
* @param {*} [options] Override http request option.
|
|
67965
68781
|
* @throws {RequiredError}
|
|
67966
68782
|
*/
|
|
67967
|
-
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
68783
|
+
createEntityAutomations(workspaceId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
67968
68784
|
/**
|
|
67969
68785
|
*
|
|
67970
68786
|
* @summary Post Custom Application Settings
|
|
@@ -68257,7 +69073,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
68257
69073
|
* @param {string} workspaceId
|
|
68258
69074
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
68259
69075
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
68260
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69076
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68261
69077
|
* @param {number} [page] Zero-based page index (0..N)
|
|
68262
69078
|
* @param {number} [size] The size of the page to be returned
|
|
68263
69079
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -68266,7 +69082,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
68266
69082
|
* @param {*} [options] Override http request option.
|
|
68267
69083
|
* @throws {RequiredError}
|
|
68268
69084
|
*/
|
|
68269
|
-
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
69085
|
+
getAllEntitiesAutomations(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutList>>;
|
|
68270
69086
|
/**
|
|
68271
69087
|
*
|
|
68272
69088
|
* @summary Get all Custom Application Settings
|
|
@@ -68518,13 +69334,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
68518
69334
|
* @param {string} workspaceId
|
|
68519
69335
|
* @param {string} objectId
|
|
68520
69336
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
68521
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69337
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68522
69338
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
68523
69339
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
68524
69340
|
* @param {*} [options] Override http request option.
|
|
68525
69341
|
* @throws {RequiredError}
|
|
68526
69342
|
*/
|
|
68527
|
-
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
69343
|
+
getEntityAutomations(workspaceId: string, objectId: string, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
68528
69344
|
/**
|
|
68529
69345
|
*
|
|
68530
69346
|
* @summary Get a Custom Application Setting
|
|
@@ -68723,11 +69539,11 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
68723
69539
|
* @param {string} objectId
|
|
68724
69540
|
* @param {JsonApiAutomationPatchDocument} jsonApiAutomationPatchDocument
|
|
68725
69541
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
68726
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69542
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68727
69543
|
* @param {*} [options] Override http request option.
|
|
68728
69544
|
* @throws {RequiredError}
|
|
68729
69545
|
*/
|
|
68730
|
-
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
69546
|
+
patchEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationPatchDocument: JsonApiAutomationPatchDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
68731
69547
|
/**
|
|
68732
69548
|
*
|
|
68733
69549
|
* @summary Patch a Custom Application Setting
|
|
@@ -68877,11 +69693,11 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
68877
69693
|
* @param {string} objectId
|
|
68878
69694
|
* @param {JsonApiAutomationInDocument} jsonApiAutomationInDocument
|
|
68879
69695
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
68880
|
-
* @param {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69696
|
+
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68881
69697
|
* @param {*} [options] Override http request option.
|
|
68882
69698
|
* @throws {RequiredError}
|
|
68883
69699
|
*/
|
|
68884
|
-
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
69700
|
+
updateEntityAutomations(workspaceId: string, objectId: string, jsonApiAutomationInDocument: JsonApiAutomationInDocument, filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAutomationOutDocument>>;
|
|
68885
69701
|
/**
|
|
68886
69702
|
*
|
|
68887
69703
|
* @summary Put a Custom Application Setting
|
|
@@ -69214,10 +70030,10 @@ export declare interface WorkspaceObjectControllerApiGetAllEntitiesAutomationsRe
|
|
|
69214
70030
|
readonly filter?: string;
|
|
69215
70031
|
/**
|
|
69216
70032
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69217
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
70033
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
69218
70034
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAutomations
|
|
69219
70035
|
*/
|
|
69220
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
70036
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
69221
70037
|
/**
|
|
69222
70038
|
* Zero-based page index (0..N)
|
|
69223
70039
|
* @type {number}
|
|
@@ -70202,10 +71018,10 @@ export declare interface WorkspaceObjectControllerApiGetEntityAutomationsRequest
|
|
|
70202
71018
|
readonly filter?: string;
|
|
70203
71019
|
/**
|
|
70204
71020
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70205
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
71021
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
70206
71022
|
* @memberof WorkspaceObjectControllerApiGetEntityAutomations
|
|
70207
71023
|
*/
|
|
70208
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
71024
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
70209
71025
|
/**
|
|
70210
71026
|
*
|
|
70211
71027
|
* @type {boolean}
|
|
@@ -71670,10 +72486,10 @@ export declare interface WorkspaceObjectControllerApiPatchEntityAutomationsReque
|
|
|
71670
72486
|
readonly filter?: string;
|
|
71671
72487
|
/**
|
|
71672
72488
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
71673
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
72489
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
71674
72490
|
* @memberof WorkspaceObjectControllerApiPatchEntityAutomations
|
|
71675
72491
|
*/
|
|
71676
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
72492
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
71677
72493
|
}
|
|
71678
72494
|
|
|
71679
72495
|
/**
|
|
@@ -72152,10 +72968,10 @@ export declare interface WorkspaceObjectControllerApiUpdateEntityAutomationsRequ
|
|
|
72152
72968
|
readonly filter?: string;
|
|
72153
72969
|
/**
|
|
72154
72970
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
72155
|
-
* @type {Array<'notificationChannels' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
72971
|
+
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
72156
72972
|
* @memberof WorkspaceObjectControllerApiUpdateEntityAutomations
|
|
72157
72973
|
*/
|
|
72158
|
-
readonly include?: Array<"notificationChannels" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
72974
|
+
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
72159
72975
|
}
|
|
72160
72976
|
|
|
72161
72977
|
/**
|