@gooddata/api-client-tiger 11.67.0 → 11.68.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +2170 -84
- package/esm/generated/afm-rest-api/api.d.ts +35 -14
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +2 -2
- package/esm/generated/ai-json-api/api.d.ts +51 -0
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +1 -0
- package/esm/generated/metadata-json-api/api.d.ts +1953 -127
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +201 -49
- package/esm/generated/scan-json-api/api.d.ts +6 -0
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -1593,6 +1593,10 @@ export interface DeclarativeAnalyticsLayer {
|
|
|
1593
1593
|
* A list of AI memory items available in the workspace.
|
|
1594
1594
|
*/
|
|
1595
1595
|
'memoryItems'?: Array<DeclarativeMemoryItem>;
|
|
1596
|
+
/**
|
|
1597
|
+
* A list of metric permissions assigned to a related metric.
|
|
1598
|
+
*/
|
|
1599
|
+
'metricExtensions'?: Array<DeclarativeMetricExtension>;
|
|
1596
1600
|
/**
|
|
1597
1601
|
* A list of metrics available in the model.
|
|
1598
1602
|
*/
|
|
@@ -1617,6 +1621,10 @@ export interface DeclarativeAnalyticsLayer {
|
|
|
1617
1621
|
* A list of reports available in the model.
|
|
1618
1622
|
*/
|
|
1619
1623
|
'reports'?: Array<DeclarativeReport>;
|
|
1624
|
+
/**
|
|
1625
|
+
* A list of visualization object permissions assigned to a related visualization object.
|
|
1626
|
+
*/
|
|
1627
|
+
'visualizationObjectExtensions'?: Array<DeclarativeVisualizationObjectExtension>;
|
|
1620
1628
|
/**
|
|
1621
1629
|
* A list of visualization objects available in the model.
|
|
1622
1630
|
*/
|
|
@@ -2661,6 +2669,20 @@ export interface DeclarativeMetric {
|
|
|
2661
2669
|
'title': string;
|
|
2662
2670
|
}
|
|
2663
2671
|
export type DeclarativeMetricCertificationEnum = 'CERTIFIED';
|
|
2672
|
+
export interface DeclarativeMetricExtension {
|
|
2673
|
+
/**
|
|
2674
|
+
* Metric ID.
|
|
2675
|
+
*/
|
|
2676
|
+
'id': string;
|
|
2677
|
+
/**
|
|
2678
|
+
* A list of permissions.
|
|
2679
|
+
*/
|
|
2680
|
+
'permissions': Array<DeclarativeMetricExtensionPermissionsInner>;
|
|
2681
|
+
}
|
|
2682
|
+
/**
|
|
2683
|
+
* @type DeclarativeMetricExtensionPermissionsInner
|
|
2684
|
+
*/
|
|
2685
|
+
export type DeclarativeMetricExtensionPermissionsInner = DeclarativeMetricPermissionForAssignee | DeclarativeMetricPermissionForAssigneeRule;
|
|
2664
2686
|
/**
|
|
2665
2687
|
* Metric permission.
|
|
2666
2688
|
*/
|
|
@@ -2870,10 +2892,12 @@ export interface DeclarativeParameter {
|
|
|
2870
2892
|
'title': string;
|
|
2871
2893
|
}
|
|
2872
2894
|
export interface DeclarativePublisherDocument {
|
|
2895
|
+
'content': PublisherDocumentContent;
|
|
2873
2896
|
/**
|
|
2874
|
-
*
|
|
2897
|
+
* Time of the entity creation.
|
|
2875
2898
|
*/
|
|
2876
|
-
'
|
|
2899
|
+
'createdAt'?: string | null;
|
|
2900
|
+
'createdBy'?: DeclarativeUserIdentifier;
|
|
2877
2901
|
/**
|
|
2878
2902
|
* Document description.
|
|
2879
2903
|
*/
|
|
@@ -2882,6 +2906,11 @@ export interface DeclarativePublisherDocument {
|
|
|
2882
2906
|
* Document ID.
|
|
2883
2907
|
*/
|
|
2884
2908
|
'id': string;
|
|
2909
|
+
/**
|
|
2910
|
+
* Time of the last entity modification.
|
|
2911
|
+
*/
|
|
2912
|
+
'modifiedAt'?: string | null;
|
|
2913
|
+
'modifiedBy'?: DeclarativeUserIdentifier;
|
|
2885
2914
|
'period': PublisherDocumentPeriod;
|
|
2886
2915
|
'tags'?: Array<string>;
|
|
2887
2916
|
/**
|
|
@@ -2894,10 +2923,7 @@ export interface DeclarativePublisherDocument {
|
|
|
2894
2923
|
'version': string;
|
|
2895
2924
|
}
|
|
2896
2925
|
export interface DeclarativePublisherDocumentPageTemplate {
|
|
2897
|
-
|
|
2898
|
-
* Free-form JSON object
|
|
2899
|
-
*/
|
|
2900
|
-
'content': object | null;
|
|
2926
|
+
'content': PublisherDocumentPageTemplateContent;
|
|
2901
2927
|
/**
|
|
2902
2928
|
* Page template description.
|
|
2903
2929
|
*/
|
|
@@ -2917,10 +2943,7 @@ export interface DeclarativePublisherDocumentPageTemplate {
|
|
|
2917
2943
|
'version': string;
|
|
2918
2944
|
}
|
|
2919
2945
|
export interface DeclarativePublisherDocumentTemplate {
|
|
2920
|
-
|
|
2921
|
-
* Free-form JSON object
|
|
2922
|
-
*/
|
|
2923
|
-
'content': object | null;
|
|
2946
|
+
'content': PublisherDocumentContent;
|
|
2924
2947
|
/**
|
|
2925
2948
|
* Document template description.
|
|
2926
2949
|
*/
|
|
@@ -3115,7 +3138,7 @@ export interface DeclarativeSetting {
|
|
|
3115
3138
|
*/
|
|
3116
3139
|
'type'?: DeclarativeSettingTypeEnum;
|
|
3117
3140
|
}
|
|
3118
|
-
export type DeclarativeSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
3141
|
+
export type DeclarativeSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE' | 'EMBEDDING_ORIGINS';
|
|
3119
3142
|
export interface DeclarativeSingleWorkspacePermission {
|
|
3120
3143
|
'assignee': AssigneeIdentifier;
|
|
3121
3144
|
/**
|
|
@@ -3155,6 +3178,12 @@ export interface DeclarativeTable {
|
|
|
3155
3178
|
* Path to table.
|
|
3156
3179
|
*/
|
|
3157
3180
|
'path': Array<string>;
|
|
3181
|
+
/**
|
|
3182
|
+
* Additional properties of the table that the data source passes on to the modeler and other callers. The data source decides which keys it sends. A caller uses the keys it understands and skips all other keys.
|
|
3183
|
+
*/
|
|
3184
|
+
'properties'?: {
|
|
3185
|
+
[key: string]: string;
|
|
3186
|
+
};
|
|
3158
3187
|
/**
|
|
3159
3188
|
* Table type: TABLE or VIEW.
|
|
3160
3189
|
*/
|
|
@@ -3390,6 +3419,20 @@ export interface DeclarativeVisualizationObject {
|
|
|
3390
3419
|
'title': string;
|
|
3391
3420
|
}
|
|
3392
3421
|
export type DeclarativeVisualizationObjectCertificationEnum = 'CERTIFIED';
|
|
3422
|
+
export interface DeclarativeVisualizationObjectExtension {
|
|
3423
|
+
/**
|
|
3424
|
+
* Visualization object ID.
|
|
3425
|
+
*/
|
|
3426
|
+
'id': string;
|
|
3427
|
+
/**
|
|
3428
|
+
* A list of permissions.
|
|
3429
|
+
*/
|
|
3430
|
+
'permissions': Array<DeclarativeVisualizationObjectExtensionPermissionsInner>;
|
|
3431
|
+
}
|
|
3432
|
+
/**
|
|
3433
|
+
* @type DeclarativeVisualizationObjectExtensionPermissionsInner
|
|
3434
|
+
*/
|
|
3435
|
+
export type DeclarativeVisualizationObjectExtensionPermissionsInner = DeclarativeVisualizationObjectPermissionForAssignee | DeclarativeVisualizationObjectPermissionForAssigneeRule;
|
|
3393
3436
|
/**
|
|
3394
3437
|
* Visualization object permission.
|
|
3395
3438
|
*/
|
|
@@ -3804,8 +3847,11 @@ export interface FactPermissionsForAssigneeRule {
|
|
|
3804
3847
|
}
|
|
3805
3848
|
export type FactPermissionsForAssigneeRulePermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
|
|
3806
3849
|
export interface FeatureFlagsContext {
|
|
3850
|
+
'controlledFeatureRollout': string;
|
|
3851
|
+
'dataCenter': string;
|
|
3807
3852
|
'earlyAccess': string;
|
|
3808
3853
|
'earlyAccessValues': Array<string>;
|
|
3854
|
+
'tier': string;
|
|
3809
3855
|
}
|
|
3810
3856
|
/**
|
|
3811
3857
|
* Base Structure for feature flags
|
|
@@ -11354,7 +11400,7 @@ export interface JsonApiOrganizationSettingInAttributes {
|
|
|
11354
11400
|
'content'?: object;
|
|
11355
11401
|
'type'?: JsonApiOrganizationSettingInAttributesTypeEnum;
|
|
11356
11402
|
}
|
|
11357
|
-
export type JsonApiOrganizationSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
11403
|
+
export type JsonApiOrganizationSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE' | 'EMBEDDING_ORIGINS';
|
|
11358
11404
|
export interface JsonApiOrganizationSettingInDocument {
|
|
11359
11405
|
'data': JsonApiOrganizationSettingIn;
|
|
11360
11406
|
}
|
|
@@ -11380,7 +11426,7 @@ export interface JsonApiOrganizationSettingOutAttributes {
|
|
|
11380
11426
|
'content'?: object;
|
|
11381
11427
|
'type'?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
11382
11428
|
}
|
|
11383
|
-
export type JsonApiOrganizationSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
11429
|
+
export type JsonApiOrganizationSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE' | 'EMBEDDING_ORIGINS';
|
|
11384
11430
|
export interface JsonApiOrganizationSettingOutDocument {
|
|
11385
11431
|
'data': JsonApiOrganizationSettingOut;
|
|
11386
11432
|
'links'?: ObjectLinks;
|
|
@@ -11431,7 +11477,7 @@ export interface JsonApiOrganizationSettingPatchAttributes {
|
|
|
11431
11477
|
'content'?: object;
|
|
11432
11478
|
'type'?: JsonApiOrganizationSettingPatchAttributesTypeEnum;
|
|
11433
11479
|
}
|
|
11434
|
-
export type JsonApiOrganizationSettingPatchAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
11480
|
+
export type JsonApiOrganizationSettingPatchAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE' | 'EMBEDDING_ORIGINS';
|
|
11435
11481
|
export interface JsonApiOrganizationSettingPatchDocument {
|
|
11436
11482
|
'data': JsonApiOrganizationSettingPatch;
|
|
11437
11483
|
}
|
|
@@ -11672,10 +11718,7 @@ export interface JsonApiPublisherDocumentIn {
|
|
|
11672
11718
|
export type JsonApiPublisherDocumentInTypeEnum = 'document';
|
|
11673
11719
|
export interface JsonApiPublisherDocumentInAttributes {
|
|
11674
11720
|
'areRelationsValid'?: boolean;
|
|
11675
|
-
|
|
11676
|
-
* Free-form document definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
11677
|
-
*/
|
|
11678
|
-
'content': object;
|
|
11721
|
+
'content': JsonApiPublisherDocumentInAttributesContent;
|
|
11679
11722
|
'description'?: string;
|
|
11680
11723
|
'period': JsonApiPublisherDocumentInAttributesPeriod;
|
|
11681
11724
|
'tags'?: Array<string>;
|
|
@@ -11685,6 +11728,34 @@ export interface JsonApiPublisherDocumentInAttributes {
|
|
|
11685
11728
|
*/
|
|
11686
11729
|
'version': string;
|
|
11687
11730
|
}
|
|
11731
|
+
/**
|
|
11732
|
+
* Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.
|
|
11733
|
+
*/
|
|
11734
|
+
export interface JsonApiPublisherDocumentInAttributesContent {
|
|
11735
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
11736
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
11737
|
+
/**
|
|
11738
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
11739
|
+
*/
|
|
11740
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
11741
|
+
/**
|
|
11742
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
11743
|
+
*/
|
|
11744
|
+
'formatLocale'?: string;
|
|
11745
|
+
/**
|
|
11746
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
11747
|
+
*/
|
|
11748
|
+
'locale'?: string;
|
|
11749
|
+
/**
|
|
11750
|
+
* The document\'s pages, when it has no sections.
|
|
11751
|
+
*/
|
|
11752
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
11753
|
+
/**
|
|
11754
|
+
* Groups of pages, when the document has no top-level pages.
|
|
11755
|
+
*/
|
|
11756
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
11757
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
11758
|
+
}
|
|
11688
11759
|
/**
|
|
11689
11760
|
* @type JsonApiPublisherDocumentInAttributesPeriod
|
|
11690
11761
|
* The period the document covers, absolute or relative to today.
|
|
@@ -11716,10 +11787,7 @@ export interface JsonApiPublisherDocumentOut {
|
|
|
11716
11787
|
export type JsonApiPublisherDocumentOutTypeEnum = 'document';
|
|
11717
11788
|
export interface JsonApiPublisherDocumentOutAttributes {
|
|
11718
11789
|
'areRelationsValid'?: boolean;
|
|
11719
|
-
|
|
11720
|
-
* Free-form document definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
11721
|
-
*/
|
|
11722
|
-
'content': object;
|
|
11790
|
+
'content': JsonApiPublisherDocumentOutAttributesContent;
|
|
11723
11791
|
/**
|
|
11724
11792
|
* Time of the entity creation.
|
|
11725
11793
|
*/
|
|
@@ -11737,6 +11805,34 @@ export interface JsonApiPublisherDocumentOutAttributes {
|
|
|
11737
11805
|
*/
|
|
11738
11806
|
'version': string;
|
|
11739
11807
|
}
|
|
11808
|
+
/**
|
|
11809
|
+
* Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.
|
|
11810
|
+
*/
|
|
11811
|
+
export interface JsonApiPublisherDocumentOutAttributesContent {
|
|
11812
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
11813
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
11814
|
+
/**
|
|
11815
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
11816
|
+
*/
|
|
11817
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
11818
|
+
/**
|
|
11819
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
11820
|
+
*/
|
|
11821
|
+
'formatLocale'?: string;
|
|
11822
|
+
/**
|
|
11823
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
11824
|
+
*/
|
|
11825
|
+
'locale'?: string;
|
|
11826
|
+
/**
|
|
11827
|
+
* The document\'s pages, when it has no sections.
|
|
11828
|
+
*/
|
|
11829
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
11830
|
+
/**
|
|
11831
|
+
* Groups of pages, when the document has no top-level pages.
|
|
11832
|
+
*/
|
|
11833
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
11834
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
11835
|
+
}
|
|
11740
11836
|
/**
|
|
11741
11837
|
* @type JsonApiPublisherDocumentOutAttributesPeriod
|
|
11742
11838
|
* The period the document covers, absolute or relative to today.
|
|
@@ -11868,10 +11964,7 @@ export interface JsonApiPublisherDocumentPageTemplateIn {
|
|
|
11868
11964
|
export type JsonApiPublisherDocumentPageTemplateInTypeEnum = 'pageTemplate';
|
|
11869
11965
|
export interface JsonApiPublisherDocumentPageTemplateInAttributes {
|
|
11870
11966
|
'areRelationsValid'?: boolean;
|
|
11871
|
-
|
|
11872
|
-
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
11873
|
-
*/
|
|
11874
|
-
'content': object;
|
|
11967
|
+
'content': JsonApiPublisherDocumentPageTemplateInAttributesContent;
|
|
11875
11968
|
'description'?: string;
|
|
11876
11969
|
'tags'?: Array<string>;
|
|
11877
11970
|
'title': string;
|
|
@@ -11880,6 +11973,28 @@ export interface JsonApiPublisherDocumentPageTemplateInAttributes {
|
|
|
11880
11973
|
*/
|
|
11881
11974
|
'version': string;
|
|
11882
11975
|
}
|
|
11976
|
+
/**
|
|
11977
|
+
* One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.
|
|
11978
|
+
*/
|
|
11979
|
+
export interface JsonApiPublisherDocumentPageTemplateInAttributesContent {
|
|
11980
|
+
/**
|
|
11981
|
+
* Page filters; stored, not applied.
|
|
11982
|
+
*/
|
|
11983
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
11984
|
+
/**
|
|
11985
|
+
* Editor hint.
|
|
11986
|
+
*/
|
|
11987
|
+
'kind'?: JsonApiPublisherDocumentPageTemplateInAttributesContentKindEnum;
|
|
11988
|
+
'layout': PublisherDocumentLayoutNode;
|
|
11989
|
+
/**
|
|
11990
|
+
* Speaker notes in markdown, never drawn.
|
|
11991
|
+
*/
|
|
11992
|
+
'notes'?: string;
|
|
11993
|
+
'pageSize'?: JsonApiPublisherDocumentPageTemplateInAttributesContentPageSizeEnum;
|
|
11994
|
+
'style'?: PublisherDocumentPageStyle;
|
|
11995
|
+
}
|
|
11996
|
+
export type JsonApiPublisherDocumentPageTemplateInAttributesContentKindEnum = 'cover' | 'section' | 'content';
|
|
11997
|
+
export type JsonApiPublisherDocumentPageTemplateInAttributesContentPageSizeEnum = 'widescreen';
|
|
11883
11998
|
export interface JsonApiPublisherDocumentPageTemplateInDocument {
|
|
11884
11999
|
'data': JsonApiPublisherDocumentPageTemplateIn;
|
|
11885
12000
|
}
|
|
@@ -11902,15 +12017,16 @@ export interface JsonApiPublisherDocumentPageTemplateOut {
|
|
|
11902
12017
|
export type JsonApiPublisherDocumentPageTemplateOutTypeEnum = 'pageTemplate';
|
|
11903
12018
|
export interface JsonApiPublisherDocumentPageTemplateOutAttributes {
|
|
11904
12019
|
'areRelationsValid'?: boolean;
|
|
11905
|
-
|
|
11906
|
-
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
11907
|
-
*/
|
|
11908
|
-
'content': object;
|
|
12020
|
+
'content': JsonApiPublisherDocumentPageTemplateOutAttributesContent;
|
|
11909
12021
|
/**
|
|
11910
12022
|
* Time of the entity creation.
|
|
11911
12023
|
*/
|
|
11912
12024
|
'createdAt'?: string | null;
|
|
11913
12025
|
'description'?: string;
|
|
12026
|
+
/**
|
|
12027
|
+
* Whether the backend ships this page template as a read-only default.
|
|
12028
|
+
*/
|
|
12029
|
+
'isDefault': boolean;
|
|
11914
12030
|
/**
|
|
11915
12031
|
* Time of the last entity modification.
|
|
11916
12032
|
*/
|
|
@@ -11922,6 +12038,28 @@ export interface JsonApiPublisherDocumentPageTemplateOutAttributes {
|
|
|
11922
12038
|
*/
|
|
11923
12039
|
'version': string;
|
|
11924
12040
|
}
|
|
12041
|
+
/**
|
|
12042
|
+
* One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.
|
|
12043
|
+
*/
|
|
12044
|
+
export interface JsonApiPublisherDocumentPageTemplateOutAttributesContent {
|
|
12045
|
+
/**
|
|
12046
|
+
* Page filters; stored, not applied.
|
|
12047
|
+
*/
|
|
12048
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12049
|
+
/**
|
|
12050
|
+
* Editor hint.
|
|
12051
|
+
*/
|
|
12052
|
+
'kind'?: JsonApiPublisherDocumentPageTemplateOutAttributesContentKindEnum;
|
|
12053
|
+
'layout': PublisherDocumentLayoutNode;
|
|
12054
|
+
/**
|
|
12055
|
+
* Speaker notes in markdown, never drawn.
|
|
12056
|
+
*/
|
|
12057
|
+
'notes'?: string;
|
|
12058
|
+
'pageSize'?: JsonApiPublisherDocumentPageTemplateOutAttributesContentPageSizeEnum;
|
|
12059
|
+
'style'?: PublisherDocumentPageStyle;
|
|
12060
|
+
}
|
|
12061
|
+
export type JsonApiPublisherDocumentPageTemplateOutAttributesContentKindEnum = 'cover' | 'section' | 'content';
|
|
12062
|
+
export type JsonApiPublisherDocumentPageTemplateOutAttributesContentPageSizeEnum = 'widescreen';
|
|
11925
12063
|
export interface JsonApiPublisherDocumentPageTemplateOutDocument {
|
|
11926
12064
|
'data': JsonApiPublisherDocumentPageTemplateOut;
|
|
11927
12065
|
/**
|
|
@@ -12012,10 +12150,7 @@ export interface JsonApiPublisherDocumentPageTemplatePatch {
|
|
|
12012
12150
|
export type JsonApiPublisherDocumentPageTemplatePatchTypeEnum = 'pageTemplate';
|
|
12013
12151
|
export interface JsonApiPublisherDocumentPageTemplatePatchAttributes {
|
|
12014
12152
|
'areRelationsValid'?: boolean;
|
|
12015
|
-
|
|
12016
|
-
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
12017
|
-
*/
|
|
12018
|
-
'content'?: object;
|
|
12153
|
+
'content'?: JsonApiPublisherDocumentPageTemplatePatchAttributesContent;
|
|
12019
12154
|
'description'?: string;
|
|
12020
12155
|
'tags'?: Array<string>;
|
|
12021
12156
|
'title'?: string;
|
|
@@ -12024,6 +12159,28 @@ export interface JsonApiPublisherDocumentPageTemplatePatchAttributes {
|
|
|
12024
12159
|
*/
|
|
12025
12160
|
'version'?: string;
|
|
12026
12161
|
}
|
|
12162
|
+
/**
|
|
12163
|
+
* One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.
|
|
12164
|
+
*/
|
|
12165
|
+
export interface JsonApiPublisherDocumentPageTemplatePatchAttributesContent {
|
|
12166
|
+
/**
|
|
12167
|
+
* Page filters; stored, not applied.
|
|
12168
|
+
*/
|
|
12169
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12170
|
+
/**
|
|
12171
|
+
* Editor hint.
|
|
12172
|
+
*/
|
|
12173
|
+
'kind'?: JsonApiPublisherDocumentPageTemplatePatchAttributesContentKindEnum;
|
|
12174
|
+
'layout': PublisherDocumentLayoutNode;
|
|
12175
|
+
/**
|
|
12176
|
+
* Speaker notes in markdown, never drawn.
|
|
12177
|
+
*/
|
|
12178
|
+
'notes'?: string;
|
|
12179
|
+
'pageSize'?: JsonApiPublisherDocumentPageTemplatePatchAttributesContentPageSizeEnum;
|
|
12180
|
+
'style'?: PublisherDocumentPageStyle;
|
|
12181
|
+
}
|
|
12182
|
+
export type JsonApiPublisherDocumentPageTemplatePatchAttributesContentKindEnum = 'cover' | 'section' | 'content';
|
|
12183
|
+
export type JsonApiPublisherDocumentPageTemplatePatchAttributesContentPageSizeEnum = 'widescreen';
|
|
12027
12184
|
export interface JsonApiPublisherDocumentPageTemplatePatchDocument {
|
|
12028
12185
|
'data': JsonApiPublisherDocumentPageTemplatePatch;
|
|
12029
12186
|
}
|
|
@@ -12044,10 +12201,7 @@ export interface JsonApiPublisherDocumentPageTemplatePostOptionalId {
|
|
|
12044
12201
|
export type JsonApiPublisherDocumentPageTemplatePostOptionalIdTypeEnum = 'pageTemplate';
|
|
12045
12202
|
export interface JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributes {
|
|
12046
12203
|
'areRelationsValid'?: boolean;
|
|
12047
|
-
|
|
12048
|
-
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
12049
|
-
*/
|
|
12050
|
-
'content': object;
|
|
12204
|
+
'content': JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContent;
|
|
12051
12205
|
'description'?: string;
|
|
12052
12206
|
'tags'?: Array<string>;
|
|
12053
12207
|
'title': string;
|
|
@@ -12056,6 +12210,28 @@ export interface JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributes {
|
|
|
12056
12210
|
*/
|
|
12057
12211
|
'version': string;
|
|
12058
12212
|
}
|
|
12213
|
+
/**
|
|
12214
|
+
* One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.
|
|
12215
|
+
*/
|
|
12216
|
+
export interface JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContent {
|
|
12217
|
+
/**
|
|
12218
|
+
* Page filters; stored, not applied.
|
|
12219
|
+
*/
|
|
12220
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12221
|
+
/**
|
|
12222
|
+
* Editor hint.
|
|
12223
|
+
*/
|
|
12224
|
+
'kind'?: JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContentKindEnum;
|
|
12225
|
+
'layout': PublisherDocumentLayoutNode;
|
|
12226
|
+
/**
|
|
12227
|
+
* Speaker notes in markdown, never drawn.
|
|
12228
|
+
*/
|
|
12229
|
+
'notes'?: string;
|
|
12230
|
+
'pageSize'?: JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContentPageSizeEnum;
|
|
12231
|
+
'style'?: PublisherDocumentPageStyle;
|
|
12232
|
+
}
|
|
12233
|
+
export type JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContentKindEnum = 'cover' | 'section' | 'content';
|
|
12234
|
+
export type JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContentPageSizeEnum = 'widescreen';
|
|
12059
12235
|
export interface JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument {
|
|
12060
12236
|
'data': JsonApiPublisherDocumentPageTemplatePostOptionalId;
|
|
12061
12237
|
}
|
|
@@ -12076,10 +12252,7 @@ export interface JsonApiPublisherDocumentPatch {
|
|
|
12076
12252
|
export type JsonApiPublisherDocumentPatchTypeEnum = 'document';
|
|
12077
12253
|
export interface JsonApiPublisherDocumentPatchAttributes {
|
|
12078
12254
|
'areRelationsValid'?: boolean;
|
|
12079
|
-
|
|
12080
|
-
* Free-form document definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
12081
|
-
*/
|
|
12082
|
-
'content'?: object;
|
|
12255
|
+
'content'?: JsonApiPublisherDocumentPatchAttributesContent;
|
|
12083
12256
|
'description'?: string;
|
|
12084
12257
|
'period'?: JsonApiPublisherDocumentPatchAttributesPeriod;
|
|
12085
12258
|
'tags'?: Array<string>;
|
|
@@ -12089,6 +12262,34 @@ export interface JsonApiPublisherDocumentPatchAttributes {
|
|
|
12089
12262
|
*/
|
|
12090
12263
|
'version'?: string;
|
|
12091
12264
|
}
|
|
12265
|
+
/**
|
|
12266
|
+
* Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.
|
|
12267
|
+
*/
|
|
12268
|
+
export interface JsonApiPublisherDocumentPatchAttributesContent {
|
|
12269
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12270
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12271
|
+
/**
|
|
12272
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12273
|
+
*/
|
|
12274
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12275
|
+
/**
|
|
12276
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12277
|
+
*/
|
|
12278
|
+
'formatLocale'?: string;
|
|
12279
|
+
/**
|
|
12280
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12281
|
+
*/
|
|
12282
|
+
'locale'?: string;
|
|
12283
|
+
/**
|
|
12284
|
+
* The document\'s pages, when it has no sections.
|
|
12285
|
+
*/
|
|
12286
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12287
|
+
/**
|
|
12288
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12289
|
+
*/
|
|
12290
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12291
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12292
|
+
}
|
|
12092
12293
|
/**
|
|
12093
12294
|
* @type JsonApiPublisherDocumentPatchAttributesPeriod
|
|
12094
12295
|
* The period the document covers, absolute or relative to today.
|
|
@@ -12118,10 +12319,7 @@ export interface JsonApiPublisherDocumentPostOptionalId {
|
|
|
12118
12319
|
export type JsonApiPublisherDocumentPostOptionalIdTypeEnum = 'document';
|
|
12119
12320
|
export interface JsonApiPublisherDocumentPostOptionalIdAttributes {
|
|
12120
12321
|
'areRelationsValid'?: boolean;
|
|
12121
|
-
|
|
12122
|
-
* Free-form document definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
12123
|
-
*/
|
|
12124
|
-
'content': object;
|
|
12322
|
+
'content': JsonApiPublisherDocumentPostOptionalIdAttributesContent;
|
|
12125
12323
|
'description'?: string;
|
|
12126
12324
|
'period': JsonApiPublisherDocumentPostOptionalIdAttributesPeriod;
|
|
12127
12325
|
'tags'?: Array<string>;
|
|
@@ -12131,6 +12329,34 @@ export interface JsonApiPublisherDocumentPostOptionalIdAttributes {
|
|
|
12131
12329
|
*/
|
|
12132
12330
|
'version': string;
|
|
12133
12331
|
}
|
|
12332
|
+
/**
|
|
12333
|
+
* Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.
|
|
12334
|
+
*/
|
|
12335
|
+
export interface JsonApiPublisherDocumentPostOptionalIdAttributesContent {
|
|
12336
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12337
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12338
|
+
/**
|
|
12339
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12340
|
+
*/
|
|
12341
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12342
|
+
/**
|
|
12343
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12344
|
+
*/
|
|
12345
|
+
'formatLocale'?: string;
|
|
12346
|
+
/**
|
|
12347
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12348
|
+
*/
|
|
12349
|
+
'locale'?: string;
|
|
12350
|
+
/**
|
|
12351
|
+
* The document\'s pages, when it has no sections.
|
|
12352
|
+
*/
|
|
12353
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12354
|
+
/**
|
|
12355
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12356
|
+
*/
|
|
12357
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12358
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12359
|
+
}
|
|
12134
12360
|
/**
|
|
12135
12361
|
* @type JsonApiPublisherDocumentPostOptionalIdAttributesPeriod
|
|
12136
12362
|
* The period the document covers, absolute or relative to today.
|
|
@@ -12160,10 +12386,7 @@ export interface JsonApiPublisherDocumentTemplateIn {
|
|
|
12160
12386
|
export type JsonApiPublisherDocumentTemplateInTypeEnum = 'documentTemplate';
|
|
12161
12387
|
export interface JsonApiPublisherDocumentTemplateInAttributes {
|
|
12162
12388
|
'areRelationsValid'?: boolean;
|
|
12163
|
-
|
|
12164
|
-
* Free-form document template definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
12165
|
-
*/
|
|
12166
|
-
'content': object;
|
|
12389
|
+
'content': JsonApiPublisherDocumentTemplateInAttributesContent;
|
|
12167
12390
|
'description'?: string;
|
|
12168
12391
|
'tags'?: Array<string>;
|
|
12169
12392
|
'title': string;
|
|
@@ -12172,6 +12395,34 @@ export interface JsonApiPublisherDocumentTemplateInAttributes {
|
|
|
12172
12395
|
*/
|
|
12173
12396
|
'version': string;
|
|
12174
12397
|
}
|
|
12398
|
+
/**
|
|
12399
|
+
* Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.
|
|
12400
|
+
*/
|
|
12401
|
+
export interface JsonApiPublisherDocumentTemplateInAttributesContent {
|
|
12402
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12403
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12404
|
+
/**
|
|
12405
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12406
|
+
*/
|
|
12407
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12408
|
+
/**
|
|
12409
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12410
|
+
*/
|
|
12411
|
+
'formatLocale'?: string;
|
|
12412
|
+
/**
|
|
12413
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12414
|
+
*/
|
|
12415
|
+
'locale'?: string;
|
|
12416
|
+
/**
|
|
12417
|
+
* The document\'s pages, when it has no sections.
|
|
12418
|
+
*/
|
|
12419
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12420
|
+
/**
|
|
12421
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12422
|
+
*/
|
|
12423
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12424
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12425
|
+
}
|
|
12175
12426
|
export interface JsonApiPublisherDocumentTemplateInDocument {
|
|
12176
12427
|
'data': JsonApiPublisherDocumentTemplateIn;
|
|
12177
12428
|
}
|
|
@@ -12194,10 +12445,7 @@ export interface JsonApiPublisherDocumentTemplateOut {
|
|
|
12194
12445
|
export type JsonApiPublisherDocumentTemplateOutTypeEnum = 'documentTemplate';
|
|
12195
12446
|
export interface JsonApiPublisherDocumentTemplateOutAttributes {
|
|
12196
12447
|
'areRelationsValid'?: boolean;
|
|
12197
|
-
|
|
12198
|
-
* Free-form document template definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
12199
|
-
*/
|
|
12200
|
-
'content': object;
|
|
12448
|
+
'content': JsonApiPublisherDocumentTemplateOutAttributesContent;
|
|
12201
12449
|
/**
|
|
12202
12450
|
* Time of the entity creation.
|
|
12203
12451
|
*/
|
|
@@ -12214,6 +12462,34 @@ export interface JsonApiPublisherDocumentTemplateOutAttributes {
|
|
|
12214
12462
|
*/
|
|
12215
12463
|
'version': string;
|
|
12216
12464
|
}
|
|
12465
|
+
/**
|
|
12466
|
+
* Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.
|
|
12467
|
+
*/
|
|
12468
|
+
export interface JsonApiPublisherDocumentTemplateOutAttributesContent {
|
|
12469
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12470
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12471
|
+
/**
|
|
12472
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12473
|
+
*/
|
|
12474
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12475
|
+
/**
|
|
12476
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12477
|
+
*/
|
|
12478
|
+
'formatLocale'?: string;
|
|
12479
|
+
/**
|
|
12480
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12481
|
+
*/
|
|
12482
|
+
'locale'?: string;
|
|
12483
|
+
/**
|
|
12484
|
+
* The document\'s pages, when it has no sections.
|
|
12485
|
+
*/
|
|
12486
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12487
|
+
/**
|
|
12488
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12489
|
+
*/
|
|
12490
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12491
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12492
|
+
}
|
|
12217
12493
|
export interface JsonApiPublisherDocumentTemplateOutDocument {
|
|
12218
12494
|
'data': JsonApiPublisherDocumentTemplateOut;
|
|
12219
12495
|
/**
|
|
@@ -12304,10 +12580,7 @@ export interface JsonApiPublisherDocumentTemplatePatch {
|
|
|
12304
12580
|
export type JsonApiPublisherDocumentTemplatePatchTypeEnum = 'documentTemplate';
|
|
12305
12581
|
export interface JsonApiPublisherDocumentTemplatePatchAttributes {
|
|
12306
12582
|
'areRelationsValid'?: boolean;
|
|
12307
|
-
|
|
12308
|
-
* Free-form document template definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
12309
|
-
*/
|
|
12310
|
-
'content'?: object;
|
|
12583
|
+
'content'?: JsonApiPublisherDocumentTemplatePatchAttributesContent;
|
|
12311
12584
|
'description'?: string;
|
|
12312
12585
|
'tags'?: Array<string>;
|
|
12313
12586
|
'title'?: string;
|
|
@@ -12316,6 +12589,34 @@ export interface JsonApiPublisherDocumentTemplatePatchAttributes {
|
|
|
12316
12589
|
*/
|
|
12317
12590
|
'version'?: string;
|
|
12318
12591
|
}
|
|
12592
|
+
/**
|
|
12593
|
+
* Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.
|
|
12594
|
+
*/
|
|
12595
|
+
export interface JsonApiPublisherDocumentTemplatePatchAttributesContent {
|
|
12596
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12597
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12598
|
+
/**
|
|
12599
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12600
|
+
*/
|
|
12601
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12602
|
+
/**
|
|
12603
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12604
|
+
*/
|
|
12605
|
+
'formatLocale'?: string;
|
|
12606
|
+
/**
|
|
12607
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12608
|
+
*/
|
|
12609
|
+
'locale'?: string;
|
|
12610
|
+
/**
|
|
12611
|
+
* The document\'s pages, when it has no sections.
|
|
12612
|
+
*/
|
|
12613
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12614
|
+
/**
|
|
12615
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12616
|
+
*/
|
|
12617
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12618
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12619
|
+
}
|
|
12319
12620
|
export interface JsonApiPublisherDocumentTemplatePatchDocument {
|
|
12320
12621
|
'data': JsonApiPublisherDocumentTemplatePatch;
|
|
12321
12622
|
}
|
|
@@ -12336,10 +12637,7 @@ export interface JsonApiPublisherDocumentTemplatePostOptionalId {
|
|
|
12336
12637
|
export type JsonApiPublisherDocumentTemplatePostOptionalIdTypeEnum = 'documentTemplate';
|
|
12337
12638
|
export interface JsonApiPublisherDocumentTemplatePostOptionalIdAttributes {
|
|
12338
12639
|
'areRelationsValid'?: boolean;
|
|
12339
|
-
|
|
12340
|
-
* Free-form document template definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
12341
|
-
*/
|
|
12342
|
-
'content': object;
|
|
12640
|
+
'content': JsonApiPublisherDocumentTemplatePostOptionalIdAttributesContent;
|
|
12343
12641
|
'description'?: string;
|
|
12344
12642
|
'tags'?: Array<string>;
|
|
12345
12643
|
'title': string;
|
|
@@ -12348,6 +12646,34 @@ export interface JsonApiPublisherDocumentTemplatePostOptionalIdAttributes {
|
|
|
12348
12646
|
*/
|
|
12349
12647
|
'version': string;
|
|
12350
12648
|
}
|
|
12649
|
+
/**
|
|
12650
|
+
* Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.
|
|
12651
|
+
*/
|
|
12652
|
+
export interface JsonApiPublisherDocumentTemplatePostOptionalIdAttributesContent {
|
|
12653
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12654
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12655
|
+
/**
|
|
12656
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12657
|
+
*/
|
|
12658
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12659
|
+
/**
|
|
12660
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12661
|
+
*/
|
|
12662
|
+
'formatLocale'?: string;
|
|
12663
|
+
/**
|
|
12664
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12665
|
+
*/
|
|
12666
|
+
'locale'?: string;
|
|
12667
|
+
/**
|
|
12668
|
+
* The document\'s pages, when it has no sections.
|
|
12669
|
+
*/
|
|
12670
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12671
|
+
/**
|
|
12672
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12673
|
+
*/
|
|
12674
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12675
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12676
|
+
}
|
|
12351
12677
|
export interface JsonApiPublisherDocumentTemplatePostOptionalIdDocument {
|
|
12352
12678
|
'data': JsonApiPublisherDocumentTemplatePostOptionalId;
|
|
12353
12679
|
}
|
|
@@ -13724,7 +14050,7 @@ export interface JsonApiUserSettingInAttributes {
|
|
|
13724
14050
|
'content'?: object;
|
|
13725
14051
|
'type'?: JsonApiUserSettingInAttributesTypeEnum;
|
|
13726
14052
|
}
|
|
13727
|
-
export type JsonApiUserSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
14053
|
+
export type JsonApiUserSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE';
|
|
13728
14054
|
export interface JsonApiUserSettingInDocument {
|
|
13729
14055
|
'data': JsonApiUserSettingIn;
|
|
13730
14056
|
}
|
|
@@ -13750,7 +14076,7 @@ export interface JsonApiUserSettingOutAttributes {
|
|
|
13750
14076
|
'content'?: object;
|
|
13751
14077
|
'type'?: JsonApiUserSettingOutAttributesTypeEnum;
|
|
13752
14078
|
}
|
|
13753
|
-
export type JsonApiUserSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
14079
|
+
export type JsonApiUserSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE';
|
|
13754
14080
|
export interface JsonApiUserSettingOutDocument {
|
|
13755
14081
|
'data': JsonApiUserSettingOut;
|
|
13756
14082
|
'links'?: ObjectLinks;
|
|
@@ -15282,7 +15608,7 @@ export interface JsonApiWorkspaceSettingInAttributes {
|
|
|
15282
15608
|
'content'?: object;
|
|
15283
15609
|
'type'?: JsonApiWorkspaceSettingInAttributesTypeEnum;
|
|
15284
15610
|
}
|
|
15285
|
-
export type JsonApiWorkspaceSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
15611
|
+
export type JsonApiWorkspaceSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE';
|
|
15286
15612
|
export interface JsonApiWorkspaceSettingInDocument {
|
|
15287
15613
|
'data': JsonApiWorkspaceSettingIn;
|
|
15288
15614
|
}
|
|
@@ -15309,7 +15635,7 @@ export interface JsonApiWorkspaceSettingOutAttributes {
|
|
|
15309
15635
|
'content'?: object;
|
|
15310
15636
|
'type'?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
15311
15637
|
}
|
|
15312
|
-
export type JsonApiWorkspaceSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
15638
|
+
export type JsonApiWorkspaceSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE';
|
|
15313
15639
|
export interface JsonApiWorkspaceSettingOutDocument {
|
|
15314
15640
|
'data': JsonApiWorkspaceSettingOut;
|
|
15315
15641
|
'links'?: ObjectLinks;
|
|
@@ -15375,7 +15701,7 @@ export interface JsonApiWorkspaceSettingPatchAttributes {
|
|
|
15375
15701
|
'content'?: object;
|
|
15376
15702
|
'type'?: JsonApiWorkspaceSettingPatchAttributesTypeEnum;
|
|
15377
15703
|
}
|
|
15378
|
-
export type JsonApiWorkspaceSettingPatchAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
15704
|
+
export type JsonApiWorkspaceSettingPatchAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE';
|
|
15379
15705
|
export interface JsonApiWorkspaceSettingPatchDocument {
|
|
15380
15706
|
'data': JsonApiWorkspaceSettingPatch;
|
|
15381
15707
|
}
|
|
@@ -15401,7 +15727,7 @@ export interface JsonApiWorkspaceSettingPostOptionalIdAttributes {
|
|
|
15401
15727
|
'content'?: object;
|
|
15402
15728
|
'type'?: JsonApiWorkspaceSettingPostOptionalIdAttributesTypeEnum;
|
|
15403
15729
|
}
|
|
15404
|
-
export type JsonApiWorkspaceSettingPostOptionalIdAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
15730
|
+
export type JsonApiWorkspaceSettingPostOptionalIdAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE';
|
|
15405
15731
|
export interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
15406
15732
|
'data': JsonApiWorkspaceSettingPostOptionalId;
|
|
15407
15733
|
}
|
|
@@ -15650,6 +15976,10 @@ export interface LocalizationDefaults {
|
|
|
15650
15976
|
*/
|
|
15651
15977
|
export interface LocalizationMetadataStatistics {
|
|
15652
15978
|
'locales': Array<LocalizationStatisticsLocale>;
|
|
15979
|
+
/**
|
|
15980
|
+
* Translation counts of the workspace and each parent workspace, root first. Present only with `includeCoverage=true` on the workspace endpoint.
|
|
15981
|
+
*/
|
|
15982
|
+
'workspaces'?: Array<LocalizationStatisticsWorkspace>;
|
|
15653
15983
|
}
|
|
15654
15984
|
/**
|
|
15655
15985
|
* The value a workspace gets for one setting, and where it comes from. Never null. `content.value` is null when the workspace gets no language.
|
|
@@ -15707,6 +16037,44 @@ export interface LocalizationStatisticsLocale {
|
|
|
15707
16037
|
*/
|
|
15708
16038
|
'locale': string;
|
|
15709
16039
|
}
|
|
16040
|
+
/**
|
|
16041
|
+
* Translated texts of one workspace in one language.
|
|
16042
|
+
*/
|
|
16043
|
+
export interface LocalizationStatisticsTranslatedLocale {
|
|
16044
|
+
/**
|
|
16045
|
+
* Language tag.
|
|
16046
|
+
*/
|
|
16047
|
+
'locale': string;
|
|
16048
|
+
/**
|
|
16049
|
+
* Texts of the workspace with a translation. A title, description or tag edited after its translation still counts.
|
|
16050
|
+
*/
|
|
16051
|
+
'translated': number;
|
|
16052
|
+
}
|
|
16053
|
+
/**
|
|
16054
|
+
* Metadata texts of one workspace. A row counts only the texts that the workspace owns. A child workspace sums its row and the rows of its parents.
|
|
16055
|
+
*/
|
|
16056
|
+
export interface LocalizationStatisticsWorkspace {
|
|
16057
|
+
/**
|
|
16058
|
+
* Workspace ID.
|
|
16059
|
+
*/
|
|
16060
|
+
'id': string;
|
|
16061
|
+
/**
|
|
16062
|
+
* Every language of `metadata.locales`, sorted, with 0 where nothing is translated.
|
|
16063
|
+
*/
|
|
16064
|
+
'locales': Array<LocalizationStatisticsTranslatedLocale>;
|
|
16065
|
+
/**
|
|
16066
|
+
* Workspace name.
|
|
16067
|
+
*/
|
|
16068
|
+
'name': string;
|
|
16069
|
+
/**
|
|
16070
|
+
* Parent workspace ID, null for a root workspace.
|
|
16071
|
+
*/
|
|
16072
|
+
'parentId'?: string | null;
|
|
16073
|
+
/**
|
|
16074
|
+
* Titles, descriptions, tags and free-form texts the workspace owns. Blank texts are not counted.
|
|
16075
|
+
*/
|
|
16076
|
+
'total': number;
|
|
16077
|
+
}
|
|
15710
16078
|
export interface LocalizationUsage {
|
|
15711
16079
|
'defaults': LocalizationDefaults;
|
|
15712
16080
|
'values': Array<LocalizationUsageValue>;
|
|
@@ -16317,6 +16685,838 @@ export interface ProfileLinks {
|
|
|
16317
16685
|
'self': string;
|
|
16318
16686
|
'user': string;
|
|
16319
16687
|
}
|
|
16688
|
+
/**
|
|
16689
|
+
* Filters an attribute display form by arbitrary values.
|
|
16690
|
+
*/
|
|
16691
|
+
export interface PublisherDocumentArbitraryAttributeFilter {
|
|
16692
|
+
'arbitraryAttributeFilter': PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter;
|
|
16693
|
+
}
|
|
16694
|
+
export interface PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter {
|
|
16695
|
+
'displayForm': PublisherDocumentObjRef;
|
|
16696
|
+
'filterElementsBy'?: Array<PublisherDocumentAttributeFilterParent>;
|
|
16697
|
+
'filterElementsByDate'?: Array<PublisherDocumentAttributeFilterByDate>;
|
|
16698
|
+
/**
|
|
16699
|
+
* Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.
|
|
16700
|
+
*/
|
|
16701
|
+
'localIdentifier'?: string;
|
|
16702
|
+
'negativeSelection': boolean;
|
|
16703
|
+
'title'?: string;
|
|
16704
|
+
'validateElementsBy'?: Array<PublisherDocumentObjRef>;
|
|
16705
|
+
/**
|
|
16706
|
+
* Values; `null` stands for an empty value.
|
|
16707
|
+
*/
|
|
16708
|
+
'values': Array<string | null>;
|
|
16709
|
+
}
|
|
16710
|
+
/**
|
|
16711
|
+
* Style of the area behind the pages. Lengths are in canvas px.
|
|
16712
|
+
*/
|
|
16713
|
+
export interface PublisherDocumentAreaStyle {
|
|
16714
|
+
'backgroundColor'?: string;
|
|
16715
|
+
'backgroundFit'?: PublisherDocumentAreaStyleBackgroundFitEnum;
|
|
16716
|
+
'backgroundHorizontalAlign'?: PublisherDocumentAreaStyleBackgroundHorizontalAlignEnum;
|
|
16717
|
+
'backgroundImage'?: string;
|
|
16718
|
+
'backgroundImageOpacity'?: number;
|
|
16719
|
+
'backgroundOffset'?: number;
|
|
16720
|
+
'backgroundOffsetBottom'?: number;
|
|
16721
|
+
'backgroundOffsetLeft'?: number;
|
|
16722
|
+
'backgroundOffsetRight'?: number;
|
|
16723
|
+
'backgroundOffsetTop'?: number;
|
|
16724
|
+
'backgroundOpacity'?: number;
|
|
16725
|
+
'backgroundVerticalAlign'?: PublisherDocumentAreaStyleBackgroundVerticalAlignEnum;
|
|
16726
|
+
'gap'?: PublisherDocumentAreaStyleGap;
|
|
16727
|
+
}
|
|
16728
|
+
export type PublisherDocumentAreaStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
16729
|
+
export type PublisherDocumentAreaStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
16730
|
+
export type PublisherDocumentAreaStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
16731
|
+
/**
|
|
16732
|
+
* @type PublisherDocumentAreaStyleGap
|
|
16733
|
+
* A length, or `{theme.spacing.gap.<compact|normal|spacious>}`.
|
|
16734
|
+
*/
|
|
16735
|
+
export type PublisherDocumentAreaStyleGap = number | string;
|
|
16736
|
+
/**
|
|
16737
|
+
* @type PublisherDocumentAttributeElements
|
|
16738
|
+
* Selected attribute elements: `{\"values\": [...]}` or `{\"uris\": [...]}`.
|
|
16739
|
+
*/
|
|
16740
|
+
export type PublisherDocumentAttributeElements = PublisherDocumentAttributeElementsByUri | PublisherDocumentAttributeElementsByValue;
|
|
16741
|
+
export interface PublisherDocumentAttributeElementsByUri {
|
|
16742
|
+
/**
|
|
16743
|
+
* Element URIs; `null` stands for an empty value.
|
|
16744
|
+
*/
|
|
16745
|
+
'uris': Array<string>;
|
|
16746
|
+
}
|
|
16747
|
+
export interface PublisherDocumentAttributeElementsByValue {
|
|
16748
|
+
/**
|
|
16749
|
+
* Element values; `null` stands for an empty value.
|
|
16750
|
+
*/
|
|
16751
|
+
'values': Array<string | null>;
|
|
16752
|
+
}
|
|
16753
|
+
/**
|
|
16754
|
+
* Filters an attribute display form by a list of elements.
|
|
16755
|
+
*/
|
|
16756
|
+
export interface PublisherDocumentAttributeFilter {
|
|
16757
|
+
'attributeFilter': PublisherDocumentAttributeFilterAttributeFilter;
|
|
16758
|
+
}
|
|
16759
|
+
export interface PublisherDocumentAttributeFilterAttributeFilter {
|
|
16760
|
+
'attributeElements': PublisherDocumentAttributeElements;
|
|
16761
|
+
'displayForm': PublisherDocumentObjRef;
|
|
16762
|
+
/**
|
|
16763
|
+
* Parent filters that limit the offered elements.
|
|
16764
|
+
*/
|
|
16765
|
+
'filterElementsBy'?: Array<PublisherDocumentAttributeFilterParent>;
|
|
16766
|
+
/**
|
|
16767
|
+
* Date filters that limit the offered elements.
|
|
16768
|
+
*/
|
|
16769
|
+
'filterElementsByDate'?: Array<PublisherDocumentAttributeFilterByDate>;
|
|
16770
|
+
/**
|
|
16771
|
+
* Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.
|
|
16772
|
+
*/
|
|
16773
|
+
'localIdentifier'?: string;
|
|
16774
|
+
'negativeSelection': boolean;
|
|
16775
|
+
'selectionMode'?: PublisherDocumentAttributeFilterAttributeFilterSelectionModeEnum;
|
|
16776
|
+
'title'?: string;
|
|
16777
|
+
'validateElementsBy'?: Array<PublisherDocumentObjRef>;
|
|
16778
|
+
}
|
|
16779
|
+
export type PublisherDocumentAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
|
|
16780
|
+
/**
|
|
16781
|
+
* A date filter that limits the offered elements.
|
|
16782
|
+
*/
|
|
16783
|
+
export interface PublisherDocumentAttributeFilterByDate {
|
|
16784
|
+
'dataSet'?: PublisherDocumentObjRef;
|
|
16785
|
+
'filterLocalIdentifier': string;
|
|
16786
|
+
'isCommonDate': boolean;
|
|
16787
|
+
}
|
|
16788
|
+
/**
|
|
16789
|
+
* How a document attribute filter is shown, as in dashboards.
|
|
16790
|
+
*/
|
|
16791
|
+
export interface PublisherDocumentAttributeFilterConfig {
|
|
16792
|
+
'displayAsLabel'?: PublisherDocumentObjRef;
|
|
16793
|
+
'localIdentifier': string;
|
|
16794
|
+
'mode'?: PublisherDocumentAttributeFilterConfigModeEnum;
|
|
16795
|
+
'selectionType'?: PublisherDocumentAttributeFilterConfigSelectionTypeEnum;
|
|
16796
|
+
}
|
|
16797
|
+
export type PublisherDocumentAttributeFilterConfigModeEnum = 'readonly' | 'hidden' | 'active';
|
|
16798
|
+
export type PublisherDocumentAttributeFilterConfigSelectionTypeEnum = 'list' | 'text' | 'listOrText';
|
|
16799
|
+
/**
|
|
16800
|
+
* A parent attribute filter that limits the offered elements.
|
|
16801
|
+
*/
|
|
16802
|
+
export interface PublisherDocumentAttributeFilterParent {
|
|
16803
|
+
'filterLocalIdentifier': string;
|
|
16804
|
+
'over': PublisherDocumentAttributeFilterParentOver;
|
|
16805
|
+
}
|
|
16806
|
+
/**
|
|
16807
|
+
* Attributes that connect the parent and the child filter in the data model.
|
|
16808
|
+
*/
|
|
16809
|
+
export interface PublisherDocumentAttributeFilterParentOver {
|
|
16810
|
+
'attributes': Array<PublisherDocumentObjRef>;
|
|
16811
|
+
}
|
|
16812
|
+
export interface PublisherDocumentAttributeFilterReference {
|
|
16813
|
+
'displayForm': PublisherDocumentObjRef;
|
|
16814
|
+
'type': PublisherDocumentAttributeFilterReferenceTypeEnum;
|
|
16815
|
+
}
|
|
16816
|
+
export type PublisherDocumentAttributeFilterReferenceTypeEnum = 'attributeFilterReference';
|
|
16817
|
+
export interface PublisherDocumentAutoVisibility {
|
|
16818
|
+
'visible'?: PublisherDocumentAutoVisibilityVisible;
|
|
16819
|
+
}
|
|
16820
|
+
/**
|
|
16821
|
+
* @type PublisherDocumentAutoVisibilityVisible
|
|
16822
|
+
* `true`, `false` or `\"auto\"`.
|
|
16823
|
+
*/
|
|
16824
|
+
export type PublisherDocumentAutoVisibilityVisible = boolean | string;
|
|
16825
|
+
export interface PublisherDocumentAxisDisplay {
|
|
16826
|
+
'max'?: number;
|
|
16827
|
+
'min'?: number;
|
|
16828
|
+
'name'?: PublisherDocumentAxisNameDisplay;
|
|
16829
|
+
'values'?: PublisherDocumentAxisValuesDisplay;
|
|
16830
|
+
'visible'?: boolean;
|
|
16831
|
+
}
|
|
16832
|
+
export interface PublisherDocumentAxisNameDisplay {
|
|
16833
|
+
'position'?: PublisherDocumentAxisNameDisplayPositionEnum;
|
|
16834
|
+
'visible'?: boolean;
|
|
16835
|
+
}
|
|
16836
|
+
export type PublisherDocumentAxisNameDisplayPositionEnum = 'low' | 'middle' | 'high';
|
|
16837
|
+
export interface PublisherDocumentAxisValuesDisplay {
|
|
16838
|
+
/**
|
|
16839
|
+
* Label rotation in degrees, from -90 to 90.
|
|
16840
|
+
*/
|
|
16841
|
+
'rotation'?: number;
|
|
16842
|
+
'visible'?: boolean;
|
|
16843
|
+
}
|
|
16844
|
+
/**
|
|
16845
|
+
* One open end of a relative date filter: exactly one of `from` and `to`.
|
|
16846
|
+
*/
|
|
16847
|
+
export interface PublisherDocumentBoundedFilter {
|
|
16848
|
+
'from'?: number;
|
|
16849
|
+
'granularity': PublisherDocumentBoundedFilterGranularityEnum;
|
|
16850
|
+
'to'?: number;
|
|
16851
|
+
}
|
|
16852
|
+
export type PublisherDocumentBoundedFilterGranularityEnum = 'GDC.time.second' | 'GDC.time.minute' | 'GDC.time.hour' | 'GDC.time.date' | 'GDC.time.week_us' | 'GDC.time.month' | 'GDC.time.fiscal_month' | 'GDC.time.quarter' | 'GDC.time.fiscal_quarter' | 'GDC.time.year' | 'GDC.time.fiscal_year';
|
|
16853
|
+
/**
|
|
16854
|
+
* Chart style overrides; stored, not applied. Lengths are in canvas px.
|
|
16855
|
+
*/
|
|
16856
|
+
export interface PublisherDocumentChartStyle {
|
|
16857
|
+
'axisLineColor'?: string;
|
|
16858
|
+
'axisNameColor'?: string;
|
|
16859
|
+
'axisNameSize'?: number;
|
|
16860
|
+
'axisValueColor'?: string;
|
|
16861
|
+
'axisValueSize'?: number;
|
|
16862
|
+
'dataLabelColor'?: string;
|
|
16863
|
+
'dataLabelSize'?: number;
|
|
16864
|
+
'fontSize'?: number;
|
|
16865
|
+
'gridColor'?: string;
|
|
16866
|
+
'legendColor'?: string;
|
|
16867
|
+
'legendSize'?: number;
|
|
16868
|
+
'plotLineColor'?: string;
|
|
16869
|
+
'textColor'?: string;
|
|
16870
|
+
}
|
|
16871
|
+
/**
|
|
16872
|
+
* Lays its children out top to bottom.
|
|
16873
|
+
*/
|
|
16874
|
+
export interface PublisherDocumentColumn {
|
|
16875
|
+
/**
|
|
16876
|
+
* Child nodes from top to bottom, in reading order; an empty list is a spacer.
|
|
16877
|
+
*/
|
|
16878
|
+
'children': Array<PublisherDocumentLayoutNode>;
|
|
16879
|
+
'id'?: string;
|
|
16880
|
+
/**
|
|
16881
|
+
* Locks the container in the document editor; never checked on write.
|
|
16882
|
+
*/
|
|
16883
|
+
'locked'?: boolean;
|
|
16884
|
+
/**
|
|
16885
|
+
* Share of the parent\'s main axis, greater than 0. Default 1.
|
|
16886
|
+
*/
|
|
16887
|
+
'proportion'?: number;
|
|
16888
|
+
'style'?: PublisherDocumentContainerStyle;
|
|
16889
|
+
'type': PublisherDocumentColumnTypeEnum;
|
|
16890
|
+
}
|
|
16891
|
+
export type PublisherDocumentColumnTypeEnum = 'column';
|
|
16892
|
+
export interface PublisherDocumentComparisonCondition {
|
|
16893
|
+
'comparison': PublisherDocumentComparisonConditionComparison;
|
|
16894
|
+
}
|
|
16895
|
+
export interface PublisherDocumentComparisonConditionComparison {
|
|
16896
|
+
'operator': PublisherDocumentComparisonConditionComparisonOperatorEnum;
|
|
16897
|
+
'treatNullValuesAs'?: number;
|
|
16898
|
+
'value': number;
|
|
16899
|
+
}
|
|
16900
|
+
export type PublisherDocumentComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
16901
|
+
/**
|
|
16902
|
+
* Style of a row or column; its content inherits the text keys. Lengths are in canvas px.
|
|
16903
|
+
*/
|
|
16904
|
+
export interface PublisherDocumentContainerStyle {
|
|
16905
|
+
'backgroundColor'?: string;
|
|
16906
|
+
'backgroundFit'?: PublisherDocumentContainerStyleBackgroundFitEnum;
|
|
16907
|
+
'backgroundHorizontalAlign'?: PublisherDocumentContainerStyleBackgroundHorizontalAlignEnum;
|
|
16908
|
+
'backgroundImage'?: string;
|
|
16909
|
+
'backgroundImageOpacity'?: number;
|
|
16910
|
+
'backgroundOffset'?: number;
|
|
16911
|
+
'backgroundOffsetBottom'?: number;
|
|
16912
|
+
'backgroundOffsetLeft'?: number;
|
|
16913
|
+
'backgroundOffsetRight'?: number;
|
|
16914
|
+
'backgroundOffsetTop'?: number;
|
|
16915
|
+
'backgroundOpacity'?: number;
|
|
16916
|
+
'backgroundVerticalAlign'?: PublisherDocumentContainerStyleBackgroundVerticalAlignEnum;
|
|
16917
|
+
'borderBottomColor'?: string;
|
|
16918
|
+
'borderBottomLeftRadius'?: PublisherDocumentContainerStyleBorderBottomLeftRadius;
|
|
16919
|
+
'borderBottomRightRadius'?: PublisherDocumentContainerStyleBorderBottomRightRadius;
|
|
16920
|
+
'borderBottomStyle'?: PublisherDocumentContainerStyleBorderBottomStyleEnum;
|
|
16921
|
+
'borderBottomWidth'?: number;
|
|
16922
|
+
'borderColor'?: string;
|
|
16923
|
+
'borderLeftColor'?: string;
|
|
16924
|
+
'borderLeftStyle'?: PublisherDocumentContainerStyleBorderLeftStyleEnum;
|
|
16925
|
+
'borderLeftWidth'?: number;
|
|
16926
|
+
'borderRadius'?: PublisherDocumentContainerStyleBorderRadius;
|
|
16927
|
+
'borderRightColor'?: string;
|
|
16928
|
+
'borderRightStyle'?: PublisherDocumentContainerStyleBorderRightStyleEnum;
|
|
16929
|
+
'borderRightWidth'?: number;
|
|
16930
|
+
'borderStyle'?: PublisherDocumentContainerStyleBorderStyleEnum;
|
|
16931
|
+
'borderTopColor'?: string;
|
|
16932
|
+
'borderTopLeftRadius'?: PublisherDocumentContainerStyleBorderTopLeftRadius;
|
|
16933
|
+
'borderTopRightRadius'?: PublisherDocumentContainerStyleBorderTopRightRadius;
|
|
16934
|
+
'borderTopStyle'?: PublisherDocumentContainerStyleBorderTopStyleEnum;
|
|
16935
|
+
'borderTopWidth'?: number;
|
|
16936
|
+
'borderWidth'?: number;
|
|
16937
|
+
'fontSize'?: number;
|
|
16938
|
+
'fontStyle'?: PublisherDocumentContainerStyleFontStyleEnum;
|
|
16939
|
+
'fontWeight'?: number;
|
|
16940
|
+
'gap'?: PublisherDocumentContainerStyleGap;
|
|
16941
|
+
'horizontalAlign'?: PublisherDocumentContainerStyleHorizontalAlignEnum;
|
|
16942
|
+
'letterSpacing'?: number;
|
|
16943
|
+
'lineHeight'?: number;
|
|
16944
|
+
'opacity'?: number;
|
|
16945
|
+
'padding'?: PublisherDocumentContainerStylePadding;
|
|
16946
|
+
'paddingBottom'?: PublisherDocumentContainerStylePaddingBottom;
|
|
16947
|
+
'paddingLeft'?: PublisherDocumentContainerStylePaddingLeft;
|
|
16948
|
+
'paddingRight'?: PublisherDocumentContainerStylePaddingRight;
|
|
16949
|
+
'paddingTop'?: PublisherDocumentContainerStylePaddingTop;
|
|
16950
|
+
'shadow'?: string;
|
|
16951
|
+
'shadowBlur'?: number;
|
|
16952
|
+
'shadowColor'?: string;
|
|
16953
|
+
'shadowOpacity'?: number;
|
|
16954
|
+
'shadowSpread'?: number;
|
|
16955
|
+
'shadowX'?: number;
|
|
16956
|
+
'shadowY'?: number;
|
|
16957
|
+
'textColor'?: string;
|
|
16958
|
+
'textOverflow'?: PublisherDocumentContainerStyleTextOverflowEnum;
|
|
16959
|
+
'textStyle'?: PublisherDocumentContainerStyleTextStyleEnum;
|
|
16960
|
+
'textTransform'?: PublisherDocumentContainerStyleTextTransformEnum;
|
|
16961
|
+
'verticalAlign'?: PublisherDocumentContainerStyleVerticalAlignEnum;
|
|
16962
|
+
}
|
|
16963
|
+
export type PublisherDocumentContainerStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
16964
|
+
export type PublisherDocumentContainerStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
16965
|
+
export type PublisherDocumentContainerStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
16966
|
+
export type PublisherDocumentContainerStyleBorderBottomStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
16967
|
+
export type PublisherDocumentContainerStyleBorderLeftStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
16968
|
+
export type PublisherDocumentContainerStyleBorderRightStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
16969
|
+
export type PublisherDocumentContainerStyleBorderStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
16970
|
+
export type PublisherDocumentContainerStyleBorderTopStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
16971
|
+
export type PublisherDocumentContainerStyleFontStyleEnum = 'normal' | 'italic';
|
|
16972
|
+
export type PublisherDocumentContainerStyleHorizontalAlignEnum = 'left' | 'center' | 'right' | 'justify';
|
|
16973
|
+
export type PublisherDocumentContainerStyleTextOverflowEnum = 'shrink' | 'clip' | 'ellipsis';
|
|
16974
|
+
export type PublisherDocumentContainerStyleTextStyleEnum = 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText';
|
|
16975
|
+
export type PublisherDocumentContainerStyleTextTransformEnum = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
|
|
16976
|
+
export type PublisherDocumentContainerStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
16977
|
+
/**
|
|
16978
|
+
* @type PublisherDocumentContainerStyleBorderBottomLeftRadius
|
|
16979
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
16980
|
+
*/
|
|
16981
|
+
export type PublisherDocumentContainerStyleBorderBottomLeftRadius = number | string;
|
|
16982
|
+
/**
|
|
16983
|
+
* @type PublisherDocumentContainerStyleBorderBottomRightRadius
|
|
16984
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
16985
|
+
*/
|
|
16986
|
+
export type PublisherDocumentContainerStyleBorderBottomRightRadius = number | string;
|
|
16987
|
+
/**
|
|
16988
|
+
* @type PublisherDocumentContainerStyleBorderRadius
|
|
16989
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
16990
|
+
*/
|
|
16991
|
+
export type PublisherDocumentContainerStyleBorderRadius = number | string;
|
|
16992
|
+
/**
|
|
16993
|
+
* @type PublisherDocumentContainerStyleBorderTopLeftRadius
|
|
16994
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
16995
|
+
*/
|
|
16996
|
+
export type PublisherDocumentContainerStyleBorderTopLeftRadius = number | string;
|
|
16997
|
+
/**
|
|
16998
|
+
* @type PublisherDocumentContainerStyleBorderTopRightRadius
|
|
16999
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17000
|
+
*/
|
|
17001
|
+
export type PublisherDocumentContainerStyleBorderTopRightRadius = number | string;
|
|
17002
|
+
/**
|
|
17003
|
+
* @type PublisherDocumentContainerStyleGap
|
|
17004
|
+
* A length, or `{theme.spacing.gap.<compact|normal|spacious>}`.
|
|
17005
|
+
*/
|
|
17006
|
+
export type PublisherDocumentContainerStyleGap = number | string;
|
|
17007
|
+
/**
|
|
17008
|
+
* @type PublisherDocumentContainerStylePadding
|
|
17009
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17010
|
+
*/
|
|
17011
|
+
export type PublisherDocumentContainerStylePadding = number | string;
|
|
17012
|
+
/**
|
|
17013
|
+
* @type PublisherDocumentContainerStylePaddingBottom
|
|
17014
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17015
|
+
*/
|
|
17016
|
+
export type PublisherDocumentContainerStylePaddingBottom = number | string;
|
|
17017
|
+
/**
|
|
17018
|
+
* @type PublisherDocumentContainerStylePaddingLeft
|
|
17019
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17020
|
+
*/
|
|
17021
|
+
export type PublisherDocumentContainerStylePaddingLeft = number | string;
|
|
17022
|
+
/**
|
|
17023
|
+
* @type PublisherDocumentContainerStylePaddingRight
|
|
17024
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17025
|
+
*/
|
|
17026
|
+
export type PublisherDocumentContainerStylePaddingRight = number | string;
|
|
17027
|
+
/**
|
|
17028
|
+
* @type PublisherDocumentContainerStylePaddingTop
|
|
17029
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17030
|
+
*/
|
|
17031
|
+
export type PublisherDocumentContainerStylePaddingTop = number | string;
|
|
17032
|
+
/**
|
|
17033
|
+
* Content of a document or a document template. Holds `pages` or `sections`, never both.
|
|
17034
|
+
*/
|
|
17035
|
+
export interface PublisherDocumentContent {
|
|
17036
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
17037
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
17038
|
+
/**
|
|
17039
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
17040
|
+
*/
|
|
17041
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
17042
|
+
/**
|
|
17043
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
17044
|
+
*/
|
|
17045
|
+
'formatLocale'?: string;
|
|
17046
|
+
/**
|
|
17047
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
17048
|
+
*/
|
|
17049
|
+
'locale'?: string;
|
|
17050
|
+
/**
|
|
17051
|
+
* The document\'s pages, when it has no sections.
|
|
17052
|
+
*/
|
|
17053
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
17054
|
+
/**
|
|
17055
|
+
* Groups of pages, when the document has no top-level pages.
|
|
17056
|
+
*/
|
|
17057
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
17058
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
17059
|
+
}
|
|
17060
|
+
/**
|
|
17061
|
+
* A date dataset.
|
|
17062
|
+
*/
|
|
17063
|
+
export interface PublisherDocumentDataSetRef {
|
|
17064
|
+
'identifier': string;
|
|
17065
|
+
'type': PublisherDocumentDataSetRefTypeEnum;
|
|
17066
|
+
}
|
|
17067
|
+
export type PublisherDocumentDataSetRefTypeEnum = 'dataSet';
|
|
17068
|
+
/**
|
|
17069
|
+
* Filters a date dataset. A document filter always names its `dataSet`.
|
|
17070
|
+
*/
|
|
17071
|
+
export interface PublisherDocumentDateFilter {
|
|
17072
|
+
'dateFilter': PublisherDocumentDateFilterDateFilter;
|
|
17073
|
+
}
|
|
17074
|
+
export interface PublisherDocumentDateFilterDateFilter {
|
|
17075
|
+
'attribute'?: PublisherDocumentObjRef;
|
|
17076
|
+
'boundedFilter'?: PublisherDocumentBoundedFilter;
|
|
17077
|
+
'dataSet'?: PublisherDocumentObjRef;
|
|
17078
|
+
'emptyValueHandling'?: PublisherDocumentDateFilterDateFilterEmptyValueHandlingEnum;
|
|
17079
|
+
'from'?: PublisherDocumentDateFilterDateFilterFrom;
|
|
17080
|
+
'granularity': PublisherDocumentDateFilterDateFilterGranularityEnum;
|
|
17081
|
+
/**
|
|
17082
|
+
* Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.
|
|
17083
|
+
*/
|
|
17084
|
+
'localIdentifier'?: string;
|
|
17085
|
+
'to'?: PublisherDocumentDateFilterDateFilterTo;
|
|
17086
|
+
'type': PublisherDocumentDateFilterDateFilterTypeEnum;
|
|
17087
|
+
}
|
|
17088
|
+
export type PublisherDocumentDateFilterDateFilterEmptyValueHandlingEnum = 'include' | 'exclude' | 'only';
|
|
17089
|
+
export type PublisherDocumentDateFilterDateFilterGranularityEnum = 'GDC.time.second' | 'GDC.time.minute' | 'GDC.time.hour' | 'GDC.time.date' | 'GDC.time.week_us' | 'GDC.time.month' | 'GDC.time.fiscal_month' | 'GDC.time.quarter' | 'GDC.time.fiscal_quarter' | 'GDC.time.year' | 'GDC.time.fiscal_year';
|
|
17090
|
+
export type PublisherDocumentDateFilterDateFilterTypeEnum = 'relative' | 'absolute';
|
|
17091
|
+
/**
|
|
17092
|
+
* @type PublisherDocumentDateFilterDateFilterFrom
|
|
17093
|
+
* A date, or an offset of a relative filter.
|
|
17094
|
+
*/
|
|
17095
|
+
export type PublisherDocumentDateFilterDateFilterFrom = number | string;
|
|
17096
|
+
/**
|
|
17097
|
+
* @type PublisherDocumentDateFilterDateFilterTo
|
|
17098
|
+
* A date, or an offset of a relative filter.
|
|
17099
|
+
*/
|
|
17100
|
+
export type PublisherDocumentDateFilterDateFilterTo = number | string;
|
|
17101
|
+
export interface PublisherDocumentDateFilterReference {
|
|
17102
|
+
'dataSet': PublisherDocumentObjRef;
|
|
17103
|
+
'type': PublisherDocumentDateFilterReferenceTypeEnum;
|
|
17104
|
+
}
|
|
17105
|
+
export type PublisherDocumentDateFilterReferenceTypeEnum = 'dateFilterReference';
|
|
17106
|
+
/**
|
|
17107
|
+
* Document-wide defaults.
|
|
17108
|
+
*/
|
|
17109
|
+
export interface PublisherDocumentDefaults {
|
|
17110
|
+
/**
|
|
17111
|
+
* Page size of a page that sets none.
|
|
17112
|
+
*/
|
|
17113
|
+
'pageSize'?: PublisherDocumentDefaultsPageSizeEnum;
|
|
17114
|
+
'period'?: PublisherDocumentPeriod;
|
|
17115
|
+
'takeaway'?: PublisherDocumentTakeawayDefaults;
|
|
17116
|
+
}
|
|
17117
|
+
export type PublisherDocumentDefaultsPageSizeEnum = 'widescreen';
|
|
17118
|
+
/**
|
|
17119
|
+
* @type PublisherDocumentFilter
|
|
17120
|
+
* A filter in the dashboard filter grammar, wrapped in an object keyed by its kind.
|
|
17121
|
+
*/
|
|
17122
|
+
export type PublisherDocumentFilter = PublisherDocumentArbitraryAttributeFilter | PublisherDocumentAttributeFilter | PublisherDocumentDateFilter | PublisherDocumentMatchAttributeFilter | PublisherDocumentMeasureValueFilter;
|
|
17123
|
+
/**
|
|
17124
|
+
* @type PublisherDocumentFilterReference
|
|
17125
|
+
* A reference to a document filter, selected by `type`.
|
|
17126
|
+
*/
|
|
17127
|
+
export type PublisherDocumentFilterReference = ({
|
|
17128
|
+
type: 'attributeFilterReference';
|
|
17129
|
+
} & PublisherDocumentAttributeFilterReference) | ({
|
|
17130
|
+
type: 'dateFilterReference';
|
|
17131
|
+
} & PublisherDocumentDateFilterReference) | ({
|
|
17132
|
+
type: 'measureValueFilterReference';
|
|
17133
|
+
} & PublisherDocumentMeasureValueFilterReference);
|
|
17134
|
+
/**
|
|
17135
|
+
* A heading below the page title.
|
|
17136
|
+
*/
|
|
17137
|
+
export interface PublisherDocumentHeadingWidget {
|
|
17138
|
+
/**
|
|
17139
|
+
* Unique within the page.
|
|
17140
|
+
*/
|
|
17141
|
+
'id': string;
|
|
17142
|
+
/**
|
|
17143
|
+
* Outline level below the page title. Default 1.
|
|
17144
|
+
*/
|
|
17145
|
+
'level'?: PublisherDocumentHeadingWidgetLevelEnum;
|
|
17146
|
+
/**
|
|
17147
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17148
|
+
*/
|
|
17149
|
+
'locked'?: boolean;
|
|
17150
|
+
/**
|
|
17151
|
+
* Inline markdown.
|
|
17152
|
+
*/
|
|
17153
|
+
'markdown'?: string;
|
|
17154
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17155
|
+
'proportion'?: number;
|
|
17156
|
+
'style'?: PublisherDocumentTextWidgetStyle;
|
|
17157
|
+
'type': PublisherDocumentHeadingWidgetTypeEnum;
|
|
17158
|
+
}
|
|
17159
|
+
export type PublisherDocumentHeadingWidgetLevelEnum = 1 | 2 | 3 | 4 | 5 | 6;
|
|
17160
|
+
export type PublisherDocumentHeadingWidgetTypeEnum = 'heading';
|
|
17161
|
+
/**
|
|
17162
|
+
* Headline style overrides; stored, not applied. Lengths are in canvas px.
|
|
17163
|
+
*/
|
|
17164
|
+
export interface PublisherDocumentHeadlineStyle {
|
|
17165
|
+
'negativeColor'?: string;
|
|
17166
|
+
'positiveColor'?: string;
|
|
17167
|
+
'primaryValueColor'?: string;
|
|
17168
|
+
'primaryValueSize'?: number;
|
|
17169
|
+
'secondaryValueColor'?: string;
|
|
17170
|
+
'secondaryValueSize'?: number;
|
|
17171
|
+
}
|
|
17172
|
+
/**
|
|
17173
|
+
* An image from the theme or an https URL.
|
|
17174
|
+
*/
|
|
17175
|
+
export interface PublisherDocumentImageWidget {
|
|
17176
|
+
'altText'?: string;
|
|
17177
|
+
/**
|
|
17178
|
+
* Left out of the accessibility tree, PDF tags and the AI context; needs no alt text.
|
|
17179
|
+
*/
|
|
17180
|
+
'decorative'?: boolean;
|
|
17181
|
+
/**
|
|
17182
|
+
* Unique within the page.
|
|
17183
|
+
*/
|
|
17184
|
+
'id': string;
|
|
17185
|
+
/**
|
|
17186
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17187
|
+
*/
|
|
17188
|
+
'locked'?: boolean;
|
|
17189
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17190
|
+
'proportion'?: number;
|
|
17191
|
+
/**
|
|
17192
|
+
* A theme image reference such as `{theme.logo}`, or an `https://` URL.
|
|
17193
|
+
*/
|
|
17194
|
+
'source'?: string;
|
|
17195
|
+
'style'?: PublisherDocumentImageWidgetStyle;
|
|
17196
|
+
'type': PublisherDocumentImageWidgetTypeEnum;
|
|
17197
|
+
}
|
|
17198
|
+
export type PublisherDocumentImageWidgetTypeEnum = 'image';
|
|
17199
|
+
/**
|
|
17200
|
+
* Style of an image widget. Lengths are in canvas px.
|
|
17201
|
+
*/
|
|
17202
|
+
export interface PublisherDocumentImageWidgetStyle {
|
|
17203
|
+
'backgroundColor'?: string;
|
|
17204
|
+
'backgroundFit'?: PublisherDocumentImageWidgetStyleBackgroundFitEnum;
|
|
17205
|
+
'backgroundHorizontalAlign'?: PublisherDocumentImageWidgetStyleBackgroundHorizontalAlignEnum;
|
|
17206
|
+
'backgroundImage'?: string;
|
|
17207
|
+
'backgroundImageOpacity'?: number;
|
|
17208
|
+
'backgroundOffset'?: number;
|
|
17209
|
+
'backgroundOffsetBottom'?: number;
|
|
17210
|
+
'backgroundOffsetLeft'?: number;
|
|
17211
|
+
'backgroundOffsetRight'?: number;
|
|
17212
|
+
'backgroundOffsetTop'?: number;
|
|
17213
|
+
'backgroundOpacity'?: number;
|
|
17214
|
+
'backgroundVerticalAlign'?: PublisherDocumentImageWidgetStyleBackgroundVerticalAlignEnum;
|
|
17215
|
+
'borderBottomColor'?: string;
|
|
17216
|
+
'borderBottomLeftRadius'?: PublisherDocumentImageWidgetStyleBorderBottomLeftRadius;
|
|
17217
|
+
'borderBottomRightRadius'?: PublisherDocumentImageWidgetStyleBorderBottomRightRadius;
|
|
17218
|
+
'borderBottomStyle'?: PublisherDocumentImageWidgetStyleBorderBottomStyleEnum;
|
|
17219
|
+
'borderBottomWidth'?: number;
|
|
17220
|
+
'borderColor'?: string;
|
|
17221
|
+
'borderLeftColor'?: string;
|
|
17222
|
+
'borderLeftStyle'?: PublisherDocumentImageWidgetStyleBorderLeftStyleEnum;
|
|
17223
|
+
'borderLeftWidth'?: number;
|
|
17224
|
+
'borderRadius'?: PublisherDocumentImageWidgetStyleBorderRadius;
|
|
17225
|
+
'borderRightColor'?: string;
|
|
17226
|
+
'borderRightStyle'?: PublisherDocumentImageWidgetStyleBorderRightStyleEnum;
|
|
17227
|
+
'borderRightWidth'?: number;
|
|
17228
|
+
'borderStyle'?: PublisherDocumentImageWidgetStyleBorderStyleEnum;
|
|
17229
|
+
'borderTopColor'?: string;
|
|
17230
|
+
'borderTopLeftRadius'?: PublisherDocumentImageWidgetStyleBorderTopLeftRadius;
|
|
17231
|
+
'borderTopRightRadius'?: PublisherDocumentImageWidgetStyleBorderTopRightRadius;
|
|
17232
|
+
'borderTopStyle'?: PublisherDocumentImageWidgetStyleBorderTopStyleEnum;
|
|
17233
|
+
'borderTopWidth'?: number;
|
|
17234
|
+
'borderWidth'?: number;
|
|
17235
|
+
'fit'?: PublisherDocumentImageWidgetStyleFitEnum;
|
|
17236
|
+
'horizontalAlign'?: PublisherDocumentImageWidgetStyleHorizontalAlignEnum;
|
|
17237
|
+
'opacity'?: number;
|
|
17238
|
+
'padding'?: PublisherDocumentImageWidgetStylePadding;
|
|
17239
|
+
'paddingBottom'?: PublisherDocumentImageWidgetStylePaddingBottom;
|
|
17240
|
+
'paddingLeft'?: PublisherDocumentImageWidgetStylePaddingLeft;
|
|
17241
|
+
'paddingRight'?: PublisherDocumentImageWidgetStylePaddingRight;
|
|
17242
|
+
'paddingTop'?: PublisherDocumentImageWidgetStylePaddingTop;
|
|
17243
|
+
'shadow'?: string;
|
|
17244
|
+
'shadowBlur'?: number;
|
|
17245
|
+
'shadowColor'?: string;
|
|
17246
|
+
'shadowOpacity'?: number;
|
|
17247
|
+
'shadowSpread'?: number;
|
|
17248
|
+
'shadowX'?: number;
|
|
17249
|
+
'shadowY'?: number;
|
|
17250
|
+
'verticalAlign'?: PublisherDocumentImageWidgetStyleVerticalAlignEnum;
|
|
17251
|
+
}
|
|
17252
|
+
export type PublisherDocumentImageWidgetStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17253
|
+
export type PublisherDocumentImageWidgetStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17254
|
+
export type PublisherDocumentImageWidgetStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17255
|
+
export type PublisherDocumentImageWidgetStyleBorderBottomStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17256
|
+
export type PublisherDocumentImageWidgetStyleBorderLeftStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17257
|
+
export type PublisherDocumentImageWidgetStyleBorderRightStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17258
|
+
export type PublisherDocumentImageWidgetStyleBorderStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17259
|
+
export type PublisherDocumentImageWidgetStyleBorderTopStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17260
|
+
export type PublisherDocumentImageWidgetStyleFitEnum = 'contain' | 'cover' | 'fill';
|
|
17261
|
+
export type PublisherDocumentImageWidgetStyleHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17262
|
+
export type PublisherDocumentImageWidgetStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17263
|
+
/**
|
|
17264
|
+
* @type PublisherDocumentImageWidgetStyleBorderBottomLeftRadius
|
|
17265
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17266
|
+
*/
|
|
17267
|
+
export type PublisherDocumentImageWidgetStyleBorderBottomLeftRadius = number | string;
|
|
17268
|
+
/**
|
|
17269
|
+
* @type PublisherDocumentImageWidgetStyleBorderBottomRightRadius
|
|
17270
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17271
|
+
*/
|
|
17272
|
+
export type PublisherDocumentImageWidgetStyleBorderBottomRightRadius = number | string;
|
|
17273
|
+
/**
|
|
17274
|
+
* @type PublisherDocumentImageWidgetStyleBorderRadius
|
|
17275
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17276
|
+
*/
|
|
17277
|
+
export type PublisherDocumentImageWidgetStyleBorderRadius = number | string;
|
|
17278
|
+
/**
|
|
17279
|
+
* @type PublisherDocumentImageWidgetStyleBorderTopLeftRadius
|
|
17280
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17281
|
+
*/
|
|
17282
|
+
export type PublisherDocumentImageWidgetStyleBorderTopLeftRadius = number | string;
|
|
17283
|
+
/**
|
|
17284
|
+
* @type PublisherDocumentImageWidgetStyleBorderTopRightRadius
|
|
17285
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17286
|
+
*/
|
|
17287
|
+
export type PublisherDocumentImageWidgetStyleBorderTopRightRadius = number | string;
|
|
17288
|
+
/**
|
|
17289
|
+
* @type PublisherDocumentImageWidgetStylePadding
|
|
17290
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17291
|
+
*/
|
|
17292
|
+
export type PublisherDocumentImageWidgetStylePadding = number | string;
|
|
17293
|
+
/**
|
|
17294
|
+
* @type PublisherDocumentImageWidgetStylePaddingBottom
|
|
17295
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17296
|
+
*/
|
|
17297
|
+
export type PublisherDocumentImageWidgetStylePaddingBottom = number | string;
|
|
17298
|
+
/**
|
|
17299
|
+
* @type PublisherDocumentImageWidgetStylePaddingLeft
|
|
17300
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17301
|
+
*/
|
|
17302
|
+
export type PublisherDocumentImageWidgetStylePaddingLeft = number | string;
|
|
17303
|
+
/**
|
|
17304
|
+
* @type PublisherDocumentImageWidgetStylePaddingRight
|
|
17305
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17306
|
+
*/
|
|
17307
|
+
export type PublisherDocumentImageWidgetStylePaddingRight = number | string;
|
|
17308
|
+
/**
|
|
17309
|
+
* @type PublisherDocumentImageWidgetStylePaddingTop
|
|
17310
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17311
|
+
*/
|
|
17312
|
+
export type PublisherDocumentImageWidgetStylePaddingTop = number | string;
|
|
17313
|
+
/**
|
|
17314
|
+
* @type PublisherDocumentLayoutNode
|
|
17315
|
+
* A layout node: a row or column container, or a widget. The shape is selected by `type`.
|
|
17316
|
+
*/
|
|
17317
|
+
export type PublisherDocumentLayoutNode = ({
|
|
17318
|
+
type: 'column';
|
|
17319
|
+
} & PublisherDocumentColumn) | ({
|
|
17320
|
+
type: 'heading';
|
|
17321
|
+
} & PublisherDocumentHeadingWidget) | ({
|
|
17322
|
+
type: 'image';
|
|
17323
|
+
} & PublisherDocumentImageWidget) | ({
|
|
17324
|
+
type: 'row';
|
|
17325
|
+
} & PublisherDocumentRow) | ({
|
|
17326
|
+
type: 'takeaway';
|
|
17327
|
+
} & PublisherDocumentTakeawayWidget) | ({
|
|
17328
|
+
type: 'text';
|
|
17329
|
+
} & PublisherDocumentTextWidget) | ({
|
|
17330
|
+
type: 'title';
|
|
17331
|
+
} & PublisherDocumentTitleWidget) | ({
|
|
17332
|
+
type: 'visualization';
|
|
17333
|
+
} & PublisherDocumentVisualizationWidget);
|
|
17334
|
+
export interface PublisherDocumentLegendDisplay {
|
|
17335
|
+
'position'?: PublisherDocumentLegendDisplayPositionEnum;
|
|
17336
|
+
'visible'?: boolean;
|
|
17337
|
+
}
|
|
17338
|
+
export type PublisherDocumentLegendDisplayPositionEnum = 'auto' | 'top' | 'bottom' | 'left' | 'right';
|
|
17339
|
+
/**
|
|
17340
|
+
* Filters an attribute display form by a text pattern.
|
|
17341
|
+
*/
|
|
17342
|
+
export interface PublisherDocumentMatchAttributeFilter {
|
|
17343
|
+
'matchAttributeFilter': PublisherDocumentMatchAttributeFilterMatchAttributeFilter;
|
|
17344
|
+
}
|
|
17345
|
+
export interface PublisherDocumentMatchAttributeFilterMatchAttributeFilter {
|
|
17346
|
+
'caseSensitive'?: boolean;
|
|
17347
|
+
'displayForm': PublisherDocumentObjRef;
|
|
17348
|
+
'literal': string;
|
|
17349
|
+
/**
|
|
17350
|
+
* Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.
|
|
17351
|
+
*/
|
|
17352
|
+
'localIdentifier'?: string;
|
|
17353
|
+
'negativeSelection'?: boolean;
|
|
17354
|
+
'operator': PublisherDocumentMatchAttributeFilterMatchAttributeFilterOperatorEnum;
|
|
17355
|
+
'title'?: string;
|
|
17356
|
+
}
|
|
17357
|
+
export type PublisherDocumentMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
|
|
17358
|
+
/**
|
|
17359
|
+
* @type PublisherDocumentMeasureValueCondition
|
|
17360
|
+
* A measure value condition, wrapped in an object keyed by its kind.
|
|
17361
|
+
*/
|
|
17362
|
+
export type PublisherDocumentMeasureValueCondition = PublisherDocumentComparisonCondition | PublisherDocumentRangeCondition;
|
|
17363
|
+
/**
|
|
17364
|
+
* Filters by the value of a measure.
|
|
17365
|
+
*/
|
|
17366
|
+
export interface PublisherDocumentMeasureValueFilter {
|
|
17367
|
+
'dashboardMeasureValueFilter': PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter;
|
|
17368
|
+
}
|
|
17369
|
+
export interface PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter {
|
|
17370
|
+
/**
|
|
17371
|
+
* OR-ed conditions; none means all values.
|
|
17372
|
+
*/
|
|
17373
|
+
'conditions'?: Array<PublisherDocumentMeasureValueCondition>;
|
|
17374
|
+
'dimensionality'?: Array<PublisherDocumentObjRef>;
|
|
17375
|
+
'localIdentifier': string;
|
|
17376
|
+
'measure': PublisherDocumentObjRef;
|
|
17377
|
+
'title'?: string;
|
|
17378
|
+
}
|
|
17379
|
+
export interface PublisherDocumentMeasureValueFilterReference {
|
|
17380
|
+
'measure': PublisherDocumentObjRef;
|
|
17381
|
+
'type': PublisherDocumentMeasureValueFilterReferenceTypeEnum;
|
|
17382
|
+
}
|
|
17383
|
+
export type PublisherDocumentMeasureValueFilterReferenceTypeEnum = 'measureValueFilterReference';
|
|
17384
|
+
/**
|
|
17385
|
+
* A flat object reference.
|
|
17386
|
+
*/
|
|
17387
|
+
export interface PublisherDocumentObjRef {
|
|
17388
|
+
'identifier': string;
|
|
17389
|
+
/**
|
|
17390
|
+
* sdk-model object type.
|
|
17391
|
+
*/
|
|
17392
|
+
'type': PublisherDocumentObjRefTypeEnum;
|
|
17393
|
+
}
|
|
17394
|
+
export type PublisherDocumentObjRefTypeEnum = 'insight' | 'displayForm' | 'dataSet' | 'measure' | 'attribute';
|
|
17395
|
+
/**
|
|
17396
|
+
* A page of a document.
|
|
17397
|
+
*/
|
|
17398
|
+
export interface PublisherDocumentPage {
|
|
17399
|
+
/**
|
|
17400
|
+
* Page filters; stored, not applied.
|
|
17401
|
+
*/
|
|
17402
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
17403
|
+
/**
|
|
17404
|
+
* Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.
|
|
17405
|
+
*/
|
|
17406
|
+
'id'?: string;
|
|
17407
|
+
/**
|
|
17408
|
+
* Editor hint.
|
|
17409
|
+
*/
|
|
17410
|
+
'kind'?: PublisherDocumentPageKindEnum;
|
|
17411
|
+
'layout': PublisherDocumentLayoutNode;
|
|
17412
|
+
/**
|
|
17413
|
+
* Speaker notes in markdown, never drawn.
|
|
17414
|
+
*/
|
|
17415
|
+
'notes'?: string;
|
|
17416
|
+
'pageSize'?: PublisherDocumentPagePageSizeEnum;
|
|
17417
|
+
'style'?: PublisherDocumentPageStyle;
|
|
17418
|
+
/**
|
|
17419
|
+
* `false` keeps the page out of the viewer, exports and page numbering. Default `true`.
|
|
17420
|
+
*/
|
|
17421
|
+
'visible'?: boolean;
|
|
17422
|
+
}
|
|
17423
|
+
export type PublisherDocumentPageKindEnum = 'cover' | 'section' | 'content';
|
|
17424
|
+
export type PublisherDocumentPagePageSizeEnum = 'widescreen';
|
|
17425
|
+
/**
|
|
17426
|
+
* Style of a page; containers inherit its gap and text keys. Lengths are in canvas px.
|
|
17427
|
+
*/
|
|
17428
|
+
export interface PublisherDocumentPageStyle {
|
|
17429
|
+
'backgroundColor'?: string;
|
|
17430
|
+
'backgroundFit'?: PublisherDocumentPageStyleBackgroundFitEnum;
|
|
17431
|
+
'backgroundHorizontalAlign'?: PublisherDocumentPageStyleBackgroundHorizontalAlignEnum;
|
|
17432
|
+
'backgroundImage'?: string;
|
|
17433
|
+
'backgroundImageOpacity'?: number;
|
|
17434
|
+
'backgroundOffset'?: number;
|
|
17435
|
+
'backgroundOffsetBottom'?: number;
|
|
17436
|
+
'backgroundOffsetLeft'?: number;
|
|
17437
|
+
'backgroundOffsetRight'?: number;
|
|
17438
|
+
'backgroundOffsetTop'?: number;
|
|
17439
|
+
'backgroundOpacity'?: number;
|
|
17440
|
+
'backgroundVerticalAlign'?: PublisherDocumentPageStyleBackgroundVerticalAlignEnum;
|
|
17441
|
+
'fontSize'?: number;
|
|
17442
|
+
'fontStyle'?: PublisherDocumentPageStyleFontStyleEnum;
|
|
17443
|
+
'fontWeight'?: number;
|
|
17444
|
+
'gap'?: PublisherDocumentPageStyleGap;
|
|
17445
|
+
'horizontalAlign'?: PublisherDocumentPageStyleHorizontalAlignEnum;
|
|
17446
|
+
'letterSpacing'?: number;
|
|
17447
|
+
'lineHeight'?: number;
|
|
17448
|
+
'padding'?: PublisherDocumentPageStylePadding;
|
|
17449
|
+
'paddingBottom'?: PublisherDocumentPageStylePaddingBottom;
|
|
17450
|
+
'paddingLeft'?: PublisherDocumentPageStylePaddingLeft;
|
|
17451
|
+
'paddingRight'?: PublisherDocumentPageStylePaddingRight;
|
|
17452
|
+
'paddingTop'?: PublisherDocumentPageStylePaddingTop;
|
|
17453
|
+
'textColor'?: string;
|
|
17454
|
+
'textOverflow'?: PublisherDocumentPageStyleTextOverflowEnum;
|
|
17455
|
+
'textStyle'?: PublisherDocumentPageStyleTextStyleEnum;
|
|
17456
|
+
'textTransform'?: PublisherDocumentPageStyleTextTransformEnum;
|
|
17457
|
+
'verticalAlign'?: PublisherDocumentPageStyleVerticalAlignEnum;
|
|
17458
|
+
}
|
|
17459
|
+
export type PublisherDocumentPageStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17460
|
+
export type PublisherDocumentPageStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17461
|
+
export type PublisherDocumentPageStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17462
|
+
export type PublisherDocumentPageStyleFontStyleEnum = 'normal' | 'italic';
|
|
17463
|
+
export type PublisherDocumentPageStyleHorizontalAlignEnum = 'left' | 'center' | 'right' | 'justify';
|
|
17464
|
+
export type PublisherDocumentPageStyleTextOverflowEnum = 'shrink' | 'clip' | 'ellipsis';
|
|
17465
|
+
export type PublisherDocumentPageStyleTextStyleEnum = 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText';
|
|
17466
|
+
export type PublisherDocumentPageStyleTextTransformEnum = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
|
|
17467
|
+
export type PublisherDocumentPageStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17468
|
+
/**
|
|
17469
|
+
* @type PublisherDocumentPageStyleGap
|
|
17470
|
+
* A length, or `{theme.spacing.gap.<compact|normal|spacious>}`.
|
|
17471
|
+
*/
|
|
17472
|
+
export type PublisherDocumentPageStyleGap = number | string;
|
|
17473
|
+
/**
|
|
17474
|
+
* @type PublisherDocumentPageStylePadding
|
|
17475
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17476
|
+
*/
|
|
17477
|
+
export type PublisherDocumentPageStylePadding = number | string;
|
|
17478
|
+
/**
|
|
17479
|
+
* @type PublisherDocumentPageStylePaddingBottom
|
|
17480
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17481
|
+
*/
|
|
17482
|
+
export type PublisherDocumentPageStylePaddingBottom = number | string;
|
|
17483
|
+
/**
|
|
17484
|
+
* @type PublisherDocumentPageStylePaddingLeft
|
|
17485
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17486
|
+
*/
|
|
17487
|
+
export type PublisherDocumentPageStylePaddingLeft = number | string;
|
|
17488
|
+
/**
|
|
17489
|
+
* @type PublisherDocumentPageStylePaddingRight
|
|
17490
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17491
|
+
*/
|
|
17492
|
+
export type PublisherDocumentPageStylePaddingRight = number | string;
|
|
17493
|
+
/**
|
|
17494
|
+
* @type PublisherDocumentPageStylePaddingTop
|
|
17495
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17496
|
+
*/
|
|
17497
|
+
export type PublisherDocumentPageStylePaddingTop = number | string;
|
|
17498
|
+
/**
|
|
17499
|
+
* Content of a page template: one page without `id` and `visible`.
|
|
17500
|
+
*/
|
|
17501
|
+
export interface PublisherDocumentPageTemplateContent {
|
|
17502
|
+
/**
|
|
17503
|
+
* Page filters; stored, not applied.
|
|
17504
|
+
*/
|
|
17505
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
17506
|
+
/**
|
|
17507
|
+
* Editor hint.
|
|
17508
|
+
*/
|
|
17509
|
+
'kind'?: PublisherDocumentPageTemplateContentKindEnum;
|
|
17510
|
+
'layout': PublisherDocumentLayoutNode;
|
|
17511
|
+
/**
|
|
17512
|
+
* Speaker notes in markdown, never drawn.
|
|
17513
|
+
*/
|
|
17514
|
+
'notes'?: string;
|
|
17515
|
+
'pageSize'?: PublisherDocumentPageTemplateContentPageSizeEnum;
|
|
17516
|
+
'style'?: PublisherDocumentPageStyle;
|
|
17517
|
+
}
|
|
17518
|
+
export type PublisherDocumentPageTemplateContentKindEnum = 'cover' | 'section' | 'content';
|
|
17519
|
+
export type PublisherDocumentPageTemplateContentPageSizeEnum = 'widescreen';
|
|
16320
17520
|
/**
|
|
16321
17521
|
* @type PublisherDocumentPeriod
|
|
16322
17522
|
* The period the document covers, absolute or relative to today.
|
|
@@ -16326,6 +17526,498 @@ export type PublisherDocumentPeriod = ({
|
|
|
16326
17526
|
} & AbsolutePublisherDocumentPeriod) | ({
|
|
16327
17527
|
type: 'relative';
|
|
16328
17528
|
} & RelativePublisherDocumentPeriod);
|
|
17529
|
+
export interface PublisherDocumentRangeCondition {
|
|
17530
|
+
'range': PublisherDocumentRangeConditionRange;
|
|
17531
|
+
}
|
|
17532
|
+
export interface PublisherDocumentRangeConditionRange {
|
|
17533
|
+
'from': number;
|
|
17534
|
+
'operator': PublisherDocumentRangeConditionRangeOperatorEnum;
|
|
17535
|
+
'to': number;
|
|
17536
|
+
'treatNullValuesAs'?: number;
|
|
17537
|
+
}
|
|
17538
|
+
export type PublisherDocumentRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
17539
|
+
/**
|
|
17540
|
+
* Lays its children out left to right.
|
|
17541
|
+
*/
|
|
17542
|
+
export interface PublisherDocumentRow {
|
|
17543
|
+
/**
|
|
17544
|
+
* Child nodes from left to right, in reading order; an empty list is a spacer.
|
|
17545
|
+
*/
|
|
17546
|
+
'children': Array<PublisherDocumentLayoutNode>;
|
|
17547
|
+
'id'?: string;
|
|
17548
|
+
/**
|
|
17549
|
+
* Locks the container in the document editor; never checked on write.
|
|
17550
|
+
*/
|
|
17551
|
+
'locked'?: boolean;
|
|
17552
|
+
/**
|
|
17553
|
+
* Share of the parent\'s main axis, greater than 0. Default 1.
|
|
17554
|
+
*/
|
|
17555
|
+
'proportion'?: number;
|
|
17556
|
+
'style'?: PublisherDocumentContainerStyle;
|
|
17557
|
+
'type': PublisherDocumentRowTypeEnum;
|
|
17558
|
+
}
|
|
17559
|
+
export type PublisherDocumentRowTypeEnum = 'row';
|
|
17560
|
+
/**
|
|
17561
|
+
* A group of pages, like a dashboard tab.
|
|
17562
|
+
*/
|
|
17563
|
+
export interface PublisherDocumentSection {
|
|
17564
|
+
'description'?: string;
|
|
17565
|
+
/**
|
|
17566
|
+
* Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.
|
|
17567
|
+
*/
|
|
17568
|
+
'id'?: string;
|
|
17569
|
+
'pages': Array<PublisherDocumentPage>;
|
|
17570
|
+
'title'?: string;
|
|
17571
|
+
}
|
|
17572
|
+
/**
|
|
17573
|
+
* Table style overrides; stored, not applied. Lengths are in canvas px.
|
|
17574
|
+
*/
|
|
17575
|
+
export interface PublisherDocumentTableStyle {
|
|
17576
|
+
'fontSize'?: number;
|
|
17577
|
+
'gridColor'?: string;
|
|
17578
|
+
'headerBackgroundColor'?: string;
|
|
17579
|
+
'headerLabelColor'?: string;
|
|
17580
|
+
'nullValueColor'?: string;
|
|
17581
|
+
'rowHeight'?: number;
|
|
17582
|
+
'subtotalBackgroundColor'?: string;
|
|
17583
|
+
'totalBackgroundColor'?: string;
|
|
17584
|
+
'totalValueColor'?: string;
|
|
17585
|
+
'valueColor'?: string;
|
|
17586
|
+
}
|
|
17587
|
+
/**
|
|
17588
|
+
* What the copilot reads when it writes a takeaway.
|
|
17589
|
+
*/
|
|
17590
|
+
export interface PublisherDocumentTakeawayContext {
|
|
17591
|
+
'filters'?: boolean;
|
|
17592
|
+
'otherPages'?: boolean;
|
|
17593
|
+
'pageTitle'?: boolean;
|
|
17594
|
+
/**
|
|
17595
|
+
* Widget ids on the same page.
|
|
17596
|
+
*/
|
|
17597
|
+
'widgets'?: Array<string>;
|
|
17598
|
+
}
|
|
17599
|
+
/**
|
|
17600
|
+
* Takeaway settings every takeaway widget of the document uses.
|
|
17601
|
+
*/
|
|
17602
|
+
export interface PublisherDocumentTakeawayDefaults {
|
|
17603
|
+
'generation'?: PublisherDocumentTakeawayGeneration;
|
|
17604
|
+
}
|
|
17605
|
+
/**
|
|
17606
|
+
* How the copilot writes a takeaway.
|
|
17607
|
+
*/
|
|
17608
|
+
export interface PublisherDocumentTakeawayGeneration {
|
|
17609
|
+
'context'?: PublisherDocumentTakeawayContext;
|
|
17610
|
+
'instructions'?: string;
|
|
17611
|
+
}
|
|
17612
|
+
/**
|
|
17613
|
+
* A generated takeaway, stored as markdown.
|
|
17614
|
+
*/
|
|
17615
|
+
export interface PublisherDocumentTakeawayWidget {
|
|
17616
|
+
'generation'?: PublisherDocumentTakeawayGeneration;
|
|
17617
|
+
/**
|
|
17618
|
+
* Unique within the page.
|
|
17619
|
+
*/
|
|
17620
|
+
'id': string;
|
|
17621
|
+
/**
|
|
17622
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17623
|
+
*/
|
|
17624
|
+
'locked'?: boolean;
|
|
17625
|
+
/**
|
|
17626
|
+
* The generated text.
|
|
17627
|
+
*/
|
|
17628
|
+
'markdown'?: string;
|
|
17629
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17630
|
+
'proportion'?: number;
|
|
17631
|
+
'style'?: PublisherDocumentTextWidgetStyle;
|
|
17632
|
+
'title'?: PublisherDocumentWidgetTitle;
|
|
17633
|
+
'type': PublisherDocumentTakeawayWidgetTypeEnum;
|
|
17634
|
+
}
|
|
17635
|
+
export type PublisherDocumentTakeawayWidgetTypeEnum = 'takeaway';
|
|
17636
|
+
/**
|
|
17637
|
+
* Text style of a widget title. Lengths are in canvas px.
|
|
17638
|
+
*/
|
|
17639
|
+
export interface PublisherDocumentTextStyle {
|
|
17640
|
+
'fontSize'?: number;
|
|
17641
|
+
'fontStyle'?: PublisherDocumentTextStyleFontStyleEnum;
|
|
17642
|
+
'fontWeight'?: number;
|
|
17643
|
+
'horizontalAlign'?: PublisherDocumentTextStyleHorizontalAlignEnum;
|
|
17644
|
+
'letterSpacing'?: number;
|
|
17645
|
+
'lineHeight'?: number;
|
|
17646
|
+
'textColor'?: string;
|
|
17647
|
+
'textOverflow'?: PublisherDocumentTextStyleTextOverflowEnum;
|
|
17648
|
+
'textStyle'?: PublisherDocumentTextStyleTextStyleEnum;
|
|
17649
|
+
'textTransform'?: PublisherDocumentTextStyleTextTransformEnum;
|
|
17650
|
+
'verticalAlign'?: PublisherDocumentTextStyleVerticalAlignEnum;
|
|
17651
|
+
}
|
|
17652
|
+
export type PublisherDocumentTextStyleFontStyleEnum = 'normal' | 'italic';
|
|
17653
|
+
export type PublisherDocumentTextStyleHorizontalAlignEnum = 'left' | 'center' | 'right' | 'justify';
|
|
17654
|
+
export type PublisherDocumentTextStyleTextOverflowEnum = 'shrink' | 'clip' | 'ellipsis';
|
|
17655
|
+
export type PublisherDocumentTextStyleTextStyleEnum = 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText';
|
|
17656
|
+
export type PublisherDocumentTextStyleTextTransformEnum = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
|
|
17657
|
+
export type PublisherDocumentTextStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17658
|
+
/**
|
|
17659
|
+
* A block of markdown text.
|
|
17660
|
+
*/
|
|
17661
|
+
export interface PublisherDocumentTextWidget {
|
|
17662
|
+
/**
|
|
17663
|
+
* Left out of the accessibility tree, PDF tags and the AI context.
|
|
17664
|
+
*/
|
|
17665
|
+
'decorative'?: boolean;
|
|
17666
|
+
/**
|
|
17667
|
+
* Unique within the page.
|
|
17668
|
+
*/
|
|
17669
|
+
'id': string;
|
|
17670
|
+
/**
|
|
17671
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17672
|
+
*/
|
|
17673
|
+
'locked'?: boolean;
|
|
17674
|
+
/**
|
|
17675
|
+
* Full markdown.
|
|
17676
|
+
*/
|
|
17677
|
+
'markdown'?: string;
|
|
17678
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17679
|
+
'proportion'?: number;
|
|
17680
|
+
'style'?: PublisherDocumentTextWidgetStyle;
|
|
17681
|
+
'type': PublisherDocumentTextWidgetTypeEnum;
|
|
17682
|
+
}
|
|
17683
|
+
export type PublisherDocumentTextWidgetTypeEnum = 'text';
|
|
17684
|
+
/**
|
|
17685
|
+
* Style of a title, heading, text or takeaway widget. Lengths are in canvas px.
|
|
17686
|
+
*/
|
|
17687
|
+
export interface PublisherDocumentTextWidgetStyle {
|
|
17688
|
+
'backgroundColor'?: string;
|
|
17689
|
+
'backgroundFit'?: PublisherDocumentTextWidgetStyleBackgroundFitEnum;
|
|
17690
|
+
'backgroundHorizontalAlign'?: PublisherDocumentTextWidgetStyleBackgroundHorizontalAlignEnum;
|
|
17691
|
+
'backgroundImage'?: string;
|
|
17692
|
+
'backgroundImageOpacity'?: number;
|
|
17693
|
+
'backgroundOffset'?: number;
|
|
17694
|
+
'backgroundOffsetBottom'?: number;
|
|
17695
|
+
'backgroundOffsetLeft'?: number;
|
|
17696
|
+
'backgroundOffsetRight'?: number;
|
|
17697
|
+
'backgroundOffsetTop'?: number;
|
|
17698
|
+
'backgroundOpacity'?: number;
|
|
17699
|
+
'backgroundVerticalAlign'?: PublisherDocumentTextWidgetStyleBackgroundVerticalAlignEnum;
|
|
17700
|
+
'borderBottomColor'?: string;
|
|
17701
|
+
'borderBottomLeftRadius'?: PublisherDocumentTextWidgetStyleBorderBottomLeftRadius;
|
|
17702
|
+
'borderBottomRightRadius'?: PublisherDocumentTextWidgetStyleBorderBottomRightRadius;
|
|
17703
|
+
'borderBottomStyle'?: PublisherDocumentTextWidgetStyleBorderBottomStyleEnum;
|
|
17704
|
+
'borderBottomWidth'?: number;
|
|
17705
|
+
'borderColor'?: string;
|
|
17706
|
+
'borderLeftColor'?: string;
|
|
17707
|
+
'borderLeftStyle'?: PublisherDocumentTextWidgetStyleBorderLeftStyleEnum;
|
|
17708
|
+
'borderLeftWidth'?: number;
|
|
17709
|
+
'borderRadius'?: PublisherDocumentTextWidgetStyleBorderRadius;
|
|
17710
|
+
'borderRightColor'?: string;
|
|
17711
|
+
'borderRightStyle'?: PublisherDocumentTextWidgetStyleBorderRightStyleEnum;
|
|
17712
|
+
'borderRightWidth'?: number;
|
|
17713
|
+
'borderStyle'?: PublisherDocumentTextWidgetStyleBorderStyleEnum;
|
|
17714
|
+
'borderTopColor'?: string;
|
|
17715
|
+
'borderTopLeftRadius'?: PublisherDocumentTextWidgetStyleBorderTopLeftRadius;
|
|
17716
|
+
'borderTopRightRadius'?: PublisherDocumentTextWidgetStyleBorderTopRightRadius;
|
|
17717
|
+
'borderTopStyle'?: PublisherDocumentTextWidgetStyleBorderTopStyleEnum;
|
|
17718
|
+
'borderTopWidth'?: number;
|
|
17719
|
+
'borderWidth'?: number;
|
|
17720
|
+
'fontSize'?: number;
|
|
17721
|
+
'fontStyle'?: PublisherDocumentTextWidgetStyleFontStyleEnum;
|
|
17722
|
+
'fontWeight'?: number;
|
|
17723
|
+
'horizontalAlign'?: PublisherDocumentTextWidgetStyleHorizontalAlignEnum;
|
|
17724
|
+
'letterSpacing'?: number;
|
|
17725
|
+
'lineHeight'?: number;
|
|
17726
|
+
'opacity'?: number;
|
|
17727
|
+
'padding'?: PublisherDocumentTextWidgetStylePadding;
|
|
17728
|
+
'paddingBottom'?: PublisherDocumentTextWidgetStylePaddingBottom;
|
|
17729
|
+
'paddingLeft'?: PublisherDocumentTextWidgetStylePaddingLeft;
|
|
17730
|
+
'paddingRight'?: PublisherDocumentTextWidgetStylePaddingRight;
|
|
17731
|
+
'paddingTop'?: PublisherDocumentTextWidgetStylePaddingTop;
|
|
17732
|
+
'shadow'?: string;
|
|
17733
|
+
'shadowBlur'?: number;
|
|
17734
|
+
'shadowColor'?: string;
|
|
17735
|
+
'shadowOpacity'?: number;
|
|
17736
|
+
'shadowSpread'?: number;
|
|
17737
|
+
'shadowX'?: number;
|
|
17738
|
+
'shadowY'?: number;
|
|
17739
|
+
'textColor'?: string;
|
|
17740
|
+
'textOverflow'?: PublisherDocumentTextWidgetStyleTextOverflowEnum;
|
|
17741
|
+
'textStyle'?: PublisherDocumentTextWidgetStyleTextStyleEnum;
|
|
17742
|
+
'textTransform'?: PublisherDocumentTextWidgetStyleTextTransformEnum;
|
|
17743
|
+
'verticalAlign'?: PublisherDocumentTextWidgetStyleVerticalAlignEnum;
|
|
17744
|
+
}
|
|
17745
|
+
export type PublisherDocumentTextWidgetStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17746
|
+
export type PublisherDocumentTextWidgetStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17747
|
+
export type PublisherDocumentTextWidgetStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17748
|
+
export type PublisherDocumentTextWidgetStyleBorderBottomStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17749
|
+
export type PublisherDocumentTextWidgetStyleBorderLeftStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17750
|
+
export type PublisherDocumentTextWidgetStyleBorderRightStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17751
|
+
export type PublisherDocumentTextWidgetStyleBorderStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17752
|
+
export type PublisherDocumentTextWidgetStyleBorderTopStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17753
|
+
export type PublisherDocumentTextWidgetStyleFontStyleEnum = 'normal' | 'italic';
|
|
17754
|
+
export type PublisherDocumentTextWidgetStyleHorizontalAlignEnum = 'left' | 'center' | 'right' | 'justify';
|
|
17755
|
+
export type PublisherDocumentTextWidgetStyleTextOverflowEnum = 'shrink' | 'clip' | 'ellipsis';
|
|
17756
|
+
export type PublisherDocumentTextWidgetStyleTextStyleEnum = 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText';
|
|
17757
|
+
export type PublisherDocumentTextWidgetStyleTextTransformEnum = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
|
|
17758
|
+
export type PublisherDocumentTextWidgetStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17759
|
+
/**
|
|
17760
|
+
* @type PublisherDocumentTextWidgetStyleBorderBottomLeftRadius
|
|
17761
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17762
|
+
*/
|
|
17763
|
+
export type PublisherDocumentTextWidgetStyleBorderBottomLeftRadius = number | string;
|
|
17764
|
+
/**
|
|
17765
|
+
* @type PublisherDocumentTextWidgetStyleBorderBottomRightRadius
|
|
17766
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17767
|
+
*/
|
|
17768
|
+
export type PublisherDocumentTextWidgetStyleBorderBottomRightRadius = number | string;
|
|
17769
|
+
/**
|
|
17770
|
+
* @type PublisherDocumentTextWidgetStyleBorderRadius
|
|
17771
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17772
|
+
*/
|
|
17773
|
+
export type PublisherDocumentTextWidgetStyleBorderRadius = number | string;
|
|
17774
|
+
/**
|
|
17775
|
+
* @type PublisherDocumentTextWidgetStyleBorderTopLeftRadius
|
|
17776
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17777
|
+
*/
|
|
17778
|
+
export type PublisherDocumentTextWidgetStyleBorderTopLeftRadius = number | string;
|
|
17779
|
+
/**
|
|
17780
|
+
* @type PublisherDocumentTextWidgetStyleBorderTopRightRadius
|
|
17781
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17782
|
+
*/
|
|
17783
|
+
export type PublisherDocumentTextWidgetStyleBorderTopRightRadius = number | string;
|
|
17784
|
+
/**
|
|
17785
|
+
* @type PublisherDocumentTextWidgetStylePadding
|
|
17786
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17787
|
+
*/
|
|
17788
|
+
export type PublisherDocumentTextWidgetStylePadding = number | string;
|
|
17789
|
+
/**
|
|
17790
|
+
* @type PublisherDocumentTextWidgetStylePaddingBottom
|
|
17791
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17792
|
+
*/
|
|
17793
|
+
export type PublisherDocumentTextWidgetStylePaddingBottom = number | string;
|
|
17794
|
+
/**
|
|
17795
|
+
* @type PublisherDocumentTextWidgetStylePaddingLeft
|
|
17796
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17797
|
+
*/
|
|
17798
|
+
export type PublisherDocumentTextWidgetStylePaddingLeft = number | string;
|
|
17799
|
+
/**
|
|
17800
|
+
* @type PublisherDocumentTextWidgetStylePaddingRight
|
|
17801
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17802
|
+
*/
|
|
17803
|
+
export type PublisherDocumentTextWidgetStylePaddingRight = number | string;
|
|
17804
|
+
/**
|
|
17805
|
+
* @type PublisherDocumentTextWidgetStylePaddingTop
|
|
17806
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17807
|
+
*/
|
|
17808
|
+
export type PublisherDocumentTextWidgetStylePaddingTop = number | string;
|
|
17809
|
+
/**
|
|
17810
|
+
* The page\'s title, at most one per page.
|
|
17811
|
+
*/
|
|
17812
|
+
export interface PublisherDocumentTitleWidget {
|
|
17813
|
+
/**
|
|
17814
|
+
* Unique within the page.
|
|
17815
|
+
*/
|
|
17816
|
+
'id': string;
|
|
17817
|
+
/**
|
|
17818
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17819
|
+
*/
|
|
17820
|
+
'locked'?: boolean;
|
|
17821
|
+
/**
|
|
17822
|
+
* Inline markdown.
|
|
17823
|
+
*/
|
|
17824
|
+
'markdown'?: string;
|
|
17825
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17826
|
+
'proportion'?: number;
|
|
17827
|
+
'style'?: PublisherDocumentTextWidgetStyle;
|
|
17828
|
+
'type': PublisherDocumentTitleWidgetTypeEnum;
|
|
17829
|
+
}
|
|
17830
|
+
export type PublisherDocumentTitleWidgetTypeEnum = 'title';
|
|
17831
|
+
export interface PublisherDocumentVisibility {
|
|
17832
|
+
'visible'?: boolean;
|
|
17833
|
+
}
|
|
17834
|
+
/**
|
|
17835
|
+
* Overrides of the saved visualization\'s own configuration; stored, not applied.
|
|
17836
|
+
*/
|
|
17837
|
+
export interface PublisherDocumentVisualizationDisplay {
|
|
17838
|
+
'dataLabels'?: PublisherDocumentAutoVisibility;
|
|
17839
|
+
'dataPoints'?: PublisherDocumentAutoVisibility;
|
|
17840
|
+
'gridlines'?: PublisherDocumentVisibility;
|
|
17841
|
+
'legend'?: PublisherDocumentLegendDisplay;
|
|
17842
|
+
'secondaryYAxis'?: PublisherDocumentAxisDisplay;
|
|
17843
|
+
'xAxis'?: PublisherDocumentAxisDisplay;
|
|
17844
|
+
'yAxis'?: PublisherDocumentAxisDisplay;
|
|
17845
|
+
}
|
|
17846
|
+
/**
|
|
17847
|
+
* A saved visualization.
|
|
17848
|
+
*/
|
|
17849
|
+
export interface PublisherDocumentVisualizationRef {
|
|
17850
|
+
'identifier': string;
|
|
17851
|
+
'type': PublisherDocumentVisualizationRefTypeEnum;
|
|
17852
|
+
}
|
|
17853
|
+
export type PublisherDocumentVisualizationRefTypeEnum = 'insight';
|
|
17854
|
+
/**
|
|
17855
|
+
* Style of a visualization widget. Lengths are in canvas px.
|
|
17856
|
+
*/
|
|
17857
|
+
export interface PublisherDocumentVisualizationStyle {
|
|
17858
|
+
'backgroundColor'?: string;
|
|
17859
|
+
'backgroundFit'?: PublisherDocumentVisualizationStyleBackgroundFitEnum;
|
|
17860
|
+
'backgroundHorizontalAlign'?: PublisherDocumentVisualizationStyleBackgroundHorizontalAlignEnum;
|
|
17861
|
+
'backgroundImage'?: string;
|
|
17862
|
+
'backgroundImageOpacity'?: number;
|
|
17863
|
+
'backgroundOffset'?: number;
|
|
17864
|
+
'backgroundOffsetBottom'?: number;
|
|
17865
|
+
'backgroundOffsetLeft'?: number;
|
|
17866
|
+
'backgroundOffsetRight'?: number;
|
|
17867
|
+
'backgroundOffsetTop'?: number;
|
|
17868
|
+
'backgroundOpacity'?: number;
|
|
17869
|
+
'backgroundVerticalAlign'?: PublisherDocumentVisualizationStyleBackgroundVerticalAlignEnum;
|
|
17870
|
+
'borderBottomColor'?: string;
|
|
17871
|
+
'borderBottomLeftRadius'?: PublisherDocumentVisualizationStyleBorderBottomLeftRadius;
|
|
17872
|
+
'borderBottomRightRadius'?: PublisherDocumentVisualizationStyleBorderBottomRightRadius;
|
|
17873
|
+
'borderBottomStyle'?: PublisherDocumentVisualizationStyleBorderBottomStyleEnum;
|
|
17874
|
+
'borderBottomWidth'?: number;
|
|
17875
|
+
'borderColor'?: string;
|
|
17876
|
+
'borderLeftColor'?: string;
|
|
17877
|
+
'borderLeftStyle'?: PublisherDocumentVisualizationStyleBorderLeftStyleEnum;
|
|
17878
|
+
'borderLeftWidth'?: number;
|
|
17879
|
+
'borderRadius'?: PublisherDocumentVisualizationStyleBorderRadius;
|
|
17880
|
+
'borderRightColor'?: string;
|
|
17881
|
+
'borderRightStyle'?: PublisherDocumentVisualizationStyleBorderRightStyleEnum;
|
|
17882
|
+
'borderRightWidth'?: number;
|
|
17883
|
+
'borderStyle'?: PublisherDocumentVisualizationStyleBorderStyleEnum;
|
|
17884
|
+
'borderTopColor'?: string;
|
|
17885
|
+
'borderTopLeftRadius'?: PublisherDocumentVisualizationStyleBorderTopLeftRadius;
|
|
17886
|
+
'borderTopRightRadius'?: PublisherDocumentVisualizationStyleBorderTopRightRadius;
|
|
17887
|
+
'borderTopStyle'?: PublisherDocumentVisualizationStyleBorderTopStyleEnum;
|
|
17888
|
+
'borderTopWidth'?: number;
|
|
17889
|
+
'borderWidth'?: number;
|
|
17890
|
+
'chart'?: PublisherDocumentChartStyle;
|
|
17891
|
+
'headline'?: PublisherDocumentHeadlineStyle;
|
|
17892
|
+
'opacity'?: number;
|
|
17893
|
+
'padding'?: PublisherDocumentVisualizationStylePadding;
|
|
17894
|
+
'paddingBottom'?: PublisherDocumentVisualizationStylePaddingBottom;
|
|
17895
|
+
'paddingLeft'?: PublisherDocumentVisualizationStylePaddingLeft;
|
|
17896
|
+
'paddingRight'?: PublisherDocumentVisualizationStylePaddingRight;
|
|
17897
|
+
'paddingTop'?: PublisherDocumentVisualizationStylePaddingTop;
|
|
17898
|
+
'shadow'?: string;
|
|
17899
|
+
'shadowBlur'?: number;
|
|
17900
|
+
'shadowColor'?: string;
|
|
17901
|
+
'shadowOpacity'?: number;
|
|
17902
|
+
'shadowSpread'?: number;
|
|
17903
|
+
'shadowX'?: number;
|
|
17904
|
+
'shadowY'?: number;
|
|
17905
|
+
'table'?: PublisherDocumentTableStyle;
|
|
17906
|
+
}
|
|
17907
|
+
export type PublisherDocumentVisualizationStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17908
|
+
export type PublisherDocumentVisualizationStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17909
|
+
export type PublisherDocumentVisualizationStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17910
|
+
export type PublisherDocumentVisualizationStyleBorderBottomStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17911
|
+
export type PublisherDocumentVisualizationStyleBorderLeftStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17912
|
+
export type PublisherDocumentVisualizationStyleBorderRightStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17913
|
+
export type PublisherDocumentVisualizationStyleBorderStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17914
|
+
export type PublisherDocumentVisualizationStyleBorderTopStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17915
|
+
/**
|
|
17916
|
+
* @type PublisherDocumentVisualizationStyleBorderBottomLeftRadius
|
|
17917
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17918
|
+
*/
|
|
17919
|
+
export type PublisherDocumentVisualizationStyleBorderBottomLeftRadius = number | string;
|
|
17920
|
+
/**
|
|
17921
|
+
* @type PublisherDocumentVisualizationStyleBorderBottomRightRadius
|
|
17922
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17923
|
+
*/
|
|
17924
|
+
export type PublisherDocumentVisualizationStyleBorderBottomRightRadius = number | string;
|
|
17925
|
+
/**
|
|
17926
|
+
* @type PublisherDocumentVisualizationStyleBorderRadius
|
|
17927
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17928
|
+
*/
|
|
17929
|
+
export type PublisherDocumentVisualizationStyleBorderRadius = number | string;
|
|
17930
|
+
/**
|
|
17931
|
+
* @type PublisherDocumentVisualizationStyleBorderTopLeftRadius
|
|
17932
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17933
|
+
*/
|
|
17934
|
+
export type PublisherDocumentVisualizationStyleBorderTopLeftRadius = number | string;
|
|
17935
|
+
/**
|
|
17936
|
+
* @type PublisherDocumentVisualizationStyleBorderTopRightRadius
|
|
17937
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17938
|
+
*/
|
|
17939
|
+
export type PublisherDocumentVisualizationStyleBorderTopRightRadius = number | string;
|
|
17940
|
+
/**
|
|
17941
|
+
* @type PublisherDocumentVisualizationStylePadding
|
|
17942
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17943
|
+
*/
|
|
17944
|
+
export type PublisherDocumentVisualizationStylePadding = number | string;
|
|
17945
|
+
/**
|
|
17946
|
+
* @type PublisherDocumentVisualizationStylePaddingBottom
|
|
17947
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17948
|
+
*/
|
|
17949
|
+
export type PublisherDocumentVisualizationStylePaddingBottom = number | string;
|
|
17950
|
+
/**
|
|
17951
|
+
* @type PublisherDocumentVisualizationStylePaddingLeft
|
|
17952
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17953
|
+
*/
|
|
17954
|
+
export type PublisherDocumentVisualizationStylePaddingLeft = number | string;
|
|
17955
|
+
/**
|
|
17956
|
+
* @type PublisherDocumentVisualizationStylePaddingRight
|
|
17957
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17958
|
+
*/
|
|
17959
|
+
export type PublisherDocumentVisualizationStylePaddingRight = number | string;
|
|
17960
|
+
/**
|
|
17961
|
+
* @type PublisherDocumentVisualizationStylePaddingTop
|
|
17962
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17963
|
+
*/
|
|
17964
|
+
export type PublisherDocumentVisualizationStylePaddingTop = number | string;
|
|
17965
|
+
/**
|
|
17966
|
+
* A saved visualization.
|
|
17967
|
+
*/
|
|
17968
|
+
export interface PublisherDocumentVisualizationWidget {
|
|
17969
|
+
/**
|
|
17970
|
+
* Defaults to the visualization\'s description.
|
|
17971
|
+
*/
|
|
17972
|
+
'altText'?: string;
|
|
17973
|
+
'dateDataSet'?: PublisherDocumentDataSetRef;
|
|
17974
|
+
'display'?: PublisherDocumentVisualizationDisplay;
|
|
17975
|
+
/**
|
|
17976
|
+
* Widget filters; stored, not applied.
|
|
17977
|
+
*/
|
|
17978
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
17979
|
+
/**
|
|
17980
|
+
* Unique within the page.
|
|
17981
|
+
*/
|
|
17982
|
+
'id': string;
|
|
17983
|
+
/**
|
|
17984
|
+
* Document filters this widget ignores.
|
|
17985
|
+
*/
|
|
17986
|
+
'ignoreDocumentFilters'?: Array<PublisherDocumentFilterReference>;
|
|
17987
|
+
'ignoreDocumentPeriod'?: boolean;
|
|
17988
|
+
/**
|
|
17989
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17990
|
+
*/
|
|
17991
|
+
'locked'?: boolean;
|
|
17992
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17993
|
+
'proportion'?: number;
|
|
17994
|
+
'style'?: PublisherDocumentVisualizationStyle;
|
|
17995
|
+
'title'?: PublisherDocumentWidgetTitle;
|
|
17996
|
+
'type': PublisherDocumentVisualizationWidgetTypeEnum;
|
|
17997
|
+
'visualization'?: PublisherDocumentVisualizationRef;
|
|
17998
|
+
}
|
|
17999
|
+
export type PublisherDocumentVisualizationWidgetTypeEnum = 'visualization';
|
|
18000
|
+
/**
|
|
18001
|
+
* What the editor shows in an empty widget.
|
|
18002
|
+
*/
|
|
18003
|
+
export interface PublisherDocumentWidgetPlaceholder {
|
|
18004
|
+
'hint'?: string;
|
|
18005
|
+
'required'?: boolean;
|
|
18006
|
+
}
|
|
18007
|
+
/**
|
|
18008
|
+
* Title of a visualization or takeaway widget.
|
|
18009
|
+
*/
|
|
18010
|
+
export interface PublisherDocumentWidgetTitle {
|
|
18011
|
+
'style'?: PublisherDocumentTextStyle;
|
|
18012
|
+
/**
|
|
18013
|
+
* Overrides the default title; may contain text variables.
|
|
18014
|
+
*/
|
|
18015
|
+
'text'?: string;
|
|
18016
|
+
/**
|
|
18017
|
+
* When left out, a visualization\'s title is hidden and a takeaway\'s is shown.
|
|
18018
|
+
*/
|
|
18019
|
+
'visible'?: boolean;
|
|
18020
|
+
}
|
|
16329
18021
|
export interface Range {
|
|
16330
18022
|
'from': Value;
|
|
16331
18023
|
'measure': LocalIdentifier;
|
|
@@ -16579,7 +18271,7 @@ export interface ResolvedSetting {
|
|
|
16579
18271
|
*/
|
|
16580
18272
|
'type'?: ResolvedSettingTypeEnum;
|
|
16581
18273
|
}
|
|
16582
|
-
export type ResolvedSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE';
|
|
18274
|
+
export type ResolvedSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'CONVERSATION_RETENTION_DAYS' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_AI_DATA_OBFUSCATION' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE' | 'AUTHORIZATION_SERVER_REDIRECT_POLICY' | 'DEFAULT_VISUALIZATION_VISIBILITY' | 'DEFAULT_METRIC_VISIBILITY' | 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE' | 'QUERY_ENGINE';
|
|
16583
18275
|
/**
|
|
16584
18276
|
* A reference the caller may not view.
|
|
16585
18277
|
*/
|
|
@@ -17185,6 +18877,24 @@ export interface UserPermission {
|
|
|
17185
18877
|
*/
|
|
17186
18878
|
'permissions'?: Array<GrantedPermission>;
|
|
17187
18879
|
}
|
|
18880
|
+
/**
|
|
18881
|
+
* An origin to check against the embedding origins of the organization.
|
|
18882
|
+
*/
|
|
18883
|
+
export interface ValidateEmbeddingOriginRequest {
|
|
18884
|
+
/**
|
|
18885
|
+
* The origin of the embedding application, or `*` when it hides its origin.
|
|
18886
|
+
*/
|
|
18887
|
+
'origin': string;
|
|
18888
|
+
}
|
|
18889
|
+
/**
|
|
18890
|
+
* Whether the origin may embed the application.
|
|
18891
|
+
*/
|
|
18892
|
+
export interface ValidateEmbeddingOriginResponse {
|
|
18893
|
+
/**
|
|
18894
|
+
* True when the embedding origins of the organization allow the origin.
|
|
18895
|
+
*/
|
|
18896
|
+
'valid': boolean;
|
|
18897
|
+
}
|
|
17188
18898
|
/**
|
|
17189
18899
|
* The cache expires once a fixed period elapses since the results were computed.
|
|
17190
18900
|
*/
|
|
@@ -18051,7 +19761,7 @@ export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationStat
|
|
|
18051
19761
|
*/
|
|
18052
19762
|
export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationUsage(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18053
19763
|
/**
|
|
18054
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches.
|
|
19764
|
+
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
18055
19765
|
* @summary (BETA) Users who set a language themselves.
|
|
18056
19766
|
* @param {string} [value] Language tag that the user sets.
|
|
18057
19767
|
* @param {string} [name] Filter by user name, email or login (user ID). Note that the filter is case insensitive.
|
|
@@ -18065,7 +19775,7 @@ export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationUsag
|
|
|
18065
19775
|
*/
|
|
18066
19776
|
export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationUsageUsers(value?: string, name?: string, setting?: 'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE', source?: 'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT', page?: number, size?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18067
19777
|
/**
|
|
18068
|
-
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.
|
|
19778
|
+
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
18069
19779
|
* @summary (BETA) Workspaces that use a language.
|
|
18070
19780
|
* @param {string} [value] Language tag that the workspace gets.
|
|
18071
19781
|
* @param {string} [name] Filter by workspace name. Note that the filter is case insensitive.
|
|
@@ -18317,6 +20027,15 @@ export declare function ActionsApiAxiosParamCreator_UnsubscribeSelectedWorkspace
|
|
|
18317
20027
|
* @throws {RequiredError}
|
|
18318
20028
|
*/
|
|
18319
20029
|
export declare function ActionsApiAxiosParamCreator_UnsubscribeWorkspaceAutomations(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20030
|
+
/**
|
|
20031
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
20032
|
+
* @summary Validate an embedding origin.
|
|
20033
|
+
* @param {ValidateEmbeddingOriginRequest} validateEmbeddingOriginRequest
|
|
20034
|
+
* @param {*} [options] Override http request option.
|
|
20035
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20036
|
+
* @throws {RequiredError}
|
|
20037
|
+
*/
|
|
20038
|
+
export declare function ActionsApiAxiosParamCreator_ValidateEmbeddingOrigin(validateEmbeddingOriginRequest: ValidateEmbeddingOriginRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18320
20039
|
/**
|
|
18321
20040
|
*
|
|
18322
20041
|
* @summary (BETA) Get Visualization Permissions
|
|
@@ -18328,14 +20047,15 @@ export declare function ActionsApiAxiosParamCreator_UnsubscribeWorkspaceAutomati
|
|
|
18328
20047
|
*/
|
|
18329
20048
|
export declare function ActionsApiAxiosParamCreator_VisualizationPermissions(workspaceId: string, visualizationObjectId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18330
20049
|
/**
|
|
18331
|
-
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.
|
|
20050
|
+
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.
|
|
18332
20051
|
* @summary (BETA) Languages with translations in the workspace.
|
|
18333
20052
|
* @param {string} workspaceId
|
|
20053
|
+
* @param {boolean} [includeCoverage] Adds translation counts for the workspace and each parent, root first.
|
|
18334
20054
|
* @param {*} [options] Override http request option.
|
|
18335
20055
|
* @param {Configuration} [configuration] Optional configuration.
|
|
18336
20056
|
* @throws {RequiredError}
|
|
18337
20057
|
*/
|
|
18338
|
-
export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationStatistics(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20058
|
+
export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationStatistics(workspaceId: string, includeCoverage?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18339
20059
|
/**
|
|
18340
20060
|
* (BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included.
|
|
18341
20061
|
* @summary (BETA) Languages used in the workspace.
|
|
@@ -18346,7 +20066,7 @@ export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationStatist
|
|
|
18346
20066
|
*/
|
|
18347
20067
|
export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationUsage(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18348
20068
|
/**
|
|
18349
|
-
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.
|
|
20069
|
+
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
18350
20070
|
* @summary (BETA) Workspace members who get a language.
|
|
18351
20071
|
* @param {string} workspaceId
|
|
18352
20072
|
* @param {string} [value] Language tag that the user gets.
|
|
@@ -18751,7 +20471,7 @@ export declare function ActionsApi_OrganizationLocalizationStatistics(axios: Axi
|
|
|
18751
20471
|
*/
|
|
18752
20472
|
export declare function ActionsApi_OrganizationLocalizationUsage(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsage>;
|
|
18753
20473
|
/**
|
|
18754
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches.
|
|
20474
|
+
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
18755
20475
|
* @summary (BETA) Users who set a language themselves.
|
|
18756
20476
|
* @param {AxiosInstance} axios Axios instance.
|
|
18757
20477
|
* @param {string} basePath Base path.
|
|
@@ -18762,7 +20482,7 @@ export declare function ActionsApi_OrganizationLocalizationUsage(axios: AxiosIns
|
|
|
18762
20482
|
*/
|
|
18763
20483
|
export declare function ActionsApi_OrganizationLocalizationUsageUsers(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsageUsers>;
|
|
18764
20484
|
/**
|
|
18765
|
-
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.
|
|
20485
|
+
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
18766
20486
|
* @summary (BETA) Workspaces that use a language.
|
|
18767
20487
|
* @param {AxiosInstance} axios Axios instance.
|
|
18768
20488
|
* @param {string} basePath Base path.
|
|
@@ -19054,6 +20774,17 @@ export declare function ActionsApi_UnsubscribeSelectedWorkspaceAutomations(axios
|
|
|
19054
20774
|
* @throws {RequiredError}
|
|
19055
20775
|
*/
|
|
19056
20776
|
export declare function ActionsApi_UnsubscribeWorkspaceAutomations(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
20777
|
+
/**
|
|
20778
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
20779
|
+
* @summary Validate an embedding origin.
|
|
20780
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
20781
|
+
* @param {string} basePath Base path.
|
|
20782
|
+
* @param {ActionsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
20783
|
+
* @param {*} [options] Override http request option.
|
|
20784
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20785
|
+
* @throws {RequiredError}
|
|
20786
|
+
*/
|
|
20787
|
+
export declare function ActionsApi_ValidateEmbeddingOrigin(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
19057
20788
|
/**
|
|
19058
20789
|
*
|
|
19059
20790
|
* @summary (BETA) Get Visualization Permissions
|
|
@@ -19066,7 +20797,7 @@ export declare function ActionsApi_UnsubscribeWorkspaceAutomations(axios: AxiosI
|
|
|
19066
20797
|
*/
|
|
19067
20798
|
export declare function ActionsApi_VisualizationPermissions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiVisualizationPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<VisualizationPermissions>;
|
|
19068
20799
|
/**
|
|
19069
|
-
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.
|
|
20800
|
+
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.
|
|
19070
20801
|
* @summary (BETA) Languages with translations in the workspace.
|
|
19071
20802
|
* @param {AxiosInstance} axios Axios instance.
|
|
19072
20803
|
* @param {string} basePath Base path.
|
|
@@ -19088,7 +20819,7 @@ export declare function ActionsApi_WorkspaceLocalizationStatistics(axios: AxiosI
|
|
|
19088
20819
|
*/
|
|
19089
20820
|
export declare function ActionsApi_WorkspaceLocalizationUsage(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
19090
20821
|
/**
|
|
19091
|
-
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.
|
|
20822
|
+
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
19092
20823
|
* @summary (BETA) Workspace members who get a language.
|
|
19093
20824
|
* @param {AxiosInstance} axios Axios instance.
|
|
19094
20825
|
* @param {string} basePath Base path.
|
|
@@ -19428,7 +21159,7 @@ export interface ActionsApiInterface {
|
|
|
19428
21159
|
*/
|
|
19429
21160
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
19430
21161
|
/**
|
|
19431
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches.
|
|
21162
|
+
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
19432
21163
|
* @summary (BETA) Users who set a language themselves.
|
|
19433
21164
|
* @param {ActionsApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
19434
21165
|
* @param {*} [options] Override http request option.
|
|
@@ -19437,7 +21168,7 @@ export interface ActionsApiInterface {
|
|
|
19437
21168
|
*/
|
|
19438
21169
|
organizationLocalizationUsageUsers(requestParameters: ActionsApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
19439
21170
|
/**
|
|
19440
|
-
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.
|
|
21171
|
+
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
19441
21172
|
* @summary (BETA) Workspaces that use a language.
|
|
19442
21173
|
* @param {ActionsApiOrganizationLocalizationUsageWorkspacesRequest} requestParameters Request parameters.
|
|
19443
21174
|
* @param {*} [options] Override http request option.
|
|
@@ -19675,6 +21406,15 @@ export interface ActionsApiInterface {
|
|
|
19675
21406
|
* @memberof ActionsApiInterface
|
|
19676
21407
|
*/
|
|
19677
21408
|
unsubscribeWorkspaceAutomations(requestParameters: ActionsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
21409
|
+
/**
|
|
21410
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
21411
|
+
* @summary Validate an embedding origin.
|
|
21412
|
+
* @param {ActionsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
21413
|
+
* @param {*} [options] Override http request option.
|
|
21414
|
+
* @throws {RequiredError}
|
|
21415
|
+
* @memberof ActionsApiInterface
|
|
21416
|
+
*/
|
|
21417
|
+
validateEmbeddingOrigin(requestParameters: ActionsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
19678
21418
|
/**
|
|
19679
21419
|
*
|
|
19680
21420
|
* @summary (BETA) Get Visualization Permissions
|
|
@@ -19685,7 +21425,7 @@ export interface ActionsApiInterface {
|
|
|
19685
21425
|
*/
|
|
19686
21426
|
visualizationPermissions(requestParameters: ActionsApiVisualizationPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<VisualizationPermissions>;
|
|
19687
21427
|
/**
|
|
19688
|
-
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.
|
|
21428
|
+
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.
|
|
19689
21429
|
* @summary (BETA) Languages with translations in the workspace.
|
|
19690
21430
|
* @param {ActionsApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
19691
21431
|
* @param {*} [options] Override http request option.
|
|
@@ -19703,7 +21443,7 @@ export interface ActionsApiInterface {
|
|
|
19703
21443
|
*/
|
|
19704
21444
|
workspaceLocalizationUsage(requestParameters: ActionsApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
19705
21445
|
/**
|
|
19706
|
-
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.
|
|
21446
|
+
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
19707
21447
|
* @summary (BETA) Workspace members who get a language.
|
|
19708
21448
|
* @param {ActionsApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
19709
21449
|
* @param {*} [options] Override http request option.
|
|
@@ -20769,6 +22509,19 @@ export interface ActionsApiUnsubscribeWorkspaceAutomationsRequest {
|
|
|
20769
22509
|
*/
|
|
20770
22510
|
readonly workspaceId: string;
|
|
20771
22511
|
}
|
|
22512
|
+
/**
|
|
22513
|
+
* Request parameters for validateEmbeddingOrigin operation in ActionsApi.
|
|
22514
|
+
* @export
|
|
22515
|
+
* @interface ActionsApiValidateEmbeddingOriginRequest
|
|
22516
|
+
*/
|
|
22517
|
+
export interface ActionsApiValidateEmbeddingOriginRequest {
|
|
22518
|
+
/**
|
|
22519
|
+
*
|
|
22520
|
+
* @type {ValidateEmbeddingOriginRequest}
|
|
22521
|
+
* @memberof ActionsApiValidateEmbeddingOrigin
|
|
22522
|
+
*/
|
|
22523
|
+
readonly validateEmbeddingOriginRequest: ValidateEmbeddingOriginRequest;
|
|
22524
|
+
}
|
|
20772
22525
|
/**
|
|
20773
22526
|
* Request parameters for visualizationPermissions operation in ActionsApi.
|
|
20774
22527
|
* @export
|
|
@@ -20800,6 +22553,12 @@ export interface ActionsApiWorkspaceLocalizationStatisticsRequest {
|
|
|
20800
22553
|
* @memberof ActionsApiWorkspaceLocalizationStatistics
|
|
20801
22554
|
*/
|
|
20802
22555
|
readonly workspaceId: string;
|
|
22556
|
+
/**
|
|
22557
|
+
* Adds translation counts for the workspace and each parent, root first.
|
|
22558
|
+
* @type {boolean}
|
|
22559
|
+
* @memberof ActionsApiWorkspaceLocalizationStatistics
|
|
22560
|
+
*/
|
|
22561
|
+
readonly includeCoverage?: boolean;
|
|
20803
22562
|
}
|
|
20804
22563
|
/**
|
|
20805
22564
|
* Request parameters for workspaceLocalizationUsage operation in ActionsApi.
|
|
@@ -21216,7 +22975,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21216
22975
|
*/
|
|
21217
22976
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
21218
22977
|
/**
|
|
21219
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches.
|
|
22978
|
+
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
21220
22979
|
* @summary (BETA) Users who set a language themselves.
|
|
21221
22980
|
* @param {ActionsApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
21222
22981
|
* @param {*} [options] Override http request option.
|
|
@@ -21225,7 +22984,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21225
22984
|
*/
|
|
21226
22985
|
organizationLocalizationUsageUsers(requestParameters?: ActionsApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
21227
22986
|
/**
|
|
21228
|
-
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.
|
|
22987
|
+
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
21229
22988
|
* @summary (BETA) Workspaces that use a language.
|
|
21230
22989
|
* @param {ActionsApiOrganizationLocalizationUsageWorkspacesRequest} requestParameters Request parameters.
|
|
21231
22990
|
* @param {*} [options] Override http request option.
|
|
@@ -21463,6 +23222,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21463
23222
|
* @memberof ActionsApi
|
|
21464
23223
|
*/
|
|
21465
23224
|
unsubscribeWorkspaceAutomations(requestParameters: ActionsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
23225
|
+
/**
|
|
23226
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
23227
|
+
* @summary Validate an embedding origin.
|
|
23228
|
+
* @param {ActionsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
23229
|
+
* @param {*} [options] Override http request option.
|
|
23230
|
+
* @throws {RequiredError}
|
|
23231
|
+
* @memberof ActionsApi
|
|
23232
|
+
*/
|
|
23233
|
+
validateEmbeddingOrigin(requestParameters: ActionsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
21466
23234
|
/**
|
|
21467
23235
|
*
|
|
21468
23236
|
* @summary (BETA) Get Visualization Permissions
|
|
@@ -21473,7 +23241,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21473
23241
|
*/
|
|
21474
23242
|
visualizationPermissions(requestParameters: ActionsApiVisualizationPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<VisualizationPermissions>;
|
|
21475
23243
|
/**
|
|
21476
|
-
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.
|
|
23244
|
+
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.
|
|
21477
23245
|
* @summary (BETA) Languages with translations in the workspace.
|
|
21478
23246
|
* @param {ActionsApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
21479
23247
|
* @param {*} [options] Override http request option.
|
|
@@ -21491,7 +23259,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21491
23259
|
*/
|
|
21492
23260
|
workspaceLocalizationUsage(requestParameters: ActionsApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
21493
23261
|
/**
|
|
21494
|
-
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.
|
|
23262
|
+
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
21495
23263
|
* @summary (BETA) Workspace members who get a language.
|
|
21496
23264
|
* @param {ActionsApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
21497
23265
|
* @param {*} [options] Override http request option.
|
|
@@ -38588,7 +40356,7 @@ export declare function DocumentControllerApiAxiosParamCreator_DeleteEntityDocum
|
|
|
38588
40356
|
* @param {string} workspaceId
|
|
38589
40357
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
38590
40358
|
* @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\').
|
|
38591
|
-
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
40359
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | '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.
|
|
38592
40360
|
* @param {number} [page] Zero-based page index (0..N)
|
|
38593
40361
|
* @param {number} [size] The size of the page to be returned
|
|
38594
40362
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -38605,7 +40373,7 @@ export declare function DocumentControllerApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
38605
40373
|
* @param {string} workspaceId
|
|
38606
40374
|
* @param {string} objectId
|
|
38607
40375
|
* @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\').
|
|
38608
|
-
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
40376
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | '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.
|
|
38609
40377
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
38610
40378
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38611
40379
|
* @param {*} [options] Override http request option.
|
|
@@ -39084,7 +40852,7 @@ export declare function DocumentTemplateControllerApiAxiosParamCreator_DeleteEnt
|
|
|
39084
40852
|
* @param {string} workspaceId
|
|
39085
40853
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
39086
40854
|
* @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\').
|
|
39087
|
-
* @param {Array<'userIdentifiers' | '
|
|
40855
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
39088
40856
|
* @param {number} [page] Zero-based page index (0..N)
|
|
39089
40857
|
* @param {number} [size] The size of the page to be returned
|
|
39090
40858
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -39101,7 +40869,7 @@ export declare function DocumentTemplateControllerApiAxiosParamCreator_GetAllEnt
|
|
|
39101
40869
|
* @param {string} workspaceId
|
|
39102
40870
|
* @param {string} objectId
|
|
39103
40871
|
* @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\').
|
|
39104
|
-
* @param {Array<'userIdentifiers' | '
|
|
40872
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
39105
40873
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
39106
40874
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39107
40875
|
* @param {*} [options] Override http request option.
|
|
@@ -40835,7 +42603,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesDocumentTempl
|
|
|
40835
42603
|
* @param {string} workspaceId
|
|
40836
42604
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
40837
42605
|
* @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\').
|
|
40838
|
-
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
42606
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | '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.
|
|
40839
42607
|
* @param {number} [page] Zero-based page index (0..N)
|
|
40840
42608
|
* @param {number} [size] The size of the page to be returned
|
|
40841
42609
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -41131,7 +42899,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesOrgMemoryItem
|
|
|
41131
42899
|
*/
|
|
41132
42900
|
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesOrganizationSettings(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
41133
42901
|
/**
|
|
41134
|
-
*
|
|
42902
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
41135
42903
|
* @summary Get all Page Templates
|
|
41136
42904
|
* @param {string} workspaceId
|
|
41137
42905
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
@@ -41170,7 +42938,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesParameters(wo
|
|
|
41170
42938
|
* @param {string} workspaceId
|
|
41171
42939
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
41172
42940
|
* @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\').
|
|
41173
|
-
* @param {Array<'userIdentifiers' | '
|
|
42941
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
41174
42942
|
* @param {number} [page] Zero-based page index (0..N)
|
|
41175
42943
|
* @param {number} [size] The size of the page to be returned
|
|
41176
42944
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -41694,7 +43462,7 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityDocumentTemplates(
|
|
|
41694
43462
|
* @param {string} workspaceId
|
|
41695
43463
|
* @param {string} objectId
|
|
41696
43464
|
* @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\').
|
|
41697
|
-
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
43465
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | '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.
|
|
41698
43466
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
41699
43467
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
41700
43468
|
* @param {*} [options] Override http request option.
|
|
@@ -42001,7 +43769,7 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityReportTemplates(wo
|
|
|
42001
43769
|
* @param {string} workspaceId
|
|
42002
43770
|
* @param {string} objectId
|
|
42003
43771
|
* @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\').
|
|
42004
|
-
* @param {Array<'userIdentifiers' | '
|
|
43772
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
42005
43773
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
42006
43774
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
42007
43775
|
* @param {*} [options] Override http request option.
|
|
@@ -45180,7 +46948,7 @@ export declare function EntitiesApi_GetAllEntitiesOrgMemoryItems(axios: AxiosIns
|
|
|
45180
46948
|
*/
|
|
45181
46949
|
export declare function EntitiesApi_GetAllEntitiesOrganizationSettings(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiGetAllEntitiesOrganizationSettingsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiOrganizationSettingOutList>;
|
|
45182
46950
|
/**
|
|
45183
|
-
*
|
|
46951
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
45184
46952
|
* @summary Get all Page Templates
|
|
45185
46953
|
* @param {AxiosInstance} axios Axios instance.
|
|
45186
46954
|
* @param {string} basePath Base path.
|
|
@@ -48666,7 +50434,7 @@ export interface EntitiesApiInterface {
|
|
|
48666
50434
|
*/
|
|
48667
50435
|
getAllEntitiesOrganizationSettings(requestParameters: EntitiesApiGetAllEntitiesOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationSettingOutList>;
|
|
48668
50436
|
/**
|
|
48669
|
-
*
|
|
50437
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
48670
50438
|
* @summary Get all Page Templates
|
|
48671
50439
|
* @param {EntitiesApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
48672
50440
|
* @param {*} [options] Override http request option.
|
|
@@ -62536,7 +64304,7 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
62536
64304
|
*/
|
|
62537
64305
|
getAllEntitiesOrganizationSettings(requestParameters?: EntitiesApiGetAllEntitiesOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationSettingOutList>;
|
|
62538
64306
|
/**
|
|
62539
|
-
*
|
|
64307
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
62540
64308
|
* @summary Get all Page Templates
|
|
62541
64309
|
* @param {EntitiesApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
62542
64310
|
* @param {*} [options] Override http request option.
|
|
@@ -79181,7 +80949,7 @@ export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizatio
|
|
|
79181
80949
|
*/
|
|
79182
80950
|
export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizationUsage(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79183
80951
|
/**
|
|
79184
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches.
|
|
80952
|
+
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79185
80953
|
* @summary (BETA) Users who set a language themselves.
|
|
79186
80954
|
* @param {string} [value] Language tag that the user sets.
|
|
79187
80955
|
* @param {string} [name] Filter by user name, email or login (user ID). Note that the filter is case insensitive.
|
|
@@ -79195,7 +80963,7 @@ export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizatio
|
|
|
79195
80963
|
*/
|
|
79196
80964
|
export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizationUsageUsers(value?: string, name?: string, setting?: 'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE', source?: 'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT', page?: number, size?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79197
80965
|
/**
|
|
79198
|
-
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.
|
|
80966
|
+
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79199
80967
|
* @summary (BETA) Workspaces that use a language.
|
|
79200
80968
|
* @param {string} [value] Language tag that the workspace gets.
|
|
79201
80969
|
* @param {string} [name] Filter by workspace name. Note that the filter is case insensitive.
|
|
@@ -79209,14 +80977,15 @@ export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizatio
|
|
|
79209
80977
|
*/
|
|
79210
80978
|
export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizationUsageWorkspaces(value?: string, name?: string, setting?: 'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE', source?: 'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT', page?: number, size?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79211
80979
|
/**
|
|
79212
|
-
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.
|
|
80980
|
+
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.
|
|
79213
80981
|
* @summary (BETA) Languages with translations in the workspace.
|
|
79214
80982
|
* @param {string} workspaceId
|
|
80983
|
+
* @param {boolean} [includeCoverage] Adds translation counts for the workspace and each parent, root first.
|
|
79215
80984
|
* @param {*} [options] Override http request option.
|
|
79216
80985
|
* @param {Configuration} [configuration] Optional configuration.
|
|
79217
80986
|
* @throws {RequiredError}
|
|
79218
80987
|
*/
|
|
79219
|
-
export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationStatistics(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
80988
|
+
export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationStatistics(workspaceId: string, includeCoverage?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79220
80989
|
/**
|
|
79221
80990
|
* (BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included.
|
|
79222
80991
|
* @summary (BETA) Languages used in the workspace.
|
|
@@ -79227,7 +80996,7 @@ export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationSt
|
|
|
79227
80996
|
*/
|
|
79228
80997
|
export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationUsage(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79229
80998
|
/**
|
|
79230
|
-
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.
|
|
80999
|
+
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79231
81000
|
* @summary (BETA) Workspace members who get a language.
|
|
79232
81001
|
* @param {string} workspaceId
|
|
79233
81002
|
* @param {string} [value] Language tag that the user gets.
|
|
@@ -79262,7 +81031,7 @@ export declare function LocalizationApi_OrganizationLocalizationStatistics(axios
|
|
|
79262
81031
|
*/
|
|
79263
81032
|
export declare function LocalizationApi_OrganizationLocalizationUsage(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsage>;
|
|
79264
81033
|
/**
|
|
79265
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches.
|
|
81034
|
+
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79266
81035
|
* @summary (BETA) Users who set a language themselves.
|
|
79267
81036
|
* @param {AxiosInstance} axios Axios instance.
|
|
79268
81037
|
* @param {string} basePath Base path.
|
|
@@ -79273,7 +81042,7 @@ export declare function LocalizationApi_OrganizationLocalizationUsage(axios: Axi
|
|
|
79273
81042
|
*/
|
|
79274
81043
|
export declare function LocalizationApi_OrganizationLocalizationUsageUsers(axios: AxiosInstance, basePath: string, requestParameters: LocalizationApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsageUsers>;
|
|
79275
81044
|
/**
|
|
79276
|
-
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.
|
|
81045
|
+
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79277
81046
|
* @summary (BETA) Workspaces that use a language.
|
|
79278
81047
|
* @param {AxiosInstance} axios Axios instance.
|
|
79279
81048
|
* @param {string} basePath Base path.
|
|
@@ -79284,7 +81053,7 @@ export declare function LocalizationApi_OrganizationLocalizationUsageUsers(axios
|
|
|
79284
81053
|
*/
|
|
79285
81054
|
export declare function LocalizationApi_OrganizationLocalizationUsageWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: LocalizationApiOrganizationLocalizationUsageWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsageWorkspaces>;
|
|
79286
81055
|
/**
|
|
79287
|
-
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.
|
|
81056
|
+
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.
|
|
79288
81057
|
* @summary (BETA) Languages with translations in the workspace.
|
|
79289
81058
|
* @param {AxiosInstance} axios Axios instance.
|
|
79290
81059
|
* @param {string} basePath Base path.
|
|
@@ -79306,7 +81075,7 @@ export declare function LocalizationApi_WorkspaceLocalizationStatistics(axios: A
|
|
|
79306
81075
|
*/
|
|
79307
81076
|
export declare function LocalizationApi_WorkspaceLocalizationUsage(axios: AxiosInstance, basePath: string, requestParameters: LocalizationApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
79308
81077
|
/**
|
|
79309
|
-
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.
|
|
81078
|
+
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79310
81079
|
* @summary (BETA) Workspace members who get a language.
|
|
79311
81080
|
* @param {AxiosInstance} axios Axios instance.
|
|
79312
81081
|
* @param {string} basePath Base path.
|
|
@@ -79339,7 +81108,7 @@ export interface LocalizationApiInterface {
|
|
|
79339
81108
|
*/
|
|
79340
81109
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
79341
81110
|
/**
|
|
79342
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches.
|
|
81111
|
+
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79343
81112
|
* @summary (BETA) Users who set a language themselves.
|
|
79344
81113
|
* @param {LocalizationApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
79345
81114
|
* @param {*} [options] Override http request option.
|
|
@@ -79348,7 +81117,7 @@ export interface LocalizationApiInterface {
|
|
|
79348
81117
|
*/
|
|
79349
81118
|
organizationLocalizationUsageUsers(requestParameters: LocalizationApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
79350
81119
|
/**
|
|
79351
|
-
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.
|
|
81120
|
+
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79352
81121
|
* @summary (BETA) Workspaces that use a language.
|
|
79353
81122
|
* @param {LocalizationApiOrganizationLocalizationUsageWorkspacesRequest} requestParameters Request parameters.
|
|
79354
81123
|
* @param {*} [options] Override http request option.
|
|
@@ -79357,7 +81126,7 @@ export interface LocalizationApiInterface {
|
|
|
79357
81126
|
*/
|
|
79358
81127
|
organizationLocalizationUsageWorkspaces(requestParameters: LocalizationApiOrganizationLocalizationUsageWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageWorkspaces>;
|
|
79359
81128
|
/**
|
|
79360
|
-
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.
|
|
81129
|
+
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.
|
|
79361
81130
|
* @summary (BETA) Languages with translations in the workspace.
|
|
79362
81131
|
* @param {LocalizationApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
79363
81132
|
* @param {*} [options] Override http request option.
|
|
@@ -79375,7 +81144,7 @@ export interface LocalizationApiInterface {
|
|
|
79375
81144
|
*/
|
|
79376
81145
|
workspaceLocalizationUsage(requestParameters: LocalizationApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
79377
81146
|
/**
|
|
79378
|
-
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.
|
|
81147
|
+
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79379
81148
|
* @summary (BETA) Workspace members who get a language.
|
|
79380
81149
|
* @param {LocalizationApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
79381
81150
|
* @param {*} [options] Override http request option.
|
|
@@ -79482,6 +81251,12 @@ export interface LocalizationApiWorkspaceLocalizationStatisticsRequest {
|
|
|
79482
81251
|
* @memberof LocalizationApiWorkspaceLocalizationStatistics
|
|
79483
81252
|
*/
|
|
79484
81253
|
readonly workspaceId: string;
|
|
81254
|
+
/**
|
|
81255
|
+
* Adds translation counts for the workspace and each parent, root first.
|
|
81256
|
+
* @type {boolean}
|
|
81257
|
+
* @memberof LocalizationApiWorkspaceLocalizationStatistics
|
|
81258
|
+
*/
|
|
81259
|
+
readonly includeCoverage?: boolean;
|
|
79485
81260
|
}
|
|
79486
81261
|
/**
|
|
79487
81262
|
* Request parameters for workspaceLocalizationUsage operation in LocalizationApi.
|
|
@@ -79569,7 +81344,7 @@ export declare class LocalizationApi extends BaseAPI implements LocalizationApiI
|
|
|
79569
81344
|
*/
|
|
79570
81345
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
79571
81346
|
/**
|
|
79572
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches.
|
|
81347
|
+
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79573
81348
|
* @summary (BETA) Users who set a language themselves.
|
|
79574
81349
|
* @param {LocalizationApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
79575
81350
|
* @param {*} [options] Override http request option.
|
|
@@ -79578,7 +81353,7 @@ export declare class LocalizationApi extends BaseAPI implements LocalizationApiI
|
|
|
79578
81353
|
*/
|
|
79579
81354
|
organizationLocalizationUsageUsers(requestParameters?: LocalizationApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
79580
81355
|
/**
|
|
79581
|
-
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.
|
|
81356
|
+
* (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79582
81357
|
* @summary (BETA) Workspaces that use a language.
|
|
79583
81358
|
* @param {LocalizationApiOrganizationLocalizationUsageWorkspacesRequest} requestParameters Request parameters.
|
|
79584
81359
|
* @param {*} [options] Override http request option.
|
|
@@ -79587,7 +81362,7 @@ export declare class LocalizationApi extends BaseAPI implements LocalizationApiI
|
|
|
79587
81362
|
*/
|
|
79588
81363
|
organizationLocalizationUsageWorkspaces(requestParameters?: LocalizationApiOrganizationLocalizationUsageWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageWorkspaces>;
|
|
79589
81364
|
/**
|
|
79590
|
-
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.
|
|
81365
|
+
* (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.
|
|
79591
81366
|
* @summary (BETA) Languages with translations in the workspace.
|
|
79592
81367
|
* @param {LocalizationApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
79593
81368
|
* @param {*} [options] Override http request option.
|
|
@@ -79605,7 +81380,7 @@ export declare class LocalizationApi extends BaseAPI implements LocalizationApiI
|
|
|
79605
81380
|
*/
|
|
79606
81381
|
workspaceLocalizationUsage(requestParameters: LocalizationApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
79607
81382
|
/**
|
|
79608
|
-
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.
|
|
81383
|
+
* (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.
|
|
79609
81384
|
* @summary (BETA) Workspace members who get a language.
|
|
79610
81385
|
* @param {LocalizationApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
79611
81386
|
* @param {*} [options] Override http request option.
|
|
@@ -86289,7 +88064,7 @@ export declare function PageTemplateControllerApiAxiosParamCreator_CreateEntityP
|
|
|
86289
88064
|
*/
|
|
86290
88065
|
export declare function PageTemplateControllerApiAxiosParamCreator_DeleteEntityPageTemplates(workspaceId: string, objectId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86291
88066
|
/**
|
|
86292
|
-
*
|
|
88067
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
86293
88068
|
* @summary Get all Page Templates
|
|
86294
88069
|
* @param {string} workspaceId
|
|
86295
88070
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
@@ -86368,7 +88143,7 @@ export declare function PageTemplateControllerApi_CreateEntityPageTemplates(axio
|
|
|
86368
88143
|
*/
|
|
86369
88144
|
export declare function PageTemplateControllerApi_DeleteEntityPageTemplates(axios: AxiosInstance, basePath: string, requestParameters: PageTemplateControllerApiDeleteEntityPageTemplatesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
86370
88145
|
/**
|
|
86371
|
-
*
|
|
88146
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
86372
88147
|
* @summary Get all Page Templates
|
|
86373
88148
|
* @param {AxiosInstance} axios Axios instance.
|
|
86374
88149
|
* @param {string} basePath Base path.
|
|
@@ -86436,7 +88211,7 @@ export interface PageTemplateControllerApiInterface {
|
|
|
86436
88211
|
*/
|
|
86437
88212
|
deleteEntityPageTemplates(requestParameters: PageTemplateControllerApiDeleteEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
86438
88213
|
/**
|
|
86439
|
-
*
|
|
88214
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
86440
88215
|
* @summary Get all Page Templates
|
|
86441
88216
|
* @param {PageTemplateControllerApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
86442
88217
|
* @param {*} [options] Override http request option.
|
|
@@ -86726,7 +88501,7 @@ export declare class PageTemplateControllerApi extends BaseAPI implements PageTe
|
|
|
86726
88501
|
*/
|
|
86727
88502
|
deleteEntityPageTemplates(requestParameters: PageTemplateControllerApiDeleteEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
86728
88503
|
/**
|
|
86729
|
-
*
|
|
88504
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
86730
88505
|
* @summary Get all Page Templates
|
|
86731
88506
|
* @param {PageTemplateControllerApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
86732
88507
|
* @param {*} [options] Override http request option.
|
|
@@ -90068,7 +91843,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
90068
91843
|
* @param {string} workspaceId
|
|
90069
91844
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
90070
91845
|
* @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\').
|
|
90071
|
-
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
91846
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | '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.
|
|
90072
91847
|
* @param {number} [page] Zero-based page index (0..N)
|
|
90073
91848
|
* @param {number} [size] The size of the page to be returned
|
|
90074
91849
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -90080,7 +91855,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
90080
91855
|
*/
|
|
90081
91856
|
export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDocuments(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90082
91857
|
/**
|
|
90083
|
-
*
|
|
91858
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
90084
91859
|
* @summary Get all Page Templates
|
|
90085
91860
|
* @param {string} workspaceId
|
|
90086
91861
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
@@ -90116,7 +91891,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetEntityDocument
|
|
|
90116
91891
|
* @param {string} workspaceId
|
|
90117
91892
|
* @param {string} objectId
|
|
90118
91893
|
* @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\').
|
|
90119
|
-
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
91894
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | '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.
|
|
90120
91895
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
90121
91896
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
90122
91897
|
* @param {*} [options] Override http request option.
|
|
@@ -90305,7 +92080,7 @@ export declare function PublisherDocumentsApi_GetAllEntitiesDocumentTemplates(ax
|
|
|
90305
92080
|
*/
|
|
90306
92081
|
export declare function PublisherDocumentsApi_GetAllEntitiesDocuments(axios: AxiosInstance, basePath: string, requestParameters: PublisherDocumentsApiGetAllEntitiesDocumentsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiPublisherDocumentOutList>;
|
|
90307
92082
|
/**
|
|
90308
|
-
*
|
|
92083
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
90309
92084
|
* @summary Get all Page Templates
|
|
90310
92085
|
* @param {AxiosInstance} axios Axios instance.
|
|
90311
92086
|
* @param {string} basePath Base path.
|
|
@@ -90493,7 +92268,7 @@ export interface PublisherDocumentsApiInterface {
|
|
|
90493
92268
|
*/
|
|
90494
92269
|
getAllEntitiesDocuments(requestParameters: PublisherDocumentsApiGetAllEntitiesDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutList>;
|
|
90495
92270
|
/**
|
|
90496
|
-
*
|
|
92271
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
90497
92272
|
* @summary Get all Page Templates
|
|
90498
92273
|
* @param {PublisherDocumentsApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
90499
92274
|
* @param {*} [options] Override http request option.
|
|
@@ -91347,7 +93122,7 @@ export declare class PublisherDocumentsApi extends BaseAPI implements PublisherD
|
|
|
91347
93122
|
*/
|
|
91348
93123
|
getAllEntitiesDocuments(requestParameters: PublisherDocumentsApiGetAllEntitiesDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutList>;
|
|
91349
93124
|
/**
|
|
91350
|
-
*
|
|
93125
|
+
* Lists the default page templates first, in a fixed order, then the workspace page templates. Paging counts both as one sequence. `filter` and `sort` apply to the workspace page templates only; the default page templates are always listed first and in full, and `isDefault` is not filterable. The default page templates are listed only with `origin=ALL`.
|
|
91351
93126
|
* @summary Get all Page Templates
|
|
91352
93127
|
* @param {PublisherDocumentsApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
91353
93128
|
* @param {*} [options] Override http request option.
|
|
@@ -91465,7 +93240,7 @@ export declare function ReportControllerApiAxiosParamCreator_DeleteEntityReports
|
|
|
91465
93240
|
* @param {string} workspaceId
|
|
91466
93241
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
91467
93242
|
* @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\').
|
|
91468
|
-
* @param {Array<'userIdentifiers' | '
|
|
93243
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
91469
93244
|
* @param {number} [page] Zero-based page index (0..N)
|
|
91470
93245
|
* @param {number} [size] The size of the page to be returned
|
|
91471
93246
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -91482,7 +93257,7 @@ export declare function ReportControllerApiAxiosParamCreator_GetAllEntitiesRepor
|
|
|
91482
93257
|
* @param {string} workspaceId
|
|
91483
93258
|
* @param {string} objectId
|
|
91484
93259
|
* @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\').
|
|
91485
|
-
* @param {Array<'userIdentifiers' | '
|
|
93260
|
+
* @param {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | '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.
|
|
91486
93261
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
91487
93262
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
91488
93263
|
* @param {*} [options] Override http request option.
|
|
@@ -92944,6 +94719,15 @@ export declare function ReportingSettingsApiAxiosParamCreator_ResolveAllSettings
|
|
|
92944
94719
|
* @throws {RequiredError}
|
|
92945
94720
|
*/
|
|
92946
94721
|
export declare function ReportingSettingsApiAxiosParamCreator_ResolveSettingsWithoutWorkspace(resolveSettingsRequest: ResolveSettingsRequest, excludeUserSettings?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
94722
|
+
/**
|
|
94723
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
94724
|
+
* @summary Validate an embedding origin.
|
|
94725
|
+
* @param {ValidateEmbeddingOriginRequest} validateEmbeddingOriginRequest
|
|
94726
|
+
* @param {*} [options] Override http request option.
|
|
94727
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
94728
|
+
* @throws {RequiredError}
|
|
94729
|
+
*/
|
|
94730
|
+
export declare function ReportingSettingsApiAxiosParamCreator_ValidateEmbeddingOrigin(validateEmbeddingOriginRequest: ValidateEmbeddingOriginRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
92947
94731
|
/**
|
|
92948
94732
|
* Resolves values for all settings without workspace by current user, organization, or default settings.
|
|
92949
94733
|
* @summary Values for all settings without workspace.
|
|
@@ -92966,6 +94750,17 @@ export declare function ReportingSettingsApi_ResolveAllSettingsWithoutWorkspace(
|
|
|
92966
94750
|
* @throws {RequiredError}
|
|
92967
94751
|
*/
|
|
92968
94752
|
export declare function ReportingSettingsApi_ResolveSettingsWithoutWorkspace(axios: AxiosInstance, basePath: string, requestParameters: ReportingSettingsApiResolveSettingsWithoutWorkspaceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<Array<ResolvedSetting>>;
|
|
94753
|
+
/**
|
|
94754
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
94755
|
+
* @summary Validate an embedding origin.
|
|
94756
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
94757
|
+
* @param {string} basePath Base path.
|
|
94758
|
+
* @param {ReportingSettingsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
94759
|
+
* @param {*} [options] Override http request option.
|
|
94760
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
94761
|
+
* @throws {RequiredError}
|
|
94762
|
+
*/
|
|
94763
|
+
export declare function ReportingSettingsApi_ValidateEmbeddingOrigin(axios: AxiosInstance, basePath: string, requestParameters: ReportingSettingsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
92969
94764
|
/**
|
|
92970
94765
|
* ReportingSettingsApi - interface
|
|
92971
94766
|
* @export
|
|
@@ -92990,6 +94785,15 @@ export interface ReportingSettingsApiInterface {
|
|
|
92990
94785
|
* @memberof ReportingSettingsApiInterface
|
|
92991
94786
|
*/
|
|
92992
94787
|
resolveSettingsWithoutWorkspace(requestParameters: ReportingSettingsApiResolveSettingsWithoutWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ResolvedSetting>>;
|
|
94788
|
+
/**
|
|
94789
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
94790
|
+
* @summary Validate an embedding origin.
|
|
94791
|
+
* @param {ReportingSettingsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
94792
|
+
* @param {*} [options] Override http request option.
|
|
94793
|
+
* @throws {RequiredError}
|
|
94794
|
+
* @memberof ReportingSettingsApiInterface
|
|
94795
|
+
*/
|
|
94796
|
+
validateEmbeddingOrigin(requestParameters: ReportingSettingsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
92993
94797
|
}
|
|
92994
94798
|
/**
|
|
92995
94799
|
* Request parameters for resolveAllSettingsWithoutWorkspace operation in ReportingSettingsApi.
|
|
@@ -93023,6 +94827,19 @@ export interface ReportingSettingsApiResolveSettingsWithoutWorkspaceRequest {
|
|
|
93023
94827
|
*/
|
|
93024
94828
|
readonly excludeUserSettings?: boolean;
|
|
93025
94829
|
}
|
|
94830
|
+
/**
|
|
94831
|
+
* Request parameters for validateEmbeddingOrigin operation in ReportingSettingsApi.
|
|
94832
|
+
* @export
|
|
94833
|
+
* @interface ReportingSettingsApiValidateEmbeddingOriginRequest
|
|
94834
|
+
*/
|
|
94835
|
+
export interface ReportingSettingsApiValidateEmbeddingOriginRequest {
|
|
94836
|
+
/**
|
|
94837
|
+
*
|
|
94838
|
+
* @type {ValidateEmbeddingOriginRequest}
|
|
94839
|
+
* @memberof ReportingSettingsApiValidateEmbeddingOrigin
|
|
94840
|
+
*/
|
|
94841
|
+
readonly validateEmbeddingOriginRequest: ValidateEmbeddingOriginRequest;
|
|
94842
|
+
}
|
|
93026
94843
|
/**
|
|
93027
94844
|
* ReportingSettingsApi - object-oriented interface
|
|
93028
94845
|
* @export
|
|
@@ -93048,6 +94865,15 @@ export declare class ReportingSettingsApi extends BaseAPI implements ReportingSe
|
|
|
93048
94865
|
* @memberof ReportingSettingsApi
|
|
93049
94866
|
*/
|
|
93050
94867
|
resolveSettingsWithoutWorkspace(requestParameters: ReportingSettingsApiResolveSettingsWithoutWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<ResolvedSetting[]>;
|
|
94868
|
+
/**
|
|
94869
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
94870
|
+
* @summary Validate an embedding origin.
|
|
94871
|
+
* @param {ReportingSettingsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
94872
|
+
* @param {*} [options] Override http request option.
|
|
94873
|
+
* @throws {RequiredError}
|
|
94874
|
+
* @memberof ReportingSettingsApi
|
|
94875
|
+
*/
|
|
94876
|
+
validateEmbeddingOrigin(requestParameters: ReportingSettingsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
93051
94877
|
}
|
|
93052
94878
|
/**
|
|
93053
94879
|
*
|