@gooddata/api-client-tiger 11.68.0-alpha.0 → 11.68.0-alpha.10
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/LICENSE +1 -1
- package/NOTICE +1877 -0
- 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 +2636 -868
- package/esm/axios.d.ts.map +1 -1
- package/esm/axios.js +3 -2
- package/esm/endpoints/actions/index.d.ts +1 -1
- package/esm/endpoints/actions/index.d.ts.map +1 -1
- package/esm/endpoints/actions/index.js +2 -2
- package/esm/gd-tiger-model/AnalyticalDashboardModelV1.d.ts.map +1 -1
- package/esm/gd-tiger-model/AnalyticalDashboardModelV1.js +3 -3
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.d.ts.map +1 -1
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.js +7 -7
- package/esm/gd-tiger-model/AnalyticalDashboardModelV3.js +2 -2
- package/esm/gd-tiger-model/VisualizationObjectModelV1.js +2 -2
- package/esm/gd-tiger-model/VisualizationObjectModelV2.js +2 -2
- package/esm/generated/afm-rest-api/api.d.ts +46 -15
- 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 +272 -651
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +47 -377
- package/esm/generated/automation-json-api/api.d.ts +2 -2
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +34 -34
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +24 -24
- package/esm/generated/metadata-json-api/api.d.ts +2356 -128
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +595 -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 +2 -2
- package/esm/index.d.ts.map +1 -1
- package/esm/metadataUtilities.d.ts.map +1 -1
- package/esm/metadataUtilities.js +4 -3
- package/esm/organizationUtilities.d.ts.map +1 -1
- package/esm/organizationUtilities.js +3 -2
- package/package.json +7 -5
|
@@ -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,12 @@ export interface DeclarativePublisherDocument {
|
|
|
2894
2923
|
'version': string;
|
|
2895
2924
|
}
|
|
2896
2925
|
export interface DeclarativePublisherDocumentPageTemplate {
|
|
2926
|
+
'content': PublisherDocumentPageTemplateContent;
|
|
2897
2927
|
/**
|
|
2898
|
-
*
|
|
2928
|
+
* Time of the entity creation.
|
|
2899
2929
|
*/
|
|
2900
|
-
'
|
|
2930
|
+
'createdAt'?: string | null;
|
|
2931
|
+
'createdBy'?: DeclarativeUserIdentifier;
|
|
2901
2932
|
/**
|
|
2902
2933
|
* Page template description.
|
|
2903
2934
|
*/
|
|
@@ -2906,6 +2937,11 @@ export interface DeclarativePublisherDocumentPageTemplate {
|
|
|
2906
2937
|
* Page template ID.
|
|
2907
2938
|
*/
|
|
2908
2939
|
'id': string;
|
|
2940
|
+
/**
|
|
2941
|
+
* Time of the last entity modification.
|
|
2942
|
+
*/
|
|
2943
|
+
'modifiedAt'?: string | null;
|
|
2944
|
+
'modifiedBy'?: DeclarativeUserIdentifier;
|
|
2909
2945
|
'tags'?: Array<string>;
|
|
2910
2946
|
/**
|
|
2911
2947
|
* Page template title.
|
|
@@ -2917,10 +2953,12 @@ export interface DeclarativePublisherDocumentPageTemplate {
|
|
|
2917
2953
|
'version': string;
|
|
2918
2954
|
}
|
|
2919
2955
|
export interface DeclarativePublisherDocumentTemplate {
|
|
2956
|
+
'content': PublisherDocumentContent;
|
|
2920
2957
|
/**
|
|
2921
|
-
*
|
|
2958
|
+
* Time of the entity creation.
|
|
2922
2959
|
*/
|
|
2923
|
-
'
|
|
2960
|
+
'createdAt'?: string | null;
|
|
2961
|
+
'createdBy'?: DeclarativeUserIdentifier;
|
|
2924
2962
|
/**
|
|
2925
2963
|
* Document template description.
|
|
2926
2964
|
*/
|
|
@@ -2929,6 +2967,11 @@ export interface DeclarativePublisherDocumentTemplate {
|
|
|
2929
2967
|
* Document template ID.
|
|
2930
2968
|
*/
|
|
2931
2969
|
'id': string;
|
|
2970
|
+
/**
|
|
2971
|
+
* Time of the last entity modification.
|
|
2972
|
+
*/
|
|
2973
|
+
'modifiedAt'?: string | null;
|
|
2974
|
+
'modifiedBy'?: DeclarativeUserIdentifier;
|
|
2932
2975
|
'tags'?: Array<string>;
|
|
2933
2976
|
/**
|
|
2934
2977
|
* Document template title.
|
|
@@ -3115,7 +3158,7 @@ export interface DeclarativeSetting {
|
|
|
3115
3158
|
*/
|
|
3116
3159
|
'type'?: DeclarativeSettingTypeEnum;
|
|
3117
3160
|
}
|
|
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';
|
|
3161
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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' | 'AI_LAKE_CREDENTIAL_VENDING';
|
|
3119
3162
|
export interface DeclarativeSingleWorkspacePermission {
|
|
3120
3163
|
'assignee': AssigneeIdentifier;
|
|
3121
3164
|
/**
|
|
@@ -3155,6 +3198,12 @@ export interface DeclarativeTable {
|
|
|
3155
3198
|
* Path to table.
|
|
3156
3199
|
*/
|
|
3157
3200
|
'path': Array<string>;
|
|
3201
|
+
/**
|
|
3202
|
+
* 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.
|
|
3203
|
+
*/
|
|
3204
|
+
'properties'?: {
|
|
3205
|
+
[key: string]: string;
|
|
3206
|
+
};
|
|
3158
3207
|
/**
|
|
3159
3208
|
* Table type: TABLE or VIEW.
|
|
3160
3209
|
*/
|
|
@@ -3390,6 +3439,20 @@ export interface DeclarativeVisualizationObject {
|
|
|
3390
3439
|
'title': string;
|
|
3391
3440
|
}
|
|
3392
3441
|
export type DeclarativeVisualizationObjectCertificationEnum = 'CERTIFIED';
|
|
3442
|
+
export interface DeclarativeVisualizationObjectExtension {
|
|
3443
|
+
/**
|
|
3444
|
+
* Visualization object ID.
|
|
3445
|
+
*/
|
|
3446
|
+
'id': string;
|
|
3447
|
+
/**
|
|
3448
|
+
* A list of permissions.
|
|
3449
|
+
*/
|
|
3450
|
+
'permissions': Array<DeclarativeVisualizationObjectExtensionPermissionsInner>;
|
|
3451
|
+
}
|
|
3452
|
+
/**
|
|
3453
|
+
* @type DeclarativeVisualizationObjectExtensionPermissionsInner
|
|
3454
|
+
*/
|
|
3455
|
+
export type DeclarativeVisualizationObjectExtensionPermissionsInner = DeclarativeVisualizationObjectPermissionForAssignee | DeclarativeVisualizationObjectPermissionForAssigneeRule;
|
|
3393
3456
|
/**
|
|
3394
3457
|
* Visualization object permission.
|
|
3395
3458
|
*/
|
|
@@ -3804,8 +3867,11 @@ export interface FactPermissionsForAssigneeRule {
|
|
|
3804
3867
|
}
|
|
3805
3868
|
export type FactPermissionsForAssigneeRulePermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
|
|
3806
3869
|
export interface FeatureFlagsContext {
|
|
3870
|
+
'controlledFeatureRollout': string;
|
|
3871
|
+
'dataCenter': string;
|
|
3807
3872
|
'earlyAccess': string;
|
|
3808
3873
|
'earlyAccessValues': Array<string>;
|
|
3874
|
+
'tier': string;
|
|
3809
3875
|
}
|
|
3810
3876
|
/**
|
|
3811
3877
|
* Base Structure for feature flags
|
|
@@ -3935,6 +4001,16 @@ export interface GeoCollectionIdentifier {
|
|
|
3935
4001
|
'kind'?: GeoCollectionIdentifierKindEnum;
|
|
3936
4002
|
}
|
|
3937
4003
|
export type GeoCollectionIdentifierKindEnum = 'STATIC' | 'CUSTOM';
|
|
4004
|
+
/**
|
|
4005
|
+
* Configuration for GoodData AI provider. Inference is served by GoodData; no credentials are needed.
|
|
4006
|
+
*/
|
|
4007
|
+
export interface GoodDataAiProviderConfig {
|
|
4008
|
+
/**
|
|
4009
|
+
* Provider type.
|
|
4010
|
+
*/
|
|
4011
|
+
'type': GoodDataAiProviderConfigTypeEnum;
|
|
4012
|
+
}
|
|
4013
|
+
export type GoodDataAiProviderConfigTypeEnum = 'GOODDATA_AI';
|
|
3938
4014
|
/**
|
|
3939
4015
|
* A grain identifier.
|
|
3940
4016
|
*/
|
|
@@ -9945,7 +10021,7 @@ export type JsonApiLlmProviderInAttributesModelsInnerFamilyEnum = 'OPENAI' | 'AN
|
|
|
9945
10021
|
* @type JsonApiLlmProviderInAttributesProviderConfig
|
|
9946
10022
|
* Provider-specific configuration including authentication.
|
|
9947
10023
|
*/
|
|
9948
|
-
export type JsonApiLlmProviderInAttributesProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
10024
|
+
export type JsonApiLlmProviderInAttributesProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | GoodDataAiProviderConfig | OpenAIProviderConfig;
|
|
9949
10025
|
export interface JsonApiLlmProviderInDocument {
|
|
9950
10026
|
'data': JsonApiLlmProviderIn;
|
|
9951
10027
|
}
|
|
@@ -9998,7 +10074,7 @@ export type JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum = 'OPENAI' | 'A
|
|
|
9998
10074
|
* @type JsonApiLlmProviderOutAttributesProviderConfig
|
|
9999
10075
|
* Provider-specific configuration including authentication.
|
|
10000
10076
|
*/
|
|
10001
|
-
export type JsonApiLlmProviderOutAttributesProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
10077
|
+
export type JsonApiLlmProviderOutAttributesProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | GoodDataAiProviderConfig | OpenAIProviderConfig;
|
|
10002
10078
|
export interface JsonApiLlmProviderOutDocument {
|
|
10003
10079
|
'data': JsonApiLlmProviderOut;
|
|
10004
10080
|
'links'?: ObjectLinks;
|
|
@@ -10076,7 +10152,7 @@ export type JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum = 'OPENAI' |
|
|
|
10076
10152
|
* @type JsonApiLlmProviderPatchAttributesProviderConfig
|
|
10077
10153
|
* Provider-specific configuration including authentication.
|
|
10078
10154
|
*/
|
|
10079
|
-
export type JsonApiLlmProviderPatchAttributesProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
10155
|
+
export type JsonApiLlmProviderPatchAttributesProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | GoodDataAiProviderConfig | OpenAIProviderConfig;
|
|
10080
10156
|
export interface JsonApiLlmProviderPatchDocument {
|
|
10081
10157
|
'data': JsonApiLlmProviderPatch;
|
|
10082
10158
|
}
|
|
@@ -11354,7 +11430,7 @@ export interface JsonApiOrganizationSettingInAttributes {
|
|
|
11354
11430
|
'content'?: object;
|
|
11355
11431
|
'type'?: JsonApiOrganizationSettingInAttributesTypeEnum;
|
|
11356
11432
|
}
|
|
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';
|
|
11433
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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' | 'AI_LAKE_CREDENTIAL_VENDING';
|
|
11358
11434
|
export interface JsonApiOrganizationSettingInDocument {
|
|
11359
11435
|
'data': JsonApiOrganizationSettingIn;
|
|
11360
11436
|
}
|
|
@@ -11380,7 +11456,7 @@ export interface JsonApiOrganizationSettingOutAttributes {
|
|
|
11380
11456
|
'content'?: object;
|
|
11381
11457
|
'type'?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
11382
11458
|
}
|
|
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';
|
|
11459
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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' | 'AI_LAKE_CREDENTIAL_VENDING';
|
|
11384
11460
|
export interface JsonApiOrganizationSettingOutDocument {
|
|
11385
11461
|
'data': JsonApiOrganizationSettingOut;
|
|
11386
11462
|
'links'?: ObjectLinks;
|
|
@@ -11431,7 +11507,7 @@ export interface JsonApiOrganizationSettingPatchAttributes {
|
|
|
11431
11507
|
'content'?: object;
|
|
11432
11508
|
'type'?: JsonApiOrganizationSettingPatchAttributesTypeEnum;
|
|
11433
11509
|
}
|
|
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';
|
|
11510
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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' | 'AI_LAKE_CREDENTIAL_VENDING';
|
|
11435
11511
|
export interface JsonApiOrganizationSettingPatchDocument {
|
|
11436
11512
|
'data': JsonApiOrganizationSettingPatch;
|
|
11437
11513
|
}
|
|
@@ -11672,10 +11748,7 @@ export interface JsonApiPublisherDocumentIn {
|
|
|
11672
11748
|
export type JsonApiPublisherDocumentInTypeEnum = 'document';
|
|
11673
11749
|
export interface JsonApiPublisherDocumentInAttributes {
|
|
11674
11750
|
'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;
|
|
11751
|
+
'content': JsonApiPublisherDocumentInAttributesContent;
|
|
11679
11752
|
'description'?: string;
|
|
11680
11753
|
'period': JsonApiPublisherDocumentInAttributesPeriod;
|
|
11681
11754
|
'tags'?: Array<string>;
|
|
@@ -11685,6 +11758,34 @@ export interface JsonApiPublisherDocumentInAttributes {
|
|
|
11685
11758
|
*/
|
|
11686
11759
|
'version': string;
|
|
11687
11760
|
}
|
|
11761
|
+
/**
|
|
11762
|
+
* 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.
|
|
11763
|
+
*/
|
|
11764
|
+
export interface JsonApiPublisherDocumentInAttributesContent {
|
|
11765
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
11766
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
11767
|
+
/**
|
|
11768
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
11769
|
+
*/
|
|
11770
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
11771
|
+
/**
|
|
11772
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
11773
|
+
*/
|
|
11774
|
+
'formatLocale'?: string;
|
|
11775
|
+
/**
|
|
11776
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
11777
|
+
*/
|
|
11778
|
+
'locale'?: string;
|
|
11779
|
+
/**
|
|
11780
|
+
* The document\'s pages, when it has no sections.
|
|
11781
|
+
*/
|
|
11782
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
11783
|
+
/**
|
|
11784
|
+
* Groups of pages, when the document has no top-level pages.
|
|
11785
|
+
*/
|
|
11786
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
11787
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
11788
|
+
}
|
|
11688
11789
|
/**
|
|
11689
11790
|
* @type JsonApiPublisherDocumentInAttributesPeriod
|
|
11690
11791
|
* The period the document covers, absolute or relative to today.
|
|
@@ -11716,10 +11817,7 @@ export interface JsonApiPublisherDocumentOut {
|
|
|
11716
11817
|
export type JsonApiPublisherDocumentOutTypeEnum = 'document';
|
|
11717
11818
|
export interface JsonApiPublisherDocumentOutAttributes {
|
|
11718
11819
|
'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;
|
|
11820
|
+
'content': JsonApiPublisherDocumentOutAttributesContent;
|
|
11723
11821
|
/**
|
|
11724
11822
|
* Time of the entity creation.
|
|
11725
11823
|
*/
|
|
@@ -11737,6 +11835,34 @@ export interface JsonApiPublisherDocumentOutAttributes {
|
|
|
11737
11835
|
*/
|
|
11738
11836
|
'version': string;
|
|
11739
11837
|
}
|
|
11838
|
+
/**
|
|
11839
|
+
* 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.
|
|
11840
|
+
*/
|
|
11841
|
+
export interface JsonApiPublisherDocumentOutAttributesContent {
|
|
11842
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
11843
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
11844
|
+
/**
|
|
11845
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
11846
|
+
*/
|
|
11847
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
11848
|
+
/**
|
|
11849
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
11850
|
+
*/
|
|
11851
|
+
'formatLocale'?: string;
|
|
11852
|
+
/**
|
|
11853
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
11854
|
+
*/
|
|
11855
|
+
'locale'?: string;
|
|
11856
|
+
/**
|
|
11857
|
+
* The document\'s pages, when it has no sections.
|
|
11858
|
+
*/
|
|
11859
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
11860
|
+
/**
|
|
11861
|
+
* Groups of pages, when the document has no top-level pages.
|
|
11862
|
+
*/
|
|
11863
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
11864
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
11865
|
+
}
|
|
11740
11866
|
/**
|
|
11741
11867
|
* @type JsonApiPublisherDocumentOutAttributesPeriod
|
|
11742
11868
|
* The period the document covers, absolute or relative to today.
|
|
@@ -11868,10 +11994,7 @@ export interface JsonApiPublisherDocumentPageTemplateIn {
|
|
|
11868
11994
|
export type JsonApiPublisherDocumentPageTemplateInTypeEnum = 'pageTemplate';
|
|
11869
11995
|
export interface JsonApiPublisherDocumentPageTemplateInAttributes {
|
|
11870
11996
|
'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;
|
|
11997
|
+
'content': JsonApiPublisherDocumentPageTemplateInAttributesContent;
|
|
11875
11998
|
'description'?: string;
|
|
11876
11999
|
'tags'?: Array<string>;
|
|
11877
12000
|
'title': string;
|
|
@@ -11880,6 +12003,28 @@ export interface JsonApiPublisherDocumentPageTemplateInAttributes {
|
|
|
11880
12003
|
*/
|
|
11881
12004
|
'version': string;
|
|
11882
12005
|
}
|
|
12006
|
+
/**
|
|
12007
|
+
* 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.
|
|
12008
|
+
*/
|
|
12009
|
+
export interface JsonApiPublisherDocumentPageTemplateInAttributesContent {
|
|
12010
|
+
/**
|
|
12011
|
+
* Page filters; stored, not applied.
|
|
12012
|
+
*/
|
|
12013
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12014
|
+
/**
|
|
12015
|
+
* Editor hint.
|
|
12016
|
+
*/
|
|
12017
|
+
'kind'?: JsonApiPublisherDocumentPageTemplateInAttributesContentKindEnum;
|
|
12018
|
+
'layout': PublisherDocumentLayoutNode;
|
|
12019
|
+
/**
|
|
12020
|
+
* Speaker notes in markdown, never drawn.
|
|
12021
|
+
*/
|
|
12022
|
+
'notes'?: string;
|
|
12023
|
+
'pageSize'?: JsonApiPublisherDocumentPageTemplateInAttributesContentPageSizeEnum;
|
|
12024
|
+
'style'?: PublisherDocumentPageStyle;
|
|
12025
|
+
}
|
|
12026
|
+
export type JsonApiPublisherDocumentPageTemplateInAttributesContentKindEnum = 'cover' | 'section' | 'content';
|
|
12027
|
+
export type JsonApiPublisherDocumentPageTemplateInAttributesContentPageSizeEnum = 'widescreen';
|
|
11883
12028
|
export interface JsonApiPublisherDocumentPageTemplateInDocument {
|
|
11884
12029
|
'data': JsonApiPublisherDocumentPageTemplateIn;
|
|
11885
12030
|
}
|
|
@@ -11902,15 +12047,16 @@ export interface JsonApiPublisherDocumentPageTemplateOut {
|
|
|
11902
12047
|
export type JsonApiPublisherDocumentPageTemplateOutTypeEnum = 'pageTemplate';
|
|
11903
12048
|
export interface JsonApiPublisherDocumentPageTemplateOutAttributes {
|
|
11904
12049
|
'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;
|
|
12050
|
+
'content': JsonApiPublisherDocumentPageTemplateOutAttributesContent;
|
|
11909
12051
|
/**
|
|
11910
12052
|
* Time of the entity creation.
|
|
11911
12053
|
*/
|
|
11912
12054
|
'createdAt'?: string | null;
|
|
11913
12055
|
'description'?: string;
|
|
12056
|
+
/**
|
|
12057
|
+
* Whether the backend ships this page template as a read-only default.
|
|
12058
|
+
*/
|
|
12059
|
+
'isDefault': boolean;
|
|
11914
12060
|
/**
|
|
11915
12061
|
* Time of the last entity modification.
|
|
11916
12062
|
*/
|
|
@@ -11922,6 +12068,28 @@ export interface JsonApiPublisherDocumentPageTemplateOutAttributes {
|
|
|
11922
12068
|
*/
|
|
11923
12069
|
'version': string;
|
|
11924
12070
|
}
|
|
12071
|
+
/**
|
|
12072
|
+
* 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.
|
|
12073
|
+
*/
|
|
12074
|
+
export interface JsonApiPublisherDocumentPageTemplateOutAttributesContent {
|
|
12075
|
+
/**
|
|
12076
|
+
* Page filters; stored, not applied.
|
|
12077
|
+
*/
|
|
12078
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12079
|
+
/**
|
|
12080
|
+
* Editor hint.
|
|
12081
|
+
*/
|
|
12082
|
+
'kind'?: JsonApiPublisherDocumentPageTemplateOutAttributesContentKindEnum;
|
|
12083
|
+
'layout': PublisherDocumentLayoutNode;
|
|
12084
|
+
/**
|
|
12085
|
+
* Speaker notes in markdown, never drawn.
|
|
12086
|
+
*/
|
|
12087
|
+
'notes'?: string;
|
|
12088
|
+
'pageSize'?: JsonApiPublisherDocumentPageTemplateOutAttributesContentPageSizeEnum;
|
|
12089
|
+
'style'?: PublisherDocumentPageStyle;
|
|
12090
|
+
}
|
|
12091
|
+
export type JsonApiPublisherDocumentPageTemplateOutAttributesContentKindEnum = 'cover' | 'section' | 'content';
|
|
12092
|
+
export type JsonApiPublisherDocumentPageTemplateOutAttributesContentPageSizeEnum = 'widescreen';
|
|
11925
12093
|
export interface JsonApiPublisherDocumentPageTemplateOutDocument {
|
|
11926
12094
|
'data': JsonApiPublisherDocumentPageTemplateOut;
|
|
11927
12095
|
/**
|
|
@@ -12012,10 +12180,7 @@ export interface JsonApiPublisherDocumentPageTemplatePatch {
|
|
|
12012
12180
|
export type JsonApiPublisherDocumentPageTemplatePatchTypeEnum = 'pageTemplate';
|
|
12013
12181
|
export interface JsonApiPublisherDocumentPageTemplatePatchAttributes {
|
|
12014
12182
|
'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;
|
|
12183
|
+
'content'?: JsonApiPublisherDocumentPageTemplatePatchAttributesContent;
|
|
12019
12184
|
'description'?: string;
|
|
12020
12185
|
'tags'?: Array<string>;
|
|
12021
12186
|
'title'?: string;
|
|
@@ -12024,6 +12189,28 @@ export interface JsonApiPublisherDocumentPageTemplatePatchAttributes {
|
|
|
12024
12189
|
*/
|
|
12025
12190
|
'version'?: string;
|
|
12026
12191
|
}
|
|
12192
|
+
/**
|
|
12193
|
+
* 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.
|
|
12194
|
+
*/
|
|
12195
|
+
export interface JsonApiPublisherDocumentPageTemplatePatchAttributesContent {
|
|
12196
|
+
/**
|
|
12197
|
+
* Page filters; stored, not applied.
|
|
12198
|
+
*/
|
|
12199
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12200
|
+
/**
|
|
12201
|
+
* Editor hint.
|
|
12202
|
+
*/
|
|
12203
|
+
'kind'?: JsonApiPublisherDocumentPageTemplatePatchAttributesContentKindEnum;
|
|
12204
|
+
'layout': PublisherDocumentLayoutNode;
|
|
12205
|
+
/**
|
|
12206
|
+
* Speaker notes in markdown, never drawn.
|
|
12207
|
+
*/
|
|
12208
|
+
'notes'?: string;
|
|
12209
|
+
'pageSize'?: JsonApiPublisherDocumentPageTemplatePatchAttributesContentPageSizeEnum;
|
|
12210
|
+
'style'?: PublisherDocumentPageStyle;
|
|
12211
|
+
}
|
|
12212
|
+
export type JsonApiPublisherDocumentPageTemplatePatchAttributesContentKindEnum = 'cover' | 'section' | 'content';
|
|
12213
|
+
export type JsonApiPublisherDocumentPageTemplatePatchAttributesContentPageSizeEnum = 'widescreen';
|
|
12027
12214
|
export interface JsonApiPublisherDocumentPageTemplatePatchDocument {
|
|
12028
12215
|
'data': JsonApiPublisherDocumentPageTemplatePatch;
|
|
12029
12216
|
}
|
|
@@ -12044,10 +12231,7 @@ export interface JsonApiPublisherDocumentPageTemplatePostOptionalId {
|
|
|
12044
12231
|
export type JsonApiPublisherDocumentPageTemplatePostOptionalIdTypeEnum = 'pageTemplate';
|
|
12045
12232
|
export interface JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributes {
|
|
12046
12233
|
'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;
|
|
12234
|
+
'content': JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContent;
|
|
12051
12235
|
'description'?: string;
|
|
12052
12236
|
'tags'?: Array<string>;
|
|
12053
12237
|
'title': string;
|
|
@@ -12056,6 +12240,28 @@ export interface JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributes {
|
|
|
12056
12240
|
*/
|
|
12057
12241
|
'version': string;
|
|
12058
12242
|
}
|
|
12243
|
+
/**
|
|
12244
|
+
* 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.
|
|
12245
|
+
*/
|
|
12246
|
+
export interface JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContent {
|
|
12247
|
+
/**
|
|
12248
|
+
* Page filters; stored, not applied.
|
|
12249
|
+
*/
|
|
12250
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12251
|
+
/**
|
|
12252
|
+
* Editor hint.
|
|
12253
|
+
*/
|
|
12254
|
+
'kind'?: JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContentKindEnum;
|
|
12255
|
+
'layout': PublisherDocumentLayoutNode;
|
|
12256
|
+
/**
|
|
12257
|
+
* Speaker notes in markdown, never drawn.
|
|
12258
|
+
*/
|
|
12259
|
+
'notes'?: string;
|
|
12260
|
+
'pageSize'?: JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContentPageSizeEnum;
|
|
12261
|
+
'style'?: PublisherDocumentPageStyle;
|
|
12262
|
+
}
|
|
12263
|
+
export type JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContentKindEnum = 'cover' | 'section' | 'content';
|
|
12264
|
+
export type JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributesContentPageSizeEnum = 'widescreen';
|
|
12059
12265
|
export interface JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument {
|
|
12060
12266
|
'data': JsonApiPublisherDocumentPageTemplatePostOptionalId;
|
|
12061
12267
|
}
|
|
@@ -12076,10 +12282,7 @@ export interface JsonApiPublisherDocumentPatch {
|
|
|
12076
12282
|
export type JsonApiPublisherDocumentPatchTypeEnum = 'document';
|
|
12077
12283
|
export interface JsonApiPublisherDocumentPatchAttributes {
|
|
12078
12284
|
'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;
|
|
12285
|
+
'content'?: JsonApiPublisherDocumentPatchAttributesContent;
|
|
12083
12286
|
'description'?: string;
|
|
12084
12287
|
'period'?: JsonApiPublisherDocumentPatchAttributesPeriod;
|
|
12085
12288
|
'tags'?: Array<string>;
|
|
@@ -12089,6 +12292,34 @@ export interface JsonApiPublisherDocumentPatchAttributes {
|
|
|
12089
12292
|
*/
|
|
12090
12293
|
'version'?: string;
|
|
12091
12294
|
}
|
|
12295
|
+
/**
|
|
12296
|
+
* 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.
|
|
12297
|
+
*/
|
|
12298
|
+
export interface JsonApiPublisherDocumentPatchAttributesContent {
|
|
12299
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12300
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12301
|
+
/**
|
|
12302
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12303
|
+
*/
|
|
12304
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12305
|
+
/**
|
|
12306
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12307
|
+
*/
|
|
12308
|
+
'formatLocale'?: string;
|
|
12309
|
+
/**
|
|
12310
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12311
|
+
*/
|
|
12312
|
+
'locale'?: string;
|
|
12313
|
+
/**
|
|
12314
|
+
* The document\'s pages, when it has no sections.
|
|
12315
|
+
*/
|
|
12316
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12317
|
+
/**
|
|
12318
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12319
|
+
*/
|
|
12320
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12321
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12322
|
+
}
|
|
12092
12323
|
/**
|
|
12093
12324
|
* @type JsonApiPublisherDocumentPatchAttributesPeriod
|
|
12094
12325
|
* The period the document covers, absolute or relative to today.
|
|
@@ -12118,10 +12349,7 @@ export interface JsonApiPublisherDocumentPostOptionalId {
|
|
|
12118
12349
|
export type JsonApiPublisherDocumentPostOptionalIdTypeEnum = 'document';
|
|
12119
12350
|
export interface JsonApiPublisherDocumentPostOptionalIdAttributes {
|
|
12120
12351
|
'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;
|
|
12352
|
+
'content': JsonApiPublisherDocumentPostOptionalIdAttributesContent;
|
|
12125
12353
|
'description'?: string;
|
|
12126
12354
|
'period': JsonApiPublisherDocumentPostOptionalIdAttributesPeriod;
|
|
12127
12355
|
'tags'?: Array<string>;
|
|
@@ -12131,6 +12359,34 @@ export interface JsonApiPublisherDocumentPostOptionalIdAttributes {
|
|
|
12131
12359
|
*/
|
|
12132
12360
|
'version': string;
|
|
12133
12361
|
}
|
|
12362
|
+
/**
|
|
12363
|
+
* 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.
|
|
12364
|
+
*/
|
|
12365
|
+
export interface JsonApiPublisherDocumentPostOptionalIdAttributesContent {
|
|
12366
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12367
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12368
|
+
/**
|
|
12369
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12370
|
+
*/
|
|
12371
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12372
|
+
/**
|
|
12373
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12374
|
+
*/
|
|
12375
|
+
'formatLocale'?: string;
|
|
12376
|
+
/**
|
|
12377
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12378
|
+
*/
|
|
12379
|
+
'locale'?: string;
|
|
12380
|
+
/**
|
|
12381
|
+
* The document\'s pages, when it has no sections.
|
|
12382
|
+
*/
|
|
12383
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12384
|
+
/**
|
|
12385
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12386
|
+
*/
|
|
12387
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12388
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12389
|
+
}
|
|
12134
12390
|
/**
|
|
12135
12391
|
* @type JsonApiPublisherDocumentPostOptionalIdAttributesPeriod
|
|
12136
12392
|
* The period the document covers, absolute or relative to today.
|
|
@@ -12160,10 +12416,7 @@ export interface JsonApiPublisherDocumentTemplateIn {
|
|
|
12160
12416
|
export type JsonApiPublisherDocumentTemplateInTypeEnum = 'documentTemplate';
|
|
12161
12417
|
export interface JsonApiPublisherDocumentTemplateInAttributes {
|
|
12162
12418
|
'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;
|
|
12419
|
+
'content': JsonApiPublisherDocumentTemplateInAttributesContent;
|
|
12167
12420
|
'description'?: string;
|
|
12168
12421
|
'tags'?: Array<string>;
|
|
12169
12422
|
'title': string;
|
|
@@ -12172,6 +12425,34 @@ export interface JsonApiPublisherDocumentTemplateInAttributes {
|
|
|
12172
12425
|
*/
|
|
12173
12426
|
'version': string;
|
|
12174
12427
|
}
|
|
12428
|
+
/**
|
|
12429
|
+
* 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.
|
|
12430
|
+
*/
|
|
12431
|
+
export interface JsonApiPublisherDocumentTemplateInAttributesContent {
|
|
12432
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12433
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12434
|
+
/**
|
|
12435
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12436
|
+
*/
|
|
12437
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12438
|
+
/**
|
|
12439
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12440
|
+
*/
|
|
12441
|
+
'formatLocale'?: string;
|
|
12442
|
+
/**
|
|
12443
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12444
|
+
*/
|
|
12445
|
+
'locale'?: string;
|
|
12446
|
+
/**
|
|
12447
|
+
* The document\'s pages, when it has no sections.
|
|
12448
|
+
*/
|
|
12449
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12450
|
+
/**
|
|
12451
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12452
|
+
*/
|
|
12453
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12454
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12455
|
+
}
|
|
12175
12456
|
export interface JsonApiPublisherDocumentTemplateInDocument {
|
|
12176
12457
|
'data': JsonApiPublisherDocumentTemplateIn;
|
|
12177
12458
|
}
|
|
@@ -12194,10 +12475,7 @@ export interface JsonApiPublisherDocumentTemplateOut {
|
|
|
12194
12475
|
export type JsonApiPublisherDocumentTemplateOutTypeEnum = 'documentTemplate';
|
|
12195
12476
|
export interface JsonApiPublisherDocumentTemplateOutAttributes {
|
|
12196
12477
|
'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;
|
|
12478
|
+
'content': JsonApiPublisherDocumentTemplateOutAttributesContent;
|
|
12201
12479
|
/**
|
|
12202
12480
|
* Time of the entity creation.
|
|
12203
12481
|
*/
|
|
@@ -12214,6 +12492,34 @@ export interface JsonApiPublisherDocumentTemplateOutAttributes {
|
|
|
12214
12492
|
*/
|
|
12215
12493
|
'version': string;
|
|
12216
12494
|
}
|
|
12495
|
+
/**
|
|
12496
|
+
* 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.
|
|
12497
|
+
*/
|
|
12498
|
+
export interface JsonApiPublisherDocumentTemplateOutAttributesContent {
|
|
12499
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12500
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12501
|
+
/**
|
|
12502
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12503
|
+
*/
|
|
12504
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12505
|
+
/**
|
|
12506
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12507
|
+
*/
|
|
12508
|
+
'formatLocale'?: string;
|
|
12509
|
+
/**
|
|
12510
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12511
|
+
*/
|
|
12512
|
+
'locale'?: string;
|
|
12513
|
+
/**
|
|
12514
|
+
* The document\'s pages, when it has no sections.
|
|
12515
|
+
*/
|
|
12516
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12517
|
+
/**
|
|
12518
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12519
|
+
*/
|
|
12520
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12521
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12522
|
+
}
|
|
12217
12523
|
export interface JsonApiPublisherDocumentTemplateOutDocument {
|
|
12218
12524
|
'data': JsonApiPublisherDocumentTemplateOut;
|
|
12219
12525
|
/**
|
|
@@ -12304,10 +12610,7 @@ export interface JsonApiPublisherDocumentTemplatePatch {
|
|
|
12304
12610
|
export type JsonApiPublisherDocumentTemplatePatchTypeEnum = 'documentTemplate';
|
|
12305
12611
|
export interface JsonApiPublisherDocumentTemplatePatchAttributes {
|
|
12306
12612
|
'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;
|
|
12613
|
+
'content'?: JsonApiPublisherDocumentTemplatePatchAttributesContent;
|
|
12311
12614
|
'description'?: string;
|
|
12312
12615
|
'tags'?: Array<string>;
|
|
12313
12616
|
'title'?: string;
|
|
@@ -12316,6 +12619,34 @@ export interface JsonApiPublisherDocumentTemplatePatchAttributes {
|
|
|
12316
12619
|
*/
|
|
12317
12620
|
'version'?: string;
|
|
12318
12621
|
}
|
|
12622
|
+
/**
|
|
12623
|
+
* 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.
|
|
12624
|
+
*/
|
|
12625
|
+
export interface JsonApiPublisherDocumentTemplatePatchAttributesContent {
|
|
12626
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12627
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12628
|
+
/**
|
|
12629
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12630
|
+
*/
|
|
12631
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12632
|
+
/**
|
|
12633
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12634
|
+
*/
|
|
12635
|
+
'formatLocale'?: string;
|
|
12636
|
+
/**
|
|
12637
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12638
|
+
*/
|
|
12639
|
+
'locale'?: string;
|
|
12640
|
+
/**
|
|
12641
|
+
* The document\'s pages, when it has no sections.
|
|
12642
|
+
*/
|
|
12643
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12644
|
+
/**
|
|
12645
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12646
|
+
*/
|
|
12647
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12648
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12649
|
+
}
|
|
12319
12650
|
export interface JsonApiPublisherDocumentTemplatePatchDocument {
|
|
12320
12651
|
'data': JsonApiPublisherDocumentTemplatePatch;
|
|
12321
12652
|
}
|
|
@@ -12336,10 +12667,7 @@ export interface JsonApiPublisherDocumentTemplatePostOptionalId {
|
|
|
12336
12667
|
export type JsonApiPublisherDocumentTemplatePostOptionalIdTypeEnum = 'documentTemplate';
|
|
12337
12668
|
export interface JsonApiPublisherDocumentTemplatePostOptionalIdAttributes {
|
|
12338
12669
|
'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;
|
|
12670
|
+
'content': JsonApiPublisherDocumentTemplatePostOptionalIdAttributesContent;
|
|
12343
12671
|
'description'?: string;
|
|
12344
12672
|
'tags'?: Array<string>;
|
|
12345
12673
|
'title': string;
|
|
@@ -12348,6 +12676,34 @@ export interface JsonApiPublisherDocumentTemplatePostOptionalIdAttributes {
|
|
|
12348
12676
|
*/
|
|
12349
12677
|
'version': string;
|
|
12350
12678
|
}
|
|
12679
|
+
/**
|
|
12680
|
+
* 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.
|
|
12681
|
+
*/
|
|
12682
|
+
export interface JsonApiPublisherDocumentTemplatePostOptionalIdAttributesContent {
|
|
12683
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
12684
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
12685
|
+
/**
|
|
12686
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
12687
|
+
*/
|
|
12688
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
12689
|
+
/**
|
|
12690
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
12691
|
+
*/
|
|
12692
|
+
'formatLocale'?: string;
|
|
12693
|
+
/**
|
|
12694
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
12695
|
+
*/
|
|
12696
|
+
'locale'?: string;
|
|
12697
|
+
/**
|
|
12698
|
+
* The document\'s pages, when it has no sections.
|
|
12699
|
+
*/
|
|
12700
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
12701
|
+
/**
|
|
12702
|
+
* Groups of pages, when the document has no top-level pages.
|
|
12703
|
+
*/
|
|
12704
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
12705
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
12706
|
+
}
|
|
12351
12707
|
export interface JsonApiPublisherDocumentTemplatePostOptionalIdDocument {
|
|
12352
12708
|
'data': JsonApiPublisherDocumentTemplatePostOptionalId;
|
|
12353
12709
|
}
|
|
@@ -13724,7 +14080,7 @@ export interface JsonApiUserSettingInAttributes {
|
|
|
13724
14080
|
'content'?: object;
|
|
13725
14081
|
'type'?: JsonApiUserSettingInAttributesTypeEnum;
|
|
13726
14082
|
}
|
|
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';
|
|
14083
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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
14084
|
export interface JsonApiUserSettingInDocument {
|
|
13729
14085
|
'data': JsonApiUserSettingIn;
|
|
13730
14086
|
}
|
|
@@ -13750,7 +14106,7 @@ export interface JsonApiUserSettingOutAttributes {
|
|
|
13750
14106
|
'content'?: object;
|
|
13751
14107
|
'type'?: JsonApiUserSettingOutAttributesTypeEnum;
|
|
13752
14108
|
}
|
|
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';
|
|
14109
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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
14110
|
export interface JsonApiUserSettingOutDocument {
|
|
13755
14111
|
'data': JsonApiUserSettingOut;
|
|
13756
14112
|
'links'?: ObjectLinks;
|
|
@@ -15282,7 +15638,7 @@ export interface JsonApiWorkspaceSettingInAttributes {
|
|
|
15282
15638
|
'content'?: object;
|
|
15283
15639
|
'type'?: JsonApiWorkspaceSettingInAttributesTypeEnum;
|
|
15284
15640
|
}
|
|
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';
|
|
15641
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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
15642
|
export interface JsonApiWorkspaceSettingInDocument {
|
|
15287
15643
|
'data': JsonApiWorkspaceSettingIn;
|
|
15288
15644
|
}
|
|
@@ -15309,7 +15665,7 @@ export interface JsonApiWorkspaceSettingOutAttributes {
|
|
|
15309
15665
|
'content'?: object;
|
|
15310
15666
|
'type'?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
15311
15667
|
}
|
|
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';
|
|
15668
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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
15669
|
export interface JsonApiWorkspaceSettingOutDocument {
|
|
15314
15670
|
'data': JsonApiWorkspaceSettingOut;
|
|
15315
15671
|
'links'?: ObjectLinks;
|
|
@@ -15375,7 +15731,7 @@ export interface JsonApiWorkspaceSettingPatchAttributes {
|
|
|
15375
15731
|
'content'?: object;
|
|
15376
15732
|
'type'?: JsonApiWorkspaceSettingPatchAttributesTypeEnum;
|
|
15377
15733
|
}
|
|
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';
|
|
15734
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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
15735
|
export interface JsonApiWorkspaceSettingPatchDocument {
|
|
15380
15736
|
'data': JsonApiWorkspaceSettingPatch;
|
|
15381
15737
|
}
|
|
@@ -15401,7 +15757,7 @@ export interface JsonApiWorkspaceSettingPostOptionalIdAttributes {
|
|
|
15401
15757
|
'content'?: object;
|
|
15402
15758
|
'type'?: JsonApiWorkspaceSettingPostOptionalIdAttributesTypeEnum;
|
|
15403
15759
|
}
|
|
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';
|
|
15760
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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
15761
|
export interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
15406
15762
|
'data': JsonApiWorkspaceSettingPostOptionalId;
|
|
15407
15763
|
}
|
|
@@ -15645,11 +16001,59 @@ export interface LocalizationDefaults {
|
|
|
15645
16001
|
'LOCALE'?: LocalizationDefault | null;
|
|
15646
16002
|
'METADATA_LOCALE'?: LocalizationDefault | null;
|
|
15647
16003
|
}
|
|
16004
|
+
/**
|
|
16005
|
+
* One localization issue in one language.
|
|
16006
|
+
*/
|
|
16007
|
+
export interface LocalizationIssue {
|
|
16008
|
+
/**
|
|
16009
|
+
* The problem language.
|
|
16010
|
+
*/
|
|
16011
|
+
'locale': string;
|
|
16012
|
+
/**
|
|
16013
|
+
* The kind of localization issue. The prefix names the area of the problem. METADATA_MISSING_TRANSLATION - the metadata language has no translation under exactly its code. When the metadata language is the default, the display language is checked instead. METADATA_LANGUAGE_MISMATCH - the display language has a translation, but the metadata language is not set to it. METADATA_UNUSED_TRANSLATION - the workspace owns a translation that nobody uses. No workspace in its subtree gets that language. No user has it as their own language. System accounts and the bootstrap user are not counted, as in the usage endpoints. New types may be added.
|
|
16014
|
+
*/
|
|
16015
|
+
'type': LocalizationIssueTypeEnum;
|
|
16016
|
+
/**
|
|
16017
|
+
* Organization issues only. The number of workspaces with this issue.
|
|
16018
|
+
*/
|
|
16019
|
+
'workspaces'?: number;
|
|
16020
|
+
}
|
|
16021
|
+
export type LocalizationIssueTypeEnum = 'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION';
|
|
16022
|
+
export interface LocalizationIssueWorkspace {
|
|
16023
|
+
'bySetting': LocalizationResolvedValues;
|
|
16024
|
+
/**
|
|
16025
|
+
* Number of direct child workspaces.
|
|
16026
|
+
*/
|
|
16027
|
+
'childrenCount': number;
|
|
16028
|
+
'id': string;
|
|
16029
|
+
'name': string;
|
|
16030
|
+
/**
|
|
16031
|
+
* The parent workspace, or null for a root workspace.
|
|
16032
|
+
*/
|
|
16033
|
+
'parentId'?: string | null;
|
|
16034
|
+
}
|
|
16035
|
+
export interface LocalizationIssueWorkspaces {
|
|
16036
|
+
/**
|
|
16037
|
+
* The total number of workspaces with this issue that match the name filter.
|
|
16038
|
+
*/
|
|
16039
|
+
'totalCount': number;
|
|
16040
|
+
'workspaces': Array<LocalizationIssueWorkspace>;
|
|
16041
|
+
}
|
|
16042
|
+
export interface LocalizationIssues {
|
|
16043
|
+
/**
|
|
16044
|
+
* Sorted by type in the order of the enum, then by locale. Empty when nothing is wrong.
|
|
16045
|
+
*/
|
|
16046
|
+
'issues': Array<LocalizationIssue>;
|
|
16047
|
+
}
|
|
15648
16048
|
/**
|
|
15649
16049
|
* Translations of titles, descriptions, tags and free-form texts of workspace objects. `locales` lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty.
|
|
15650
16050
|
*/
|
|
15651
16051
|
export interface LocalizationMetadataStatistics {
|
|
15652
16052
|
'locales': Array<LocalizationStatisticsLocale>;
|
|
16053
|
+
/**
|
|
16054
|
+
* Translation counts of the workspace and each parent workspace, root first. Present only with `includeCoverage=true` on the workspace endpoint.
|
|
16055
|
+
*/
|
|
16056
|
+
'workspaces'?: Array<LocalizationStatisticsWorkspace>;
|
|
15653
16057
|
}
|
|
15654
16058
|
/**
|
|
15655
16059
|
* 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 +16111,44 @@ export interface LocalizationStatisticsLocale {
|
|
|
15707
16111
|
*/
|
|
15708
16112
|
'locale': string;
|
|
15709
16113
|
}
|
|
16114
|
+
/**
|
|
16115
|
+
* Translated texts of one workspace in one language.
|
|
16116
|
+
*/
|
|
16117
|
+
export interface LocalizationStatisticsTranslatedLocale {
|
|
16118
|
+
/**
|
|
16119
|
+
* Language tag.
|
|
16120
|
+
*/
|
|
16121
|
+
'locale': string;
|
|
16122
|
+
/**
|
|
16123
|
+
* Texts of the workspace with a translation. A title, description or tag edited after its translation still counts.
|
|
16124
|
+
*/
|
|
16125
|
+
'translated': number;
|
|
16126
|
+
}
|
|
16127
|
+
/**
|
|
16128
|
+
* 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.
|
|
16129
|
+
*/
|
|
16130
|
+
export interface LocalizationStatisticsWorkspace {
|
|
16131
|
+
/**
|
|
16132
|
+
* Workspace ID.
|
|
16133
|
+
*/
|
|
16134
|
+
'id': string;
|
|
16135
|
+
/**
|
|
16136
|
+
* Every language of `metadata.locales`, sorted, with 0 where nothing is translated.
|
|
16137
|
+
*/
|
|
16138
|
+
'locales': Array<LocalizationStatisticsTranslatedLocale>;
|
|
16139
|
+
/**
|
|
16140
|
+
* Workspace name.
|
|
16141
|
+
*/
|
|
16142
|
+
'name': string;
|
|
16143
|
+
/**
|
|
16144
|
+
* Parent workspace ID, null for a root workspace.
|
|
16145
|
+
*/
|
|
16146
|
+
'parentId'?: string | null;
|
|
16147
|
+
/**
|
|
16148
|
+
* Titles, descriptions, tags and free-form texts the workspace owns. Blank texts are not counted.
|
|
16149
|
+
*/
|
|
16150
|
+
'total': number;
|
|
16151
|
+
}
|
|
15710
16152
|
export interface LocalizationUsage {
|
|
15711
16153
|
'defaults': LocalizationDefaults;
|
|
15712
16154
|
'values': Array<LocalizationUsageValue>;
|
|
@@ -16317,6 +16759,838 @@ export interface ProfileLinks {
|
|
|
16317
16759
|
'self': string;
|
|
16318
16760
|
'user': string;
|
|
16319
16761
|
}
|
|
16762
|
+
/**
|
|
16763
|
+
* Filters an attribute display form by arbitrary values.
|
|
16764
|
+
*/
|
|
16765
|
+
export interface PublisherDocumentArbitraryAttributeFilter {
|
|
16766
|
+
'arbitraryAttributeFilter': PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter;
|
|
16767
|
+
}
|
|
16768
|
+
export interface PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter {
|
|
16769
|
+
'displayForm': PublisherDocumentObjRef;
|
|
16770
|
+
'filterElementsBy'?: Array<PublisherDocumentAttributeFilterParent>;
|
|
16771
|
+
'filterElementsByDate'?: Array<PublisherDocumentAttributeFilterByDate>;
|
|
16772
|
+
/**
|
|
16773
|
+
* 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.
|
|
16774
|
+
*/
|
|
16775
|
+
'localIdentifier'?: string;
|
|
16776
|
+
'negativeSelection': boolean;
|
|
16777
|
+
'title'?: string;
|
|
16778
|
+
'validateElementsBy'?: Array<PublisherDocumentObjRef>;
|
|
16779
|
+
/**
|
|
16780
|
+
* Values; `null` stands for an empty value.
|
|
16781
|
+
*/
|
|
16782
|
+
'values': Array<string | null>;
|
|
16783
|
+
}
|
|
16784
|
+
/**
|
|
16785
|
+
* Style of the area behind the pages. Lengths are in canvas px.
|
|
16786
|
+
*/
|
|
16787
|
+
export interface PublisherDocumentAreaStyle {
|
|
16788
|
+
'backgroundColor'?: string;
|
|
16789
|
+
'backgroundFit'?: PublisherDocumentAreaStyleBackgroundFitEnum;
|
|
16790
|
+
'backgroundHorizontalAlign'?: PublisherDocumentAreaStyleBackgroundHorizontalAlignEnum;
|
|
16791
|
+
'backgroundImage'?: string;
|
|
16792
|
+
'backgroundImageOpacity'?: number;
|
|
16793
|
+
'backgroundOffset'?: number;
|
|
16794
|
+
'backgroundOffsetBottom'?: number;
|
|
16795
|
+
'backgroundOffsetLeft'?: number;
|
|
16796
|
+
'backgroundOffsetRight'?: number;
|
|
16797
|
+
'backgroundOffsetTop'?: number;
|
|
16798
|
+
'backgroundOpacity'?: number;
|
|
16799
|
+
'backgroundVerticalAlign'?: PublisherDocumentAreaStyleBackgroundVerticalAlignEnum;
|
|
16800
|
+
'gap'?: PublisherDocumentAreaStyleGap;
|
|
16801
|
+
}
|
|
16802
|
+
export type PublisherDocumentAreaStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
16803
|
+
export type PublisherDocumentAreaStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
16804
|
+
export type PublisherDocumentAreaStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
16805
|
+
/**
|
|
16806
|
+
* @type PublisherDocumentAreaStyleGap
|
|
16807
|
+
* A length, or `{theme.spacing.gap.<compact|normal|spacious>}`.
|
|
16808
|
+
*/
|
|
16809
|
+
export type PublisherDocumentAreaStyleGap = number | string;
|
|
16810
|
+
/**
|
|
16811
|
+
* @type PublisherDocumentAttributeElements
|
|
16812
|
+
* Selected attribute elements: `{\"values\": [...]}` or `{\"uris\": [...]}`.
|
|
16813
|
+
*/
|
|
16814
|
+
export type PublisherDocumentAttributeElements = PublisherDocumentAttributeElementsByUri | PublisherDocumentAttributeElementsByValue;
|
|
16815
|
+
export interface PublisherDocumentAttributeElementsByUri {
|
|
16816
|
+
/**
|
|
16817
|
+
* Element URIs; `null` stands for an empty value.
|
|
16818
|
+
*/
|
|
16819
|
+
'uris': Array<string>;
|
|
16820
|
+
}
|
|
16821
|
+
export interface PublisherDocumentAttributeElementsByValue {
|
|
16822
|
+
/**
|
|
16823
|
+
* Element values; `null` stands for an empty value.
|
|
16824
|
+
*/
|
|
16825
|
+
'values': Array<string | null>;
|
|
16826
|
+
}
|
|
16827
|
+
/**
|
|
16828
|
+
* Filters an attribute display form by a list of elements.
|
|
16829
|
+
*/
|
|
16830
|
+
export interface PublisherDocumentAttributeFilter {
|
|
16831
|
+
'attributeFilter': PublisherDocumentAttributeFilterAttributeFilter;
|
|
16832
|
+
}
|
|
16833
|
+
export interface PublisherDocumentAttributeFilterAttributeFilter {
|
|
16834
|
+
'attributeElements': PublisherDocumentAttributeElements;
|
|
16835
|
+
'displayForm': PublisherDocumentObjRef;
|
|
16836
|
+
/**
|
|
16837
|
+
* Parent filters that limit the offered elements.
|
|
16838
|
+
*/
|
|
16839
|
+
'filterElementsBy'?: Array<PublisherDocumentAttributeFilterParent>;
|
|
16840
|
+
/**
|
|
16841
|
+
* Date filters that limit the offered elements.
|
|
16842
|
+
*/
|
|
16843
|
+
'filterElementsByDate'?: Array<PublisherDocumentAttributeFilterByDate>;
|
|
16844
|
+
/**
|
|
16845
|
+
* 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.
|
|
16846
|
+
*/
|
|
16847
|
+
'localIdentifier'?: string;
|
|
16848
|
+
'negativeSelection': boolean;
|
|
16849
|
+
'selectionMode'?: PublisherDocumentAttributeFilterAttributeFilterSelectionModeEnum;
|
|
16850
|
+
'title'?: string;
|
|
16851
|
+
'validateElementsBy'?: Array<PublisherDocumentObjRef>;
|
|
16852
|
+
}
|
|
16853
|
+
export type PublisherDocumentAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
|
|
16854
|
+
/**
|
|
16855
|
+
* A date filter that limits the offered elements.
|
|
16856
|
+
*/
|
|
16857
|
+
export interface PublisherDocumentAttributeFilterByDate {
|
|
16858
|
+
'dataSet'?: PublisherDocumentObjRef;
|
|
16859
|
+
'filterLocalIdentifier': string;
|
|
16860
|
+
'isCommonDate': boolean;
|
|
16861
|
+
}
|
|
16862
|
+
/**
|
|
16863
|
+
* How a document attribute filter is shown, as in dashboards.
|
|
16864
|
+
*/
|
|
16865
|
+
export interface PublisherDocumentAttributeFilterConfig {
|
|
16866
|
+
'displayAsLabel'?: PublisherDocumentObjRef;
|
|
16867
|
+
'localIdentifier': string;
|
|
16868
|
+
'mode'?: PublisherDocumentAttributeFilterConfigModeEnum;
|
|
16869
|
+
'selectionType'?: PublisherDocumentAttributeFilterConfigSelectionTypeEnum;
|
|
16870
|
+
}
|
|
16871
|
+
export type PublisherDocumentAttributeFilterConfigModeEnum = 'readonly' | 'hidden' | 'active';
|
|
16872
|
+
export type PublisherDocumentAttributeFilterConfigSelectionTypeEnum = 'list' | 'text' | 'listOrText';
|
|
16873
|
+
/**
|
|
16874
|
+
* A parent attribute filter that limits the offered elements.
|
|
16875
|
+
*/
|
|
16876
|
+
export interface PublisherDocumentAttributeFilterParent {
|
|
16877
|
+
'filterLocalIdentifier': string;
|
|
16878
|
+
'over': PublisherDocumentAttributeFilterParentOver;
|
|
16879
|
+
}
|
|
16880
|
+
/**
|
|
16881
|
+
* Attributes that connect the parent and the child filter in the data model.
|
|
16882
|
+
*/
|
|
16883
|
+
export interface PublisherDocumentAttributeFilterParentOver {
|
|
16884
|
+
'attributes': Array<PublisherDocumentObjRef>;
|
|
16885
|
+
}
|
|
16886
|
+
export interface PublisherDocumentAttributeFilterReference {
|
|
16887
|
+
'displayForm': PublisherDocumentObjRef;
|
|
16888
|
+
'type': PublisherDocumentAttributeFilterReferenceTypeEnum;
|
|
16889
|
+
}
|
|
16890
|
+
export type PublisherDocumentAttributeFilterReferenceTypeEnum = 'attributeFilterReference';
|
|
16891
|
+
export interface PublisherDocumentAutoVisibility {
|
|
16892
|
+
'visible'?: PublisherDocumentAutoVisibilityVisible;
|
|
16893
|
+
}
|
|
16894
|
+
/**
|
|
16895
|
+
* @type PublisherDocumentAutoVisibilityVisible
|
|
16896
|
+
* `true`, `false` or `\"auto\"`.
|
|
16897
|
+
*/
|
|
16898
|
+
export type PublisherDocumentAutoVisibilityVisible = boolean | string;
|
|
16899
|
+
export interface PublisherDocumentAxisDisplay {
|
|
16900
|
+
'max'?: number;
|
|
16901
|
+
'min'?: number;
|
|
16902
|
+
'name'?: PublisherDocumentAxisNameDisplay;
|
|
16903
|
+
'values'?: PublisherDocumentAxisValuesDisplay;
|
|
16904
|
+
'visible'?: boolean;
|
|
16905
|
+
}
|
|
16906
|
+
export interface PublisherDocumentAxisNameDisplay {
|
|
16907
|
+
'position'?: PublisherDocumentAxisNameDisplayPositionEnum;
|
|
16908
|
+
'visible'?: boolean;
|
|
16909
|
+
}
|
|
16910
|
+
export type PublisherDocumentAxisNameDisplayPositionEnum = 'low' | 'middle' | 'high';
|
|
16911
|
+
export interface PublisherDocumentAxisValuesDisplay {
|
|
16912
|
+
/**
|
|
16913
|
+
* Label rotation in degrees, from -90 to 90.
|
|
16914
|
+
*/
|
|
16915
|
+
'rotation'?: number;
|
|
16916
|
+
'visible'?: boolean;
|
|
16917
|
+
}
|
|
16918
|
+
/**
|
|
16919
|
+
* One open end of a relative date filter: exactly one of `from` and `to`.
|
|
16920
|
+
*/
|
|
16921
|
+
export interface PublisherDocumentBoundedFilter {
|
|
16922
|
+
'from'?: number;
|
|
16923
|
+
'granularity': PublisherDocumentBoundedFilterGranularityEnum;
|
|
16924
|
+
'to'?: number;
|
|
16925
|
+
}
|
|
16926
|
+
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';
|
|
16927
|
+
/**
|
|
16928
|
+
* Chart style overrides; stored, not applied. Lengths are in canvas px.
|
|
16929
|
+
*/
|
|
16930
|
+
export interface PublisherDocumentChartStyle {
|
|
16931
|
+
'axisLineColor'?: string;
|
|
16932
|
+
'axisNameColor'?: string;
|
|
16933
|
+
'axisNameSize'?: number;
|
|
16934
|
+
'axisValueColor'?: string;
|
|
16935
|
+
'axisValueSize'?: number;
|
|
16936
|
+
'dataLabelColor'?: string;
|
|
16937
|
+
'dataLabelSize'?: number;
|
|
16938
|
+
'fontSize'?: number;
|
|
16939
|
+
'gridColor'?: string;
|
|
16940
|
+
'legendColor'?: string;
|
|
16941
|
+
'legendSize'?: number;
|
|
16942
|
+
'plotLineColor'?: string;
|
|
16943
|
+
'textColor'?: string;
|
|
16944
|
+
}
|
|
16945
|
+
/**
|
|
16946
|
+
* Lays its children out top to bottom.
|
|
16947
|
+
*/
|
|
16948
|
+
export interface PublisherDocumentColumn {
|
|
16949
|
+
/**
|
|
16950
|
+
* Child nodes from top to bottom, in reading order; an empty list is a spacer.
|
|
16951
|
+
*/
|
|
16952
|
+
'children': Array<PublisherDocumentLayoutNode>;
|
|
16953
|
+
'id'?: string;
|
|
16954
|
+
/**
|
|
16955
|
+
* Locks the container in the document editor; never checked on write.
|
|
16956
|
+
*/
|
|
16957
|
+
'locked'?: boolean;
|
|
16958
|
+
/**
|
|
16959
|
+
* Share of the parent\'s main axis, greater than 0. Default 1.
|
|
16960
|
+
*/
|
|
16961
|
+
'proportion'?: number;
|
|
16962
|
+
'style'?: PublisherDocumentContainerStyle;
|
|
16963
|
+
'type': PublisherDocumentColumnTypeEnum;
|
|
16964
|
+
}
|
|
16965
|
+
export type PublisherDocumentColumnTypeEnum = 'column';
|
|
16966
|
+
export interface PublisherDocumentComparisonCondition {
|
|
16967
|
+
'comparison': PublisherDocumentComparisonConditionComparison;
|
|
16968
|
+
}
|
|
16969
|
+
export interface PublisherDocumentComparisonConditionComparison {
|
|
16970
|
+
'operator': PublisherDocumentComparisonConditionComparisonOperatorEnum;
|
|
16971
|
+
'treatNullValuesAs'?: number;
|
|
16972
|
+
'value': number;
|
|
16973
|
+
}
|
|
16974
|
+
export type PublisherDocumentComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
16975
|
+
/**
|
|
16976
|
+
* Style of a row or column; its content inherits the text keys. Lengths are in canvas px.
|
|
16977
|
+
*/
|
|
16978
|
+
export interface PublisherDocumentContainerStyle {
|
|
16979
|
+
'backgroundColor'?: string;
|
|
16980
|
+
'backgroundFit'?: PublisherDocumentContainerStyleBackgroundFitEnum;
|
|
16981
|
+
'backgroundHorizontalAlign'?: PublisherDocumentContainerStyleBackgroundHorizontalAlignEnum;
|
|
16982
|
+
'backgroundImage'?: string;
|
|
16983
|
+
'backgroundImageOpacity'?: number;
|
|
16984
|
+
'backgroundOffset'?: number;
|
|
16985
|
+
'backgroundOffsetBottom'?: number;
|
|
16986
|
+
'backgroundOffsetLeft'?: number;
|
|
16987
|
+
'backgroundOffsetRight'?: number;
|
|
16988
|
+
'backgroundOffsetTop'?: number;
|
|
16989
|
+
'backgroundOpacity'?: number;
|
|
16990
|
+
'backgroundVerticalAlign'?: PublisherDocumentContainerStyleBackgroundVerticalAlignEnum;
|
|
16991
|
+
'borderBottomColor'?: string;
|
|
16992
|
+
'borderBottomLeftRadius'?: PublisherDocumentContainerStyleBorderBottomLeftRadius;
|
|
16993
|
+
'borderBottomRightRadius'?: PublisherDocumentContainerStyleBorderBottomRightRadius;
|
|
16994
|
+
'borderBottomStyle'?: PublisherDocumentContainerStyleBorderBottomStyleEnum;
|
|
16995
|
+
'borderBottomWidth'?: number;
|
|
16996
|
+
'borderColor'?: string;
|
|
16997
|
+
'borderLeftColor'?: string;
|
|
16998
|
+
'borderLeftStyle'?: PublisherDocumentContainerStyleBorderLeftStyleEnum;
|
|
16999
|
+
'borderLeftWidth'?: number;
|
|
17000
|
+
'borderRadius'?: PublisherDocumentContainerStyleBorderRadius;
|
|
17001
|
+
'borderRightColor'?: string;
|
|
17002
|
+
'borderRightStyle'?: PublisherDocumentContainerStyleBorderRightStyleEnum;
|
|
17003
|
+
'borderRightWidth'?: number;
|
|
17004
|
+
'borderStyle'?: PublisherDocumentContainerStyleBorderStyleEnum;
|
|
17005
|
+
'borderTopColor'?: string;
|
|
17006
|
+
'borderTopLeftRadius'?: PublisherDocumentContainerStyleBorderTopLeftRadius;
|
|
17007
|
+
'borderTopRightRadius'?: PublisherDocumentContainerStyleBorderTopRightRadius;
|
|
17008
|
+
'borderTopStyle'?: PublisherDocumentContainerStyleBorderTopStyleEnum;
|
|
17009
|
+
'borderTopWidth'?: number;
|
|
17010
|
+
'borderWidth'?: number;
|
|
17011
|
+
'fontSize'?: number;
|
|
17012
|
+
'fontStyle'?: PublisherDocumentContainerStyleFontStyleEnum;
|
|
17013
|
+
'fontWeight'?: number;
|
|
17014
|
+
'gap'?: PublisherDocumentContainerStyleGap;
|
|
17015
|
+
'horizontalAlign'?: PublisherDocumentContainerStyleHorizontalAlignEnum;
|
|
17016
|
+
'letterSpacing'?: number;
|
|
17017
|
+
'lineHeight'?: number;
|
|
17018
|
+
'opacity'?: number;
|
|
17019
|
+
'padding'?: PublisherDocumentContainerStylePadding;
|
|
17020
|
+
'paddingBottom'?: PublisherDocumentContainerStylePaddingBottom;
|
|
17021
|
+
'paddingLeft'?: PublisherDocumentContainerStylePaddingLeft;
|
|
17022
|
+
'paddingRight'?: PublisherDocumentContainerStylePaddingRight;
|
|
17023
|
+
'paddingTop'?: PublisherDocumentContainerStylePaddingTop;
|
|
17024
|
+
'shadow'?: string;
|
|
17025
|
+
'shadowBlur'?: number;
|
|
17026
|
+
'shadowColor'?: string;
|
|
17027
|
+
'shadowOpacity'?: number;
|
|
17028
|
+
'shadowSpread'?: number;
|
|
17029
|
+
'shadowX'?: number;
|
|
17030
|
+
'shadowY'?: number;
|
|
17031
|
+
'textColor'?: string;
|
|
17032
|
+
'textOverflow'?: PublisherDocumentContainerStyleTextOverflowEnum;
|
|
17033
|
+
'textStyle'?: PublisherDocumentContainerStyleTextStyleEnum;
|
|
17034
|
+
'textTransform'?: PublisherDocumentContainerStyleTextTransformEnum;
|
|
17035
|
+
'verticalAlign'?: PublisherDocumentContainerStyleVerticalAlignEnum;
|
|
17036
|
+
}
|
|
17037
|
+
export type PublisherDocumentContainerStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17038
|
+
export type PublisherDocumentContainerStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17039
|
+
export type PublisherDocumentContainerStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17040
|
+
export type PublisherDocumentContainerStyleBorderBottomStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17041
|
+
export type PublisherDocumentContainerStyleBorderLeftStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17042
|
+
export type PublisherDocumentContainerStyleBorderRightStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17043
|
+
export type PublisherDocumentContainerStyleBorderStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17044
|
+
export type PublisherDocumentContainerStyleBorderTopStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17045
|
+
export type PublisherDocumentContainerStyleFontStyleEnum = 'normal' | 'italic';
|
|
17046
|
+
export type PublisherDocumentContainerStyleHorizontalAlignEnum = 'left' | 'center' | 'right' | 'justify';
|
|
17047
|
+
export type PublisherDocumentContainerStyleTextOverflowEnum = 'shrink' | 'clip' | 'ellipsis';
|
|
17048
|
+
export type PublisherDocumentContainerStyleTextStyleEnum = 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText';
|
|
17049
|
+
export type PublisherDocumentContainerStyleTextTransformEnum = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
|
|
17050
|
+
export type PublisherDocumentContainerStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17051
|
+
/**
|
|
17052
|
+
* @type PublisherDocumentContainerStyleBorderBottomLeftRadius
|
|
17053
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17054
|
+
*/
|
|
17055
|
+
export type PublisherDocumentContainerStyleBorderBottomLeftRadius = number | string;
|
|
17056
|
+
/**
|
|
17057
|
+
* @type PublisherDocumentContainerStyleBorderBottomRightRadius
|
|
17058
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17059
|
+
*/
|
|
17060
|
+
export type PublisherDocumentContainerStyleBorderBottomRightRadius = number | string;
|
|
17061
|
+
/**
|
|
17062
|
+
* @type PublisherDocumentContainerStyleBorderRadius
|
|
17063
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17064
|
+
*/
|
|
17065
|
+
export type PublisherDocumentContainerStyleBorderRadius = number | string;
|
|
17066
|
+
/**
|
|
17067
|
+
* @type PublisherDocumentContainerStyleBorderTopLeftRadius
|
|
17068
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17069
|
+
*/
|
|
17070
|
+
export type PublisherDocumentContainerStyleBorderTopLeftRadius = number | string;
|
|
17071
|
+
/**
|
|
17072
|
+
* @type PublisherDocumentContainerStyleBorderTopRightRadius
|
|
17073
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17074
|
+
*/
|
|
17075
|
+
export type PublisherDocumentContainerStyleBorderTopRightRadius = number | string;
|
|
17076
|
+
/**
|
|
17077
|
+
* @type PublisherDocumentContainerStyleGap
|
|
17078
|
+
* A length, or `{theme.spacing.gap.<compact|normal|spacious>}`.
|
|
17079
|
+
*/
|
|
17080
|
+
export type PublisherDocumentContainerStyleGap = number | string;
|
|
17081
|
+
/**
|
|
17082
|
+
* @type PublisherDocumentContainerStylePadding
|
|
17083
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17084
|
+
*/
|
|
17085
|
+
export type PublisherDocumentContainerStylePadding = number | string;
|
|
17086
|
+
/**
|
|
17087
|
+
* @type PublisherDocumentContainerStylePaddingBottom
|
|
17088
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17089
|
+
*/
|
|
17090
|
+
export type PublisherDocumentContainerStylePaddingBottom = number | string;
|
|
17091
|
+
/**
|
|
17092
|
+
* @type PublisherDocumentContainerStylePaddingLeft
|
|
17093
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17094
|
+
*/
|
|
17095
|
+
export type PublisherDocumentContainerStylePaddingLeft = number | string;
|
|
17096
|
+
/**
|
|
17097
|
+
* @type PublisherDocumentContainerStylePaddingRight
|
|
17098
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17099
|
+
*/
|
|
17100
|
+
export type PublisherDocumentContainerStylePaddingRight = number | string;
|
|
17101
|
+
/**
|
|
17102
|
+
* @type PublisherDocumentContainerStylePaddingTop
|
|
17103
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17104
|
+
*/
|
|
17105
|
+
export type PublisherDocumentContainerStylePaddingTop = number | string;
|
|
17106
|
+
/**
|
|
17107
|
+
* Content of a document or a document template. Holds `pages` or `sections`, never both.
|
|
17108
|
+
*/
|
|
17109
|
+
export interface PublisherDocumentContent {
|
|
17110
|
+
'attributeFilterConfigs'?: Array<PublisherDocumentAttributeFilterConfig>;
|
|
17111
|
+
'defaults'?: PublisherDocumentDefaults;
|
|
17112
|
+
/**
|
|
17113
|
+
* Document filters, at most one per attribute display form or date dataset.
|
|
17114
|
+
*/
|
|
17115
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
17116
|
+
/**
|
|
17117
|
+
* Locale for formatting dates in variables, charts and tables.
|
|
17118
|
+
*/
|
|
17119
|
+
'formatLocale'?: string;
|
|
17120
|
+
/**
|
|
17121
|
+
* Locale of the text the product writes, such as `de-DE`.
|
|
17122
|
+
*/
|
|
17123
|
+
'locale'?: string;
|
|
17124
|
+
/**
|
|
17125
|
+
* The document\'s pages, when it has no sections.
|
|
17126
|
+
*/
|
|
17127
|
+
'pages'?: Array<PublisherDocumentPage>;
|
|
17128
|
+
/**
|
|
17129
|
+
* Groups of pages, when the document has no top-level pages.
|
|
17130
|
+
*/
|
|
17131
|
+
'sections'?: Array<PublisherDocumentSection>;
|
|
17132
|
+
'style'?: PublisherDocumentAreaStyle;
|
|
17133
|
+
}
|
|
17134
|
+
/**
|
|
17135
|
+
* A date dataset.
|
|
17136
|
+
*/
|
|
17137
|
+
export interface PublisherDocumentDataSetRef {
|
|
17138
|
+
'identifier': string;
|
|
17139
|
+
'type': PublisherDocumentDataSetRefTypeEnum;
|
|
17140
|
+
}
|
|
17141
|
+
export type PublisherDocumentDataSetRefTypeEnum = 'dataSet';
|
|
17142
|
+
/**
|
|
17143
|
+
* Filters a date dataset. A document filter always names its `dataSet`.
|
|
17144
|
+
*/
|
|
17145
|
+
export interface PublisherDocumentDateFilter {
|
|
17146
|
+
'dateFilter': PublisherDocumentDateFilterDateFilter;
|
|
17147
|
+
}
|
|
17148
|
+
export interface PublisherDocumentDateFilterDateFilter {
|
|
17149
|
+
'attribute'?: PublisherDocumentObjRef;
|
|
17150
|
+
'boundedFilter'?: PublisherDocumentBoundedFilter;
|
|
17151
|
+
'dataSet'?: PublisherDocumentObjRef;
|
|
17152
|
+
'emptyValueHandling'?: PublisherDocumentDateFilterDateFilterEmptyValueHandlingEnum;
|
|
17153
|
+
'from'?: PublisherDocumentDateFilterDateFilterFrom;
|
|
17154
|
+
'granularity': PublisherDocumentDateFilterDateFilterGranularityEnum;
|
|
17155
|
+
/**
|
|
17156
|
+
* 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.
|
|
17157
|
+
*/
|
|
17158
|
+
'localIdentifier'?: string;
|
|
17159
|
+
'to'?: PublisherDocumentDateFilterDateFilterTo;
|
|
17160
|
+
'type': PublisherDocumentDateFilterDateFilterTypeEnum;
|
|
17161
|
+
}
|
|
17162
|
+
export type PublisherDocumentDateFilterDateFilterEmptyValueHandlingEnum = 'include' | 'exclude' | 'only';
|
|
17163
|
+
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';
|
|
17164
|
+
export type PublisherDocumentDateFilterDateFilterTypeEnum = 'relative' | 'absolute';
|
|
17165
|
+
/**
|
|
17166
|
+
* @type PublisherDocumentDateFilterDateFilterFrom
|
|
17167
|
+
* A date, or an offset of a relative filter.
|
|
17168
|
+
*/
|
|
17169
|
+
export type PublisherDocumentDateFilterDateFilterFrom = number | string;
|
|
17170
|
+
/**
|
|
17171
|
+
* @type PublisherDocumentDateFilterDateFilterTo
|
|
17172
|
+
* A date, or an offset of a relative filter.
|
|
17173
|
+
*/
|
|
17174
|
+
export type PublisherDocumentDateFilterDateFilterTo = number | string;
|
|
17175
|
+
export interface PublisherDocumentDateFilterReference {
|
|
17176
|
+
'dataSet': PublisherDocumentObjRef;
|
|
17177
|
+
'type': PublisherDocumentDateFilterReferenceTypeEnum;
|
|
17178
|
+
}
|
|
17179
|
+
export type PublisherDocumentDateFilterReferenceTypeEnum = 'dateFilterReference';
|
|
17180
|
+
/**
|
|
17181
|
+
* Document-wide defaults.
|
|
17182
|
+
*/
|
|
17183
|
+
export interface PublisherDocumentDefaults {
|
|
17184
|
+
/**
|
|
17185
|
+
* Page size of a page that sets none.
|
|
17186
|
+
*/
|
|
17187
|
+
'pageSize'?: PublisherDocumentDefaultsPageSizeEnum;
|
|
17188
|
+
'period'?: PublisherDocumentPeriod;
|
|
17189
|
+
'takeaway'?: PublisherDocumentTakeawayDefaults;
|
|
17190
|
+
}
|
|
17191
|
+
export type PublisherDocumentDefaultsPageSizeEnum = 'widescreen';
|
|
17192
|
+
/**
|
|
17193
|
+
* @type PublisherDocumentFilter
|
|
17194
|
+
* A filter in the dashboard filter grammar, wrapped in an object keyed by its kind.
|
|
17195
|
+
*/
|
|
17196
|
+
export type PublisherDocumentFilter = PublisherDocumentArbitraryAttributeFilter | PublisherDocumentAttributeFilter | PublisherDocumentDateFilter | PublisherDocumentMatchAttributeFilter | PublisherDocumentMeasureValueFilter;
|
|
17197
|
+
/**
|
|
17198
|
+
* @type PublisherDocumentFilterReference
|
|
17199
|
+
* A reference to a document filter, selected by `type`.
|
|
17200
|
+
*/
|
|
17201
|
+
export type PublisherDocumentFilterReference = ({
|
|
17202
|
+
type: 'attributeFilterReference';
|
|
17203
|
+
} & PublisherDocumentAttributeFilterReference) | ({
|
|
17204
|
+
type: 'dateFilterReference';
|
|
17205
|
+
} & PublisherDocumentDateFilterReference) | ({
|
|
17206
|
+
type: 'measureValueFilterReference';
|
|
17207
|
+
} & PublisherDocumentMeasureValueFilterReference);
|
|
17208
|
+
/**
|
|
17209
|
+
* A heading below the page title.
|
|
17210
|
+
*/
|
|
17211
|
+
export interface PublisherDocumentHeadingWidget {
|
|
17212
|
+
/**
|
|
17213
|
+
* Unique within the page.
|
|
17214
|
+
*/
|
|
17215
|
+
'id': string;
|
|
17216
|
+
/**
|
|
17217
|
+
* Outline level below the page title. Default 1.
|
|
17218
|
+
*/
|
|
17219
|
+
'level'?: PublisherDocumentHeadingWidgetLevelEnum;
|
|
17220
|
+
/**
|
|
17221
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17222
|
+
*/
|
|
17223
|
+
'locked'?: boolean;
|
|
17224
|
+
/**
|
|
17225
|
+
* Inline markdown.
|
|
17226
|
+
*/
|
|
17227
|
+
'markdown'?: string;
|
|
17228
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17229
|
+
'proportion'?: number;
|
|
17230
|
+
'style'?: PublisherDocumentTextWidgetStyle;
|
|
17231
|
+
'type': PublisherDocumentHeadingWidgetTypeEnum;
|
|
17232
|
+
}
|
|
17233
|
+
export type PublisherDocumentHeadingWidgetLevelEnum = 1 | 2 | 3 | 4 | 5 | 6;
|
|
17234
|
+
export type PublisherDocumentHeadingWidgetTypeEnum = 'heading';
|
|
17235
|
+
/**
|
|
17236
|
+
* Headline style overrides; stored, not applied. Lengths are in canvas px.
|
|
17237
|
+
*/
|
|
17238
|
+
export interface PublisherDocumentHeadlineStyle {
|
|
17239
|
+
'negativeColor'?: string;
|
|
17240
|
+
'positiveColor'?: string;
|
|
17241
|
+
'primaryValueColor'?: string;
|
|
17242
|
+
'primaryValueSize'?: number;
|
|
17243
|
+
'secondaryValueColor'?: string;
|
|
17244
|
+
'secondaryValueSize'?: number;
|
|
17245
|
+
}
|
|
17246
|
+
/**
|
|
17247
|
+
* An image from the theme or an https URL.
|
|
17248
|
+
*/
|
|
17249
|
+
export interface PublisherDocumentImageWidget {
|
|
17250
|
+
'altText'?: string;
|
|
17251
|
+
/**
|
|
17252
|
+
* Left out of the accessibility tree, PDF tags and the AI context; needs no alt text.
|
|
17253
|
+
*/
|
|
17254
|
+
'decorative'?: boolean;
|
|
17255
|
+
/**
|
|
17256
|
+
* Unique within the page.
|
|
17257
|
+
*/
|
|
17258
|
+
'id': string;
|
|
17259
|
+
/**
|
|
17260
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17261
|
+
*/
|
|
17262
|
+
'locked'?: boolean;
|
|
17263
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17264
|
+
'proportion'?: number;
|
|
17265
|
+
/**
|
|
17266
|
+
* A theme image reference such as `{theme.logo}`, or an `https://` URL.
|
|
17267
|
+
*/
|
|
17268
|
+
'source'?: string;
|
|
17269
|
+
'style'?: PublisherDocumentImageWidgetStyle;
|
|
17270
|
+
'type': PublisherDocumentImageWidgetTypeEnum;
|
|
17271
|
+
}
|
|
17272
|
+
export type PublisherDocumentImageWidgetTypeEnum = 'image';
|
|
17273
|
+
/**
|
|
17274
|
+
* Style of an image widget. Lengths are in canvas px.
|
|
17275
|
+
*/
|
|
17276
|
+
export interface PublisherDocumentImageWidgetStyle {
|
|
17277
|
+
'backgroundColor'?: string;
|
|
17278
|
+
'backgroundFit'?: PublisherDocumentImageWidgetStyleBackgroundFitEnum;
|
|
17279
|
+
'backgroundHorizontalAlign'?: PublisherDocumentImageWidgetStyleBackgroundHorizontalAlignEnum;
|
|
17280
|
+
'backgroundImage'?: string;
|
|
17281
|
+
'backgroundImageOpacity'?: number;
|
|
17282
|
+
'backgroundOffset'?: number;
|
|
17283
|
+
'backgroundOffsetBottom'?: number;
|
|
17284
|
+
'backgroundOffsetLeft'?: number;
|
|
17285
|
+
'backgroundOffsetRight'?: number;
|
|
17286
|
+
'backgroundOffsetTop'?: number;
|
|
17287
|
+
'backgroundOpacity'?: number;
|
|
17288
|
+
'backgroundVerticalAlign'?: PublisherDocumentImageWidgetStyleBackgroundVerticalAlignEnum;
|
|
17289
|
+
'borderBottomColor'?: string;
|
|
17290
|
+
'borderBottomLeftRadius'?: PublisherDocumentImageWidgetStyleBorderBottomLeftRadius;
|
|
17291
|
+
'borderBottomRightRadius'?: PublisherDocumentImageWidgetStyleBorderBottomRightRadius;
|
|
17292
|
+
'borderBottomStyle'?: PublisherDocumentImageWidgetStyleBorderBottomStyleEnum;
|
|
17293
|
+
'borderBottomWidth'?: number;
|
|
17294
|
+
'borderColor'?: string;
|
|
17295
|
+
'borderLeftColor'?: string;
|
|
17296
|
+
'borderLeftStyle'?: PublisherDocumentImageWidgetStyleBorderLeftStyleEnum;
|
|
17297
|
+
'borderLeftWidth'?: number;
|
|
17298
|
+
'borderRadius'?: PublisherDocumentImageWidgetStyleBorderRadius;
|
|
17299
|
+
'borderRightColor'?: string;
|
|
17300
|
+
'borderRightStyle'?: PublisherDocumentImageWidgetStyleBorderRightStyleEnum;
|
|
17301
|
+
'borderRightWidth'?: number;
|
|
17302
|
+
'borderStyle'?: PublisherDocumentImageWidgetStyleBorderStyleEnum;
|
|
17303
|
+
'borderTopColor'?: string;
|
|
17304
|
+
'borderTopLeftRadius'?: PublisherDocumentImageWidgetStyleBorderTopLeftRadius;
|
|
17305
|
+
'borderTopRightRadius'?: PublisherDocumentImageWidgetStyleBorderTopRightRadius;
|
|
17306
|
+
'borderTopStyle'?: PublisherDocumentImageWidgetStyleBorderTopStyleEnum;
|
|
17307
|
+
'borderTopWidth'?: number;
|
|
17308
|
+
'borderWidth'?: number;
|
|
17309
|
+
'fit'?: PublisherDocumentImageWidgetStyleFitEnum;
|
|
17310
|
+
'horizontalAlign'?: PublisherDocumentImageWidgetStyleHorizontalAlignEnum;
|
|
17311
|
+
'opacity'?: number;
|
|
17312
|
+
'padding'?: PublisherDocumentImageWidgetStylePadding;
|
|
17313
|
+
'paddingBottom'?: PublisherDocumentImageWidgetStylePaddingBottom;
|
|
17314
|
+
'paddingLeft'?: PublisherDocumentImageWidgetStylePaddingLeft;
|
|
17315
|
+
'paddingRight'?: PublisherDocumentImageWidgetStylePaddingRight;
|
|
17316
|
+
'paddingTop'?: PublisherDocumentImageWidgetStylePaddingTop;
|
|
17317
|
+
'shadow'?: string;
|
|
17318
|
+
'shadowBlur'?: number;
|
|
17319
|
+
'shadowColor'?: string;
|
|
17320
|
+
'shadowOpacity'?: number;
|
|
17321
|
+
'shadowSpread'?: number;
|
|
17322
|
+
'shadowX'?: number;
|
|
17323
|
+
'shadowY'?: number;
|
|
17324
|
+
'verticalAlign'?: PublisherDocumentImageWidgetStyleVerticalAlignEnum;
|
|
17325
|
+
}
|
|
17326
|
+
export type PublisherDocumentImageWidgetStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17327
|
+
export type PublisherDocumentImageWidgetStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17328
|
+
export type PublisherDocumentImageWidgetStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17329
|
+
export type PublisherDocumentImageWidgetStyleBorderBottomStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17330
|
+
export type PublisherDocumentImageWidgetStyleBorderLeftStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17331
|
+
export type PublisherDocumentImageWidgetStyleBorderRightStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17332
|
+
export type PublisherDocumentImageWidgetStyleBorderStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17333
|
+
export type PublisherDocumentImageWidgetStyleBorderTopStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17334
|
+
export type PublisherDocumentImageWidgetStyleFitEnum = 'contain' | 'cover' | 'fill';
|
|
17335
|
+
export type PublisherDocumentImageWidgetStyleHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17336
|
+
export type PublisherDocumentImageWidgetStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17337
|
+
/**
|
|
17338
|
+
* @type PublisherDocumentImageWidgetStyleBorderBottomLeftRadius
|
|
17339
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17340
|
+
*/
|
|
17341
|
+
export type PublisherDocumentImageWidgetStyleBorderBottomLeftRadius = number | string;
|
|
17342
|
+
/**
|
|
17343
|
+
* @type PublisherDocumentImageWidgetStyleBorderBottomRightRadius
|
|
17344
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17345
|
+
*/
|
|
17346
|
+
export type PublisherDocumentImageWidgetStyleBorderBottomRightRadius = number | string;
|
|
17347
|
+
/**
|
|
17348
|
+
* @type PublisherDocumentImageWidgetStyleBorderRadius
|
|
17349
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17350
|
+
*/
|
|
17351
|
+
export type PublisherDocumentImageWidgetStyleBorderRadius = number | string;
|
|
17352
|
+
/**
|
|
17353
|
+
* @type PublisherDocumentImageWidgetStyleBorderTopLeftRadius
|
|
17354
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17355
|
+
*/
|
|
17356
|
+
export type PublisherDocumentImageWidgetStyleBorderTopLeftRadius = number | string;
|
|
17357
|
+
/**
|
|
17358
|
+
* @type PublisherDocumentImageWidgetStyleBorderTopRightRadius
|
|
17359
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17360
|
+
*/
|
|
17361
|
+
export type PublisherDocumentImageWidgetStyleBorderTopRightRadius = number | string;
|
|
17362
|
+
/**
|
|
17363
|
+
* @type PublisherDocumentImageWidgetStylePadding
|
|
17364
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17365
|
+
*/
|
|
17366
|
+
export type PublisherDocumentImageWidgetStylePadding = number | string;
|
|
17367
|
+
/**
|
|
17368
|
+
* @type PublisherDocumentImageWidgetStylePaddingBottom
|
|
17369
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17370
|
+
*/
|
|
17371
|
+
export type PublisherDocumentImageWidgetStylePaddingBottom = number | string;
|
|
17372
|
+
/**
|
|
17373
|
+
* @type PublisherDocumentImageWidgetStylePaddingLeft
|
|
17374
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17375
|
+
*/
|
|
17376
|
+
export type PublisherDocumentImageWidgetStylePaddingLeft = number | string;
|
|
17377
|
+
/**
|
|
17378
|
+
* @type PublisherDocumentImageWidgetStylePaddingRight
|
|
17379
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17380
|
+
*/
|
|
17381
|
+
export type PublisherDocumentImageWidgetStylePaddingRight = number | string;
|
|
17382
|
+
/**
|
|
17383
|
+
* @type PublisherDocumentImageWidgetStylePaddingTop
|
|
17384
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17385
|
+
*/
|
|
17386
|
+
export type PublisherDocumentImageWidgetStylePaddingTop = number | string;
|
|
17387
|
+
/**
|
|
17388
|
+
* @type PublisherDocumentLayoutNode
|
|
17389
|
+
* A layout node: a row or column container, or a widget. The shape is selected by `type`.
|
|
17390
|
+
*/
|
|
17391
|
+
export type PublisherDocumentLayoutNode = ({
|
|
17392
|
+
type: 'column';
|
|
17393
|
+
} & PublisherDocumentColumn) | ({
|
|
17394
|
+
type: 'heading';
|
|
17395
|
+
} & PublisherDocumentHeadingWidget) | ({
|
|
17396
|
+
type: 'image';
|
|
17397
|
+
} & PublisherDocumentImageWidget) | ({
|
|
17398
|
+
type: 'row';
|
|
17399
|
+
} & PublisherDocumentRow) | ({
|
|
17400
|
+
type: 'takeaway';
|
|
17401
|
+
} & PublisherDocumentTakeawayWidget) | ({
|
|
17402
|
+
type: 'text';
|
|
17403
|
+
} & PublisherDocumentTextWidget) | ({
|
|
17404
|
+
type: 'title';
|
|
17405
|
+
} & PublisherDocumentTitleWidget) | ({
|
|
17406
|
+
type: 'visualization';
|
|
17407
|
+
} & PublisherDocumentVisualizationWidget);
|
|
17408
|
+
export interface PublisherDocumentLegendDisplay {
|
|
17409
|
+
'position'?: PublisherDocumentLegendDisplayPositionEnum;
|
|
17410
|
+
'visible'?: boolean;
|
|
17411
|
+
}
|
|
17412
|
+
export type PublisherDocumentLegendDisplayPositionEnum = 'auto' | 'top' | 'bottom' | 'left' | 'right';
|
|
17413
|
+
/**
|
|
17414
|
+
* Filters an attribute display form by a text pattern.
|
|
17415
|
+
*/
|
|
17416
|
+
export interface PublisherDocumentMatchAttributeFilter {
|
|
17417
|
+
'matchAttributeFilter': PublisherDocumentMatchAttributeFilterMatchAttributeFilter;
|
|
17418
|
+
}
|
|
17419
|
+
export interface PublisherDocumentMatchAttributeFilterMatchAttributeFilter {
|
|
17420
|
+
'caseSensitive'?: boolean;
|
|
17421
|
+
'displayForm': PublisherDocumentObjRef;
|
|
17422
|
+
'literal': string;
|
|
17423
|
+
/**
|
|
17424
|
+
* 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.
|
|
17425
|
+
*/
|
|
17426
|
+
'localIdentifier'?: string;
|
|
17427
|
+
'negativeSelection'?: boolean;
|
|
17428
|
+
'operator': PublisherDocumentMatchAttributeFilterMatchAttributeFilterOperatorEnum;
|
|
17429
|
+
'title'?: string;
|
|
17430
|
+
}
|
|
17431
|
+
export type PublisherDocumentMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
|
|
17432
|
+
/**
|
|
17433
|
+
* @type PublisherDocumentMeasureValueCondition
|
|
17434
|
+
* A measure value condition, wrapped in an object keyed by its kind.
|
|
17435
|
+
*/
|
|
17436
|
+
export type PublisherDocumentMeasureValueCondition = PublisherDocumentComparisonCondition | PublisherDocumentRangeCondition;
|
|
17437
|
+
/**
|
|
17438
|
+
* Filters by the value of a measure.
|
|
17439
|
+
*/
|
|
17440
|
+
export interface PublisherDocumentMeasureValueFilter {
|
|
17441
|
+
'dashboardMeasureValueFilter': PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter;
|
|
17442
|
+
}
|
|
17443
|
+
export interface PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter {
|
|
17444
|
+
/**
|
|
17445
|
+
* OR-ed conditions; none means all values.
|
|
17446
|
+
*/
|
|
17447
|
+
'conditions'?: Array<PublisherDocumentMeasureValueCondition>;
|
|
17448
|
+
'dimensionality'?: Array<PublisherDocumentObjRef>;
|
|
17449
|
+
'localIdentifier': string;
|
|
17450
|
+
'measure': PublisherDocumentObjRef;
|
|
17451
|
+
'title'?: string;
|
|
17452
|
+
}
|
|
17453
|
+
export interface PublisherDocumentMeasureValueFilterReference {
|
|
17454
|
+
'measure': PublisherDocumentObjRef;
|
|
17455
|
+
'type': PublisherDocumentMeasureValueFilterReferenceTypeEnum;
|
|
17456
|
+
}
|
|
17457
|
+
export type PublisherDocumentMeasureValueFilterReferenceTypeEnum = 'measureValueFilterReference';
|
|
17458
|
+
/**
|
|
17459
|
+
* A flat object reference.
|
|
17460
|
+
*/
|
|
17461
|
+
export interface PublisherDocumentObjRef {
|
|
17462
|
+
'identifier': string;
|
|
17463
|
+
/**
|
|
17464
|
+
* sdk-model object type.
|
|
17465
|
+
*/
|
|
17466
|
+
'type': PublisherDocumentObjRefTypeEnum;
|
|
17467
|
+
}
|
|
17468
|
+
export type PublisherDocumentObjRefTypeEnum = 'insight' | 'displayForm' | 'dataSet' | 'measure' | 'attribute';
|
|
17469
|
+
/**
|
|
17470
|
+
* A page of a document.
|
|
17471
|
+
*/
|
|
17472
|
+
export interface PublisherDocumentPage {
|
|
17473
|
+
/**
|
|
17474
|
+
* Page filters; stored, not applied.
|
|
17475
|
+
*/
|
|
17476
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
17477
|
+
/**
|
|
17478
|
+
* Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.
|
|
17479
|
+
*/
|
|
17480
|
+
'id'?: string;
|
|
17481
|
+
/**
|
|
17482
|
+
* Editor hint.
|
|
17483
|
+
*/
|
|
17484
|
+
'kind'?: PublisherDocumentPageKindEnum;
|
|
17485
|
+
'layout': PublisherDocumentLayoutNode;
|
|
17486
|
+
/**
|
|
17487
|
+
* Speaker notes in markdown, never drawn.
|
|
17488
|
+
*/
|
|
17489
|
+
'notes'?: string;
|
|
17490
|
+
'pageSize'?: PublisherDocumentPagePageSizeEnum;
|
|
17491
|
+
'style'?: PublisherDocumentPageStyle;
|
|
17492
|
+
/**
|
|
17493
|
+
* `false` keeps the page out of the viewer, exports and page numbering. Default `true`.
|
|
17494
|
+
*/
|
|
17495
|
+
'visible'?: boolean;
|
|
17496
|
+
}
|
|
17497
|
+
export type PublisherDocumentPageKindEnum = 'cover' | 'section' | 'content';
|
|
17498
|
+
export type PublisherDocumentPagePageSizeEnum = 'widescreen';
|
|
17499
|
+
/**
|
|
17500
|
+
* Style of a page; containers inherit its gap and text keys. Lengths are in canvas px.
|
|
17501
|
+
*/
|
|
17502
|
+
export interface PublisherDocumentPageStyle {
|
|
17503
|
+
'backgroundColor'?: string;
|
|
17504
|
+
'backgroundFit'?: PublisherDocumentPageStyleBackgroundFitEnum;
|
|
17505
|
+
'backgroundHorizontalAlign'?: PublisherDocumentPageStyleBackgroundHorizontalAlignEnum;
|
|
17506
|
+
'backgroundImage'?: string;
|
|
17507
|
+
'backgroundImageOpacity'?: number;
|
|
17508
|
+
'backgroundOffset'?: number;
|
|
17509
|
+
'backgroundOffsetBottom'?: number;
|
|
17510
|
+
'backgroundOffsetLeft'?: number;
|
|
17511
|
+
'backgroundOffsetRight'?: number;
|
|
17512
|
+
'backgroundOffsetTop'?: number;
|
|
17513
|
+
'backgroundOpacity'?: number;
|
|
17514
|
+
'backgroundVerticalAlign'?: PublisherDocumentPageStyleBackgroundVerticalAlignEnum;
|
|
17515
|
+
'fontSize'?: number;
|
|
17516
|
+
'fontStyle'?: PublisherDocumentPageStyleFontStyleEnum;
|
|
17517
|
+
'fontWeight'?: number;
|
|
17518
|
+
'gap'?: PublisherDocumentPageStyleGap;
|
|
17519
|
+
'horizontalAlign'?: PublisherDocumentPageStyleHorizontalAlignEnum;
|
|
17520
|
+
'letterSpacing'?: number;
|
|
17521
|
+
'lineHeight'?: number;
|
|
17522
|
+
'padding'?: PublisherDocumentPageStylePadding;
|
|
17523
|
+
'paddingBottom'?: PublisherDocumentPageStylePaddingBottom;
|
|
17524
|
+
'paddingLeft'?: PublisherDocumentPageStylePaddingLeft;
|
|
17525
|
+
'paddingRight'?: PublisherDocumentPageStylePaddingRight;
|
|
17526
|
+
'paddingTop'?: PublisherDocumentPageStylePaddingTop;
|
|
17527
|
+
'textColor'?: string;
|
|
17528
|
+
'textOverflow'?: PublisherDocumentPageStyleTextOverflowEnum;
|
|
17529
|
+
'textStyle'?: PublisherDocumentPageStyleTextStyleEnum;
|
|
17530
|
+
'textTransform'?: PublisherDocumentPageStyleTextTransformEnum;
|
|
17531
|
+
'verticalAlign'?: PublisherDocumentPageStyleVerticalAlignEnum;
|
|
17532
|
+
}
|
|
17533
|
+
export type PublisherDocumentPageStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17534
|
+
export type PublisherDocumentPageStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17535
|
+
export type PublisherDocumentPageStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17536
|
+
export type PublisherDocumentPageStyleFontStyleEnum = 'normal' | 'italic';
|
|
17537
|
+
export type PublisherDocumentPageStyleHorizontalAlignEnum = 'left' | 'center' | 'right' | 'justify';
|
|
17538
|
+
export type PublisherDocumentPageStyleTextOverflowEnum = 'shrink' | 'clip' | 'ellipsis';
|
|
17539
|
+
export type PublisherDocumentPageStyleTextStyleEnum = 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText';
|
|
17540
|
+
export type PublisherDocumentPageStyleTextTransformEnum = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
|
|
17541
|
+
export type PublisherDocumentPageStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17542
|
+
/**
|
|
17543
|
+
* @type PublisherDocumentPageStyleGap
|
|
17544
|
+
* A length, or `{theme.spacing.gap.<compact|normal|spacious>}`.
|
|
17545
|
+
*/
|
|
17546
|
+
export type PublisherDocumentPageStyleGap = number | string;
|
|
17547
|
+
/**
|
|
17548
|
+
* @type PublisherDocumentPageStylePadding
|
|
17549
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17550
|
+
*/
|
|
17551
|
+
export type PublisherDocumentPageStylePadding = number | string;
|
|
17552
|
+
/**
|
|
17553
|
+
* @type PublisherDocumentPageStylePaddingBottom
|
|
17554
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17555
|
+
*/
|
|
17556
|
+
export type PublisherDocumentPageStylePaddingBottom = number | string;
|
|
17557
|
+
/**
|
|
17558
|
+
* @type PublisherDocumentPageStylePaddingLeft
|
|
17559
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17560
|
+
*/
|
|
17561
|
+
export type PublisherDocumentPageStylePaddingLeft = number | string;
|
|
17562
|
+
/**
|
|
17563
|
+
* @type PublisherDocumentPageStylePaddingRight
|
|
17564
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17565
|
+
*/
|
|
17566
|
+
export type PublisherDocumentPageStylePaddingRight = number | string;
|
|
17567
|
+
/**
|
|
17568
|
+
* @type PublisherDocumentPageStylePaddingTop
|
|
17569
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17570
|
+
*/
|
|
17571
|
+
export type PublisherDocumentPageStylePaddingTop = number | string;
|
|
17572
|
+
/**
|
|
17573
|
+
* Content of a page template: one page without `id` and `visible`.
|
|
17574
|
+
*/
|
|
17575
|
+
export interface PublisherDocumentPageTemplateContent {
|
|
17576
|
+
/**
|
|
17577
|
+
* Page filters; stored, not applied.
|
|
17578
|
+
*/
|
|
17579
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
17580
|
+
/**
|
|
17581
|
+
* Editor hint.
|
|
17582
|
+
*/
|
|
17583
|
+
'kind'?: PublisherDocumentPageTemplateContentKindEnum;
|
|
17584
|
+
'layout': PublisherDocumentLayoutNode;
|
|
17585
|
+
/**
|
|
17586
|
+
* Speaker notes in markdown, never drawn.
|
|
17587
|
+
*/
|
|
17588
|
+
'notes'?: string;
|
|
17589
|
+
'pageSize'?: PublisherDocumentPageTemplateContentPageSizeEnum;
|
|
17590
|
+
'style'?: PublisherDocumentPageStyle;
|
|
17591
|
+
}
|
|
17592
|
+
export type PublisherDocumentPageTemplateContentKindEnum = 'cover' | 'section' | 'content';
|
|
17593
|
+
export type PublisherDocumentPageTemplateContentPageSizeEnum = 'widescreen';
|
|
16320
17594
|
/**
|
|
16321
17595
|
* @type PublisherDocumentPeriod
|
|
16322
17596
|
* The period the document covers, absolute or relative to today.
|
|
@@ -16326,6 +17600,498 @@ export type PublisherDocumentPeriod = ({
|
|
|
16326
17600
|
} & AbsolutePublisherDocumentPeriod) | ({
|
|
16327
17601
|
type: 'relative';
|
|
16328
17602
|
} & RelativePublisherDocumentPeriod);
|
|
17603
|
+
export interface PublisherDocumentRangeCondition {
|
|
17604
|
+
'range': PublisherDocumentRangeConditionRange;
|
|
17605
|
+
}
|
|
17606
|
+
export interface PublisherDocumentRangeConditionRange {
|
|
17607
|
+
'from': number;
|
|
17608
|
+
'operator': PublisherDocumentRangeConditionRangeOperatorEnum;
|
|
17609
|
+
'to': number;
|
|
17610
|
+
'treatNullValuesAs'?: number;
|
|
17611
|
+
}
|
|
17612
|
+
export type PublisherDocumentRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
17613
|
+
/**
|
|
17614
|
+
* Lays its children out left to right.
|
|
17615
|
+
*/
|
|
17616
|
+
export interface PublisherDocumentRow {
|
|
17617
|
+
/**
|
|
17618
|
+
* Child nodes from left to right, in reading order; an empty list is a spacer.
|
|
17619
|
+
*/
|
|
17620
|
+
'children': Array<PublisherDocumentLayoutNode>;
|
|
17621
|
+
'id'?: string;
|
|
17622
|
+
/**
|
|
17623
|
+
* Locks the container in the document editor; never checked on write.
|
|
17624
|
+
*/
|
|
17625
|
+
'locked'?: boolean;
|
|
17626
|
+
/**
|
|
17627
|
+
* Share of the parent\'s main axis, greater than 0. Default 1.
|
|
17628
|
+
*/
|
|
17629
|
+
'proportion'?: number;
|
|
17630
|
+
'style'?: PublisherDocumentContainerStyle;
|
|
17631
|
+
'type': PublisherDocumentRowTypeEnum;
|
|
17632
|
+
}
|
|
17633
|
+
export type PublisherDocumentRowTypeEnum = 'row';
|
|
17634
|
+
/**
|
|
17635
|
+
* A group of pages, like a dashboard tab.
|
|
17636
|
+
*/
|
|
17637
|
+
export interface PublisherDocumentSection {
|
|
17638
|
+
'description'?: string;
|
|
17639
|
+
/**
|
|
17640
|
+
* Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.
|
|
17641
|
+
*/
|
|
17642
|
+
'id'?: string;
|
|
17643
|
+
'pages': Array<PublisherDocumentPage>;
|
|
17644
|
+
'title'?: string;
|
|
17645
|
+
}
|
|
17646
|
+
/**
|
|
17647
|
+
* Table style overrides; stored, not applied. Lengths are in canvas px.
|
|
17648
|
+
*/
|
|
17649
|
+
export interface PublisherDocumentTableStyle {
|
|
17650
|
+
'fontSize'?: number;
|
|
17651
|
+
'gridColor'?: string;
|
|
17652
|
+
'headerBackgroundColor'?: string;
|
|
17653
|
+
'headerLabelColor'?: string;
|
|
17654
|
+
'nullValueColor'?: string;
|
|
17655
|
+
'rowHeight'?: number;
|
|
17656
|
+
'subtotalBackgroundColor'?: string;
|
|
17657
|
+
'totalBackgroundColor'?: string;
|
|
17658
|
+
'totalValueColor'?: string;
|
|
17659
|
+
'valueColor'?: string;
|
|
17660
|
+
}
|
|
17661
|
+
/**
|
|
17662
|
+
* What the copilot reads when it writes a takeaway.
|
|
17663
|
+
*/
|
|
17664
|
+
export interface PublisherDocumentTakeawayContext {
|
|
17665
|
+
'filters'?: boolean;
|
|
17666
|
+
'otherPages'?: boolean;
|
|
17667
|
+
'pageTitle'?: boolean;
|
|
17668
|
+
/**
|
|
17669
|
+
* Widget ids on the same page.
|
|
17670
|
+
*/
|
|
17671
|
+
'widgets'?: Array<string>;
|
|
17672
|
+
}
|
|
17673
|
+
/**
|
|
17674
|
+
* Takeaway settings every takeaway widget of the document uses.
|
|
17675
|
+
*/
|
|
17676
|
+
export interface PublisherDocumentTakeawayDefaults {
|
|
17677
|
+
'generation'?: PublisherDocumentTakeawayGeneration;
|
|
17678
|
+
}
|
|
17679
|
+
/**
|
|
17680
|
+
* How the copilot writes a takeaway.
|
|
17681
|
+
*/
|
|
17682
|
+
export interface PublisherDocumentTakeawayGeneration {
|
|
17683
|
+
'context'?: PublisherDocumentTakeawayContext;
|
|
17684
|
+
'instructions'?: string;
|
|
17685
|
+
}
|
|
17686
|
+
/**
|
|
17687
|
+
* A generated takeaway, stored as markdown.
|
|
17688
|
+
*/
|
|
17689
|
+
export interface PublisherDocumentTakeawayWidget {
|
|
17690
|
+
'generation'?: PublisherDocumentTakeawayGeneration;
|
|
17691
|
+
/**
|
|
17692
|
+
* Unique within the page.
|
|
17693
|
+
*/
|
|
17694
|
+
'id': string;
|
|
17695
|
+
/**
|
|
17696
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17697
|
+
*/
|
|
17698
|
+
'locked'?: boolean;
|
|
17699
|
+
/**
|
|
17700
|
+
* The generated text.
|
|
17701
|
+
*/
|
|
17702
|
+
'markdown'?: string;
|
|
17703
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17704
|
+
'proportion'?: number;
|
|
17705
|
+
'style'?: PublisherDocumentTextWidgetStyle;
|
|
17706
|
+
'title'?: PublisherDocumentWidgetTitle;
|
|
17707
|
+
'type': PublisherDocumentTakeawayWidgetTypeEnum;
|
|
17708
|
+
}
|
|
17709
|
+
export type PublisherDocumentTakeawayWidgetTypeEnum = 'takeaway';
|
|
17710
|
+
/**
|
|
17711
|
+
* Text style of a widget title. Lengths are in canvas px.
|
|
17712
|
+
*/
|
|
17713
|
+
export interface PublisherDocumentTextStyle {
|
|
17714
|
+
'fontSize'?: number;
|
|
17715
|
+
'fontStyle'?: PublisherDocumentTextStyleFontStyleEnum;
|
|
17716
|
+
'fontWeight'?: number;
|
|
17717
|
+
'horizontalAlign'?: PublisherDocumentTextStyleHorizontalAlignEnum;
|
|
17718
|
+
'letterSpacing'?: number;
|
|
17719
|
+
'lineHeight'?: number;
|
|
17720
|
+
'textColor'?: string;
|
|
17721
|
+
'textOverflow'?: PublisherDocumentTextStyleTextOverflowEnum;
|
|
17722
|
+
'textStyle'?: PublisherDocumentTextStyleTextStyleEnum;
|
|
17723
|
+
'textTransform'?: PublisherDocumentTextStyleTextTransformEnum;
|
|
17724
|
+
'verticalAlign'?: PublisherDocumentTextStyleVerticalAlignEnum;
|
|
17725
|
+
}
|
|
17726
|
+
export type PublisherDocumentTextStyleFontStyleEnum = 'normal' | 'italic';
|
|
17727
|
+
export type PublisherDocumentTextStyleHorizontalAlignEnum = 'left' | 'center' | 'right' | 'justify';
|
|
17728
|
+
export type PublisherDocumentTextStyleTextOverflowEnum = 'shrink' | 'clip' | 'ellipsis';
|
|
17729
|
+
export type PublisherDocumentTextStyleTextStyleEnum = 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText';
|
|
17730
|
+
export type PublisherDocumentTextStyleTextTransformEnum = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
|
|
17731
|
+
export type PublisherDocumentTextStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17732
|
+
/**
|
|
17733
|
+
* A block of markdown text.
|
|
17734
|
+
*/
|
|
17735
|
+
export interface PublisherDocumentTextWidget {
|
|
17736
|
+
/**
|
|
17737
|
+
* Left out of the accessibility tree, PDF tags and the AI context.
|
|
17738
|
+
*/
|
|
17739
|
+
'decorative'?: boolean;
|
|
17740
|
+
/**
|
|
17741
|
+
* Unique within the page.
|
|
17742
|
+
*/
|
|
17743
|
+
'id': string;
|
|
17744
|
+
/**
|
|
17745
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17746
|
+
*/
|
|
17747
|
+
'locked'?: boolean;
|
|
17748
|
+
/**
|
|
17749
|
+
* Full markdown.
|
|
17750
|
+
*/
|
|
17751
|
+
'markdown'?: string;
|
|
17752
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17753
|
+
'proportion'?: number;
|
|
17754
|
+
'style'?: PublisherDocumentTextWidgetStyle;
|
|
17755
|
+
'type': PublisherDocumentTextWidgetTypeEnum;
|
|
17756
|
+
}
|
|
17757
|
+
export type PublisherDocumentTextWidgetTypeEnum = 'text';
|
|
17758
|
+
/**
|
|
17759
|
+
* Style of a title, heading, text or takeaway widget. Lengths are in canvas px.
|
|
17760
|
+
*/
|
|
17761
|
+
export interface PublisherDocumentTextWidgetStyle {
|
|
17762
|
+
'backgroundColor'?: string;
|
|
17763
|
+
'backgroundFit'?: PublisherDocumentTextWidgetStyleBackgroundFitEnum;
|
|
17764
|
+
'backgroundHorizontalAlign'?: PublisherDocumentTextWidgetStyleBackgroundHorizontalAlignEnum;
|
|
17765
|
+
'backgroundImage'?: string;
|
|
17766
|
+
'backgroundImageOpacity'?: number;
|
|
17767
|
+
'backgroundOffset'?: number;
|
|
17768
|
+
'backgroundOffsetBottom'?: number;
|
|
17769
|
+
'backgroundOffsetLeft'?: number;
|
|
17770
|
+
'backgroundOffsetRight'?: number;
|
|
17771
|
+
'backgroundOffsetTop'?: number;
|
|
17772
|
+
'backgroundOpacity'?: number;
|
|
17773
|
+
'backgroundVerticalAlign'?: PublisherDocumentTextWidgetStyleBackgroundVerticalAlignEnum;
|
|
17774
|
+
'borderBottomColor'?: string;
|
|
17775
|
+
'borderBottomLeftRadius'?: PublisherDocumentTextWidgetStyleBorderBottomLeftRadius;
|
|
17776
|
+
'borderBottomRightRadius'?: PublisherDocumentTextWidgetStyleBorderBottomRightRadius;
|
|
17777
|
+
'borderBottomStyle'?: PublisherDocumentTextWidgetStyleBorderBottomStyleEnum;
|
|
17778
|
+
'borderBottomWidth'?: number;
|
|
17779
|
+
'borderColor'?: string;
|
|
17780
|
+
'borderLeftColor'?: string;
|
|
17781
|
+
'borderLeftStyle'?: PublisherDocumentTextWidgetStyleBorderLeftStyleEnum;
|
|
17782
|
+
'borderLeftWidth'?: number;
|
|
17783
|
+
'borderRadius'?: PublisherDocumentTextWidgetStyleBorderRadius;
|
|
17784
|
+
'borderRightColor'?: string;
|
|
17785
|
+
'borderRightStyle'?: PublisherDocumentTextWidgetStyleBorderRightStyleEnum;
|
|
17786
|
+
'borderRightWidth'?: number;
|
|
17787
|
+
'borderStyle'?: PublisherDocumentTextWidgetStyleBorderStyleEnum;
|
|
17788
|
+
'borderTopColor'?: string;
|
|
17789
|
+
'borderTopLeftRadius'?: PublisherDocumentTextWidgetStyleBorderTopLeftRadius;
|
|
17790
|
+
'borderTopRightRadius'?: PublisherDocumentTextWidgetStyleBorderTopRightRadius;
|
|
17791
|
+
'borderTopStyle'?: PublisherDocumentTextWidgetStyleBorderTopStyleEnum;
|
|
17792
|
+
'borderTopWidth'?: number;
|
|
17793
|
+
'borderWidth'?: number;
|
|
17794
|
+
'fontSize'?: number;
|
|
17795
|
+
'fontStyle'?: PublisherDocumentTextWidgetStyleFontStyleEnum;
|
|
17796
|
+
'fontWeight'?: number;
|
|
17797
|
+
'horizontalAlign'?: PublisherDocumentTextWidgetStyleHorizontalAlignEnum;
|
|
17798
|
+
'letterSpacing'?: number;
|
|
17799
|
+
'lineHeight'?: number;
|
|
17800
|
+
'opacity'?: number;
|
|
17801
|
+
'padding'?: PublisherDocumentTextWidgetStylePadding;
|
|
17802
|
+
'paddingBottom'?: PublisherDocumentTextWidgetStylePaddingBottom;
|
|
17803
|
+
'paddingLeft'?: PublisherDocumentTextWidgetStylePaddingLeft;
|
|
17804
|
+
'paddingRight'?: PublisherDocumentTextWidgetStylePaddingRight;
|
|
17805
|
+
'paddingTop'?: PublisherDocumentTextWidgetStylePaddingTop;
|
|
17806
|
+
'shadow'?: string;
|
|
17807
|
+
'shadowBlur'?: number;
|
|
17808
|
+
'shadowColor'?: string;
|
|
17809
|
+
'shadowOpacity'?: number;
|
|
17810
|
+
'shadowSpread'?: number;
|
|
17811
|
+
'shadowX'?: number;
|
|
17812
|
+
'shadowY'?: number;
|
|
17813
|
+
'textColor'?: string;
|
|
17814
|
+
'textOverflow'?: PublisherDocumentTextWidgetStyleTextOverflowEnum;
|
|
17815
|
+
'textStyle'?: PublisherDocumentTextWidgetStyleTextStyleEnum;
|
|
17816
|
+
'textTransform'?: PublisherDocumentTextWidgetStyleTextTransformEnum;
|
|
17817
|
+
'verticalAlign'?: PublisherDocumentTextWidgetStyleVerticalAlignEnum;
|
|
17818
|
+
}
|
|
17819
|
+
export type PublisherDocumentTextWidgetStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17820
|
+
export type PublisherDocumentTextWidgetStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17821
|
+
export type PublisherDocumentTextWidgetStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17822
|
+
export type PublisherDocumentTextWidgetStyleBorderBottomStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17823
|
+
export type PublisherDocumentTextWidgetStyleBorderLeftStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17824
|
+
export type PublisherDocumentTextWidgetStyleBorderRightStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17825
|
+
export type PublisherDocumentTextWidgetStyleBorderStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17826
|
+
export type PublisherDocumentTextWidgetStyleBorderTopStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17827
|
+
export type PublisherDocumentTextWidgetStyleFontStyleEnum = 'normal' | 'italic';
|
|
17828
|
+
export type PublisherDocumentTextWidgetStyleHorizontalAlignEnum = 'left' | 'center' | 'right' | 'justify';
|
|
17829
|
+
export type PublisherDocumentTextWidgetStyleTextOverflowEnum = 'shrink' | 'clip' | 'ellipsis';
|
|
17830
|
+
export type PublisherDocumentTextWidgetStyleTextStyleEnum = 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText';
|
|
17831
|
+
export type PublisherDocumentTextWidgetStyleTextTransformEnum = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
|
|
17832
|
+
export type PublisherDocumentTextWidgetStyleVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17833
|
+
/**
|
|
17834
|
+
* @type PublisherDocumentTextWidgetStyleBorderBottomLeftRadius
|
|
17835
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17836
|
+
*/
|
|
17837
|
+
export type PublisherDocumentTextWidgetStyleBorderBottomLeftRadius = number | string;
|
|
17838
|
+
/**
|
|
17839
|
+
* @type PublisherDocumentTextWidgetStyleBorderBottomRightRadius
|
|
17840
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17841
|
+
*/
|
|
17842
|
+
export type PublisherDocumentTextWidgetStyleBorderBottomRightRadius = number | string;
|
|
17843
|
+
/**
|
|
17844
|
+
* @type PublisherDocumentTextWidgetStyleBorderRadius
|
|
17845
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17846
|
+
*/
|
|
17847
|
+
export type PublisherDocumentTextWidgetStyleBorderRadius = number | string;
|
|
17848
|
+
/**
|
|
17849
|
+
* @type PublisherDocumentTextWidgetStyleBorderTopLeftRadius
|
|
17850
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17851
|
+
*/
|
|
17852
|
+
export type PublisherDocumentTextWidgetStyleBorderTopLeftRadius = number | string;
|
|
17853
|
+
/**
|
|
17854
|
+
* @type PublisherDocumentTextWidgetStyleBorderTopRightRadius
|
|
17855
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17856
|
+
*/
|
|
17857
|
+
export type PublisherDocumentTextWidgetStyleBorderTopRightRadius = number | string;
|
|
17858
|
+
/**
|
|
17859
|
+
* @type PublisherDocumentTextWidgetStylePadding
|
|
17860
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17861
|
+
*/
|
|
17862
|
+
export type PublisherDocumentTextWidgetStylePadding = number | string;
|
|
17863
|
+
/**
|
|
17864
|
+
* @type PublisherDocumentTextWidgetStylePaddingBottom
|
|
17865
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17866
|
+
*/
|
|
17867
|
+
export type PublisherDocumentTextWidgetStylePaddingBottom = number | string;
|
|
17868
|
+
/**
|
|
17869
|
+
* @type PublisherDocumentTextWidgetStylePaddingLeft
|
|
17870
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17871
|
+
*/
|
|
17872
|
+
export type PublisherDocumentTextWidgetStylePaddingLeft = number | string;
|
|
17873
|
+
/**
|
|
17874
|
+
* @type PublisherDocumentTextWidgetStylePaddingRight
|
|
17875
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17876
|
+
*/
|
|
17877
|
+
export type PublisherDocumentTextWidgetStylePaddingRight = number | string;
|
|
17878
|
+
/**
|
|
17879
|
+
* @type PublisherDocumentTextWidgetStylePaddingTop
|
|
17880
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
17881
|
+
*/
|
|
17882
|
+
export type PublisherDocumentTextWidgetStylePaddingTop = number | string;
|
|
17883
|
+
/**
|
|
17884
|
+
* The page\'s title, at most one per page.
|
|
17885
|
+
*/
|
|
17886
|
+
export interface PublisherDocumentTitleWidget {
|
|
17887
|
+
/**
|
|
17888
|
+
* Unique within the page.
|
|
17889
|
+
*/
|
|
17890
|
+
'id': string;
|
|
17891
|
+
/**
|
|
17892
|
+
* Locks the widget in the document editor; never checked on write.
|
|
17893
|
+
*/
|
|
17894
|
+
'locked'?: boolean;
|
|
17895
|
+
/**
|
|
17896
|
+
* Inline markdown.
|
|
17897
|
+
*/
|
|
17898
|
+
'markdown'?: string;
|
|
17899
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
17900
|
+
'proportion'?: number;
|
|
17901
|
+
'style'?: PublisherDocumentTextWidgetStyle;
|
|
17902
|
+
'type': PublisherDocumentTitleWidgetTypeEnum;
|
|
17903
|
+
}
|
|
17904
|
+
export type PublisherDocumentTitleWidgetTypeEnum = 'title';
|
|
17905
|
+
export interface PublisherDocumentVisibility {
|
|
17906
|
+
'visible'?: boolean;
|
|
17907
|
+
}
|
|
17908
|
+
/**
|
|
17909
|
+
* Overrides of the saved visualization\'s own configuration; stored, not applied.
|
|
17910
|
+
*/
|
|
17911
|
+
export interface PublisherDocumentVisualizationDisplay {
|
|
17912
|
+
'dataLabels'?: PublisherDocumentAutoVisibility;
|
|
17913
|
+
'dataPoints'?: PublisherDocumentAutoVisibility;
|
|
17914
|
+
'gridlines'?: PublisherDocumentVisibility;
|
|
17915
|
+
'legend'?: PublisherDocumentLegendDisplay;
|
|
17916
|
+
'secondaryYAxis'?: PublisherDocumentAxisDisplay;
|
|
17917
|
+
'xAxis'?: PublisherDocumentAxisDisplay;
|
|
17918
|
+
'yAxis'?: PublisherDocumentAxisDisplay;
|
|
17919
|
+
}
|
|
17920
|
+
/**
|
|
17921
|
+
* A saved visualization.
|
|
17922
|
+
*/
|
|
17923
|
+
export interface PublisherDocumentVisualizationRef {
|
|
17924
|
+
'identifier': string;
|
|
17925
|
+
'type': PublisherDocumentVisualizationRefTypeEnum;
|
|
17926
|
+
}
|
|
17927
|
+
export type PublisherDocumentVisualizationRefTypeEnum = 'insight';
|
|
17928
|
+
/**
|
|
17929
|
+
* Style of a visualization widget. Lengths are in canvas px.
|
|
17930
|
+
*/
|
|
17931
|
+
export interface PublisherDocumentVisualizationStyle {
|
|
17932
|
+
'backgroundColor'?: string;
|
|
17933
|
+
'backgroundFit'?: PublisherDocumentVisualizationStyleBackgroundFitEnum;
|
|
17934
|
+
'backgroundHorizontalAlign'?: PublisherDocumentVisualizationStyleBackgroundHorizontalAlignEnum;
|
|
17935
|
+
'backgroundImage'?: string;
|
|
17936
|
+
'backgroundImageOpacity'?: number;
|
|
17937
|
+
'backgroundOffset'?: number;
|
|
17938
|
+
'backgroundOffsetBottom'?: number;
|
|
17939
|
+
'backgroundOffsetLeft'?: number;
|
|
17940
|
+
'backgroundOffsetRight'?: number;
|
|
17941
|
+
'backgroundOffsetTop'?: number;
|
|
17942
|
+
'backgroundOpacity'?: number;
|
|
17943
|
+
'backgroundVerticalAlign'?: PublisherDocumentVisualizationStyleBackgroundVerticalAlignEnum;
|
|
17944
|
+
'borderBottomColor'?: string;
|
|
17945
|
+
'borderBottomLeftRadius'?: PublisherDocumentVisualizationStyleBorderBottomLeftRadius;
|
|
17946
|
+
'borderBottomRightRadius'?: PublisherDocumentVisualizationStyleBorderBottomRightRadius;
|
|
17947
|
+
'borderBottomStyle'?: PublisherDocumentVisualizationStyleBorderBottomStyleEnum;
|
|
17948
|
+
'borderBottomWidth'?: number;
|
|
17949
|
+
'borderColor'?: string;
|
|
17950
|
+
'borderLeftColor'?: string;
|
|
17951
|
+
'borderLeftStyle'?: PublisherDocumentVisualizationStyleBorderLeftStyleEnum;
|
|
17952
|
+
'borderLeftWidth'?: number;
|
|
17953
|
+
'borderRadius'?: PublisherDocumentVisualizationStyleBorderRadius;
|
|
17954
|
+
'borderRightColor'?: string;
|
|
17955
|
+
'borderRightStyle'?: PublisherDocumentVisualizationStyleBorderRightStyleEnum;
|
|
17956
|
+
'borderRightWidth'?: number;
|
|
17957
|
+
'borderStyle'?: PublisherDocumentVisualizationStyleBorderStyleEnum;
|
|
17958
|
+
'borderTopColor'?: string;
|
|
17959
|
+
'borderTopLeftRadius'?: PublisherDocumentVisualizationStyleBorderTopLeftRadius;
|
|
17960
|
+
'borderTopRightRadius'?: PublisherDocumentVisualizationStyleBorderTopRightRadius;
|
|
17961
|
+
'borderTopStyle'?: PublisherDocumentVisualizationStyleBorderTopStyleEnum;
|
|
17962
|
+
'borderTopWidth'?: number;
|
|
17963
|
+
'borderWidth'?: number;
|
|
17964
|
+
'chart'?: PublisherDocumentChartStyle;
|
|
17965
|
+
'headline'?: PublisherDocumentHeadlineStyle;
|
|
17966
|
+
'opacity'?: number;
|
|
17967
|
+
'padding'?: PublisherDocumentVisualizationStylePadding;
|
|
17968
|
+
'paddingBottom'?: PublisherDocumentVisualizationStylePaddingBottom;
|
|
17969
|
+
'paddingLeft'?: PublisherDocumentVisualizationStylePaddingLeft;
|
|
17970
|
+
'paddingRight'?: PublisherDocumentVisualizationStylePaddingRight;
|
|
17971
|
+
'paddingTop'?: PublisherDocumentVisualizationStylePaddingTop;
|
|
17972
|
+
'shadow'?: string;
|
|
17973
|
+
'shadowBlur'?: number;
|
|
17974
|
+
'shadowColor'?: string;
|
|
17975
|
+
'shadowOpacity'?: number;
|
|
17976
|
+
'shadowSpread'?: number;
|
|
17977
|
+
'shadowX'?: number;
|
|
17978
|
+
'shadowY'?: number;
|
|
17979
|
+
'table'?: PublisherDocumentTableStyle;
|
|
17980
|
+
}
|
|
17981
|
+
export type PublisherDocumentVisualizationStyleBackgroundFitEnum = 'cover' | 'contain' | 'fill' | 'tile';
|
|
17982
|
+
export type PublisherDocumentVisualizationStyleBackgroundHorizontalAlignEnum = 'left' | 'center' | 'right';
|
|
17983
|
+
export type PublisherDocumentVisualizationStyleBackgroundVerticalAlignEnum = 'top' | 'center' | 'bottom';
|
|
17984
|
+
export type PublisherDocumentVisualizationStyleBorderBottomStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17985
|
+
export type PublisherDocumentVisualizationStyleBorderLeftStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17986
|
+
export type PublisherDocumentVisualizationStyleBorderRightStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17987
|
+
export type PublisherDocumentVisualizationStyleBorderStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17988
|
+
export type PublisherDocumentVisualizationStyleBorderTopStyleEnum = 'solid' | 'dashed' | 'dotted' | 'none';
|
|
17989
|
+
/**
|
|
17990
|
+
* @type PublisherDocumentVisualizationStyleBorderBottomLeftRadius
|
|
17991
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17992
|
+
*/
|
|
17993
|
+
export type PublisherDocumentVisualizationStyleBorderBottomLeftRadius = number | string;
|
|
17994
|
+
/**
|
|
17995
|
+
* @type PublisherDocumentVisualizationStyleBorderBottomRightRadius
|
|
17996
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
17997
|
+
*/
|
|
17998
|
+
export type PublisherDocumentVisualizationStyleBorderBottomRightRadius = number | string;
|
|
17999
|
+
/**
|
|
18000
|
+
* @type PublisherDocumentVisualizationStyleBorderRadius
|
|
18001
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
18002
|
+
*/
|
|
18003
|
+
export type PublisherDocumentVisualizationStyleBorderRadius = number | string;
|
|
18004
|
+
/**
|
|
18005
|
+
* @type PublisherDocumentVisualizationStyleBorderTopLeftRadius
|
|
18006
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
18007
|
+
*/
|
|
18008
|
+
export type PublisherDocumentVisualizationStyleBorderTopLeftRadius = number | string;
|
|
18009
|
+
/**
|
|
18010
|
+
* @type PublisherDocumentVisualizationStyleBorderTopRightRadius
|
|
18011
|
+
* A length, or `{theme.corners.<small|medium|large|full>}`.
|
|
18012
|
+
*/
|
|
18013
|
+
export type PublisherDocumentVisualizationStyleBorderTopRightRadius = number | string;
|
|
18014
|
+
/**
|
|
18015
|
+
* @type PublisherDocumentVisualizationStylePadding
|
|
18016
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
18017
|
+
*/
|
|
18018
|
+
export type PublisherDocumentVisualizationStylePadding = number | string;
|
|
18019
|
+
/**
|
|
18020
|
+
* @type PublisherDocumentVisualizationStylePaddingBottom
|
|
18021
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
18022
|
+
*/
|
|
18023
|
+
export type PublisherDocumentVisualizationStylePaddingBottom = number | string;
|
|
18024
|
+
/**
|
|
18025
|
+
* @type PublisherDocumentVisualizationStylePaddingLeft
|
|
18026
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
18027
|
+
*/
|
|
18028
|
+
export type PublisherDocumentVisualizationStylePaddingLeft = number | string;
|
|
18029
|
+
/**
|
|
18030
|
+
* @type PublisherDocumentVisualizationStylePaddingRight
|
|
18031
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
18032
|
+
*/
|
|
18033
|
+
export type PublisherDocumentVisualizationStylePaddingRight = number | string;
|
|
18034
|
+
/**
|
|
18035
|
+
* @type PublisherDocumentVisualizationStylePaddingTop
|
|
18036
|
+
* A length, or `{theme.spacing.padding.<compact|normal|spacious>}`.
|
|
18037
|
+
*/
|
|
18038
|
+
export type PublisherDocumentVisualizationStylePaddingTop = number | string;
|
|
18039
|
+
/**
|
|
18040
|
+
* A saved visualization.
|
|
18041
|
+
*/
|
|
18042
|
+
export interface PublisherDocumentVisualizationWidget {
|
|
18043
|
+
/**
|
|
18044
|
+
* Defaults to the visualization\'s description.
|
|
18045
|
+
*/
|
|
18046
|
+
'altText'?: string;
|
|
18047
|
+
'dateDataSet'?: PublisherDocumentDataSetRef;
|
|
18048
|
+
'display'?: PublisherDocumentVisualizationDisplay;
|
|
18049
|
+
/**
|
|
18050
|
+
* Widget filters; stored, not applied.
|
|
18051
|
+
*/
|
|
18052
|
+
'filters'?: Array<PublisherDocumentFilter>;
|
|
18053
|
+
/**
|
|
18054
|
+
* Unique within the page.
|
|
18055
|
+
*/
|
|
18056
|
+
'id': string;
|
|
18057
|
+
/**
|
|
18058
|
+
* Document filters this widget ignores.
|
|
18059
|
+
*/
|
|
18060
|
+
'ignoreDocumentFilters'?: Array<PublisherDocumentFilterReference>;
|
|
18061
|
+
'ignoreDocumentPeriod'?: boolean;
|
|
18062
|
+
/**
|
|
18063
|
+
* Locks the widget in the document editor; never checked on write.
|
|
18064
|
+
*/
|
|
18065
|
+
'locked'?: boolean;
|
|
18066
|
+
'placeholder'?: PublisherDocumentWidgetPlaceholder;
|
|
18067
|
+
'proportion'?: number;
|
|
18068
|
+
'style'?: PublisherDocumentVisualizationStyle;
|
|
18069
|
+
'title'?: PublisherDocumentWidgetTitle;
|
|
18070
|
+
'type': PublisherDocumentVisualizationWidgetTypeEnum;
|
|
18071
|
+
'visualization'?: PublisherDocumentVisualizationRef;
|
|
18072
|
+
}
|
|
18073
|
+
export type PublisherDocumentVisualizationWidgetTypeEnum = 'visualization';
|
|
18074
|
+
/**
|
|
18075
|
+
* What the editor shows in an empty widget.
|
|
18076
|
+
*/
|
|
18077
|
+
export interface PublisherDocumentWidgetPlaceholder {
|
|
18078
|
+
'hint'?: string;
|
|
18079
|
+
'required'?: boolean;
|
|
18080
|
+
}
|
|
18081
|
+
/**
|
|
18082
|
+
* Title of a visualization or takeaway widget.
|
|
18083
|
+
*/
|
|
18084
|
+
export interface PublisherDocumentWidgetTitle {
|
|
18085
|
+
'style'?: PublisherDocumentTextStyle;
|
|
18086
|
+
/**
|
|
18087
|
+
* Overrides the default title; may contain text variables.
|
|
18088
|
+
*/
|
|
18089
|
+
'text'?: string;
|
|
18090
|
+
/**
|
|
18091
|
+
* When left out, a visualization\'s title is hidden and a takeaway\'s is shown.
|
|
18092
|
+
*/
|
|
18093
|
+
'visible'?: boolean;
|
|
18094
|
+
}
|
|
16329
18095
|
export interface Range {
|
|
16330
18096
|
'from': Value;
|
|
16331
18097
|
'measure': LocalIdentifier;
|
|
@@ -16494,9 +18260,9 @@ export interface Relative {
|
|
|
16494
18260
|
}
|
|
16495
18261
|
export type RelativeOperatorEnum = 'INCREASES_BY' | 'DECREASES_BY' | 'CHANGES_BY';
|
|
16496
18262
|
export interface RelativeBoundedDateFilter {
|
|
16497
|
-
'from'?: number;
|
|
18263
|
+
'from'?: number | null;
|
|
16498
18264
|
'granularity': RelativeBoundedDateFilterGranularityEnum;
|
|
16499
|
-
'to'?: number;
|
|
18265
|
+
'to'?: number | null;
|
|
16500
18266
|
}
|
|
16501
18267
|
export type RelativeBoundedDateFilterGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.minute_in_day' | 'GDC.time.second' | 'GDC.time.second_in_minute' | 'GDC.time.second_in_day' | 'GDC.time.fiscal_week' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_semester' | 'GDC.time.fiscal_year' | 'GDC.time.fiscal_day_in_fiscal_week' | 'GDC.time.fiscal_day_in_fiscal_month' | 'GDC.time.fiscal_day_in_fiscal_quarter' | 'GDC.time.fiscal_day_in_fiscal_semester' | 'GDC.time.fiscal_day_in_fiscal_year' | 'GDC.time.fiscal_week_in_fiscal_month' | 'GDC.time.fiscal_week_in_fiscal_quarter' | 'GDC.time.fiscal_week_in_fiscal_semester' | 'GDC.time.fiscal_week_in_fiscal_year' | 'GDC.time.fiscal_month_in_fiscal_quarter' | 'GDC.time.fiscal_month_in_fiscal_semester' | 'GDC.time.fiscal_month_in_fiscal_year' | 'GDC.time.fiscal_quarter_in_fiscal_semester' | 'GDC.time.fiscal_quarter_in_fiscal_year' | 'GDC.time.fiscal_semester_in_fiscal_year';
|
|
16502
18268
|
/**
|
|
@@ -16579,7 +18345,7 @@ export interface ResolvedSetting {
|
|
|
16579
18345
|
*/
|
|
16580
18346
|
'type'?: ResolvedSettingTypeEnum;
|
|
16581
18347
|
}
|
|
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';
|
|
18348
|
+
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_AI_TRACE_OBFUSCATION' | 'ENABLE_AI_PERSISTENCE_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' | 'AI_LAKE_CREDENTIAL_VENDING';
|
|
16583
18349
|
/**
|
|
16584
18350
|
* A reference the caller may not view.
|
|
16585
18351
|
*/
|
|
@@ -17185,6 +18951,24 @@ export interface UserPermission {
|
|
|
17185
18951
|
*/
|
|
17186
18952
|
'permissions'?: Array<GrantedPermission>;
|
|
17187
18953
|
}
|
|
18954
|
+
/**
|
|
18955
|
+
* An origin to check against the embedding origins of the organization.
|
|
18956
|
+
*/
|
|
18957
|
+
export interface ValidateEmbeddingOriginRequest {
|
|
18958
|
+
/**
|
|
18959
|
+
* The origin of the embedding application, or `*` when it hides its origin.
|
|
18960
|
+
*/
|
|
18961
|
+
'origin': string;
|
|
18962
|
+
}
|
|
18963
|
+
/**
|
|
18964
|
+
* Whether the origin may embed the application.
|
|
18965
|
+
*/
|
|
18966
|
+
export interface ValidateEmbeddingOriginResponse {
|
|
18967
|
+
/**
|
|
18968
|
+
* True when the embedding origins of the organization allow the origin.
|
|
18969
|
+
*/
|
|
18970
|
+
'valid': boolean;
|
|
18971
|
+
}
|
|
17188
18972
|
/**
|
|
17189
18973
|
* The cache expires once a fixed period elapses since the results were computed.
|
|
17190
18974
|
*/
|
|
@@ -18034,6 +19818,27 @@ export declare function ActionsApiAxiosParamCreator_ManageWorkspacePermissions(w
|
|
|
18034
19818
|
* @throws {RequiredError}
|
|
18035
19819
|
*/
|
|
18036
19820
|
export declare function ActionsApiAxiosParamCreator_MetricPermissions(workspaceId: string, metricId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
19821
|
+
/**
|
|
19822
|
+
* (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.
|
|
19823
|
+
* @summary (BETA) Workspaces with a localization issue.
|
|
19824
|
+
* @param {'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION'} type The type of the issue.
|
|
19825
|
+
* @param {string} locale The language of the issue.
|
|
19826
|
+
* @param {string} [name] Filter by workspace name. Note that the filter is case insensitive.
|
|
19827
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
19828
|
+
* @param {number} [size] The size of the page to be returned.
|
|
19829
|
+
* @param {*} [options] Override http request option.
|
|
19830
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
19831
|
+
* @throws {RequiredError}
|
|
19832
|
+
*/
|
|
19833
|
+
export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationIssueWorkspaces(type: 'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION', locale: string, name?: string, page?: number, size?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
19834
|
+
/**
|
|
19835
|
+
* (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.
|
|
19836
|
+
* @summary (BETA) Localization issues of the organization.
|
|
19837
|
+
* @param {*} [options] Override http request option.
|
|
19838
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
19839
|
+
* @throws {RequiredError}
|
|
19840
|
+
*/
|
|
19841
|
+
export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationIssues(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18037
19842
|
/**
|
|
18038
19843
|
* (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
|
|
18039
19844
|
* @summary (BETA) Languages with translations in the organization.
|
|
@@ -18051,7 +19856,7 @@ export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationStat
|
|
|
18051
19856
|
*/
|
|
18052
19857
|
export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationUsage(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18053
19858
|
/**
|
|
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.
|
|
19859
|
+
* (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
19860
|
* @summary (BETA) Users who set a language themselves.
|
|
18056
19861
|
* @param {string} [value] Language tag that the user sets.
|
|
18057
19862
|
* @param {string} [name] Filter by user name, email or login (user ID). Note that the filter is case insensitive.
|
|
@@ -18065,7 +19870,7 @@ export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationUsag
|
|
|
18065
19870
|
*/
|
|
18066
19871
|
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
19872
|
/**
|
|
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.
|
|
19873
|
+
* (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
19874
|
* @summary (BETA) Workspaces that use a language.
|
|
18070
19875
|
* @param {string} [value] Language tag that the workspace gets.
|
|
18071
19876
|
* @param {string} [name] Filter by workspace name. Note that the filter is case insensitive.
|
|
@@ -18317,6 +20122,15 @@ export declare function ActionsApiAxiosParamCreator_UnsubscribeSelectedWorkspace
|
|
|
18317
20122
|
* @throws {RequiredError}
|
|
18318
20123
|
*/
|
|
18319
20124
|
export declare function ActionsApiAxiosParamCreator_UnsubscribeWorkspaceAutomations(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20125
|
+
/**
|
|
20126
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
20127
|
+
* @summary Validate an embedding origin.
|
|
20128
|
+
* @param {ValidateEmbeddingOriginRequest} validateEmbeddingOriginRequest
|
|
20129
|
+
* @param {*} [options] Override http request option.
|
|
20130
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20131
|
+
* @throws {RequiredError}
|
|
20132
|
+
*/
|
|
20133
|
+
export declare function ActionsApiAxiosParamCreator_ValidateEmbeddingOrigin(validateEmbeddingOriginRequest: ValidateEmbeddingOriginRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18320
20134
|
/**
|
|
18321
20135
|
*
|
|
18322
20136
|
* @summary (BETA) Get Visualization Permissions
|
|
@@ -18328,14 +20142,24 @@ export declare function ActionsApiAxiosParamCreator_UnsubscribeWorkspaceAutomati
|
|
|
18328
20142
|
*/
|
|
18329
20143
|
export declare function ActionsApiAxiosParamCreator_VisualizationPermissions(workspaceId: string, visualizationObjectId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18330
20144
|
/**
|
|
18331
|
-
* (BETA)
|
|
20145
|
+
* (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses.
|
|
20146
|
+
* @summary (BETA) Localization issues of the workspace.
|
|
20147
|
+
* @param {string} workspaceId
|
|
20148
|
+
* @param {*} [options] Override http request option.
|
|
20149
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20150
|
+
* @throws {RequiredError}
|
|
20151
|
+
*/
|
|
20152
|
+
export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationIssues(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20153
|
+
/**
|
|
20154
|
+
* (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
20155
|
* @summary (BETA) Languages with translations in the workspace.
|
|
18333
20156
|
* @param {string} workspaceId
|
|
20157
|
+
* @param {boolean} [includeCoverage] Adds translation counts for the workspace and each parent, root first.
|
|
18334
20158
|
* @param {*} [options] Override http request option.
|
|
18335
20159
|
* @param {Configuration} [configuration] Optional configuration.
|
|
18336
20160
|
* @throws {RequiredError}
|
|
18337
20161
|
*/
|
|
18338
|
-
export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationStatistics(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20162
|
+
export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationStatistics(workspaceId: string, includeCoverage?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18339
20163
|
/**
|
|
18340
20164
|
* (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
20165
|
* @summary (BETA) Languages used in the workspace.
|
|
@@ -18346,7 +20170,7 @@ export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationStatist
|
|
|
18346
20170
|
*/
|
|
18347
20171
|
export declare function ActionsApiAxiosParamCreator_WorkspaceLocalizationUsage(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18348
20172
|
/**
|
|
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.
|
|
20173
|
+
* (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
20174
|
* @summary (BETA) Workspace members who get a language.
|
|
18351
20175
|
* @param {string} workspaceId
|
|
18352
20176
|
* @param {string} [value] Language tag that the user gets.
|
|
@@ -18730,6 +20554,27 @@ export declare function ActionsApi_ManageWorkspacePermissions(axios: AxiosInstan
|
|
|
18730
20554
|
* @throws {RequiredError}
|
|
18731
20555
|
*/
|
|
18732
20556
|
export declare function ActionsApi_MetricPermissions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<MetricPermissions>;
|
|
20557
|
+
/**
|
|
20558
|
+
* (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.
|
|
20559
|
+
* @summary (BETA) Workspaces with a localization issue.
|
|
20560
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
20561
|
+
* @param {string} basePath Base path.
|
|
20562
|
+
* @param {ActionsApiOrganizationLocalizationIssueWorkspacesRequest} requestParameters Request parameters.
|
|
20563
|
+
* @param {*} [options] Override http request option.
|
|
20564
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20565
|
+
* @throws {RequiredError}
|
|
20566
|
+
*/
|
|
20567
|
+
export declare function ActionsApi_OrganizationLocalizationIssueWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiOrganizationLocalizationIssueWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationIssueWorkspaces>;
|
|
20568
|
+
/**
|
|
20569
|
+
* (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.
|
|
20570
|
+
* @summary (BETA) Localization issues of the organization.
|
|
20571
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
20572
|
+
* @param {string} basePath Base path.
|
|
20573
|
+
* @param {*} [options] Override http request option.
|
|
20574
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20575
|
+
* @throws {RequiredError}
|
|
20576
|
+
*/
|
|
20577
|
+
export declare function ActionsApi_OrganizationLocalizationIssues(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationIssues>;
|
|
18733
20578
|
/**
|
|
18734
20579
|
* (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
|
|
18735
20580
|
* @summary (BETA) Languages with translations in the organization.
|
|
@@ -18751,7 +20596,7 @@ export declare function ActionsApi_OrganizationLocalizationStatistics(axios: Axi
|
|
|
18751
20596
|
*/
|
|
18752
20597
|
export declare function ActionsApi_OrganizationLocalizationUsage(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsage>;
|
|
18753
20598
|
/**
|
|
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.
|
|
20599
|
+
* (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
20600
|
* @summary (BETA) Users who set a language themselves.
|
|
18756
20601
|
* @param {AxiosInstance} axios Axios instance.
|
|
18757
20602
|
* @param {string} basePath Base path.
|
|
@@ -18762,7 +20607,7 @@ export declare function ActionsApi_OrganizationLocalizationUsage(axios: AxiosIns
|
|
|
18762
20607
|
*/
|
|
18763
20608
|
export declare function ActionsApi_OrganizationLocalizationUsageUsers(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsageUsers>;
|
|
18764
20609
|
/**
|
|
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.
|
|
20610
|
+
* (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
20611
|
* @summary (BETA) Workspaces that use a language.
|
|
18767
20612
|
* @param {AxiosInstance} axios Axios instance.
|
|
18768
20613
|
* @param {string} basePath Base path.
|
|
@@ -19054,6 +20899,17 @@ export declare function ActionsApi_UnsubscribeSelectedWorkspaceAutomations(axios
|
|
|
19054
20899
|
* @throws {RequiredError}
|
|
19055
20900
|
*/
|
|
19056
20901
|
export declare function ActionsApi_UnsubscribeWorkspaceAutomations(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
20902
|
+
/**
|
|
20903
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
20904
|
+
* @summary Validate an embedding origin.
|
|
20905
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
20906
|
+
* @param {string} basePath Base path.
|
|
20907
|
+
* @param {ActionsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
20908
|
+
* @param {*} [options] Override http request option.
|
|
20909
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20910
|
+
* @throws {RequiredError}
|
|
20911
|
+
*/
|
|
20912
|
+
export declare function ActionsApi_ValidateEmbeddingOrigin(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
19057
20913
|
/**
|
|
19058
20914
|
*
|
|
19059
20915
|
* @summary (BETA) Get Visualization Permissions
|
|
@@ -19066,7 +20922,18 @@ export declare function ActionsApi_UnsubscribeWorkspaceAutomations(axios: AxiosI
|
|
|
19066
20922
|
*/
|
|
19067
20923
|
export declare function ActionsApi_VisualizationPermissions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiVisualizationPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<VisualizationPermissions>;
|
|
19068
20924
|
/**
|
|
19069
|
-
* (BETA)
|
|
20925
|
+
* (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses.
|
|
20926
|
+
* @summary (BETA) Localization issues of the workspace.
|
|
20927
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
20928
|
+
* @param {string} basePath Base path.
|
|
20929
|
+
* @param {ActionsApiWorkspaceLocalizationIssuesRequest} requestParameters Request parameters.
|
|
20930
|
+
* @param {*} [options] Override http request option.
|
|
20931
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20932
|
+
* @throws {RequiredError}
|
|
20933
|
+
*/
|
|
20934
|
+
export declare function ActionsApi_WorkspaceLocalizationIssues(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiWorkspaceLocalizationIssuesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationIssues>;
|
|
20935
|
+
/**
|
|
20936
|
+
* (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
20937
|
* @summary (BETA) Languages with translations in the workspace.
|
|
19071
20938
|
* @param {AxiosInstance} axios Axios instance.
|
|
19072
20939
|
* @param {string} basePath Base path.
|
|
@@ -19088,7 +20955,7 @@ export declare function ActionsApi_WorkspaceLocalizationStatistics(axios: AxiosI
|
|
|
19088
20955
|
*/
|
|
19089
20956
|
export declare function ActionsApi_WorkspaceLocalizationUsage(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
19090
20957
|
/**
|
|
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.
|
|
20958
|
+
* (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
20959
|
* @summary (BETA) Workspace members who get a language.
|
|
19093
20960
|
* @param {AxiosInstance} axios Axios instance.
|
|
19094
20961
|
* @param {string} basePath Base path.
|
|
@@ -19411,6 +21278,23 @@ export interface ActionsApiInterface {
|
|
|
19411
21278
|
* @memberof ActionsApiInterface
|
|
19412
21279
|
*/
|
|
19413
21280
|
metricPermissions(requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<MetricPermissions>;
|
|
21281
|
+
/**
|
|
21282
|
+
* (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.
|
|
21283
|
+
* @summary (BETA) Workspaces with a localization issue.
|
|
21284
|
+
* @param {ActionsApiOrganizationLocalizationIssueWorkspacesRequest} requestParameters Request parameters.
|
|
21285
|
+
* @param {*} [options] Override http request option.
|
|
21286
|
+
* @throws {RequiredError}
|
|
21287
|
+
* @memberof ActionsApiInterface
|
|
21288
|
+
*/
|
|
21289
|
+
organizationLocalizationIssueWorkspaces(requestParameters: ActionsApiOrganizationLocalizationIssueWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationIssueWorkspaces>;
|
|
21290
|
+
/**
|
|
21291
|
+
* (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.
|
|
21292
|
+
* @summary (BETA) Localization issues of the organization.
|
|
21293
|
+
* @param {*} [options] Override http request option.
|
|
21294
|
+
* @throws {RequiredError}
|
|
21295
|
+
* @memberof ActionsApiInterface
|
|
21296
|
+
*/
|
|
21297
|
+
organizationLocalizationIssues(options?: AxiosRequestConfig): AxiosPromise<LocalizationIssues>;
|
|
19414
21298
|
/**
|
|
19415
21299
|
* (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
|
|
19416
21300
|
* @summary (BETA) Languages with translations in the organization.
|
|
@@ -19428,7 +21312,7 @@ export interface ActionsApiInterface {
|
|
|
19428
21312
|
*/
|
|
19429
21313
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
19430
21314
|
/**
|
|
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.
|
|
21315
|
+
* (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
21316
|
* @summary (BETA) Users who set a language themselves.
|
|
19433
21317
|
* @param {ActionsApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
19434
21318
|
* @param {*} [options] Override http request option.
|
|
@@ -19437,7 +21321,7 @@ export interface ActionsApiInterface {
|
|
|
19437
21321
|
*/
|
|
19438
21322
|
organizationLocalizationUsageUsers(requestParameters: ActionsApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
19439
21323
|
/**
|
|
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.
|
|
21324
|
+
* (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
21325
|
* @summary (BETA) Workspaces that use a language.
|
|
19442
21326
|
* @param {ActionsApiOrganizationLocalizationUsageWorkspacesRequest} requestParameters Request parameters.
|
|
19443
21327
|
* @param {*} [options] Override http request option.
|
|
@@ -19675,6 +21559,15 @@ export interface ActionsApiInterface {
|
|
|
19675
21559
|
* @memberof ActionsApiInterface
|
|
19676
21560
|
*/
|
|
19677
21561
|
unsubscribeWorkspaceAutomations(requestParameters: ActionsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
21562
|
+
/**
|
|
21563
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
21564
|
+
* @summary Validate an embedding origin.
|
|
21565
|
+
* @param {ActionsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
21566
|
+
* @param {*} [options] Override http request option.
|
|
21567
|
+
* @throws {RequiredError}
|
|
21568
|
+
* @memberof ActionsApiInterface
|
|
21569
|
+
*/
|
|
21570
|
+
validateEmbeddingOrigin(requestParameters: ActionsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
19678
21571
|
/**
|
|
19679
21572
|
*
|
|
19680
21573
|
* @summary (BETA) Get Visualization Permissions
|
|
@@ -19685,7 +21578,16 @@ export interface ActionsApiInterface {
|
|
|
19685
21578
|
*/
|
|
19686
21579
|
visualizationPermissions(requestParameters: ActionsApiVisualizationPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<VisualizationPermissions>;
|
|
19687
21580
|
/**
|
|
19688
|
-
* (BETA)
|
|
21581
|
+
* (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses.
|
|
21582
|
+
* @summary (BETA) Localization issues of the workspace.
|
|
21583
|
+
* @param {ActionsApiWorkspaceLocalizationIssuesRequest} requestParameters Request parameters.
|
|
21584
|
+
* @param {*} [options] Override http request option.
|
|
21585
|
+
* @throws {RequiredError}
|
|
21586
|
+
* @memberof ActionsApiInterface
|
|
21587
|
+
*/
|
|
21588
|
+
workspaceLocalizationIssues(requestParameters: ActionsApiWorkspaceLocalizationIssuesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationIssues>;
|
|
21589
|
+
/**
|
|
21590
|
+
* (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
21591
|
* @summary (BETA) Languages with translations in the workspace.
|
|
19690
21592
|
* @param {ActionsApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
19691
21593
|
* @param {*} [options] Override http request option.
|
|
@@ -19703,7 +21605,7 @@ export interface ActionsApiInterface {
|
|
|
19703
21605
|
*/
|
|
19704
21606
|
workspaceLocalizationUsage(requestParameters: ActionsApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
19705
21607
|
/**
|
|
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.
|
|
21608
|
+
* (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
21609
|
* @summary (BETA) Workspace members who get a language.
|
|
19708
21610
|
* @param {ActionsApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
19709
21611
|
* @param {*} [options] Override http request option.
|
|
@@ -20343,6 +22245,43 @@ export interface ActionsApiMetricPermissionsRequest {
|
|
|
20343
22245
|
*/
|
|
20344
22246
|
readonly metricId: string;
|
|
20345
22247
|
}
|
|
22248
|
+
/**
|
|
22249
|
+
* Request parameters for organizationLocalizationIssueWorkspaces operation in ActionsApi.
|
|
22250
|
+
* @export
|
|
22251
|
+
* @interface ActionsApiOrganizationLocalizationIssueWorkspacesRequest
|
|
22252
|
+
*/
|
|
22253
|
+
export interface ActionsApiOrganizationLocalizationIssueWorkspacesRequest {
|
|
22254
|
+
/**
|
|
22255
|
+
* The type of the issue.
|
|
22256
|
+
* @type {'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION'}
|
|
22257
|
+
* @memberof ActionsApiOrganizationLocalizationIssueWorkspaces
|
|
22258
|
+
*/
|
|
22259
|
+
readonly type: 'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION';
|
|
22260
|
+
/**
|
|
22261
|
+
* The language of the issue.
|
|
22262
|
+
* @type {string}
|
|
22263
|
+
* @memberof ActionsApiOrganizationLocalizationIssueWorkspaces
|
|
22264
|
+
*/
|
|
22265
|
+
readonly locale: string;
|
|
22266
|
+
/**
|
|
22267
|
+
* Filter by workspace name. Note that the filter is case insensitive.
|
|
22268
|
+
* @type {string}
|
|
22269
|
+
* @memberof ActionsApiOrganizationLocalizationIssueWorkspaces
|
|
22270
|
+
*/
|
|
22271
|
+
readonly name?: string;
|
|
22272
|
+
/**
|
|
22273
|
+
* Zero-based page index (0..N)
|
|
22274
|
+
* @type {number}
|
|
22275
|
+
* @memberof ActionsApiOrganizationLocalizationIssueWorkspaces
|
|
22276
|
+
*/
|
|
22277
|
+
readonly page?: number;
|
|
22278
|
+
/**
|
|
22279
|
+
* The size of the page to be returned.
|
|
22280
|
+
* @type {number}
|
|
22281
|
+
* @memberof ActionsApiOrganizationLocalizationIssueWorkspaces
|
|
22282
|
+
*/
|
|
22283
|
+
readonly size?: number;
|
|
22284
|
+
}
|
|
20346
22285
|
/**
|
|
20347
22286
|
* Request parameters for organizationLocalizationUsageUsers operation in ActionsApi.
|
|
20348
22287
|
* @export
|
|
@@ -20769,6 +22708,19 @@ export interface ActionsApiUnsubscribeWorkspaceAutomationsRequest {
|
|
|
20769
22708
|
*/
|
|
20770
22709
|
readonly workspaceId: string;
|
|
20771
22710
|
}
|
|
22711
|
+
/**
|
|
22712
|
+
* Request parameters for validateEmbeddingOrigin operation in ActionsApi.
|
|
22713
|
+
* @export
|
|
22714
|
+
* @interface ActionsApiValidateEmbeddingOriginRequest
|
|
22715
|
+
*/
|
|
22716
|
+
export interface ActionsApiValidateEmbeddingOriginRequest {
|
|
22717
|
+
/**
|
|
22718
|
+
*
|
|
22719
|
+
* @type {ValidateEmbeddingOriginRequest}
|
|
22720
|
+
* @memberof ActionsApiValidateEmbeddingOrigin
|
|
22721
|
+
*/
|
|
22722
|
+
readonly validateEmbeddingOriginRequest: ValidateEmbeddingOriginRequest;
|
|
22723
|
+
}
|
|
20772
22724
|
/**
|
|
20773
22725
|
* Request parameters for visualizationPermissions operation in ActionsApi.
|
|
20774
22726
|
* @export
|
|
@@ -20788,6 +22740,19 @@ export interface ActionsApiVisualizationPermissionsRequest {
|
|
|
20788
22740
|
*/
|
|
20789
22741
|
readonly visualizationObjectId: string;
|
|
20790
22742
|
}
|
|
22743
|
+
/**
|
|
22744
|
+
* Request parameters for workspaceLocalizationIssues operation in ActionsApi.
|
|
22745
|
+
* @export
|
|
22746
|
+
* @interface ActionsApiWorkspaceLocalizationIssuesRequest
|
|
22747
|
+
*/
|
|
22748
|
+
export interface ActionsApiWorkspaceLocalizationIssuesRequest {
|
|
22749
|
+
/**
|
|
22750
|
+
*
|
|
22751
|
+
* @type {string}
|
|
22752
|
+
* @memberof ActionsApiWorkspaceLocalizationIssues
|
|
22753
|
+
*/
|
|
22754
|
+
readonly workspaceId: string;
|
|
22755
|
+
}
|
|
20791
22756
|
/**
|
|
20792
22757
|
* Request parameters for workspaceLocalizationStatistics operation in ActionsApi.
|
|
20793
22758
|
* @export
|
|
@@ -20800,6 +22765,12 @@ export interface ActionsApiWorkspaceLocalizationStatisticsRequest {
|
|
|
20800
22765
|
* @memberof ActionsApiWorkspaceLocalizationStatistics
|
|
20801
22766
|
*/
|
|
20802
22767
|
readonly workspaceId: string;
|
|
22768
|
+
/**
|
|
22769
|
+
* Adds translation counts for the workspace and each parent, root first.
|
|
22770
|
+
* @type {boolean}
|
|
22771
|
+
* @memberof ActionsApiWorkspaceLocalizationStatistics
|
|
22772
|
+
*/
|
|
22773
|
+
readonly includeCoverage?: boolean;
|
|
20803
22774
|
}
|
|
20804
22775
|
/**
|
|
20805
22776
|
* Request parameters for workspaceLocalizationUsage operation in ActionsApi.
|
|
@@ -21199,6 +23170,23 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21199
23170
|
* @memberof ActionsApi
|
|
21200
23171
|
*/
|
|
21201
23172
|
metricPermissions(requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<MetricPermissions>;
|
|
23173
|
+
/**
|
|
23174
|
+
* (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.
|
|
23175
|
+
* @summary (BETA) Workspaces with a localization issue.
|
|
23176
|
+
* @param {ActionsApiOrganizationLocalizationIssueWorkspacesRequest} requestParameters Request parameters.
|
|
23177
|
+
* @param {*} [options] Override http request option.
|
|
23178
|
+
* @throws {RequiredError}
|
|
23179
|
+
* @memberof ActionsApi
|
|
23180
|
+
*/
|
|
23181
|
+
organizationLocalizationIssueWorkspaces(requestParameters: ActionsApiOrganizationLocalizationIssueWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationIssueWorkspaces>;
|
|
23182
|
+
/**
|
|
23183
|
+
* (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.
|
|
23184
|
+
* @summary (BETA) Localization issues of the organization.
|
|
23185
|
+
* @param {*} [options] Override http request option.
|
|
23186
|
+
* @throws {RequiredError}
|
|
23187
|
+
* @memberof ActionsApi
|
|
23188
|
+
*/
|
|
23189
|
+
organizationLocalizationIssues(options?: AxiosRequestConfig): AxiosPromise<LocalizationIssues>;
|
|
21202
23190
|
/**
|
|
21203
23191
|
* (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
|
|
21204
23192
|
* @summary (BETA) Languages with translations in the organization.
|
|
@@ -21216,7 +23204,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21216
23204
|
*/
|
|
21217
23205
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
21218
23206
|
/**
|
|
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.
|
|
23207
|
+
* (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
23208
|
* @summary (BETA) Users who set a language themselves.
|
|
21221
23209
|
* @param {ActionsApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
21222
23210
|
* @param {*} [options] Override http request option.
|
|
@@ -21225,7 +23213,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21225
23213
|
*/
|
|
21226
23214
|
organizationLocalizationUsageUsers(requestParameters?: ActionsApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
21227
23215
|
/**
|
|
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.
|
|
23216
|
+
* (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
23217
|
* @summary (BETA) Workspaces that use a language.
|
|
21230
23218
|
* @param {ActionsApiOrganizationLocalizationUsageWorkspacesRequest} requestParameters Request parameters.
|
|
21231
23219
|
* @param {*} [options] Override http request option.
|
|
@@ -21463,6 +23451,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21463
23451
|
* @memberof ActionsApi
|
|
21464
23452
|
*/
|
|
21465
23453
|
unsubscribeWorkspaceAutomations(requestParameters: ActionsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
23454
|
+
/**
|
|
23455
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
23456
|
+
* @summary Validate an embedding origin.
|
|
23457
|
+
* @param {ActionsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
23458
|
+
* @param {*} [options] Override http request option.
|
|
23459
|
+
* @throws {RequiredError}
|
|
23460
|
+
* @memberof ActionsApi
|
|
23461
|
+
*/
|
|
23462
|
+
validateEmbeddingOrigin(requestParameters: ActionsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
21466
23463
|
/**
|
|
21467
23464
|
*
|
|
21468
23465
|
* @summary (BETA) Get Visualization Permissions
|
|
@@ -21473,7 +23470,16 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21473
23470
|
*/
|
|
21474
23471
|
visualizationPermissions(requestParameters: ActionsApiVisualizationPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<VisualizationPermissions>;
|
|
21475
23472
|
/**
|
|
21476
|
-
* (BETA)
|
|
23473
|
+
* (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses.
|
|
23474
|
+
* @summary (BETA) Localization issues of the workspace.
|
|
23475
|
+
* @param {ActionsApiWorkspaceLocalizationIssuesRequest} requestParameters Request parameters.
|
|
23476
|
+
* @param {*} [options] Override http request option.
|
|
23477
|
+
* @throws {RequiredError}
|
|
23478
|
+
* @memberof ActionsApi
|
|
23479
|
+
*/
|
|
23480
|
+
workspaceLocalizationIssues(requestParameters: ActionsApiWorkspaceLocalizationIssuesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationIssues>;
|
|
23481
|
+
/**
|
|
23482
|
+
* (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
23483
|
* @summary (BETA) Languages with translations in the workspace.
|
|
21478
23484
|
* @param {ActionsApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
21479
23485
|
* @param {*} [options] Override http request option.
|
|
@@ -21491,7 +23497,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
21491
23497
|
*/
|
|
21492
23498
|
workspaceLocalizationUsage(requestParameters: ActionsApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
21493
23499
|
/**
|
|
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.
|
|
23500
|
+
* (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
23501
|
* @summary (BETA) Workspace members who get a language.
|
|
21496
23502
|
* @param {ActionsApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
21497
23503
|
* @param {*} [options] Override http request option.
|
|
@@ -38588,7 +40594,7 @@ export declare function DocumentControllerApiAxiosParamCreator_DeleteEntityDocum
|
|
|
38588
40594
|
* @param {string} workspaceId
|
|
38589
40595
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
38590
40596
|
* @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.
|
|
40597
|
+
* @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
40598
|
* @param {number} [page] Zero-based page index (0..N)
|
|
38593
40599
|
* @param {number} [size] The size of the page to be returned
|
|
38594
40600
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -38605,7 +40611,7 @@ export declare function DocumentControllerApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
38605
40611
|
* @param {string} workspaceId
|
|
38606
40612
|
* @param {string} objectId
|
|
38607
40613
|
* @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.
|
|
40614
|
+
* @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
40615
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
38610
40616
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38611
40617
|
* @param {*} [options] Override http request option.
|
|
@@ -39084,7 +41090,7 @@ export declare function DocumentTemplateControllerApiAxiosParamCreator_DeleteEnt
|
|
|
39084
41090
|
* @param {string} workspaceId
|
|
39085
41091
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
39086
41092
|
* @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' | '
|
|
41093
|
+
* @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
41094
|
* @param {number} [page] Zero-based page index (0..N)
|
|
39089
41095
|
* @param {number} [size] The size of the page to be returned
|
|
39090
41096
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -39101,7 +41107,7 @@ export declare function DocumentTemplateControllerApiAxiosParamCreator_GetAllEnt
|
|
|
39101
41107
|
* @param {string} workspaceId
|
|
39102
41108
|
* @param {string} objectId
|
|
39103
41109
|
* @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' | '
|
|
41110
|
+
* @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
41111
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
39106
41112
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39107
41113
|
* @param {*} [options] Override http request option.
|
|
@@ -40835,7 +42841,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesDocumentTempl
|
|
|
40835
42841
|
* @param {string} workspaceId
|
|
40836
42842
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
40837
42843
|
* @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.
|
|
42844
|
+
* @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
42845
|
* @param {number} [page] Zero-based page index (0..N)
|
|
40840
42846
|
* @param {number} [size] The size of the page to be returned
|
|
40841
42847
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -41131,7 +43137,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesOrgMemoryItem
|
|
|
41131
43137
|
*/
|
|
41132
43138
|
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
43139
|
/**
|
|
41134
|
-
*
|
|
43140
|
+
* 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
43141
|
* @summary Get all Page Templates
|
|
41136
43142
|
* @param {string} workspaceId
|
|
41137
43143
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
@@ -41170,7 +43176,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesParameters(wo
|
|
|
41170
43176
|
* @param {string} workspaceId
|
|
41171
43177
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
41172
43178
|
* @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' | '
|
|
43179
|
+
* @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
43180
|
* @param {number} [page] Zero-based page index (0..N)
|
|
41175
43181
|
* @param {number} [size] The size of the page to be returned
|
|
41176
43182
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -41694,7 +43700,7 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityDocumentTemplates(
|
|
|
41694
43700
|
* @param {string} workspaceId
|
|
41695
43701
|
* @param {string} objectId
|
|
41696
43702
|
* @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.
|
|
43703
|
+
* @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
43704
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
41699
43705
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
41700
43706
|
* @param {*} [options] Override http request option.
|
|
@@ -42001,7 +44007,7 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityReportTemplates(wo
|
|
|
42001
44007
|
* @param {string} workspaceId
|
|
42002
44008
|
* @param {string} objectId
|
|
42003
44009
|
* @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' | '
|
|
44010
|
+
* @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
44011
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
42006
44012
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
42007
44013
|
* @param {*} [options] Override http request option.
|
|
@@ -45180,7 +47186,7 @@ export declare function EntitiesApi_GetAllEntitiesOrgMemoryItems(axios: AxiosIns
|
|
|
45180
47186
|
*/
|
|
45181
47187
|
export declare function EntitiesApi_GetAllEntitiesOrganizationSettings(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiGetAllEntitiesOrganizationSettingsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiOrganizationSettingOutList>;
|
|
45182
47188
|
/**
|
|
45183
|
-
*
|
|
47189
|
+
* 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
47190
|
* @summary Get all Page Templates
|
|
45185
47191
|
* @param {AxiosInstance} axios Axios instance.
|
|
45186
47192
|
* @param {string} basePath Base path.
|
|
@@ -48666,7 +50672,7 @@ export interface EntitiesApiInterface {
|
|
|
48666
50672
|
*/
|
|
48667
50673
|
getAllEntitiesOrganizationSettings(requestParameters: EntitiesApiGetAllEntitiesOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationSettingOutList>;
|
|
48668
50674
|
/**
|
|
48669
|
-
*
|
|
50675
|
+
* 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
50676
|
* @summary Get all Page Templates
|
|
48671
50677
|
* @param {EntitiesApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
48672
50678
|
* @param {*} [options] Override http request option.
|
|
@@ -62536,7 +64542,7 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
62536
64542
|
*/
|
|
62537
64543
|
getAllEntitiesOrganizationSettings(requestParameters?: EntitiesApiGetAllEntitiesOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationSettingOutList>;
|
|
62538
64544
|
/**
|
|
62539
|
-
*
|
|
64545
|
+
* 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
64546
|
* @summary Get all Page Templates
|
|
62541
64547
|
* @param {EntitiesApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
62542
64548
|
* @param {*} [options] Override http request option.
|
|
@@ -79164,6 +81170,27 @@ export declare class LlmProviderControllerApi extends BaseAPI implements LlmProv
|
|
|
79164
81170
|
*/
|
|
79165
81171
|
updateEntityLlmProviders(requestParameters: LlmProviderControllerApiUpdateEntityLlmProvidersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmProviderOutDocument>;
|
|
79166
81172
|
}
|
|
81173
|
+
/**
|
|
81174
|
+
* (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.
|
|
81175
|
+
* @summary (BETA) Workspaces with a localization issue.
|
|
81176
|
+
* @param {'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION'} type The type of the issue.
|
|
81177
|
+
* @param {string} locale The language of the issue.
|
|
81178
|
+
* @param {string} [name] Filter by workspace name. Note that the filter is case insensitive.
|
|
81179
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
81180
|
+
* @param {number} [size] The size of the page to be returned.
|
|
81181
|
+
* @param {*} [options] Override http request option.
|
|
81182
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
81183
|
+
* @throws {RequiredError}
|
|
81184
|
+
*/
|
|
81185
|
+
export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizationIssueWorkspaces(type: 'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION', locale: string, name?: string, page?: number, size?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
81186
|
+
/**
|
|
81187
|
+
* (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.
|
|
81188
|
+
* @summary (BETA) Localization issues of the organization.
|
|
81189
|
+
* @param {*} [options] Override http request option.
|
|
81190
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
81191
|
+
* @throws {RequiredError}
|
|
81192
|
+
*/
|
|
81193
|
+
export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizationIssues(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79167
81194
|
/**
|
|
79168
81195
|
* (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
|
|
79169
81196
|
* @summary (BETA) Languages with translations in the organization.
|
|
@@ -79181,7 +81208,7 @@ export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizatio
|
|
|
79181
81208
|
*/
|
|
79182
81209
|
export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizationUsage(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79183
81210
|
/**
|
|
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.
|
|
81211
|
+
* (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
81212
|
* @summary (BETA) Users who set a language themselves.
|
|
79186
81213
|
* @param {string} [value] Language tag that the user sets.
|
|
79187
81214
|
* @param {string} [name] Filter by user name, email or login (user ID). Note that the filter is case insensitive.
|
|
@@ -79195,7 +81222,7 @@ export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizatio
|
|
|
79195
81222
|
*/
|
|
79196
81223
|
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
81224
|
/**
|
|
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.
|
|
81225
|
+
* (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
81226
|
* @summary (BETA) Workspaces that use a language.
|
|
79200
81227
|
* @param {string} [value] Language tag that the workspace gets.
|
|
79201
81228
|
* @param {string} [name] Filter by workspace name. Note that the filter is case insensitive.
|
|
@@ -79209,14 +81236,24 @@ export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizatio
|
|
|
79209
81236
|
*/
|
|
79210
81237
|
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
81238
|
/**
|
|
79212
|
-
* (BETA)
|
|
81239
|
+
* (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses.
|
|
81240
|
+
* @summary (BETA) Localization issues of the workspace.
|
|
81241
|
+
* @param {string} workspaceId
|
|
81242
|
+
* @param {*} [options] Override http request option.
|
|
81243
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
81244
|
+
* @throws {RequiredError}
|
|
81245
|
+
*/
|
|
81246
|
+
export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationIssues(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
81247
|
+
/**
|
|
81248
|
+
* (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
81249
|
* @summary (BETA) Languages with translations in the workspace.
|
|
79214
81250
|
* @param {string} workspaceId
|
|
81251
|
+
* @param {boolean} [includeCoverage] Adds translation counts for the workspace and each parent, root first.
|
|
79215
81252
|
* @param {*} [options] Override http request option.
|
|
79216
81253
|
* @param {Configuration} [configuration] Optional configuration.
|
|
79217
81254
|
* @throws {RequiredError}
|
|
79218
81255
|
*/
|
|
79219
|
-
export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationStatistics(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
81256
|
+
export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationStatistics(workspaceId: string, includeCoverage?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79220
81257
|
/**
|
|
79221
81258
|
* (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
81259
|
* @summary (BETA) Languages used in the workspace.
|
|
@@ -79227,7 +81264,7 @@ export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationSt
|
|
|
79227
81264
|
*/
|
|
79228
81265
|
export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationUsage(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
79229
81266
|
/**
|
|
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.
|
|
81267
|
+
* (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
81268
|
* @summary (BETA) Workspace members who get a language.
|
|
79232
81269
|
* @param {string} workspaceId
|
|
79233
81270
|
* @param {string} [value] Language tag that the user gets.
|
|
@@ -79241,6 +81278,27 @@ export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationUs
|
|
|
79241
81278
|
* @throws {RequiredError}
|
|
79242
81279
|
*/
|
|
79243
81280
|
export declare function LocalizationApiAxiosParamCreator_WorkspaceLocalizationUsageUsers(workspaceId: string, 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>;
|
|
81281
|
+
/**
|
|
81282
|
+
* (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.
|
|
81283
|
+
* @summary (BETA) Workspaces with a localization issue.
|
|
81284
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
81285
|
+
* @param {string} basePath Base path.
|
|
81286
|
+
* @param {LocalizationApiOrganizationLocalizationIssueWorkspacesRequest} requestParameters Request parameters.
|
|
81287
|
+
* @param {*} [options] Override http request option.
|
|
81288
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
81289
|
+
* @throws {RequiredError}
|
|
81290
|
+
*/
|
|
81291
|
+
export declare function LocalizationApi_OrganizationLocalizationIssueWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: LocalizationApiOrganizationLocalizationIssueWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationIssueWorkspaces>;
|
|
81292
|
+
/**
|
|
81293
|
+
* (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.
|
|
81294
|
+
* @summary (BETA) Localization issues of the organization.
|
|
81295
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
81296
|
+
* @param {string} basePath Base path.
|
|
81297
|
+
* @param {*} [options] Override http request option.
|
|
81298
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
81299
|
+
* @throws {RequiredError}
|
|
81300
|
+
*/
|
|
81301
|
+
export declare function LocalizationApi_OrganizationLocalizationIssues(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationIssues>;
|
|
79244
81302
|
/**
|
|
79245
81303
|
* (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
|
|
79246
81304
|
* @summary (BETA) Languages with translations in the organization.
|
|
@@ -79262,7 +81320,7 @@ export declare function LocalizationApi_OrganizationLocalizationStatistics(axios
|
|
|
79262
81320
|
*/
|
|
79263
81321
|
export declare function LocalizationApi_OrganizationLocalizationUsage(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsage>;
|
|
79264
81322
|
/**
|
|
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.
|
|
81323
|
+
* (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
81324
|
* @summary (BETA) Users who set a language themselves.
|
|
79267
81325
|
* @param {AxiosInstance} axios Axios instance.
|
|
79268
81326
|
* @param {string} basePath Base path.
|
|
@@ -79273,7 +81331,7 @@ export declare function LocalizationApi_OrganizationLocalizationUsage(axios: Axi
|
|
|
79273
81331
|
*/
|
|
79274
81332
|
export declare function LocalizationApi_OrganizationLocalizationUsageUsers(axios: AxiosInstance, basePath: string, requestParameters: LocalizationApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsageUsers>;
|
|
79275
81333
|
/**
|
|
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.
|
|
81334
|
+
* (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
81335
|
* @summary (BETA) Workspaces that use a language.
|
|
79278
81336
|
* @param {AxiosInstance} axios Axios instance.
|
|
79279
81337
|
* @param {string} basePath Base path.
|
|
@@ -79284,7 +81342,18 @@ export declare function LocalizationApi_OrganizationLocalizationUsageUsers(axios
|
|
|
79284
81342
|
*/
|
|
79285
81343
|
export declare function LocalizationApi_OrganizationLocalizationUsageWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: LocalizationApiOrganizationLocalizationUsageWorkspacesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationUsageWorkspaces>;
|
|
79286
81344
|
/**
|
|
79287
|
-
* (BETA)
|
|
81345
|
+
* (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses.
|
|
81346
|
+
* @summary (BETA) Localization issues of the workspace.
|
|
81347
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
81348
|
+
* @param {string} basePath Base path.
|
|
81349
|
+
* @param {LocalizationApiWorkspaceLocalizationIssuesRequest} requestParameters Request parameters.
|
|
81350
|
+
* @param {*} [options] Override http request option.
|
|
81351
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
81352
|
+
* @throws {RequiredError}
|
|
81353
|
+
*/
|
|
81354
|
+
export declare function LocalizationApi_WorkspaceLocalizationIssues(axios: AxiosInstance, basePath: string, requestParameters: LocalizationApiWorkspaceLocalizationIssuesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationIssues>;
|
|
81355
|
+
/**
|
|
81356
|
+
* (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
81357
|
* @summary (BETA) Languages with translations in the workspace.
|
|
79289
81358
|
* @param {AxiosInstance} axios Axios instance.
|
|
79290
81359
|
* @param {string} basePath Base path.
|
|
@@ -79306,7 +81375,7 @@ export declare function LocalizationApi_WorkspaceLocalizationStatistics(axios: A
|
|
|
79306
81375
|
*/
|
|
79307
81376
|
export declare function LocalizationApi_WorkspaceLocalizationUsage(axios: AxiosInstance, basePath: string, requestParameters: LocalizationApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
79308
81377
|
/**
|
|
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.
|
|
81378
|
+
* (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
81379
|
* @summary (BETA) Workspace members who get a language.
|
|
79311
81380
|
* @param {AxiosInstance} axios Axios instance.
|
|
79312
81381
|
* @param {string} basePath Base path.
|
|
@@ -79322,6 +81391,23 @@ export declare function LocalizationApi_WorkspaceLocalizationUsageUsers(axios: A
|
|
|
79322
81391
|
* @interface LocalizationApi
|
|
79323
81392
|
*/
|
|
79324
81393
|
export interface LocalizationApiInterface {
|
|
81394
|
+
/**
|
|
81395
|
+
* (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.
|
|
81396
|
+
* @summary (BETA) Workspaces with a localization issue.
|
|
81397
|
+
* @param {LocalizationApiOrganizationLocalizationIssueWorkspacesRequest} requestParameters Request parameters.
|
|
81398
|
+
* @param {*} [options] Override http request option.
|
|
81399
|
+
* @throws {RequiredError}
|
|
81400
|
+
* @memberof LocalizationApiInterface
|
|
81401
|
+
*/
|
|
81402
|
+
organizationLocalizationIssueWorkspaces(requestParameters: LocalizationApiOrganizationLocalizationIssueWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationIssueWorkspaces>;
|
|
81403
|
+
/**
|
|
81404
|
+
* (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.
|
|
81405
|
+
* @summary (BETA) Localization issues of the organization.
|
|
81406
|
+
* @param {*} [options] Override http request option.
|
|
81407
|
+
* @throws {RequiredError}
|
|
81408
|
+
* @memberof LocalizationApiInterface
|
|
81409
|
+
*/
|
|
81410
|
+
organizationLocalizationIssues(options?: AxiosRequestConfig): AxiosPromise<LocalizationIssues>;
|
|
79325
81411
|
/**
|
|
79326
81412
|
* (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
|
|
79327
81413
|
* @summary (BETA) Languages with translations in the organization.
|
|
@@ -79339,7 +81425,7 @@ export interface LocalizationApiInterface {
|
|
|
79339
81425
|
*/
|
|
79340
81426
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
79341
81427
|
/**
|
|
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.
|
|
81428
|
+
* (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
81429
|
* @summary (BETA) Users who set a language themselves.
|
|
79344
81430
|
* @param {LocalizationApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
79345
81431
|
* @param {*} [options] Override http request option.
|
|
@@ -79348,7 +81434,7 @@ export interface LocalizationApiInterface {
|
|
|
79348
81434
|
*/
|
|
79349
81435
|
organizationLocalizationUsageUsers(requestParameters: LocalizationApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
79350
81436
|
/**
|
|
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.
|
|
81437
|
+
* (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
81438
|
* @summary (BETA) Workspaces that use a language.
|
|
79353
81439
|
* @param {LocalizationApiOrganizationLocalizationUsageWorkspacesRequest} requestParameters Request parameters.
|
|
79354
81440
|
* @param {*} [options] Override http request option.
|
|
@@ -79357,7 +81443,16 @@ export interface LocalizationApiInterface {
|
|
|
79357
81443
|
*/
|
|
79358
81444
|
organizationLocalizationUsageWorkspaces(requestParameters: LocalizationApiOrganizationLocalizationUsageWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageWorkspaces>;
|
|
79359
81445
|
/**
|
|
79360
|
-
* (BETA)
|
|
81446
|
+
* (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses.
|
|
81447
|
+
* @summary (BETA) Localization issues of the workspace.
|
|
81448
|
+
* @param {LocalizationApiWorkspaceLocalizationIssuesRequest} requestParameters Request parameters.
|
|
81449
|
+
* @param {*} [options] Override http request option.
|
|
81450
|
+
* @throws {RequiredError}
|
|
81451
|
+
* @memberof LocalizationApiInterface
|
|
81452
|
+
*/
|
|
81453
|
+
workspaceLocalizationIssues(requestParameters: LocalizationApiWorkspaceLocalizationIssuesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationIssues>;
|
|
81454
|
+
/**
|
|
81455
|
+
* (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
81456
|
* @summary (BETA) Languages with translations in the workspace.
|
|
79362
81457
|
* @param {LocalizationApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
79363
81458
|
* @param {*} [options] Override http request option.
|
|
@@ -79375,7 +81470,7 @@ export interface LocalizationApiInterface {
|
|
|
79375
81470
|
*/
|
|
79376
81471
|
workspaceLocalizationUsage(requestParameters: LocalizationApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
79377
81472
|
/**
|
|
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.
|
|
81473
|
+
* (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
81474
|
* @summary (BETA) Workspace members who get a language.
|
|
79380
81475
|
* @param {LocalizationApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
79381
81476
|
* @param {*} [options] Override http request option.
|
|
@@ -79384,6 +81479,43 @@ export interface LocalizationApiInterface {
|
|
|
79384
81479
|
*/
|
|
79385
81480
|
workspaceLocalizationUsageUsers(requestParameters: LocalizationApiWorkspaceLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
79386
81481
|
}
|
|
81482
|
+
/**
|
|
81483
|
+
* Request parameters for organizationLocalizationIssueWorkspaces operation in LocalizationApi.
|
|
81484
|
+
* @export
|
|
81485
|
+
* @interface LocalizationApiOrganizationLocalizationIssueWorkspacesRequest
|
|
81486
|
+
*/
|
|
81487
|
+
export interface LocalizationApiOrganizationLocalizationIssueWorkspacesRequest {
|
|
81488
|
+
/**
|
|
81489
|
+
* The type of the issue.
|
|
81490
|
+
* @type {'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION'}
|
|
81491
|
+
* @memberof LocalizationApiOrganizationLocalizationIssueWorkspaces
|
|
81492
|
+
*/
|
|
81493
|
+
readonly type: 'METADATA_MISSING_TRANSLATION' | 'METADATA_LANGUAGE_MISMATCH' | 'METADATA_UNUSED_TRANSLATION';
|
|
81494
|
+
/**
|
|
81495
|
+
* The language of the issue.
|
|
81496
|
+
* @type {string}
|
|
81497
|
+
* @memberof LocalizationApiOrganizationLocalizationIssueWorkspaces
|
|
81498
|
+
*/
|
|
81499
|
+
readonly locale: string;
|
|
81500
|
+
/**
|
|
81501
|
+
* Filter by workspace name. Note that the filter is case insensitive.
|
|
81502
|
+
* @type {string}
|
|
81503
|
+
* @memberof LocalizationApiOrganizationLocalizationIssueWorkspaces
|
|
81504
|
+
*/
|
|
81505
|
+
readonly name?: string;
|
|
81506
|
+
/**
|
|
81507
|
+
* Zero-based page index (0..N)
|
|
81508
|
+
* @type {number}
|
|
81509
|
+
* @memberof LocalizationApiOrganizationLocalizationIssueWorkspaces
|
|
81510
|
+
*/
|
|
81511
|
+
readonly page?: number;
|
|
81512
|
+
/**
|
|
81513
|
+
* The size of the page to be returned.
|
|
81514
|
+
* @type {number}
|
|
81515
|
+
* @memberof LocalizationApiOrganizationLocalizationIssueWorkspaces
|
|
81516
|
+
*/
|
|
81517
|
+
readonly size?: number;
|
|
81518
|
+
}
|
|
79387
81519
|
/**
|
|
79388
81520
|
* Request parameters for organizationLocalizationUsageUsers operation in LocalizationApi.
|
|
79389
81521
|
* @export
|
|
@@ -79470,6 +81602,19 @@ export interface LocalizationApiOrganizationLocalizationUsageWorkspacesRequest {
|
|
|
79470
81602
|
*/
|
|
79471
81603
|
readonly size?: number;
|
|
79472
81604
|
}
|
|
81605
|
+
/**
|
|
81606
|
+
* Request parameters for workspaceLocalizationIssues operation in LocalizationApi.
|
|
81607
|
+
* @export
|
|
81608
|
+
* @interface LocalizationApiWorkspaceLocalizationIssuesRequest
|
|
81609
|
+
*/
|
|
81610
|
+
export interface LocalizationApiWorkspaceLocalizationIssuesRequest {
|
|
81611
|
+
/**
|
|
81612
|
+
*
|
|
81613
|
+
* @type {string}
|
|
81614
|
+
* @memberof LocalizationApiWorkspaceLocalizationIssues
|
|
81615
|
+
*/
|
|
81616
|
+
readonly workspaceId: string;
|
|
81617
|
+
}
|
|
79473
81618
|
/**
|
|
79474
81619
|
* Request parameters for workspaceLocalizationStatistics operation in LocalizationApi.
|
|
79475
81620
|
* @export
|
|
@@ -79482,6 +81627,12 @@ export interface LocalizationApiWorkspaceLocalizationStatisticsRequest {
|
|
|
79482
81627
|
* @memberof LocalizationApiWorkspaceLocalizationStatistics
|
|
79483
81628
|
*/
|
|
79484
81629
|
readonly workspaceId: string;
|
|
81630
|
+
/**
|
|
81631
|
+
* Adds translation counts for the workspace and each parent, root first.
|
|
81632
|
+
* @type {boolean}
|
|
81633
|
+
* @memberof LocalizationApiWorkspaceLocalizationStatistics
|
|
81634
|
+
*/
|
|
81635
|
+
readonly includeCoverage?: boolean;
|
|
79485
81636
|
}
|
|
79486
81637
|
/**
|
|
79487
81638
|
* Request parameters for workspaceLocalizationUsage operation in LocalizationApi.
|
|
@@ -79552,6 +81703,23 @@ export interface LocalizationApiWorkspaceLocalizationUsageUsersRequest {
|
|
|
79552
81703
|
* @extends {BaseAPI}
|
|
79553
81704
|
*/
|
|
79554
81705
|
export declare class LocalizationApi extends BaseAPI implements LocalizationApiInterface {
|
|
81706
|
+
/**
|
|
81707
|
+
* (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.
|
|
81708
|
+
* @summary (BETA) Workspaces with a localization issue.
|
|
81709
|
+
* @param {LocalizationApiOrganizationLocalizationIssueWorkspacesRequest} requestParameters Request parameters.
|
|
81710
|
+
* @param {*} [options] Override http request option.
|
|
81711
|
+
* @throws {RequiredError}
|
|
81712
|
+
* @memberof LocalizationApi
|
|
81713
|
+
*/
|
|
81714
|
+
organizationLocalizationIssueWorkspaces(requestParameters: LocalizationApiOrganizationLocalizationIssueWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationIssueWorkspaces>;
|
|
81715
|
+
/**
|
|
81716
|
+
* (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.
|
|
81717
|
+
* @summary (BETA) Localization issues of the organization.
|
|
81718
|
+
* @param {*} [options] Override http request option.
|
|
81719
|
+
* @throws {RequiredError}
|
|
81720
|
+
* @memberof LocalizationApi
|
|
81721
|
+
*/
|
|
81722
|
+
organizationLocalizationIssues(options?: AxiosRequestConfig): AxiosPromise<LocalizationIssues>;
|
|
79555
81723
|
/**
|
|
79556
81724
|
* (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
|
|
79557
81725
|
* @summary (BETA) Languages with translations in the organization.
|
|
@@ -79569,7 +81737,7 @@ export declare class LocalizationApi extends BaseAPI implements LocalizationApiI
|
|
|
79569
81737
|
*/
|
|
79570
81738
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
79571
81739
|
/**
|
|
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.
|
|
81740
|
+
* (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
81741
|
* @summary (BETA) Users who set a language themselves.
|
|
79574
81742
|
* @param {LocalizationApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
79575
81743
|
* @param {*} [options] Override http request option.
|
|
@@ -79578,7 +81746,7 @@ export declare class LocalizationApi extends BaseAPI implements LocalizationApiI
|
|
|
79578
81746
|
*/
|
|
79579
81747
|
organizationLocalizationUsageUsers(requestParameters?: LocalizationApiOrganizationLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
79580
81748
|
/**
|
|
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.
|
|
81749
|
+
* (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
81750
|
* @summary (BETA) Workspaces that use a language.
|
|
79583
81751
|
* @param {LocalizationApiOrganizationLocalizationUsageWorkspacesRequest} requestParameters Request parameters.
|
|
79584
81752
|
* @param {*} [options] Override http request option.
|
|
@@ -79587,7 +81755,16 @@ export declare class LocalizationApi extends BaseAPI implements LocalizationApiI
|
|
|
79587
81755
|
*/
|
|
79588
81756
|
organizationLocalizationUsageWorkspaces(requestParameters?: LocalizationApiOrganizationLocalizationUsageWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageWorkspaces>;
|
|
79589
81757
|
/**
|
|
79590
|
-
* (BETA)
|
|
81758
|
+
* (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses.
|
|
81759
|
+
* @summary (BETA) Localization issues of the workspace.
|
|
81760
|
+
* @param {LocalizationApiWorkspaceLocalizationIssuesRequest} requestParameters Request parameters.
|
|
81761
|
+
* @param {*} [options] Override http request option.
|
|
81762
|
+
* @throws {RequiredError}
|
|
81763
|
+
* @memberof LocalizationApi
|
|
81764
|
+
*/
|
|
81765
|
+
workspaceLocalizationIssues(requestParameters: LocalizationApiWorkspaceLocalizationIssuesRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationIssues>;
|
|
81766
|
+
/**
|
|
81767
|
+
* (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
81768
|
* @summary (BETA) Languages with translations in the workspace.
|
|
79592
81769
|
* @param {LocalizationApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
79593
81770
|
* @param {*} [options] Override http request option.
|
|
@@ -79605,7 +81782,7 @@ export declare class LocalizationApi extends BaseAPI implements LocalizationApiI
|
|
|
79605
81782
|
*/
|
|
79606
81783
|
workspaceLocalizationUsage(requestParameters: LocalizationApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
79607
81784
|
/**
|
|
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.
|
|
81785
|
+
* (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
81786
|
* @summary (BETA) Workspace members who get a language.
|
|
79610
81787
|
* @param {LocalizationApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
79611
81788
|
* @param {*} [options] Override http request option.
|
|
@@ -86289,7 +88466,7 @@ export declare function PageTemplateControllerApiAxiosParamCreator_CreateEntityP
|
|
|
86289
88466
|
*/
|
|
86290
88467
|
export declare function PageTemplateControllerApiAxiosParamCreator_DeleteEntityPageTemplates(workspaceId: string, objectId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86291
88468
|
/**
|
|
86292
|
-
*
|
|
88469
|
+
* 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
88470
|
* @summary Get all Page Templates
|
|
86294
88471
|
* @param {string} workspaceId
|
|
86295
88472
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
@@ -86368,7 +88545,7 @@ export declare function PageTemplateControllerApi_CreateEntityPageTemplates(axio
|
|
|
86368
88545
|
*/
|
|
86369
88546
|
export declare function PageTemplateControllerApi_DeleteEntityPageTemplates(axios: AxiosInstance, basePath: string, requestParameters: PageTemplateControllerApiDeleteEntityPageTemplatesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
86370
88547
|
/**
|
|
86371
|
-
*
|
|
88548
|
+
* 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
88549
|
* @summary Get all Page Templates
|
|
86373
88550
|
* @param {AxiosInstance} axios Axios instance.
|
|
86374
88551
|
* @param {string} basePath Base path.
|
|
@@ -86436,7 +88613,7 @@ export interface PageTemplateControllerApiInterface {
|
|
|
86436
88613
|
*/
|
|
86437
88614
|
deleteEntityPageTemplates(requestParameters: PageTemplateControllerApiDeleteEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
86438
88615
|
/**
|
|
86439
|
-
*
|
|
88616
|
+
* 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
88617
|
* @summary Get all Page Templates
|
|
86441
88618
|
* @param {PageTemplateControllerApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
86442
88619
|
* @param {*} [options] Override http request option.
|
|
@@ -86726,7 +88903,7 @@ export declare class PageTemplateControllerApi extends BaseAPI implements PageTe
|
|
|
86726
88903
|
*/
|
|
86727
88904
|
deleteEntityPageTemplates(requestParameters: PageTemplateControllerApiDeleteEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
86728
88905
|
/**
|
|
86729
|
-
*
|
|
88906
|
+
* 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
88907
|
* @summary Get all Page Templates
|
|
86731
88908
|
* @param {PageTemplateControllerApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
86732
88909
|
* @param {*} [options] Override http request option.
|
|
@@ -90068,7 +92245,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
90068
92245
|
* @param {string} workspaceId
|
|
90069
92246
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
90070
92247
|
* @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.
|
|
92248
|
+
* @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
92249
|
* @param {number} [page] Zero-based page index (0..N)
|
|
90073
92250
|
* @param {number} [size] The size of the page to be returned
|
|
90074
92251
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -90080,7 +92257,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
90080
92257
|
*/
|
|
90081
92258
|
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
92259
|
/**
|
|
90083
|
-
*
|
|
92260
|
+
* 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
92261
|
* @summary Get all Page Templates
|
|
90085
92262
|
* @param {string} workspaceId
|
|
90086
92263
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
@@ -90116,7 +92293,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetEntityDocument
|
|
|
90116
92293
|
* @param {string} workspaceId
|
|
90117
92294
|
* @param {string} objectId
|
|
90118
92295
|
* @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.
|
|
92296
|
+
* @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
92297
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
90121
92298
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
90122
92299
|
* @param {*} [options] Override http request option.
|
|
@@ -90305,7 +92482,7 @@ export declare function PublisherDocumentsApi_GetAllEntitiesDocumentTemplates(ax
|
|
|
90305
92482
|
*/
|
|
90306
92483
|
export declare function PublisherDocumentsApi_GetAllEntitiesDocuments(axios: AxiosInstance, basePath: string, requestParameters: PublisherDocumentsApiGetAllEntitiesDocumentsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiPublisherDocumentOutList>;
|
|
90307
92484
|
/**
|
|
90308
|
-
*
|
|
92485
|
+
* 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
92486
|
* @summary Get all Page Templates
|
|
90310
92487
|
* @param {AxiosInstance} axios Axios instance.
|
|
90311
92488
|
* @param {string} basePath Base path.
|
|
@@ -90493,7 +92670,7 @@ export interface PublisherDocumentsApiInterface {
|
|
|
90493
92670
|
*/
|
|
90494
92671
|
getAllEntitiesDocuments(requestParameters: PublisherDocumentsApiGetAllEntitiesDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutList>;
|
|
90495
92672
|
/**
|
|
90496
|
-
*
|
|
92673
|
+
* 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
92674
|
* @summary Get all Page Templates
|
|
90498
92675
|
* @param {PublisherDocumentsApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
90499
92676
|
* @param {*} [options] Override http request option.
|
|
@@ -91347,7 +93524,7 @@ export declare class PublisherDocumentsApi extends BaseAPI implements PublisherD
|
|
|
91347
93524
|
*/
|
|
91348
93525
|
getAllEntitiesDocuments(requestParameters: PublisherDocumentsApiGetAllEntitiesDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutList>;
|
|
91349
93526
|
/**
|
|
91350
|
-
*
|
|
93527
|
+
* 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
93528
|
* @summary Get all Page Templates
|
|
91352
93529
|
* @param {PublisherDocumentsApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
91353
93530
|
* @param {*} [options] Override http request option.
|
|
@@ -91465,7 +93642,7 @@ export declare function ReportControllerApiAxiosParamCreator_DeleteEntityReports
|
|
|
91465
93642
|
* @param {string} workspaceId
|
|
91466
93643
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
91467
93644
|
* @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' | '
|
|
93645
|
+
* @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
93646
|
* @param {number} [page] Zero-based page index (0..N)
|
|
91470
93647
|
* @param {number} [size] The size of the page to be returned
|
|
91471
93648
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -91482,7 +93659,7 @@ export declare function ReportControllerApiAxiosParamCreator_GetAllEntitiesRepor
|
|
|
91482
93659
|
* @param {string} workspaceId
|
|
91483
93660
|
* @param {string} objectId
|
|
91484
93661
|
* @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' | '
|
|
93662
|
+
* @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
93663
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
91487
93664
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
91488
93665
|
* @param {*} [options] Override http request option.
|
|
@@ -92944,6 +95121,15 @@ export declare function ReportingSettingsApiAxiosParamCreator_ResolveAllSettings
|
|
|
92944
95121
|
* @throws {RequiredError}
|
|
92945
95122
|
*/
|
|
92946
95123
|
export declare function ReportingSettingsApiAxiosParamCreator_ResolveSettingsWithoutWorkspace(resolveSettingsRequest: ResolveSettingsRequest, excludeUserSettings?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
95124
|
+
/**
|
|
95125
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
95126
|
+
* @summary Validate an embedding origin.
|
|
95127
|
+
* @param {ValidateEmbeddingOriginRequest} validateEmbeddingOriginRequest
|
|
95128
|
+
* @param {*} [options] Override http request option.
|
|
95129
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
95130
|
+
* @throws {RequiredError}
|
|
95131
|
+
*/
|
|
95132
|
+
export declare function ReportingSettingsApiAxiosParamCreator_ValidateEmbeddingOrigin(validateEmbeddingOriginRequest: ValidateEmbeddingOriginRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
92947
95133
|
/**
|
|
92948
95134
|
* Resolves values for all settings without workspace by current user, organization, or default settings.
|
|
92949
95135
|
* @summary Values for all settings without workspace.
|
|
@@ -92966,6 +95152,17 @@ export declare function ReportingSettingsApi_ResolveAllSettingsWithoutWorkspace(
|
|
|
92966
95152
|
* @throws {RequiredError}
|
|
92967
95153
|
*/
|
|
92968
95154
|
export declare function ReportingSettingsApi_ResolveSettingsWithoutWorkspace(axios: AxiosInstance, basePath: string, requestParameters: ReportingSettingsApiResolveSettingsWithoutWorkspaceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<Array<ResolvedSetting>>;
|
|
95155
|
+
/**
|
|
95156
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
95157
|
+
* @summary Validate an embedding origin.
|
|
95158
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
95159
|
+
* @param {string} basePath Base path.
|
|
95160
|
+
* @param {ReportingSettingsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
95161
|
+
* @param {*} [options] Override http request option.
|
|
95162
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
95163
|
+
* @throws {RequiredError}
|
|
95164
|
+
*/
|
|
95165
|
+
export declare function ReportingSettingsApi_ValidateEmbeddingOrigin(axios: AxiosInstance, basePath: string, requestParameters: ReportingSettingsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
92969
95166
|
/**
|
|
92970
95167
|
* ReportingSettingsApi - interface
|
|
92971
95168
|
* @export
|
|
@@ -92990,6 +95187,15 @@ export interface ReportingSettingsApiInterface {
|
|
|
92990
95187
|
* @memberof ReportingSettingsApiInterface
|
|
92991
95188
|
*/
|
|
92992
95189
|
resolveSettingsWithoutWorkspace(requestParameters: ReportingSettingsApiResolveSettingsWithoutWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ResolvedSetting>>;
|
|
95190
|
+
/**
|
|
95191
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
95192
|
+
* @summary Validate an embedding origin.
|
|
95193
|
+
* @param {ReportingSettingsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
95194
|
+
* @param {*} [options] Override http request option.
|
|
95195
|
+
* @throws {RequiredError}
|
|
95196
|
+
* @memberof ReportingSettingsApiInterface
|
|
95197
|
+
*/
|
|
95198
|
+
validateEmbeddingOrigin(requestParameters: ReportingSettingsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
92993
95199
|
}
|
|
92994
95200
|
/**
|
|
92995
95201
|
* Request parameters for resolveAllSettingsWithoutWorkspace operation in ReportingSettingsApi.
|
|
@@ -93023,6 +95229,19 @@ export interface ReportingSettingsApiResolveSettingsWithoutWorkspaceRequest {
|
|
|
93023
95229
|
*/
|
|
93024
95230
|
readonly excludeUserSettings?: boolean;
|
|
93025
95231
|
}
|
|
95232
|
+
/**
|
|
95233
|
+
* Request parameters for validateEmbeddingOrigin operation in ReportingSettingsApi.
|
|
95234
|
+
* @export
|
|
95235
|
+
* @interface ReportingSettingsApiValidateEmbeddingOriginRequest
|
|
95236
|
+
*/
|
|
95237
|
+
export interface ReportingSettingsApiValidateEmbeddingOriginRequest {
|
|
95238
|
+
/**
|
|
95239
|
+
*
|
|
95240
|
+
* @type {ValidateEmbeddingOriginRequest}
|
|
95241
|
+
* @memberof ReportingSettingsApiValidateEmbeddingOrigin
|
|
95242
|
+
*/
|
|
95243
|
+
readonly validateEmbeddingOriginRequest: ValidateEmbeddingOriginRequest;
|
|
95244
|
+
}
|
|
93026
95245
|
/**
|
|
93027
95246
|
* ReportingSettingsApi - object-oriented interface
|
|
93028
95247
|
* @export
|
|
@@ -93048,6 +95267,15 @@ export declare class ReportingSettingsApi extends BaseAPI implements ReportingSe
|
|
|
93048
95267
|
* @memberof ReportingSettingsApi
|
|
93049
95268
|
*/
|
|
93050
95269
|
resolveSettingsWithoutWorkspace(requestParameters: ReportingSettingsApiResolveSettingsWithoutWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<ResolvedSetting[]>;
|
|
95270
|
+
/**
|
|
95271
|
+
* Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.
|
|
95272
|
+
* @summary Validate an embedding origin.
|
|
95273
|
+
* @param {ReportingSettingsApiValidateEmbeddingOriginRequest} requestParameters Request parameters.
|
|
95274
|
+
* @param {*} [options] Override http request option.
|
|
95275
|
+
* @throws {RequiredError}
|
|
95276
|
+
* @memberof ReportingSettingsApi
|
|
95277
|
+
*/
|
|
95278
|
+
validateEmbeddingOrigin(requestParameters: ReportingSettingsApiValidateEmbeddingOriginRequest, options?: AxiosRequestConfig): AxiosPromise<ValidateEmbeddingOriginResponse>;
|
|
93051
95279
|
}
|
|
93052
95280
|
/**
|
|
93053
95281
|
*
|