@gooddata/api-client-tiger 11.64.0-alpha.1 → 11.64.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +2126 -16
- 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 +1 -1
- package/esm/generated/ai-json-api/api.d.ts +32 -1
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +2 -1
- package/esm/generated/automation-json-api/api.d.ts +1 -1
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +1 -1
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +10011 -4398
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +28603 -23623
- package/esm/generated/scan-json-api/api.d.ts +4 -0
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -80,6 +80,29 @@ export declare type AbsoluteGranularityDateFilterAbsoluteGranularityDateFilterEm
|
|
|
80
80
|
|
|
81
81
|
export declare type AbsoluteGranularityDateFilterAbsoluteGranularityDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
82
82
|
|
|
83
|
+
/**
|
|
84
|
+
* A period between two dates.
|
|
85
|
+
*/
|
|
86
|
+
export declare interface AbsolutePublisherDocumentPeriod {
|
|
87
|
+
'type': AbsolutePublisherDocumentPeriodTypeEnum;
|
|
88
|
+
/**
|
|
89
|
+
* First day of the period, inclusive.
|
|
90
|
+
*/
|
|
91
|
+
'from': string;
|
|
92
|
+
/**
|
|
93
|
+
* Date granularity of the period.
|
|
94
|
+
*/
|
|
95
|
+
'granularity': AbsolutePublisherDocumentPeriodGranularityEnum;
|
|
96
|
+
/**
|
|
97
|
+
* Last day of the period, inclusive.
|
|
98
|
+
*/
|
|
99
|
+
'to': string;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export declare type AbsolutePublisherDocumentPeriodGranularityEnum = 'GDC.time.date';
|
|
103
|
+
|
|
104
|
+
export declare type AbsolutePublisherDocumentPeriodTypeEnum = 'absolute';
|
|
105
|
+
|
|
83
106
|
/**
|
|
84
107
|
* @type AbstractMeasureValueFilter
|
|
85
108
|
*/
|
|
@@ -386,7 +409,7 @@ export declare class ActionsApi extends MetadataBaseApi implements ActionsApiInt
|
|
|
386
409
|
*/
|
|
387
410
|
organizationLocalizationStatistics(options?: AxiosRequestConfig): AxiosPromise<LocalizationStatistics>;
|
|
388
411
|
/**
|
|
389
|
-
* (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count
|
|
412
|
+
* (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing.
|
|
390
413
|
* @summary (BETA) Languages used in the organization.
|
|
391
414
|
* @param {*} [options] Override http request option.
|
|
392
415
|
* @throws {RequiredError}
|
|
@@ -394,7 +417,7 @@ export declare class ActionsApi extends MetadataBaseApi implements ActionsApiInt
|
|
|
394
417
|
*/
|
|
395
418
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
396
419
|
/**
|
|
397
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last.
|
|
420
|
+
* (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. Users counted in the usage entry without a language are not listed.
|
|
398
421
|
* @summary (BETA) Users who set a language themselves.
|
|
399
422
|
* @param {ActionsApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
400
423
|
* @param {*} [options] Override http request option.
|
|
@@ -650,6 +673,33 @@ export declare class ActionsApi extends MetadataBaseApi implements ActionsApiInt
|
|
|
650
673
|
* @memberof ActionsApi
|
|
651
674
|
*/
|
|
652
675
|
visualizationPermissions(requestParameters: ActionsApiVisualizationPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<VisualizationPermissions>;
|
|
676
|
+
/**
|
|
677
|
+
* (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.
|
|
678
|
+
* @summary (BETA) Languages with translations in the workspace.
|
|
679
|
+
* @param {ActionsApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
680
|
+
* @param {*} [options] Override http request option.
|
|
681
|
+
* @throws {RequiredError}
|
|
682
|
+
* @memberof ActionsApi
|
|
683
|
+
*/
|
|
684
|
+
workspaceLocalizationStatistics(requestParameters: ActionsApiWorkspaceLocalizationStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationStatistics>;
|
|
685
|
+
/**
|
|
686
|
+
* (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.
|
|
687
|
+
* @summary (BETA) Languages used in the workspace.
|
|
688
|
+
* @param {ActionsApiWorkspaceLocalizationUsageRequest} requestParameters Request parameters.
|
|
689
|
+
* @param {*} [options] Override http request option.
|
|
690
|
+
* @throws {RequiredError}
|
|
691
|
+
* @memberof ActionsApi
|
|
692
|
+
*/
|
|
693
|
+
workspaceLocalizationUsage(requestParameters: ActionsApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
694
|
+
/**
|
|
695
|
+
* (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.
|
|
696
|
+
* @summary (BETA) Workspace members who get a language.
|
|
697
|
+
* @param {ActionsApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
698
|
+
* @param {*} [options] Override http request option.
|
|
699
|
+
* @throws {RequiredError}
|
|
700
|
+
* @memberof ActionsApi
|
|
701
|
+
*/
|
|
702
|
+
workspaceLocalizationUsageUsers(requestParameters: ActionsApiWorkspaceLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
653
703
|
/**
|
|
654
704
|
* Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.
|
|
655
705
|
* @summary Values for all settings.
|
|
@@ -3028,7 +3078,7 @@ export declare interface ActionsApiInterface {
|
|
|
3028
3078
|
*/
|
|
3029
3079
|
organizationLocalizationStatistics(options?: AxiosRequestConfig): AxiosPromise<LocalizationStatistics>;
|
|
3030
3080
|
/**
|
|
3031
|
-
* (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count
|
|
3081
|
+
* (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing.
|
|
3032
3082
|
* @summary (BETA) Languages used in the organization.
|
|
3033
3083
|
* @param {*} [options] Override http request option.
|
|
3034
3084
|
* @throws {RequiredError}
|
|
@@ -3036,7 +3086,7 @@ export declare interface ActionsApiInterface {
|
|
|
3036
3086
|
*/
|
|
3037
3087
|
organizationLocalizationUsage(options?: AxiosRequestConfig): AxiosPromise<LocalizationUsage>;
|
|
3038
3088
|
/**
|
|
3039
|
-
* (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last.
|
|
3089
|
+
* (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. Users counted in the usage entry without a language are not listed.
|
|
3040
3090
|
* @summary (BETA) Users who set a language themselves.
|
|
3041
3091
|
* @param {ActionsApiOrganizationLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
3042
3092
|
* @param {*} [options] Override http request option.
|
|
@@ -3292,6 +3342,33 @@ export declare interface ActionsApiInterface {
|
|
|
3292
3342
|
* @memberof ActionsApiInterface
|
|
3293
3343
|
*/
|
|
3294
3344
|
visualizationPermissions(requestParameters: ActionsApiVisualizationPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<VisualizationPermissions>;
|
|
3345
|
+
/**
|
|
3346
|
+
* (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.
|
|
3347
|
+
* @summary (BETA) Languages with translations in the workspace.
|
|
3348
|
+
* @param {ActionsApiWorkspaceLocalizationStatisticsRequest} requestParameters Request parameters.
|
|
3349
|
+
* @param {*} [options] Override http request option.
|
|
3350
|
+
* @throws {RequiredError}
|
|
3351
|
+
* @memberof ActionsApiInterface
|
|
3352
|
+
*/
|
|
3353
|
+
workspaceLocalizationStatistics(requestParameters: ActionsApiWorkspaceLocalizationStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationStatistics>;
|
|
3354
|
+
/**
|
|
3355
|
+
* (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.
|
|
3356
|
+
* @summary (BETA) Languages used in the workspace.
|
|
3357
|
+
* @param {ActionsApiWorkspaceLocalizationUsageRequest} requestParameters Request parameters.
|
|
3358
|
+
* @param {*} [options] Override http request option.
|
|
3359
|
+
* @throws {RequiredError}
|
|
3360
|
+
* @memberof ActionsApiInterface
|
|
3361
|
+
*/
|
|
3362
|
+
workspaceLocalizationUsage(requestParameters: ActionsApiWorkspaceLocalizationUsageRequest, options?: AxiosRequestConfig): AxiosPromise<WorkspaceLocalizationUsage>;
|
|
3363
|
+
/**
|
|
3364
|
+
* (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.
|
|
3365
|
+
* @summary (BETA) Workspace members who get a language.
|
|
3366
|
+
* @param {ActionsApiWorkspaceLocalizationUsageUsersRequest} requestParameters Request parameters.
|
|
3367
|
+
* @param {*} [options] Override http request option.
|
|
3368
|
+
* @throws {RequiredError}
|
|
3369
|
+
* @memberof ActionsApiInterface
|
|
3370
|
+
*/
|
|
3371
|
+
workspaceLocalizationUsageUsers(requestParameters: ActionsApiWorkspaceLocalizationUsageUsersRequest, options?: AxiosRequestConfig): AxiosPromise<LocalizationUsageUsers>;
|
|
3295
3372
|
/**
|
|
3296
3373
|
* Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.
|
|
3297
3374
|
* @summary Values for all settings.
|
|
@@ -3794,6 +3871,12 @@ export declare interface ActionsApiOrganizationLocalizationUsageUsersRequest {
|
|
|
3794
3871
|
* @memberof ActionsApiOrganizationLocalizationUsageUsers
|
|
3795
3872
|
*/
|
|
3796
3873
|
readonly value?: string;
|
|
3874
|
+
/**
|
|
3875
|
+
* Filter by user name, email or login (user ID). Note that the filter is case insensitive.
|
|
3876
|
+
* @type {string}
|
|
3877
|
+
* @memberof ActionsApiOrganizationLocalizationUsageUsers
|
|
3878
|
+
*/
|
|
3879
|
+
readonly name?: string;
|
|
3797
3880
|
/**
|
|
3798
3881
|
* One of LOCALE, METADATA_LOCALE and DATA_LOCALE.
|
|
3799
3882
|
* @type {'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE'}
|
|
@@ -3832,6 +3915,12 @@ export declare interface ActionsApiOrganizationLocalizationUsageWorkspacesReques
|
|
|
3832
3915
|
* @memberof ActionsApiOrganizationLocalizationUsageWorkspaces
|
|
3833
3916
|
*/
|
|
3834
3917
|
readonly value?: string;
|
|
3918
|
+
/**
|
|
3919
|
+
* Filter by workspace name. Note that the filter is case insensitive.
|
|
3920
|
+
* @type {string}
|
|
3921
|
+
* @memberof ActionsApiOrganizationLocalizationUsageWorkspaces
|
|
3922
|
+
*/
|
|
3923
|
+
readonly name?: string;
|
|
3835
3924
|
/**
|
|
3836
3925
|
* One of LOCALE, METADATA_LOCALE and DATA_LOCALE.
|
|
3837
3926
|
* @type {'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE'}
|
|
@@ -4726,6 +4815,84 @@ export declare interface ActionsApiVisualizationPermissionsRequest {
|
|
|
4726
4815
|
readonly visualizationObjectId: string;
|
|
4727
4816
|
}
|
|
4728
4817
|
|
|
4818
|
+
/**
|
|
4819
|
+
* Request parameters for workspaceLocalizationStatistics operation in ActionsApi.
|
|
4820
|
+
* @export
|
|
4821
|
+
* @interface ActionsApiWorkspaceLocalizationStatisticsRequest
|
|
4822
|
+
*/
|
|
4823
|
+
export declare interface ActionsApiWorkspaceLocalizationStatisticsRequest {
|
|
4824
|
+
/**
|
|
4825
|
+
*
|
|
4826
|
+
* @type {string}
|
|
4827
|
+
* @memberof ActionsApiWorkspaceLocalizationStatistics
|
|
4828
|
+
*/
|
|
4829
|
+
readonly workspaceId: string;
|
|
4830
|
+
}
|
|
4831
|
+
|
|
4832
|
+
/**
|
|
4833
|
+
* Request parameters for workspaceLocalizationUsage operation in ActionsApi.
|
|
4834
|
+
* @export
|
|
4835
|
+
* @interface ActionsApiWorkspaceLocalizationUsageRequest
|
|
4836
|
+
*/
|
|
4837
|
+
export declare interface ActionsApiWorkspaceLocalizationUsageRequest {
|
|
4838
|
+
/**
|
|
4839
|
+
*
|
|
4840
|
+
* @type {string}
|
|
4841
|
+
* @memberof ActionsApiWorkspaceLocalizationUsage
|
|
4842
|
+
*/
|
|
4843
|
+
readonly workspaceId: string;
|
|
4844
|
+
}
|
|
4845
|
+
|
|
4846
|
+
/**
|
|
4847
|
+
* Request parameters for workspaceLocalizationUsageUsers operation in ActionsApi.
|
|
4848
|
+
* @export
|
|
4849
|
+
* @interface ActionsApiWorkspaceLocalizationUsageUsersRequest
|
|
4850
|
+
*/
|
|
4851
|
+
export declare interface ActionsApiWorkspaceLocalizationUsageUsersRequest {
|
|
4852
|
+
/**
|
|
4853
|
+
*
|
|
4854
|
+
* @type {string}
|
|
4855
|
+
* @memberof ActionsApiWorkspaceLocalizationUsageUsers
|
|
4856
|
+
*/
|
|
4857
|
+
readonly workspaceId: string;
|
|
4858
|
+
/**
|
|
4859
|
+
* Language tag that the user gets.
|
|
4860
|
+
* @type {string}
|
|
4861
|
+
* @memberof ActionsApiWorkspaceLocalizationUsageUsers
|
|
4862
|
+
*/
|
|
4863
|
+
readonly value?: string;
|
|
4864
|
+
/**
|
|
4865
|
+
* Filter by user name, email or login (user ID). Note that the filter is case insensitive.
|
|
4866
|
+
* @type {string}
|
|
4867
|
+
* @memberof ActionsApiWorkspaceLocalizationUsageUsers
|
|
4868
|
+
*/
|
|
4869
|
+
readonly name?: string;
|
|
4870
|
+
/**
|
|
4871
|
+
* One of LOCALE, METADATA_LOCALE and DATA_LOCALE.
|
|
4872
|
+
* @type {'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE'}
|
|
4873
|
+
* @memberof ActionsApiWorkspaceLocalizationUsageUsers
|
|
4874
|
+
*/
|
|
4875
|
+
readonly setting?: 'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE';
|
|
4876
|
+
/**
|
|
4877
|
+
* Where the value comes from.
|
|
4878
|
+
* @type {'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT'}
|
|
4879
|
+
* @memberof ActionsApiWorkspaceLocalizationUsageUsers
|
|
4880
|
+
*/
|
|
4881
|
+
readonly source?: 'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT';
|
|
4882
|
+
/**
|
|
4883
|
+
* Zero-based page index (0..N)
|
|
4884
|
+
* @type {number}
|
|
4885
|
+
* @memberof ActionsApiWorkspaceLocalizationUsageUsers
|
|
4886
|
+
*/
|
|
4887
|
+
readonly page?: number;
|
|
4888
|
+
/**
|
|
4889
|
+
* The size of the page to be returned.
|
|
4890
|
+
* @type {number}
|
|
4891
|
+
* @memberof ActionsApiWorkspaceLocalizationUsageUsers
|
|
4892
|
+
*/
|
|
4893
|
+
readonly size?: number;
|
|
4894
|
+
}
|
|
4895
|
+
|
|
4729
4896
|
/**
|
|
4730
4897
|
* Request parameters for workspaceResolveAllSettings operation in ActionsApi.
|
|
4731
4898
|
* @export
|
|
@@ -11096,6 +11263,8 @@ export declare type AiContent = ({
|
|
|
11096
11263
|
} & AiMultipartContent) | ({
|
|
11097
11264
|
type: 'reasoning';
|
|
11098
11265
|
} & AiReasoningContent) | ({
|
|
11266
|
+
type: 'skillsActivated';
|
|
11267
|
+
} & AiSkillsActivatedContent) | ({
|
|
11099
11268
|
type: 'text';
|
|
11100
11269
|
} & AiTextMessageContent) | ({
|
|
11101
11270
|
type: 'toolCall';
|
|
@@ -11144,7 +11313,7 @@ export declare interface AiConversationItemResponse {
|
|
|
11144
11313
|
'createdAt': string;
|
|
11145
11314
|
'detail'?: AiConversationItemResponseDetail | null;
|
|
11146
11315
|
/**
|
|
11147
|
-
* True for items streamed only as live progress
|
|
11316
|
+
* True for items streamed only as live progress, never persisted. For reasoning items, replay returns one merged reasoning item instead. Replay never returns skillsActivated items.
|
|
11148
11317
|
*/
|
|
11149
11318
|
'interim'?: boolean;
|
|
11150
11319
|
/**
|
|
@@ -11164,6 +11333,7 @@ export declare interface AiConversationItemResponse {
|
|
|
11164
11333
|
* Author role of the item.
|
|
11165
11334
|
*/
|
|
11166
11335
|
'role': AiConversationItemResponseRoleEnum;
|
|
11336
|
+
'skillsInUse'?: Array<AiSkillRef> | null;
|
|
11167
11337
|
'stepId'?: string | null;
|
|
11168
11338
|
'taskId'?: string | null;
|
|
11169
11339
|
'trigger'?: AiConversationItemResponseTriggerEnum | null;
|
|
@@ -12734,6 +12904,7 @@ export declare const AiObjectType: {
|
|
|
12734
12904
|
readonly FILTER_CONTEXT: 'filter_context';
|
|
12735
12905
|
readonly PARAMETER: 'parameter';
|
|
12736
12906
|
readonly DOCUMENT: 'document';
|
|
12907
|
+
readonly REPORT: 'report';
|
|
12737
12908
|
};
|
|
12738
12909
|
|
|
12739
12910
|
export declare type AiObjectType = typeof AiObjectType[keyof typeof AiObjectType];
|
|
@@ -14333,6 +14504,20 @@ export declare const AiSkillName: {
|
|
|
14333
14504
|
|
|
14334
14505
|
export declare type AiSkillName = typeof AiSkillName[keyof typeof AiSkillName];
|
|
14335
14506
|
|
|
14507
|
+
/**
|
|
14508
|
+
* A skill as the UI names it.
|
|
14509
|
+
*/
|
|
14510
|
+
export declare interface AiSkillRef {
|
|
14511
|
+
/**
|
|
14512
|
+
* Skill name, as in the agent\'s skill list (e.g. dashboard_builder).
|
|
14513
|
+
*/
|
|
14514
|
+
'name': string;
|
|
14515
|
+
/**
|
|
14516
|
+
* User-facing skill title (e.g. Dashboard creation).
|
|
14517
|
+
*/
|
|
14518
|
+
'title': string;
|
|
14519
|
+
}
|
|
14520
|
+
|
|
14336
14521
|
/**
|
|
14337
14522
|
* A single skill available to the organization.
|
|
14338
14523
|
*/
|
|
@@ -14364,6 +14549,22 @@ export declare interface AiSkillRoutingDetail {
|
|
|
14364
14549
|
|
|
14365
14550
|
export declare type AiSkillRoutingDetailCategoryEnum = 'skillRouting';
|
|
14366
14551
|
|
|
14552
|
+
/**
|
|
14553
|
+
* Skills that became available to the agent before a model call. Streamed only.
|
|
14554
|
+
*/
|
|
14555
|
+
export declare interface AiSkillsActivatedContent {
|
|
14556
|
+
/**
|
|
14557
|
+
* Skills that turned on, sorted by name. Never empty: no change means no item. Each model call is compared with the previous call of the same turn. The first call of a turn is compared with the conversation\'s stored skills. Stored skills change only when the agent selects skills itself, never on a pinned turn. A pinned skill is reported on every turn that pins it. So is a skill added for the user\'s open dashboard or visualization. The turn after a pinned turn reports nothing for the stored skills it returns to.
|
|
14558
|
+
*/
|
|
14559
|
+
'skills': Array<AiSkillRef>;
|
|
14560
|
+
/**
|
|
14561
|
+
* Type of item content.
|
|
14562
|
+
*/
|
|
14563
|
+
'type'?: AiSkillsActivatedContentTypeEnum;
|
|
14564
|
+
}
|
|
14565
|
+
|
|
14566
|
+
export declare type AiSkillsActivatedContentTypeEnum = 'skillsActivated';
|
|
14567
|
+
|
|
14367
14568
|
export declare interface AiState {
|
|
14368
14569
|
'exclude'?: Array<AiStateExcludeInner> | null;
|
|
14369
14570
|
'include'?: Array<AiStateIncludeInner> | null;
|
|
@@ -23609,7 +23810,7 @@ export declare interface AutomationIdentifierRefIdentifier {
|
|
|
23609
23810
|
'type': AutomationIdentifierRefIdentifierTypeEnum;
|
|
23610
23811
|
}
|
|
23611
23812
|
|
|
23612
|
-
export declare type AutomationIdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'computedAttribute' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'reportPageLayout' | 'reportTemplate' | 'report' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
23813
|
+
export declare type AutomationIdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'computedAttribute' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'reportPageLayout' | 'reportTemplate' | 'report' | 'pageTemplate' | 'document' | 'documentTemplate' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
23613
23814
|
|
|
23614
23815
|
export declare interface AutomationImageExport {
|
|
23615
23816
|
'requestPayload': ImageExportRequest;
|
|
@@ -37280,6 +37481,14 @@ export declare interface DeclarativeAnalyticsLayer {
|
|
|
37280
37481
|
* A list of dashboard plugins available in the model.
|
|
37281
37482
|
*/
|
|
37282
37483
|
'dashboardPlugins'?: Array<DeclarativeDashboardPlugin>;
|
|
37484
|
+
/**
|
|
37485
|
+
* A list of document templates available in the model.
|
|
37486
|
+
*/
|
|
37487
|
+
'documentTemplates'?: Array<DeclarativePublisherDocumentTemplate>;
|
|
37488
|
+
/**
|
|
37489
|
+
* A list of documents available in the model.
|
|
37490
|
+
*/
|
|
37491
|
+
'documents'?: Array<DeclarativePublisherDocument>;
|
|
37283
37492
|
/**
|
|
37284
37493
|
* A list of export definitions.
|
|
37285
37494
|
*/
|
|
@@ -37296,6 +37505,10 @@ export declare interface DeclarativeAnalyticsLayer {
|
|
|
37296
37505
|
* A list of metrics available in the model.
|
|
37297
37506
|
*/
|
|
37298
37507
|
'metrics'?: Array<DeclarativeMetric>;
|
|
37508
|
+
/**
|
|
37509
|
+
* A list of page templates available in the model.
|
|
37510
|
+
*/
|
|
37511
|
+
'pageTemplates'?: Array<DeclarativePublisherDocumentPageTemplate>;
|
|
37299
37512
|
/**
|
|
37300
37513
|
* A list of parameters available in the model.
|
|
37301
37514
|
*/
|
|
@@ -37506,6 +37719,10 @@ export declare interface DeclarativeColumn {
|
|
|
37506
37719
|
* Column type
|
|
37507
37720
|
*/
|
|
37508
37721
|
'dataType': DeclarativeColumnDataTypeEnum;
|
|
37722
|
+
/**
|
|
37723
|
+
* (EXPERIMENTAL) Name of the column whose values this column labels. Logical model generation makes this column the default label of the attribute on that column, sorted by that column.
|
|
37724
|
+
*/
|
|
37725
|
+
'defaultLabelOf'?: string;
|
|
37509
37726
|
/**
|
|
37510
37727
|
* Column description/comment from database
|
|
37511
37728
|
*/
|
|
@@ -38631,6 +38848,79 @@ export declare interface DeclarativeParameter {
|
|
|
38631
38848
|
'title': string;
|
|
38632
38849
|
}
|
|
38633
38850
|
|
|
38851
|
+
export declare interface DeclarativePublisherDocument {
|
|
38852
|
+
/**
|
|
38853
|
+
* Free-form JSON object
|
|
38854
|
+
*/
|
|
38855
|
+
'content': object | null;
|
|
38856
|
+
/**
|
|
38857
|
+
* Document description.
|
|
38858
|
+
*/
|
|
38859
|
+
'description'?: string;
|
|
38860
|
+
/**
|
|
38861
|
+
* Document ID.
|
|
38862
|
+
*/
|
|
38863
|
+
'id': string;
|
|
38864
|
+
'period': PublisherDocumentPeriod;
|
|
38865
|
+
'tags'?: Array<string>;
|
|
38866
|
+
/**
|
|
38867
|
+
* Document title.
|
|
38868
|
+
*/
|
|
38869
|
+
'title': string;
|
|
38870
|
+
/**
|
|
38871
|
+
* Version of the content format.
|
|
38872
|
+
*/
|
|
38873
|
+
'version': string;
|
|
38874
|
+
}
|
|
38875
|
+
|
|
38876
|
+
export declare interface DeclarativePublisherDocumentPageTemplate {
|
|
38877
|
+
/**
|
|
38878
|
+
* Free-form JSON object
|
|
38879
|
+
*/
|
|
38880
|
+
'content': object | null;
|
|
38881
|
+
/**
|
|
38882
|
+
* Page template description.
|
|
38883
|
+
*/
|
|
38884
|
+
'description'?: string;
|
|
38885
|
+
/**
|
|
38886
|
+
* Page template ID.
|
|
38887
|
+
*/
|
|
38888
|
+
'id': string;
|
|
38889
|
+
'tags'?: Array<string>;
|
|
38890
|
+
/**
|
|
38891
|
+
* Page template title.
|
|
38892
|
+
*/
|
|
38893
|
+
'title': string;
|
|
38894
|
+
/**
|
|
38895
|
+
* Version of the content format.
|
|
38896
|
+
*/
|
|
38897
|
+
'version': string;
|
|
38898
|
+
}
|
|
38899
|
+
|
|
38900
|
+
export declare interface DeclarativePublisherDocumentTemplate {
|
|
38901
|
+
/**
|
|
38902
|
+
* Free-form JSON object
|
|
38903
|
+
*/
|
|
38904
|
+
'content': object | null;
|
|
38905
|
+
/**
|
|
38906
|
+
* Document template description.
|
|
38907
|
+
*/
|
|
38908
|
+
'description'?: string;
|
|
38909
|
+
/**
|
|
38910
|
+
* Document template ID.
|
|
38911
|
+
*/
|
|
38912
|
+
'id': string;
|
|
38913
|
+
'tags'?: Array<string>;
|
|
38914
|
+
/**
|
|
38915
|
+
* Document template title.
|
|
38916
|
+
*/
|
|
38917
|
+
'title': string;
|
|
38918
|
+
/**
|
|
38919
|
+
* Version of the content format.
|
|
38920
|
+
*/
|
|
38921
|
+
'version': string;
|
|
38922
|
+
}
|
|
38923
|
+
|
|
38634
38924
|
/**
|
|
38635
38925
|
* A dataset reference.
|
|
38636
38926
|
*/
|
|
@@ -39884,6 +40174,24 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
39884
40174
|
* @memberof EntitiesApi
|
|
39885
40175
|
*/
|
|
39886
40176
|
createEntityDataSources(requestParameters: EntitiesApiCreateEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
40177
|
+
/**
|
|
40178
|
+
*
|
|
40179
|
+
* @summary Post Document Template
|
|
40180
|
+
* @param {EntitiesApiCreateEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
40181
|
+
* @param {*} [options] Override http request option.
|
|
40182
|
+
* @throws {RequiredError}
|
|
40183
|
+
* @memberof EntitiesApi
|
|
40184
|
+
*/
|
|
40185
|
+
createEntityDocumentTemplates(requestParameters: EntitiesApiCreateEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutDocument>;
|
|
40186
|
+
/**
|
|
40187
|
+
*
|
|
40188
|
+
* @summary Post Document
|
|
40189
|
+
* @param {EntitiesApiCreateEntityDocumentsRequest} requestParameters Request parameters.
|
|
40190
|
+
* @param {*} [options] Override http request option.
|
|
40191
|
+
* @throws {RequiredError}
|
|
40192
|
+
* @memberof EntitiesApi
|
|
40193
|
+
*/
|
|
40194
|
+
createEntityDocuments(requestParameters: EntitiesApiCreateEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutDocument>;
|
|
39887
40195
|
/**
|
|
39888
40196
|
*
|
|
39889
40197
|
* @summary Post Export Definitions
|
|
@@ -40010,6 +40318,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
40010
40318
|
* @memberof EntitiesApi
|
|
40011
40319
|
*/
|
|
40012
40320
|
createEntityOrganizationSettings(requestParameters: EntitiesApiCreateEntityOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationSettingOutDocument>;
|
|
40321
|
+
/**
|
|
40322
|
+
*
|
|
40323
|
+
* @summary Post Page Template
|
|
40324
|
+
* @param {EntitiesApiCreateEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
40325
|
+
* @param {*} [options] Override http request option.
|
|
40326
|
+
* @throws {RequiredError}
|
|
40327
|
+
* @memberof EntitiesApi
|
|
40328
|
+
*/
|
|
40329
|
+
createEntityPageTemplates(requestParameters: EntitiesApiCreateEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutDocument>;
|
|
40013
40330
|
/**
|
|
40014
40331
|
*
|
|
40015
40332
|
* @summary Post Parameters
|
|
@@ -40290,6 +40607,24 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
40290
40607
|
* @memberof EntitiesApi
|
|
40291
40608
|
*/
|
|
40292
40609
|
deleteEntityDataSources(requestParameters: EntitiesApiDeleteEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
40610
|
+
/**
|
|
40611
|
+
*
|
|
40612
|
+
* @summary Delete a Document Template
|
|
40613
|
+
* @param {EntitiesApiDeleteEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
40614
|
+
* @param {*} [options] Override http request option.
|
|
40615
|
+
* @throws {RequiredError}
|
|
40616
|
+
* @memberof EntitiesApi
|
|
40617
|
+
*/
|
|
40618
|
+
deleteEntityDocumentTemplates(requestParameters: EntitiesApiDeleteEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
40619
|
+
/**
|
|
40620
|
+
*
|
|
40621
|
+
* @summary Delete a Document
|
|
40622
|
+
* @param {EntitiesApiDeleteEntityDocumentsRequest} requestParameters Request parameters.
|
|
40623
|
+
* @param {*} [options] Override http request option.
|
|
40624
|
+
* @throws {RequiredError}
|
|
40625
|
+
* @memberof EntitiesApi
|
|
40626
|
+
*/
|
|
40627
|
+
deleteEntityDocuments(requestParameters: EntitiesApiDeleteEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
40293
40628
|
/**
|
|
40294
40629
|
*
|
|
40295
40630
|
* @summary Delete an Export Definition
|
|
@@ -40416,6 +40751,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
40416
40751
|
* @memberof EntitiesApi
|
|
40417
40752
|
*/
|
|
40418
40753
|
deleteEntityOrganizationSettings(requestParameters: EntitiesApiDeleteEntityOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
40754
|
+
/**
|
|
40755
|
+
*
|
|
40756
|
+
* @summary Delete a Page Template
|
|
40757
|
+
* @param {EntitiesApiDeleteEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
40758
|
+
* @param {*} [options] Override http request option.
|
|
40759
|
+
* @throws {RequiredError}
|
|
40760
|
+
* @memberof EntitiesApi
|
|
40761
|
+
*/
|
|
40762
|
+
deleteEntityPageTemplates(requestParameters: EntitiesApiDeleteEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
40419
40763
|
/**
|
|
40420
40764
|
*
|
|
40421
40765
|
* @summary Delete a Parameter
|
|
@@ -40740,6 +41084,24 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
40740
41084
|
* @memberof EntitiesApi
|
|
40741
41085
|
*/
|
|
40742
41086
|
getAllEntitiesDatasets(requestParameters: EntitiesApiGetAllEntitiesDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutList>;
|
|
41087
|
+
/**
|
|
41088
|
+
*
|
|
41089
|
+
* @summary Get all Document Templates
|
|
41090
|
+
* @param {EntitiesApiGetAllEntitiesDocumentTemplatesRequest} requestParameters Request parameters.
|
|
41091
|
+
* @param {*} [options] Override http request option.
|
|
41092
|
+
* @throws {RequiredError}
|
|
41093
|
+
* @memberof EntitiesApi
|
|
41094
|
+
*/
|
|
41095
|
+
getAllEntitiesDocumentTemplates(requestParameters: EntitiesApiGetAllEntitiesDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutList>;
|
|
41096
|
+
/**
|
|
41097
|
+
*
|
|
41098
|
+
* @summary Get all Documents
|
|
41099
|
+
* @param {EntitiesApiGetAllEntitiesDocumentsRequest} requestParameters Request parameters.
|
|
41100
|
+
* @param {*} [options] Override http request option.
|
|
41101
|
+
* @throws {RequiredError}
|
|
41102
|
+
* @memberof EntitiesApi
|
|
41103
|
+
*/
|
|
41104
|
+
getAllEntitiesDocuments(requestParameters: EntitiesApiGetAllEntitiesDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutList>;
|
|
40743
41105
|
/**
|
|
40744
41106
|
* Space of the shared interest
|
|
40745
41107
|
* @summary Get Entitlements
|
|
@@ -40911,6 +41273,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
40911
41273
|
* @memberof EntitiesApi
|
|
40912
41274
|
*/
|
|
40913
41275
|
getAllEntitiesOrganizationSettings(requestParameters?: EntitiesApiGetAllEntitiesOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationSettingOutList>;
|
|
41276
|
+
/**
|
|
41277
|
+
*
|
|
41278
|
+
* @summary Get all Page Templates
|
|
41279
|
+
* @param {EntitiesApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
41280
|
+
* @param {*} [options] Override http request option.
|
|
41281
|
+
* @throws {RequiredError}
|
|
41282
|
+
* @memberof EntitiesApi
|
|
41283
|
+
*/
|
|
41284
|
+
getAllEntitiesPageTemplates(requestParameters: EntitiesApiGetAllEntitiesPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutList>;
|
|
40914
41285
|
/**
|
|
40915
41286
|
*
|
|
40916
41287
|
* @summary Get all Parameters
|
|
@@ -41263,6 +41634,24 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
41263
41634
|
* @memberof EntitiesApi
|
|
41264
41635
|
*/
|
|
41265
41636
|
getEntityDatasets(requestParameters: EntitiesApiGetEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
41637
|
+
/**
|
|
41638
|
+
*
|
|
41639
|
+
* @summary Get a Document Template
|
|
41640
|
+
* @param {EntitiesApiGetEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
41641
|
+
* @param {*} [options] Override http request option.
|
|
41642
|
+
* @throws {RequiredError}
|
|
41643
|
+
* @memberof EntitiesApi
|
|
41644
|
+
*/
|
|
41645
|
+
getEntityDocumentTemplates(requestParameters: EntitiesApiGetEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutDocument>;
|
|
41646
|
+
/**
|
|
41647
|
+
*
|
|
41648
|
+
* @summary Get a Document
|
|
41649
|
+
* @param {EntitiesApiGetEntityDocumentsRequest} requestParameters Request parameters.
|
|
41650
|
+
* @param {*} [options] Override http request option.
|
|
41651
|
+
* @throws {RequiredError}
|
|
41652
|
+
* @memberof EntitiesApi
|
|
41653
|
+
*/
|
|
41654
|
+
getEntityDocuments(requestParameters: EntitiesApiGetEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutDocument>;
|
|
41266
41655
|
/**
|
|
41267
41656
|
* Space of the shared interest
|
|
41268
41657
|
* @summary Get Entitlement entity
|
|
@@ -41443,6 +41832,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
41443
41832
|
* @memberof EntitiesApi
|
|
41444
41833
|
*/
|
|
41445
41834
|
getEntityOrganizations(requestParameters: EntitiesApiGetEntityOrganizationsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationOutDocument>;
|
|
41835
|
+
/**
|
|
41836
|
+
*
|
|
41837
|
+
* @summary Get a Page Template
|
|
41838
|
+
* @param {EntitiesApiGetEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
41839
|
+
* @param {*} [options] Override http request option.
|
|
41840
|
+
* @throws {RequiredError}
|
|
41841
|
+
* @memberof EntitiesApi
|
|
41842
|
+
*/
|
|
41843
|
+
getEntityPageTemplates(requestParameters: EntitiesApiGetEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutDocument>;
|
|
41446
41844
|
/**
|
|
41447
41845
|
*
|
|
41448
41846
|
* @summary Get a Parameter
|
|
@@ -41750,6 +42148,24 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
41750
42148
|
* @memberof EntitiesApi
|
|
41751
42149
|
*/
|
|
41752
42150
|
patchEntityDatasets(requestParameters: EntitiesApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
42151
|
+
/**
|
|
42152
|
+
*
|
|
42153
|
+
* @summary Patch a Document Template
|
|
42154
|
+
* @param {EntitiesApiPatchEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
42155
|
+
* @param {*} [options] Override http request option.
|
|
42156
|
+
* @throws {RequiredError}
|
|
42157
|
+
* @memberof EntitiesApi
|
|
42158
|
+
*/
|
|
42159
|
+
patchEntityDocumentTemplates(requestParameters: EntitiesApiPatchEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutDocument>;
|
|
42160
|
+
/**
|
|
42161
|
+
*
|
|
42162
|
+
* @summary Patch a Document
|
|
42163
|
+
* @param {EntitiesApiPatchEntityDocumentsRequest} requestParameters Request parameters.
|
|
42164
|
+
* @param {*} [options] Override http request option.
|
|
42165
|
+
* @throws {RequiredError}
|
|
42166
|
+
* @memberof EntitiesApi
|
|
42167
|
+
*/
|
|
42168
|
+
patchEntityDocuments(requestParameters: EntitiesApiPatchEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutDocument>;
|
|
41753
42169
|
/**
|
|
41754
42170
|
*
|
|
41755
42171
|
* @summary Patch an Export Definition
|
|
@@ -41894,6 +42310,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
41894
42310
|
* @memberof EntitiesApi
|
|
41895
42311
|
*/
|
|
41896
42312
|
patchEntityOrganizations(requestParameters: EntitiesApiPatchEntityOrganizationsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationOutDocument>;
|
|
42313
|
+
/**
|
|
42314
|
+
*
|
|
42315
|
+
* @summary Patch a Page Template
|
|
42316
|
+
* @param {EntitiesApiPatchEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
42317
|
+
* @param {*} [options] Override http request option.
|
|
42318
|
+
* @throws {RequiredError}
|
|
42319
|
+
* @memberof EntitiesApi
|
|
42320
|
+
*/
|
|
42321
|
+
patchEntityPageTemplates(requestParameters: EntitiesApiPatchEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutDocument>;
|
|
41897
42322
|
/**
|
|
41898
42323
|
*
|
|
41899
42324
|
* @summary Patch a Parameter
|
|
@@ -42381,6 +42806,24 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
42381
42806
|
* @memberof EntitiesApi
|
|
42382
42807
|
*/
|
|
42383
42808
|
updateEntityDataSources(requestParameters: EntitiesApiUpdateEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
42809
|
+
/**
|
|
42810
|
+
*
|
|
42811
|
+
* @summary Put a Document Template
|
|
42812
|
+
* @param {EntitiesApiUpdateEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
42813
|
+
* @param {*} [options] Override http request option.
|
|
42814
|
+
* @throws {RequiredError}
|
|
42815
|
+
* @memberof EntitiesApi
|
|
42816
|
+
*/
|
|
42817
|
+
updateEntityDocumentTemplates(requestParameters: EntitiesApiUpdateEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutDocument>;
|
|
42818
|
+
/**
|
|
42819
|
+
*
|
|
42820
|
+
* @summary Put a Document
|
|
42821
|
+
* @param {EntitiesApiUpdateEntityDocumentsRequest} requestParameters Request parameters.
|
|
42822
|
+
* @param {*} [options] Override http request option.
|
|
42823
|
+
* @throws {RequiredError}
|
|
42824
|
+
* @memberof EntitiesApi
|
|
42825
|
+
*/
|
|
42826
|
+
updateEntityDocuments(requestParameters: EntitiesApiUpdateEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutDocument>;
|
|
42384
42827
|
/**
|
|
42385
42828
|
*
|
|
42386
42829
|
* @summary Put an Export Definition
|
|
@@ -42516,6 +42959,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
42516
42959
|
* @memberof EntitiesApi
|
|
42517
42960
|
*/
|
|
42518
42961
|
updateEntityOrganizations(requestParameters: EntitiesApiUpdateEntityOrganizationsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationOutDocument>;
|
|
42962
|
+
/**
|
|
42963
|
+
*
|
|
42964
|
+
* @summary Put a Page Template
|
|
42965
|
+
* @param {EntitiesApiUpdateEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
42966
|
+
* @param {*} [options] Override http request option.
|
|
42967
|
+
* @throws {RequiredError}
|
|
42968
|
+
* @memberof EntitiesApi
|
|
42969
|
+
*/
|
|
42970
|
+
updateEntityPageTemplates(requestParameters: EntitiesApiUpdateEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutDocument>;
|
|
42519
42971
|
/**
|
|
42520
42972
|
*
|
|
42521
42973
|
* @summary Put a Parameter
|
|
@@ -49696,6 +50148,70 @@ export declare interface EntitiesApiCreateEntityDataSourcesRequest {
|
|
|
49696
50148
|
readonly metaInclude?: Array<'permissions' | 'all' | 'ALL'>;
|
|
49697
50149
|
}
|
|
49698
50150
|
|
|
50151
|
+
/**
|
|
50152
|
+
* Request parameters for createEntityDocuments operation in EntitiesApi.
|
|
50153
|
+
* @export
|
|
50154
|
+
* @interface EntitiesApiCreateEntityDocumentsRequest
|
|
50155
|
+
*/
|
|
50156
|
+
export declare interface EntitiesApiCreateEntityDocumentsRequest {
|
|
50157
|
+
/**
|
|
50158
|
+
*
|
|
50159
|
+
* @type {string}
|
|
50160
|
+
* @memberof EntitiesApiCreateEntityDocuments
|
|
50161
|
+
*/
|
|
50162
|
+
readonly workspaceId: string;
|
|
50163
|
+
/**
|
|
50164
|
+
*
|
|
50165
|
+
* @type {JsonApiPublisherDocumentPostOptionalIdDocument}
|
|
50166
|
+
* @memberof EntitiesApiCreateEntityDocuments
|
|
50167
|
+
*/
|
|
50168
|
+
readonly jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument;
|
|
50169
|
+
/**
|
|
50170
|
+
* 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.
|
|
50171
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50172
|
+
* @memberof EntitiesApiCreateEntityDocuments
|
|
50173
|
+
*/
|
|
50174
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50175
|
+
/**
|
|
50176
|
+
* Include Meta objects.
|
|
50177
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
50178
|
+
* @memberof EntitiesApiCreateEntityDocuments
|
|
50179
|
+
*/
|
|
50180
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
50181
|
+
}
|
|
50182
|
+
|
|
50183
|
+
/**
|
|
50184
|
+
* Request parameters for createEntityDocumentTemplates operation in EntitiesApi.
|
|
50185
|
+
* @export
|
|
50186
|
+
* @interface EntitiesApiCreateEntityDocumentTemplatesRequest
|
|
50187
|
+
*/
|
|
50188
|
+
export declare interface EntitiesApiCreateEntityDocumentTemplatesRequest {
|
|
50189
|
+
/**
|
|
50190
|
+
*
|
|
50191
|
+
* @type {string}
|
|
50192
|
+
* @memberof EntitiesApiCreateEntityDocumentTemplates
|
|
50193
|
+
*/
|
|
50194
|
+
readonly workspaceId: string;
|
|
50195
|
+
/**
|
|
50196
|
+
*
|
|
50197
|
+
* @type {JsonApiPublisherDocumentTemplatePostOptionalIdDocument}
|
|
50198
|
+
* @memberof EntitiesApiCreateEntityDocumentTemplates
|
|
50199
|
+
*/
|
|
50200
|
+
readonly jsonApiPublisherDocumentTemplatePostOptionalIdDocument: JsonApiPublisherDocumentTemplatePostOptionalIdDocument;
|
|
50201
|
+
/**
|
|
50202
|
+
* 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.
|
|
50203
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50204
|
+
* @memberof EntitiesApiCreateEntityDocumentTemplates
|
|
50205
|
+
*/
|
|
50206
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50207
|
+
/**
|
|
50208
|
+
* Include Meta objects.
|
|
50209
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
50210
|
+
* @memberof EntitiesApiCreateEntityDocumentTemplates
|
|
50211
|
+
*/
|
|
50212
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
50213
|
+
}
|
|
50214
|
+
|
|
49699
50215
|
/**
|
|
49700
50216
|
* Request parameters for createEntityExportDefinitions operation in EntitiesApi.
|
|
49701
50217
|
* @export
|
|
@@ -50006,6 +50522,38 @@ export declare interface EntitiesApiCreateEntityOrgMemoryItemsRequest {
|
|
|
50006
50522
|
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50007
50523
|
}
|
|
50008
50524
|
|
|
50525
|
+
/**
|
|
50526
|
+
* Request parameters for createEntityPageTemplates operation in EntitiesApi.
|
|
50527
|
+
* @export
|
|
50528
|
+
* @interface EntitiesApiCreateEntityPageTemplatesRequest
|
|
50529
|
+
*/
|
|
50530
|
+
export declare interface EntitiesApiCreateEntityPageTemplatesRequest {
|
|
50531
|
+
/**
|
|
50532
|
+
*
|
|
50533
|
+
* @type {string}
|
|
50534
|
+
* @memberof EntitiesApiCreateEntityPageTemplates
|
|
50535
|
+
*/
|
|
50536
|
+
readonly workspaceId: string;
|
|
50537
|
+
/**
|
|
50538
|
+
*
|
|
50539
|
+
* @type {JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument}
|
|
50540
|
+
* @memberof EntitiesApiCreateEntityPageTemplates
|
|
50541
|
+
*/
|
|
50542
|
+
readonly jsonApiPublisherDocumentPageTemplatePostOptionalIdDocument: JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument;
|
|
50543
|
+
/**
|
|
50544
|
+
* 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.
|
|
50545
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50546
|
+
* @memberof EntitiesApiCreateEntityPageTemplates
|
|
50547
|
+
*/
|
|
50548
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50549
|
+
/**
|
|
50550
|
+
* Include Meta objects.
|
|
50551
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
50552
|
+
* @memberof EntitiesApiCreateEntityPageTemplates
|
|
50553
|
+
*/
|
|
50554
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
50555
|
+
}
|
|
50556
|
+
|
|
50009
50557
|
/**
|
|
50010
50558
|
* Request parameters for createEntityParameters operation in EntitiesApi.
|
|
50011
50559
|
* @export
|
|
@@ -50696,6 +51244,46 @@ export declare interface EntitiesApiDeleteEntityDataSourcesRequest {
|
|
|
50696
51244
|
readonly id: string;
|
|
50697
51245
|
}
|
|
50698
51246
|
|
|
51247
|
+
/**
|
|
51248
|
+
* Request parameters for deleteEntityDocuments operation in EntitiesApi.
|
|
51249
|
+
* @export
|
|
51250
|
+
* @interface EntitiesApiDeleteEntityDocumentsRequest
|
|
51251
|
+
*/
|
|
51252
|
+
export declare interface EntitiesApiDeleteEntityDocumentsRequest {
|
|
51253
|
+
/**
|
|
51254
|
+
*
|
|
51255
|
+
* @type {string}
|
|
51256
|
+
* @memberof EntitiesApiDeleteEntityDocuments
|
|
51257
|
+
*/
|
|
51258
|
+
readonly workspaceId: string;
|
|
51259
|
+
/**
|
|
51260
|
+
*
|
|
51261
|
+
* @type {string}
|
|
51262
|
+
* @memberof EntitiesApiDeleteEntityDocuments
|
|
51263
|
+
*/
|
|
51264
|
+
readonly objectId: string;
|
|
51265
|
+
}
|
|
51266
|
+
|
|
51267
|
+
/**
|
|
51268
|
+
* Request parameters for deleteEntityDocumentTemplates operation in EntitiesApi.
|
|
51269
|
+
* @export
|
|
51270
|
+
* @interface EntitiesApiDeleteEntityDocumentTemplatesRequest
|
|
51271
|
+
*/
|
|
51272
|
+
export declare interface EntitiesApiDeleteEntityDocumentTemplatesRequest {
|
|
51273
|
+
/**
|
|
51274
|
+
*
|
|
51275
|
+
* @type {string}
|
|
51276
|
+
* @memberof EntitiesApiDeleteEntityDocumentTemplates
|
|
51277
|
+
*/
|
|
51278
|
+
readonly workspaceId: string;
|
|
51279
|
+
/**
|
|
51280
|
+
*
|
|
51281
|
+
* @type {string}
|
|
51282
|
+
* @memberof EntitiesApiDeleteEntityDocumentTemplates
|
|
51283
|
+
*/
|
|
51284
|
+
readonly objectId: string;
|
|
51285
|
+
}
|
|
51286
|
+
|
|
50699
51287
|
/**
|
|
50700
51288
|
* Request parameters for deleteEntityExportDefinitions operation in EntitiesApi.
|
|
50701
51289
|
* @export
|
|
@@ -50928,6 +51516,26 @@ export declare interface EntitiesApiDeleteEntityOrgMemoryItemsRequest {
|
|
|
50928
51516
|
readonly id: string;
|
|
50929
51517
|
}
|
|
50930
51518
|
|
|
51519
|
+
/**
|
|
51520
|
+
* Request parameters for deleteEntityPageTemplates operation in EntitiesApi.
|
|
51521
|
+
* @export
|
|
51522
|
+
* @interface EntitiesApiDeleteEntityPageTemplatesRequest
|
|
51523
|
+
*/
|
|
51524
|
+
export declare interface EntitiesApiDeleteEntityPageTemplatesRequest {
|
|
51525
|
+
/**
|
|
51526
|
+
*
|
|
51527
|
+
* @type {string}
|
|
51528
|
+
* @memberof EntitiesApiDeleteEntityPageTemplates
|
|
51529
|
+
*/
|
|
51530
|
+
readonly workspaceId: string;
|
|
51531
|
+
/**
|
|
51532
|
+
*
|
|
51533
|
+
* @type {string}
|
|
51534
|
+
* @memberof EntitiesApiDeleteEntityPageTemplates
|
|
51535
|
+
*/
|
|
51536
|
+
readonly objectId: string;
|
|
51537
|
+
}
|
|
51538
|
+
|
|
50931
51539
|
/**
|
|
50932
51540
|
* Request parameters for deleteEntityParameters operation in EntitiesApi.
|
|
50933
51541
|
* @export
|
|
@@ -52176,6 +52784,130 @@ export declare interface EntitiesApiGetAllEntitiesDataSourcesRequest {
|
|
|
52176
52784
|
readonly metaInclude?: Array<'permissions' | 'page' | 'all' | 'ALL'>;
|
|
52177
52785
|
}
|
|
52178
52786
|
|
|
52787
|
+
/**
|
|
52788
|
+
* Request parameters for getAllEntitiesDocuments operation in EntitiesApi.
|
|
52789
|
+
* @export
|
|
52790
|
+
* @interface EntitiesApiGetAllEntitiesDocumentsRequest
|
|
52791
|
+
*/
|
|
52792
|
+
export declare interface EntitiesApiGetAllEntitiesDocumentsRequest {
|
|
52793
|
+
/**
|
|
52794
|
+
*
|
|
52795
|
+
* @type {string}
|
|
52796
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52797
|
+
*/
|
|
52798
|
+
readonly workspaceId: string;
|
|
52799
|
+
/**
|
|
52800
|
+
*
|
|
52801
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
52802
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52803
|
+
*/
|
|
52804
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
52805
|
+
/**
|
|
52806
|
+
* 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\').
|
|
52807
|
+
* @type {string}
|
|
52808
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52809
|
+
*/
|
|
52810
|
+
readonly filter?: string;
|
|
52811
|
+
/**
|
|
52812
|
+
* 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.
|
|
52813
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
52814
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52815
|
+
*/
|
|
52816
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
52817
|
+
/**
|
|
52818
|
+
* Zero-based page index (0..N)
|
|
52819
|
+
* @type {number}
|
|
52820
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52821
|
+
*/
|
|
52822
|
+
readonly page?: number;
|
|
52823
|
+
/**
|
|
52824
|
+
* The size of the page to be returned
|
|
52825
|
+
* @type {number}
|
|
52826
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52827
|
+
*/
|
|
52828
|
+
readonly size?: number;
|
|
52829
|
+
/**
|
|
52830
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
52831
|
+
* @type {Array<string>}
|
|
52832
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52833
|
+
*/
|
|
52834
|
+
readonly sort?: Array<string>;
|
|
52835
|
+
/**
|
|
52836
|
+
*
|
|
52837
|
+
* @type {boolean}
|
|
52838
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52839
|
+
*/
|
|
52840
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
52841
|
+
/**
|
|
52842
|
+
* Include Meta objects.
|
|
52843
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
52844
|
+
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
52845
|
+
*/
|
|
52846
|
+
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
52847
|
+
}
|
|
52848
|
+
|
|
52849
|
+
/**
|
|
52850
|
+
* Request parameters for getAllEntitiesDocumentTemplates operation in EntitiesApi.
|
|
52851
|
+
* @export
|
|
52852
|
+
* @interface EntitiesApiGetAllEntitiesDocumentTemplatesRequest
|
|
52853
|
+
*/
|
|
52854
|
+
export declare interface EntitiesApiGetAllEntitiesDocumentTemplatesRequest {
|
|
52855
|
+
/**
|
|
52856
|
+
*
|
|
52857
|
+
* @type {string}
|
|
52858
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52859
|
+
*/
|
|
52860
|
+
readonly workspaceId: string;
|
|
52861
|
+
/**
|
|
52862
|
+
*
|
|
52863
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
52864
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52865
|
+
*/
|
|
52866
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
52867
|
+
/**
|
|
52868
|
+
* 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\').
|
|
52869
|
+
* @type {string}
|
|
52870
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52871
|
+
*/
|
|
52872
|
+
readonly filter?: string;
|
|
52873
|
+
/**
|
|
52874
|
+
* 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.
|
|
52875
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
52876
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52877
|
+
*/
|
|
52878
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
52879
|
+
/**
|
|
52880
|
+
* Zero-based page index (0..N)
|
|
52881
|
+
* @type {number}
|
|
52882
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52883
|
+
*/
|
|
52884
|
+
readonly page?: number;
|
|
52885
|
+
/**
|
|
52886
|
+
* The size of the page to be returned
|
|
52887
|
+
* @type {number}
|
|
52888
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52889
|
+
*/
|
|
52890
|
+
readonly size?: number;
|
|
52891
|
+
/**
|
|
52892
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
52893
|
+
* @type {Array<string>}
|
|
52894
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52895
|
+
*/
|
|
52896
|
+
readonly sort?: Array<string>;
|
|
52897
|
+
/**
|
|
52898
|
+
*
|
|
52899
|
+
* @type {boolean}
|
|
52900
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52901
|
+
*/
|
|
52902
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
52903
|
+
/**
|
|
52904
|
+
* Include Meta objects.
|
|
52905
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
52906
|
+
* @memberof EntitiesApiGetAllEntitiesDocumentTemplates
|
|
52907
|
+
*/
|
|
52908
|
+
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
52909
|
+
}
|
|
52910
|
+
|
|
52179
52911
|
/**
|
|
52180
52912
|
* Request parameters for getAllEntitiesEntitlements operation in EntitiesApi.
|
|
52181
52913
|
* @export
|
|
@@ -53120,6 +53852,68 @@ export declare interface EntitiesApiGetAllEntitiesOrgMemoryItemsRequest {
|
|
|
53120
53852
|
readonly metaInclude?: Array<'page' | 'all' | 'ALL'>;
|
|
53121
53853
|
}
|
|
53122
53854
|
|
|
53855
|
+
/**
|
|
53856
|
+
* Request parameters for getAllEntitiesPageTemplates operation in EntitiesApi.
|
|
53857
|
+
* @export
|
|
53858
|
+
* @interface EntitiesApiGetAllEntitiesPageTemplatesRequest
|
|
53859
|
+
*/
|
|
53860
|
+
export declare interface EntitiesApiGetAllEntitiesPageTemplatesRequest {
|
|
53861
|
+
/**
|
|
53862
|
+
*
|
|
53863
|
+
* @type {string}
|
|
53864
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53865
|
+
*/
|
|
53866
|
+
readonly workspaceId: string;
|
|
53867
|
+
/**
|
|
53868
|
+
*
|
|
53869
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
53870
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53871
|
+
*/
|
|
53872
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
53873
|
+
/**
|
|
53874
|
+
* 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\').
|
|
53875
|
+
* @type {string}
|
|
53876
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53877
|
+
*/
|
|
53878
|
+
readonly filter?: string;
|
|
53879
|
+
/**
|
|
53880
|
+
* 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.
|
|
53881
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
53882
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53883
|
+
*/
|
|
53884
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
53885
|
+
/**
|
|
53886
|
+
* Zero-based page index (0..N)
|
|
53887
|
+
* @type {number}
|
|
53888
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53889
|
+
*/
|
|
53890
|
+
readonly page?: number;
|
|
53891
|
+
/**
|
|
53892
|
+
* The size of the page to be returned
|
|
53893
|
+
* @type {number}
|
|
53894
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53895
|
+
*/
|
|
53896
|
+
readonly size?: number;
|
|
53897
|
+
/**
|
|
53898
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
53899
|
+
* @type {Array<string>}
|
|
53900
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53901
|
+
*/
|
|
53902
|
+
readonly sort?: Array<string>;
|
|
53903
|
+
/**
|
|
53904
|
+
*
|
|
53905
|
+
* @type {boolean}
|
|
53906
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53907
|
+
*/
|
|
53908
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
53909
|
+
/**
|
|
53910
|
+
* Include Meta objects.
|
|
53911
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
53912
|
+
* @memberof EntitiesApiGetAllEntitiesPageTemplates
|
|
53913
|
+
*/
|
|
53914
|
+
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
53915
|
+
}
|
|
53916
|
+
|
|
53123
53917
|
/**
|
|
53124
53918
|
* Request parameters for getAllEntitiesParameters operation in EntitiesApi.
|
|
53125
53919
|
* @export
|
|
@@ -54692,6 +55486,94 @@ export declare interface EntitiesApiGetEntityDataSourcesRequest {
|
|
|
54692
55486
|
readonly metaInclude?: Array<'permissions' | 'all' | 'ALL'>;
|
|
54693
55487
|
}
|
|
54694
55488
|
|
|
55489
|
+
/**
|
|
55490
|
+
* Request parameters for getEntityDocuments operation in EntitiesApi.
|
|
55491
|
+
* @export
|
|
55492
|
+
* @interface EntitiesApiGetEntityDocumentsRequest
|
|
55493
|
+
*/
|
|
55494
|
+
export declare interface EntitiesApiGetEntityDocumentsRequest {
|
|
55495
|
+
/**
|
|
55496
|
+
*
|
|
55497
|
+
* @type {string}
|
|
55498
|
+
* @memberof EntitiesApiGetEntityDocuments
|
|
55499
|
+
*/
|
|
55500
|
+
readonly workspaceId: string;
|
|
55501
|
+
/**
|
|
55502
|
+
*
|
|
55503
|
+
* @type {string}
|
|
55504
|
+
* @memberof EntitiesApiGetEntityDocuments
|
|
55505
|
+
*/
|
|
55506
|
+
readonly objectId: string;
|
|
55507
|
+
/**
|
|
55508
|
+
* 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\').
|
|
55509
|
+
* @type {string}
|
|
55510
|
+
* @memberof EntitiesApiGetEntityDocuments
|
|
55511
|
+
*/
|
|
55512
|
+
readonly filter?: string;
|
|
55513
|
+
/**
|
|
55514
|
+
* 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.
|
|
55515
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
55516
|
+
* @memberof EntitiesApiGetEntityDocuments
|
|
55517
|
+
*/
|
|
55518
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
55519
|
+
/**
|
|
55520
|
+
*
|
|
55521
|
+
* @type {boolean}
|
|
55522
|
+
* @memberof EntitiesApiGetEntityDocuments
|
|
55523
|
+
*/
|
|
55524
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
55525
|
+
/**
|
|
55526
|
+
* Include Meta objects.
|
|
55527
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
55528
|
+
* @memberof EntitiesApiGetEntityDocuments
|
|
55529
|
+
*/
|
|
55530
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
55531
|
+
}
|
|
55532
|
+
|
|
55533
|
+
/**
|
|
55534
|
+
* Request parameters for getEntityDocumentTemplates operation in EntitiesApi.
|
|
55535
|
+
* @export
|
|
55536
|
+
* @interface EntitiesApiGetEntityDocumentTemplatesRequest
|
|
55537
|
+
*/
|
|
55538
|
+
export declare interface EntitiesApiGetEntityDocumentTemplatesRequest {
|
|
55539
|
+
/**
|
|
55540
|
+
*
|
|
55541
|
+
* @type {string}
|
|
55542
|
+
* @memberof EntitiesApiGetEntityDocumentTemplates
|
|
55543
|
+
*/
|
|
55544
|
+
readonly workspaceId: string;
|
|
55545
|
+
/**
|
|
55546
|
+
*
|
|
55547
|
+
* @type {string}
|
|
55548
|
+
* @memberof EntitiesApiGetEntityDocumentTemplates
|
|
55549
|
+
*/
|
|
55550
|
+
readonly objectId: string;
|
|
55551
|
+
/**
|
|
55552
|
+
* 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\').
|
|
55553
|
+
* @type {string}
|
|
55554
|
+
* @memberof EntitiesApiGetEntityDocumentTemplates
|
|
55555
|
+
*/
|
|
55556
|
+
readonly filter?: string;
|
|
55557
|
+
/**
|
|
55558
|
+
* 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.
|
|
55559
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
55560
|
+
* @memberof EntitiesApiGetEntityDocumentTemplates
|
|
55561
|
+
*/
|
|
55562
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
55563
|
+
/**
|
|
55564
|
+
*
|
|
55565
|
+
* @type {boolean}
|
|
55566
|
+
* @memberof EntitiesApiGetEntityDocumentTemplates
|
|
55567
|
+
*/
|
|
55568
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
55569
|
+
/**
|
|
55570
|
+
* Include Meta objects.
|
|
55571
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
55572
|
+
* @memberof EntitiesApiGetEntityDocumentTemplates
|
|
55573
|
+
*/
|
|
55574
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
55575
|
+
}
|
|
55576
|
+
|
|
54695
55577
|
/**
|
|
54696
55578
|
* Request parameters for getEntityEntitlements operation in EntitiesApi.
|
|
54697
55579
|
* @export
|
|
@@ -55314,6 +56196,50 @@ export declare interface EntitiesApiGetEntityOrgMemoryItemsRequest {
|
|
|
55314
56196
|
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
55315
56197
|
}
|
|
55316
56198
|
|
|
56199
|
+
/**
|
|
56200
|
+
* Request parameters for getEntityPageTemplates operation in EntitiesApi.
|
|
56201
|
+
* @export
|
|
56202
|
+
* @interface EntitiesApiGetEntityPageTemplatesRequest
|
|
56203
|
+
*/
|
|
56204
|
+
export declare interface EntitiesApiGetEntityPageTemplatesRequest {
|
|
56205
|
+
/**
|
|
56206
|
+
*
|
|
56207
|
+
* @type {string}
|
|
56208
|
+
* @memberof EntitiesApiGetEntityPageTemplates
|
|
56209
|
+
*/
|
|
56210
|
+
readonly workspaceId: string;
|
|
56211
|
+
/**
|
|
56212
|
+
*
|
|
56213
|
+
* @type {string}
|
|
56214
|
+
* @memberof EntitiesApiGetEntityPageTemplates
|
|
56215
|
+
*/
|
|
56216
|
+
readonly objectId: string;
|
|
56217
|
+
/**
|
|
56218
|
+
* 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\').
|
|
56219
|
+
* @type {string}
|
|
56220
|
+
* @memberof EntitiesApiGetEntityPageTemplates
|
|
56221
|
+
*/
|
|
56222
|
+
readonly filter?: string;
|
|
56223
|
+
/**
|
|
56224
|
+
* 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.
|
|
56225
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
56226
|
+
* @memberof EntitiesApiGetEntityPageTemplates
|
|
56227
|
+
*/
|
|
56228
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
56229
|
+
/**
|
|
56230
|
+
*
|
|
56231
|
+
* @type {boolean}
|
|
56232
|
+
* @memberof EntitiesApiGetEntityPageTemplates
|
|
56233
|
+
*/
|
|
56234
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
56235
|
+
/**
|
|
56236
|
+
* Include Meta objects.
|
|
56237
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
56238
|
+
* @memberof EntitiesApiGetEntityPageTemplates
|
|
56239
|
+
*/
|
|
56240
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
56241
|
+
}
|
|
56242
|
+
|
|
55317
56243
|
/**
|
|
55318
56244
|
* Request parameters for getEntityParameters operation in EntitiesApi.
|
|
55319
56245
|
* @export
|
|
@@ -56128,6 +57054,24 @@ export declare interface EntitiesApiInterface {
|
|
|
56128
57054
|
* @memberof EntitiesApiInterface
|
|
56129
57055
|
*/
|
|
56130
57056
|
createEntityDataSources(requestParameters: EntitiesApiCreateEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
57057
|
+
/**
|
|
57058
|
+
*
|
|
57059
|
+
* @summary Post Document Template
|
|
57060
|
+
* @param {EntitiesApiCreateEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
57061
|
+
* @param {*} [options] Override http request option.
|
|
57062
|
+
* @throws {RequiredError}
|
|
57063
|
+
* @memberof EntitiesApiInterface
|
|
57064
|
+
*/
|
|
57065
|
+
createEntityDocumentTemplates(requestParameters: EntitiesApiCreateEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutDocument>;
|
|
57066
|
+
/**
|
|
57067
|
+
*
|
|
57068
|
+
* @summary Post Document
|
|
57069
|
+
* @param {EntitiesApiCreateEntityDocumentsRequest} requestParameters Request parameters.
|
|
57070
|
+
* @param {*} [options] Override http request option.
|
|
57071
|
+
* @throws {RequiredError}
|
|
57072
|
+
* @memberof EntitiesApiInterface
|
|
57073
|
+
*/
|
|
57074
|
+
createEntityDocuments(requestParameters: EntitiesApiCreateEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutDocument>;
|
|
56131
57075
|
/**
|
|
56132
57076
|
*
|
|
56133
57077
|
* @summary Post Export Definitions
|
|
@@ -56254,6 +57198,15 @@ export declare interface EntitiesApiInterface {
|
|
|
56254
57198
|
* @memberof EntitiesApiInterface
|
|
56255
57199
|
*/
|
|
56256
57200
|
createEntityOrganizationSettings(requestParameters: EntitiesApiCreateEntityOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationSettingOutDocument>;
|
|
57201
|
+
/**
|
|
57202
|
+
*
|
|
57203
|
+
* @summary Post Page Template
|
|
57204
|
+
* @param {EntitiesApiCreateEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
57205
|
+
* @param {*} [options] Override http request option.
|
|
57206
|
+
* @throws {RequiredError}
|
|
57207
|
+
* @memberof EntitiesApiInterface
|
|
57208
|
+
*/
|
|
57209
|
+
createEntityPageTemplates(requestParameters: EntitiesApiCreateEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutDocument>;
|
|
56257
57210
|
/**
|
|
56258
57211
|
*
|
|
56259
57212
|
* @summary Post Parameters
|
|
@@ -56534,6 +57487,24 @@ export declare interface EntitiesApiInterface {
|
|
|
56534
57487
|
* @memberof EntitiesApiInterface
|
|
56535
57488
|
*/
|
|
56536
57489
|
deleteEntityDataSources(requestParameters: EntitiesApiDeleteEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
57490
|
+
/**
|
|
57491
|
+
*
|
|
57492
|
+
* @summary Delete a Document Template
|
|
57493
|
+
* @param {EntitiesApiDeleteEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
57494
|
+
* @param {*} [options] Override http request option.
|
|
57495
|
+
* @throws {RequiredError}
|
|
57496
|
+
* @memberof EntitiesApiInterface
|
|
57497
|
+
*/
|
|
57498
|
+
deleteEntityDocumentTemplates(requestParameters: EntitiesApiDeleteEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
57499
|
+
/**
|
|
57500
|
+
*
|
|
57501
|
+
* @summary Delete a Document
|
|
57502
|
+
* @param {EntitiesApiDeleteEntityDocumentsRequest} requestParameters Request parameters.
|
|
57503
|
+
* @param {*} [options] Override http request option.
|
|
57504
|
+
* @throws {RequiredError}
|
|
57505
|
+
* @memberof EntitiesApiInterface
|
|
57506
|
+
*/
|
|
57507
|
+
deleteEntityDocuments(requestParameters: EntitiesApiDeleteEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56537
57508
|
/**
|
|
56538
57509
|
*
|
|
56539
57510
|
* @summary Delete an Export Definition
|
|
@@ -56660,6 +57631,15 @@ export declare interface EntitiesApiInterface {
|
|
|
56660
57631
|
* @memberof EntitiesApiInterface
|
|
56661
57632
|
*/
|
|
56662
57633
|
deleteEntityOrganizationSettings(requestParameters: EntitiesApiDeleteEntityOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
57634
|
+
/**
|
|
57635
|
+
*
|
|
57636
|
+
* @summary Delete a Page Template
|
|
57637
|
+
* @param {EntitiesApiDeleteEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
57638
|
+
* @param {*} [options] Override http request option.
|
|
57639
|
+
* @throws {RequiredError}
|
|
57640
|
+
* @memberof EntitiesApiInterface
|
|
57641
|
+
*/
|
|
57642
|
+
deleteEntityPageTemplates(requestParameters: EntitiesApiDeleteEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56663
57643
|
/**
|
|
56664
57644
|
*
|
|
56665
57645
|
* @summary Delete a Parameter
|
|
@@ -56984,6 +57964,24 @@ export declare interface EntitiesApiInterface {
|
|
|
56984
57964
|
* @memberof EntitiesApiInterface
|
|
56985
57965
|
*/
|
|
56986
57966
|
getAllEntitiesDatasets(requestParameters: EntitiesApiGetAllEntitiesDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutList>;
|
|
57967
|
+
/**
|
|
57968
|
+
*
|
|
57969
|
+
* @summary Get all Document Templates
|
|
57970
|
+
* @param {EntitiesApiGetAllEntitiesDocumentTemplatesRequest} requestParameters Request parameters.
|
|
57971
|
+
* @param {*} [options] Override http request option.
|
|
57972
|
+
* @throws {RequiredError}
|
|
57973
|
+
* @memberof EntitiesApiInterface
|
|
57974
|
+
*/
|
|
57975
|
+
getAllEntitiesDocumentTemplates(requestParameters: EntitiesApiGetAllEntitiesDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutList>;
|
|
57976
|
+
/**
|
|
57977
|
+
*
|
|
57978
|
+
* @summary Get all Documents
|
|
57979
|
+
* @param {EntitiesApiGetAllEntitiesDocumentsRequest} requestParameters Request parameters.
|
|
57980
|
+
* @param {*} [options] Override http request option.
|
|
57981
|
+
* @throws {RequiredError}
|
|
57982
|
+
* @memberof EntitiesApiInterface
|
|
57983
|
+
*/
|
|
57984
|
+
getAllEntitiesDocuments(requestParameters: EntitiesApiGetAllEntitiesDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutList>;
|
|
56987
57985
|
/**
|
|
56988
57986
|
* Space of the shared interest
|
|
56989
57987
|
* @summary Get Entitlements
|
|
@@ -57155,6 +58153,15 @@ export declare interface EntitiesApiInterface {
|
|
|
57155
58153
|
* @memberof EntitiesApiInterface
|
|
57156
58154
|
*/
|
|
57157
58155
|
getAllEntitiesOrganizationSettings(requestParameters: EntitiesApiGetAllEntitiesOrganizationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationSettingOutList>;
|
|
58156
|
+
/**
|
|
58157
|
+
*
|
|
58158
|
+
* @summary Get all Page Templates
|
|
58159
|
+
* @param {EntitiesApiGetAllEntitiesPageTemplatesRequest} requestParameters Request parameters.
|
|
58160
|
+
* @param {*} [options] Override http request option.
|
|
58161
|
+
* @throws {RequiredError}
|
|
58162
|
+
* @memberof EntitiesApiInterface
|
|
58163
|
+
*/
|
|
58164
|
+
getAllEntitiesPageTemplates(requestParameters: EntitiesApiGetAllEntitiesPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutList>;
|
|
57158
58165
|
/**
|
|
57159
58166
|
*
|
|
57160
58167
|
* @summary Get all Parameters
|
|
@@ -57507,6 +58514,24 @@ export declare interface EntitiesApiInterface {
|
|
|
57507
58514
|
* @memberof EntitiesApiInterface
|
|
57508
58515
|
*/
|
|
57509
58516
|
getEntityDatasets(requestParameters: EntitiesApiGetEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
58517
|
+
/**
|
|
58518
|
+
*
|
|
58519
|
+
* @summary Get a Document Template
|
|
58520
|
+
* @param {EntitiesApiGetEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
58521
|
+
* @param {*} [options] Override http request option.
|
|
58522
|
+
* @throws {RequiredError}
|
|
58523
|
+
* @memberof EntitiesApiInterface
|
|
58524
|
+
*/
|
|
58525
|
+
getEntityDocumentTemplates(requestParameters: EntitiesApiGetEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutDocument>;
|
|
58526
|
+
/**
|
|
58527
|
+
*
|
|
58528
|
+
* @summary Get a Document
|
|
58529
|
+
* @param {EntitiesApiGetEntityDocumentsRequest} requestParameters Request parameters.
|
|
58530
|
+
* @param {*} [options] Override http request option.
|
|
58531
|
+
* @throws {RequiredError}
|
|
58532
|
+
* @memberof EntitiesApiInterface
|
|
58533
|
+
*/
|
|
58534
|
+
getEntityDocuments(requestParameters: EntitiesApiGetEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutDocument>;
|
|
57510
58535
|
/**
|
|
57511
58536
|
* Space of the shared interest
|
|
57512
58537
|
* @summary Get Entitlement entity
|
|
@@ -57687,6 +58712,15 @@ export declare interface EntitiesApiInterface {
|
|
|
57687
58712
|
* @memberof EntitiesApiInterface
|
|
57688
58713
|
*/
|
|
57689
58714
|
getEntityOrganizations(requestParameters: EntitiesApiGetEntityOrganizationsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationOutDocument>;
|
|
58715
|
+
/**
|
|
58716
|
+
*
|
|
58717
|
+
* @summary Get a Page Template
|
|
58718
|
+
* @param {EntitiesApiGetEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
58719
|
+
* @param {*} [options] Override http request option.
|
|
58720
|
+
* @throws {RequiredError}
|
|
58721
|
+
* @memberof EntitiesApiInterface
|
|
58722
|
+
*/
|
|
58723
|
+
getEntityPageTemplates(requestParameters: EntitiesApiGetEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutDocument>;
|
|
57690
58724
|
/**
|
|
57691
58725
|
*
|
|
57692
58726
|
* @summary Get a Parameter
|
|
@@ -57994,6 +59028,24 @@ export declare interface EntitiesApiInterface {
|
|
|
57994
59028
|
* @memberof EntitiesApiInterface
|
|
57995
59029
|
*/
|
|
57996
59030
|
patchEntityDatasets(requestParameters: EntitiesApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
59031
|
+
/**
|
|
59032
|
+
*
|
|
59033
|
+
* @summary Patch a Document Template
|
|
59034
|
+
* @param {EntitiesApiPatchEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
59035
|
+
* @param {*} [options] Override http request option.
|
|
59036
|
+
* @throws {RequiredError}
|
|
59037
|
+
* @memberof EntitiesApiInterface
|
|
59038
|
+
*/
|
|
59039
|
+
patchEntityDocumentTemplates(requestParameters: EntitiesApiPatchEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutDocument>;
|
|
59040
|
+
/**
|
|
59041
|
+
*
|
|
59042
|
+
* @summary Patch a Document
|
|
59043
|
+
* @param {EntitiesApiPatchEntityDocumentsRequest} requestParameters Request parameters.
|
|
59044
|
+
* @param {*} [options] Override http request option.
|
|
59045
|
+
* @throws {RequiredError}
|
|
59046
|
+
* @memberof EntitiesApiInterface
|
|
59047
|
+
*/
|
|
59048
|
+
patchEntityDocuments(requestParameters: EntitiesApiPatchEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutDocument>;
|
|
57997
59049
|
/**
|
|
57998
59050
|
*
|
|
57999
59051
|
* @summary Patch an Export Definition
|
|
@@ -58138,6 +59190,15 @@ export declare interface EntitiesApiInterface {
|
|
|
58138
59190
|
* @memberof EntitiesApiInterface
|
|
58139
59191
|
*/
|
|
58140
59192
|
patchEntityOrganizations(requestParameters: EntitiesApiPatchEntityOrganizationsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationOutDocument>;
|
|
59193
|
+
/**
|
|
59194
|
+
*
|
|
59195
|
+
* @summary Patch a Page Template
|
|
59196
|
+
* @param {EntitiesApiPatchEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
59197
|
+
* @param {*} [options] Override http request option.
|
|
59198
|
+
* @throws {RequiredError}
|
|
59199
|
+
* @memberof EntitiesApiInterface
|
|
59200
|
+
*/
|
|
59201
|
+
patchEntityPageTemplates(requestParameters: EntitiesApiPatchEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutDocument>;
|
|
58141
59202
|
/**
|
|
58142
59203
|
*
|
|
58143
59204
|
* @summary Patch a Parameter
|
|
@@ -58625,6 +59686,24 @@ export declare interface EntitiesApiInterface {
|
|
|
58625
59686
|
* @memberof EntitiesApiInterface
|
|
58626
59687
|
*/
|
|
58627
59688
|
updateEntityDataSources(requestParameters: EntitiesApiUpdateEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
59689
|
+
/**
|
|
59690
|
+
*
|
|
59691
|
+
* @summary Put a Document Template
|
|
59692
|
+
* @param {EntitiesApiUpdateEntityDocumentTemplatesRequest} requestParameters Request parameters.
|
|
59693
|
+
* @param {*} [options] Override http request option.
|
|
59694
|
+
* @throws {RequiredError}
|
|
59695
|
+
* @memberof EntitiesApiInterface
|
|
59696
|
+
*/
|
|
59697
|
+
updateEntityDocumentTemplates(requestParameters: EntitiesApiUpdateEntityDocumentTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentTemplateOutDocument>;
|
|
59698
|
+
/**
|
|
59699
|
+
*
|
|
59700
|
+
* @summary Put a Document
|
|
59701
|
+
* @param {EntitiesApiUpdateEntityDocumentsRequest} requestParameters Request parameters.
|
|
59702
|
+
* @param {*} [options] Override http request option.
|
|
59703
|
+
* @throws {RequiredError}
|
|
59704
|
+
* @memberof EntitiesApiInterface
|
|
59705
|
+
*/
|
|
59706
|
+
updateEntityDocuments(requestParameters: EntitiesApiUpdateEntityDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentOutDocument>;
|
|
58628
59707
|
/**
|
|
58629
59708
|
*
|
|
58630
59709
|
* @summary Put an Export Definition
|
|
@@ -58760,6 +59839,15 @@ export declare interface EntitiesApiInterface {
|
|
|
58760
59839
|
* @memberof EntitiesApiInterface
|
|
58761
59840
|
*/
|
|
58762
59841
|
updateEntityOrganizations(requestParameters: EntitiesApiUpdateEntityOrganizationsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiOrganizationOutDocument>;
|
|
59842
|
+
/**
|
|
59843
|
+
*
|
|
59844
|
+
* @summary Put a Page Template
|
|
59845
|
+
* @param {EntitiesApiUpdateEntityPageTemplatesRequest} requestParameters Request parameters.
|
|
59846
|
+
* @param {*} [options] Override http request option.
|
|
59847
|
+
* @throws {RequiredError}
|
|
59848
|
+
* @memberof EntitiesApiInterface
|
|
59849
|
+
*/
|
|
59850
|
+
updateEntityPageTemplates(requestParameters: EntitiesApiUpdateEntityPageTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiPublisherDocumentPageTemplateOutDocument>;
|
|
58763
59851
|
/**
|
|
58764
59852
|
*
|
|
58765
59853
|
* @summary Put a Parameter
|
|
@@ -59375,6 +60463,82 @@ export declare interface EntitiesApiPatchEntityDataSourcesRequest {
|
|
|
59375
60463
|
readonly filter?: string;
|
|
59376
60464
|
}
|
|
59377
60465
|
|
|
60466
|
+
/**
|
|
60467
|
+
* Request parameters for patchEntityDocuments operation in EntitiesApi.
|
|
60468
|
+
* @export
|
|
60469
|
+
* @interface EntitiesApiPatchEntityDocumentsRequest
|
|
60470
|
+
*/
|
|
60471
|
+
export declare interface EntitiesApiPatchEntityDocumentsRequest {
|
|
60472
|
+
/**
|
|
60473
|
+
*
|
|
60474
|
+
* @type {string}
|
|
60475
|
+
* @memberof EntitiesApiPatchEntityDocuments
|
|
60476
|
+
*/
|
|
60477
|
+
readonly workspaceId: string;
|
|
60478
|
+
/**
|
|
60479
|
+
*
|
|
60480
|
+
* @type {string}
|
|
60481
|
+
* @memberof EntitiesApiPatchEntityDocuments
|
|
60482
|
+
*/
|
|
60483
|
+
readonly objectId: string;
|
|
60484
|
+
/**
|
|
60485
|
+
*
|
|
60486
|
+
* @type {JsonApiPublisherDocumentPatchDocument}
|
|
60487
|
+
* @memberof EntitiesApiPatchEntityDocuments
|
|
60488
|
+
*/
|
|
60489
|
+
readonly jsonApiPublisherDocumentPatchDocument: JsonApiPublisherDocumentPatchDocument;
|
|
60490
|
+
/**
|
|
60491
|
+
* 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\').
|
|
60492
|
+
* @type {string}
|
|
60493
|
+
* @memberof EntitiesApiPatchEntityDocuments
|
|
60494
|
+
*/
|
|
60495
|
+
readonly filter?: string;
|
|
60496
|
+
/**
|
|
60497
|
+
* 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.
|
|
60498
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
60499
|
+
* @memberof EntitiesApiPatchEntityDocuments
|
|
60500
|
+
*/
|
|
60501
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
60502
|
+
}
|
|
60503
|
+
|
|
60504
|
+
/**
|
|
60505
|
+
* Request parameters for patchEntityDocumentTemplates operation in EntitiesApi.
|
|
60506
|
+
* @export
|
|
60507
|
+
* @interface EntitiesApiPatchEntityDocumentTemplatesRequest
|
|
60508
|
+
*/
|
|
60509
|
+
export declare interface EntitiesApiPatchEntityDocumentTemplatesRequest {
|
|
60510
|
+
/**
|
|
60511
|
+
*
|
|
60512
|
+
* @type {string}
|
|
60513
|
+
* @memberof EntitiesApiPatchEntityDocumentTemplates
|
|
60514
|
+
*/
|
|
60515
|
+
readonly workspaceId: string;
|
|
60516
|
+
/**
|
|
60517
|
+
*
|
|
60518
|
+
* @type {string}
|
|
60519
|
+
* @memberof EntitiesApiPatchEntityDocumentTemplates
|
|
60520
|
+
*/
|
|
60521
|
+
readonly objectId: string;
|
|
60522
|
+
/**
|
|
60523
|
+
*
|
|
60524
|
+
* @type {JsonApiPublisherDocumentTemplatePatchDocument}
|
|
60525
|
+
* @memberof EntitiesApiPatchEntityDocumentTemplates
|
|
60526
|
+
*/
|
|
60527
|
+
readonly jsonApiPublisherDocumentTemplatePatchDocument: JsonApiPublisherDocumentTemplatePatchDocument;
|
|
60528
|
+
/**
|
|
60529
|
+
* 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\').
|
|
60530
|
+
* @type {string}
|
|
60531
|
+
* @memberof EntitiesApiPatchEntityDocumentTemplates
|
|
60532
|
+
*/
|
|
60533
|
+
readonly filter?: string;
|
|
60534
|
+
/**
|
|
60535
|
+
* 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.
|
|
60536
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
60537
|
+
* @memberof EntitiesApiPatchEntityDocumentTemplates
|
|
60538
|
+
*/
|
|
60539
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
60540
|
+
}
|
|
60541
|
+
|
|
59378
60542
|
/**
|
|
59379
60543
|
* Request parameters for patchEntityExportDefinitions operation in EntitiesApi.
|
|
59380
60544
|
* @export
|
|
@@ -59899,6 +61063,44 @@ export declare interface EntitiesApiPatchEntityOrgMemoryItemsRequest {
|
|
|
59899
61063
|
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
59900
61064
|
}
|
|
59901
61065
|
|
|
61066
|
+
/**
|
|
61067
|
+
* Request parameters for patchEntityPageTemplates operation in EntitiesApi.
|
|
61068
|
+
* @export
|
|
61069
|
+
* @interface EntitiesApiPatchEntityPageTemplatesRequest
|
|
61070
|
+
*/
|
|
61071
|
+
export declare interface EntitiesApiPatchEntityPageTemplatesRequest {
|
|
61072
|
+
/**
|
|
61073
|
+
*
|
|
61074
|
+
* @type {string}
|
|
61075
|
+
* @memberof EntitiesApiPatchEntityPageTemplates
|
|
61076
|
+
*/
|
|
61077
|
+
readonly workspaceId: string;
|
|
61078
|
+
/**
|
|
61079
|
+
*
|
|
61080
|
+
* @type {string}
|
|
61081
|
+
* @memberof EntitiesApiPatchEntityPageTemplates
|
|
61082
|
+
*/
|
|
61083
|
+
readonly objectId: string;
|
|
61084
|
+
/**
|
|
61085
|
+
*
|
|
61086
|
+
* @type {JsonApiPublisherDocumentPageTemplatePatchDocument}
|
|
61087
|
+
* @memberof EntitiesApiPatchEntityPageTemplates
|
|
61088
|
+
*/
|
|
61089
|
+
readonly jsonApiPublisherDocumentPageTemplatePatchDocument: JsonApiPublisherDocumentPageTemplatePatchDocument;
|
|
61090
|
+
/**
|
|
61091
|
+
* 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\').
|
|
61092
|
+
* @type {string}
|
|
61093
|
+
* @memberof EntitiesApiPatchEntityPageTemplates
|
|
61094
|
+
*/
|
|
61095
|
+
readonly filter?: string;
|
|
61096
|
+
/**
|
|
61097
|
+
* 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.
|
|
61098
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
61099
|
+
* @memberof EntitiesApiPatchEntityPageTemplates
|
|
61100
|
+
*/
|
|
61101
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
61102
|
+
}
|
|
61103
|
+
|
|
59902
61104
|
/**
|
|
59903
61105
|
* Request parameters for patchEntityParameters operation in EntitiesApi.
|
|
59904
61106
|
* @export
|
|
@@ -61651,6 +62853,82 @@ export declare interface EntitiesApiUpdateEntityDataSourcesRequest {
|
|
|
61651
62853
|
readonly filter?: string;
|
|
61652
62854
|
}
|
|
61653
62855
|
|
|
62856
|
+
/**
|
|
62857
|
+
* Request parameters for updateEntityDocuments operation in EntitiesApi.
|
|
62858
|
+
* @export
|
|
62859
|
+
* @interface EntitiesApiUpdateEntityDocumentsRequest
|
|
62860
|
+
*/
|
|
62861
|
+
export declare interface EntitiesApiUpdateEntityDocumentsRequest {
|
|
62862
|
+
/**
|
|
62863
|
+
*
|
|
62864
|
+
* @type {string}
|
|
62865
|
+
* @memberof EntitiesApiUpdateEntityDocuments
|
|
62866
|
+
*/
|
|
62867
|
+
readonly workspaceId: string;
|
|
62868
|
+
/**
|
|
62869
|
+
*
|
|
62870
|
+
* @type {string}
|
|
62871
|
+
* @memberof EntitiesApiUpdateEntityDocuments
|
|
62872
|
+
*/
|
|
62873
|
+
readonly objectId: string;
|
|
62874
|
+
/**
|
|
62875
|
+
*
|
|
62876
|
+
* @type {JsonApiPublisherDocumentInDocument}
|
|
62877
|
+
* @memberof EntitiesApiUpdateEntityDocuments
|
|
62878
|
+
*/
|
|
62879
|
+
readonly jsonApiPublisherDocumentInDocument: JsonApiPublisherDocumentInDocument;
|
|
62880
|
+
/**
|
|
62881
|
+
* 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\').
|
|
62882
|
+
* @type {string}
|
|
62883
|
+
* @memberof EntitiesApiUpdateEntityDocuments
|
|
62884
|
+
*/
|
|
62885
|
+
readonly filter?: string;
|
|
62886
|
+
/**
|
|
62887
|
+
* 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.
|
|
62888
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
62889
|
+
* @memberof EntitiesApiUpdateEntityDocuments
|
|
62890
|
+
*/
|
|
62891
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
62892
|
+
}
|
|
62893
|
+
|
|
62894
|
+
/**
|
|
62895
|
+
* Request parameters for updateEntityDocumentTemplates operation in EntitiesApi.
|
|
62896
|
+
* @export
|
|
62897
|
+
* @interface EntitiesApiUpdateEntityDocumentTemplatesRequest
|
|
62898
|
+
*/
|
|
62899
|
+
export declare interface EntitiesApiUpdateEntityDocumentTemplatesRequest {
|
|
62900
|
+
/**
|
|
62901
|
+
*
|
|
62902
|
+
* @type {string}
|
|
62903
|
+
* @memberof EntitiesApiUpdateEntityDocumentTemplates
|
|
62904
|
+
*/
|
|
62905
|
+
readonly workspaceId: string;
|
|
62906
|
+
/**
|
|
62907
|
+
*
|
|
62908
|
+
* @type {string}
|
|
62909
|
+
* @memberof EntitiesApiUpdateEntityDocumentTemplates
|
|
62910
|
+
*/
|
|
62911
|
+
readonly objectId: string;
|
|
62912
|
+
/**
|
|
62913
|
+
*
|
|
62914
|
+
* @type {JsonApiPublisherDocumentTemplateInDocument}
|
|
62915
|
+
* @memberof EntitiesApiUpdateEntityDocumentTemplates
|
|
62916
|
+
*/
|
|
62917
|
+
readonly jsonApiPublisherDocumentTemplateInDocument: JsonApiPublisherDocumentTemplateInDocument;
|
|
62918
|
+
/**
|
|
62919
|
+
* 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\').
|
|
62920
|
+
* @type {string}
|
|
62921
|
+
* @memberof EntitiesApiUpdateEntityDocumentTemplates
|
|
62922
|
+
*/
|
|
62923
|
+
readonly filter?: string;
|
|
62924
|
+
/**
|
|
62925
|
+
* 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.
|
|
62926
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
62927
|
+
* @memberof EntitiesApiUpdateEntityDocumentTemplates
|
|
62928
|
+
*/
|
|
62929
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
62930
|
+
}
|
|
62931
|
+
|
|
61654
62932
|
/**
|
|
61655
62933
|
* Request parameters for updateEntityExportDefinitions operation in EntitiesApi.
|
|
61656
62934
|
* @export
|
|
@@ -62131,6 +63409,44 @@ export declare interface EntitiesApiUpdateEntityOrgMemoryItemsRequest {
|
|
|
62131
63409
|
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
62132
63410
|
}
|
|
62133
63411
|
|
|
63412
|
+
/**
|
|
63413
|
+
* Request parameters for updateEntityPageTemplates operation in EntitiesApi.
|
|
63414
|
+
* @export
|
|
63415
|
+
* @interface EntitiesApiUpdateEntityPageTemplatesRequest
|
|
63416
|
+
*/
|
|
63417
|
+
export declare interface EntitiesApiUpdateEntityPageTemplatesRequest {
|
|
63418
|
+
/**
|
|
63419
|
+
*
|
|
63420
|
+
* @type {string}
|
|
63421
|
+
* @memberof EntitiesApiUpdateEntityPageTemplates
|
|
63422
|
+
*/
|
|
63423
|
+
readonly workspaceId: string;
|
|
63424
|
+
/**
|
|
63425
|
+
*
|
|
63426
|
+
* @type {string}
|
|
63427
|
+
* @memberof EntitiesApiUpdateEntityPageTemplates
|
|
63428
|
+
*/
|
|
63429
|
+
readonly objectId: string;
|
|
63430
|
+
/**
|
|
63431
|
+
*
|
|
63432
|
+
* @type {JsonApiPublisherDocumentPageTemplateInDocument}
|
|
63433
|
+
* @memberof EntitiesApiUpdateEntityPageTemplates
|
|
63434
|
+
*/
|
|
63435
|
+
readonly jsonApiPublisherDocumentPageTemplateInDocument: JsonApiPublisherDocumentPageTemplateInDocument;
|
|
63436
|
+
/**
|
|
63437
|
+
* 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\').
|
|
63438
|
+
* @type {string}
|
|
63439
|
+
* @memberof EntitiesApiUpdateEntityPageTemplates
|
|
63440
|
+
*/
|
|
63441
|
+
readonly filter?: string;
|
|
63442
|
+
/**
|
|
63443
|
+
* 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.
|
|
63444
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
63445
|
+
* @memberof EntitiesApiUpdateEntityPageTemplates
|
|
63446
|
+
*/
|
|
63447
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
63448
|
+
}
|
|
63449
|
+
|
|
62134
63450
|
/**
|
|
62135
63451
|
* Request parameters for updateEntityParameters operation in EntitiesApi.
|
|
62136
63452
|
* @export
|
|
@@ -65538,7 +66854,7 @@ export declare interface ExportIdentifierRefIdentifier {
|
|
|
65538
66854
|
'type': ExportIdentifierRefIdentifierTypeEnum;
|
|
65539
66855
|
}
|
|
65540
66856
|
|
|
65541
|
-
export declare type ExportIdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'computedAttribute' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'reportPageLayout' | 'reportTemplate' | 'report' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
66857
|
+
export declare type ExportIdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'computedAttribute' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'reportPageLayout' | 'reportTemplate' | 'report' | 'pageTemplate' | 'document' | 'documentTemplate' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
65542
66858
|
|
|
65543
66859
|
/**
|
|
65544
66860
|
* Export request object describing the export properties and metadata for image exports.
|
|
@@ -72567,7 +73883,7 @@ export declare interface IdentifierRefIdentifier {
|
|
|
72567
73883
|
'type': IdentifierRefIdentifierTypeEnum;
|
|
72568
73884
|
}
|
|
72569
73885
|
|
|
72570
|
-
export declare type IdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'computedAttribute' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'reportPageLayout' | 'reportTemplate' | 'report' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
73886
|
+
export declare type IdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'computedAttribute' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'reportPageLayout' | 'reportTemplate' | 'report' | 'pageTemplate' | 'document' | 'documentTemplate' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
72571
73887
|
|
|
72572
73888
|
/**
|
|
72573
73889
|
* IdentityProviderControllerApi - object-oriented interface
|
|
@@ -83864,6 +85180,755 @@ export declare interface JsonApiParameterPostOptionalIdDocument {
|
|
|
83864
85180
|
|
|
83865
85181
|
export declare type JsonApiParameterPostOptionalIdTypeEnum = 'parameter';
|
|
83866
85182
|
|
|
85183
|
+
/**
|
|
85184
|
+
* JSON:API representation of document entity.
|
|
85185
|
+
*/
|
|
85186
|
+
export declare interface JsonApiPublisherDocumentIn {
|
|
85187
|
+
'attributes': JsonApiPublisherDocumentInAttributes;
|
|
85188
|
+
/**
|
|
85189
|
+
* API identifier of an object
|
|
85190
|
+
*/
|
|
85191
|
+
'id': string;
|
|
85192
|
+
/**
|
|
85193
|
+
* Object type
|
|
85194
|
+
*/
|
|
85195
|
+
'type': JsonApiPublisherDocumentInTypeEnum;
|
|
85196
|
+
}
|
|
85197
|
+
|
|
85198
|
+
export declare interface JsonApiPublisherDocumentInAttributes {
|
|
85199
|
+
'areRelationsValid'?: boolean;
|
|
85200
|
+
/**
|
|
85201
|
+
* Free-form document definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85202
|
+
*/
|
|
85203
|
+
'content': object;
|
|
85204
|
+
'description'?: string;
|
|
85205
|
+
'period': JsonApiPublisherDocumentInAttributesPeriod;
|
|
85206
|
+
'tags'?: Array<string>;
|
|
85207
|
+
'title': string;
|
|
85208
|
+
/**
|
|
85209
|
+
* Version of the content format.
|
|
85210
|
+
*/
|
|
85211
|
+
'version': string;
|
|
85212
|
+
}
|
|
85213
|
+
|
|
85214
|
+
/**
|
|
85215
|
+
* @type JsonApiPublisherDocumentInAttributesPeriod
|
|
85216
|
+
* The period the document covers, absolute or relative to today.
|
|
85217
|
+
*/
|
|
85218
|
+
export declare type JsonApiPublisherDocumentInAttributesPeriod = ({
|
|
85219
|
+
type: 'absolute';
|
|
85220
|
+
} & AbsolutePublisherDocumentPeriod) | ({
|
|
85221
|
+
type: 'relative';
|
|
85222
|
+
} & RelativePublisherDocumentPeriod);
|
|
85223
|
+
|
|
85224
|
+
export declare interface JsonApiPublisherDocumentInDocument {
|
|
85225
|
+
'data': JsonApiPublisherDocumentIn;
|
|
85226
|
+
}
|
|
85227
|
+
|
|
85228
|
+
export declare type JsonApiPublisherDocumentInTypeEnum = 'document';
|
|
85229
|
+
|
|
85230
|
+
/**
|
|
85231
|
+
* JSON:API representation of document entity.
|
|
85232
|
+
*/
|
|
85233
|
+
export declare interface JsonApiPublisherDocumentOut {
|
|
85234
|
+
'attributes': JsonApiPublisherDocumentOutAttributes;
|
|
85235
|
+
/**
|
|
85236
|
+
* API identifier of an object
|
|
85237
|
+
*/
|
|
85238
|
+
'id': string;
|
|
85239
|
+
'meta'?: JsonApiPublisherDocumentOutMeta;
|
|
85240
|
+
'relationships'?: JsonApiPublisherDocumentOutRelationships;
|
|
85241
|
+
/**
|
|
85242
|
+
* Object type
|
|
85243
|
+
*/
|
|
85244
|
+
'type': JsonApiPublisherDocumentOutTypeEnum;
|
|
85245
|
+
}
|
|
85246
|
+
|
|
85247
|
+
export declare interface JsonApiPublisherDocumentOutAttributes {
|
|
85248
|
+
'areRelationsValid'?: boolean;
|
|
85249
|
+
/**
|
|
85250
|
+
* Free-form document definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85251
|
+
*/
|
|
85252
|
+
'content': object;
|
|
85253
|
+
/**
|
|
85254
|
+
* Time of the entity creation.
|
|
85255
|
+
*/
|
|
85256
|
+
'createdAt'?: string | null;
|
|
85257
|
+
'description'?: string;
|
|
85258
|
+
/**
|
|
85259
|
+
* Time of the last entity modification.
|
|
85260
|
+
*/
|
|
85261
|
+
'modifiedAt'?: string | null;
|
|
85262
|
+
'period': JsonApiPublisherDocumentOutAttributesPeriod;
|
|
85263
|
+
'tags'?: Array<string>;
|
|
85264
|
+
'title': string;
|
|
85265
|
+
/**
|
|
85266
|
+
* Version of the content format.
|
|
85267
|
+
*/
|
|
85268
|
+
'version': string;
|
|
85269
|
+
}
|
|
85270
|
+
|
|
85271
|
+
/**
|
|
85272
|
+
* @type JsonApiPublisherDocumentOutAttributesPeriod
|
|
85273
|
+
* The period the document covers, absolute or relative to today.
|
|
85274
|
+
*/
|
|
85275
|
+
export declare type JsonApiPublisherDocumentOutAttributesPeriod = ({
|
|
85276
|
+
type: 'absolute';
|
|
85277
|
+
} & AbsolutePublisherDocumentPeriod) | ({
|
|
85278
|
+
type: 'relative';
|
|
85279
|
+
} & RelativePublisherDocumentPeriod);
|
|
85280
|
+
|
|
85281
|
+
export declare interface JsonApiPublisherDocumentOutDocument {
|
|
85282
|
+
'data': JsonApiPublisherDocumentOut;
|
|
85283
|
+
/**
|
|
85284
|
+
* Included resources
|
|
85285
|
+
*/
|
|
85286
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
85287
|
+
'links'?: ObjectLinks;
|
|
85288
|
+
'meta'?: JsonApiPublisherDocumentOutDocumentMeta;
|
|
85289
|
+
}
|
|
85290
|
+
|
|
85291
|
+
export declare interface JsonApiPublisherDocumentOutDocumentMeta {
|
|
85292
|
+
/**
|
|
85293
|
+
* References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
|
|
85294
|
+
*/
|
|
85295
|
+
'restricted'?: Array<RestrictedObject>;
|
|
85296
|
+
}
|
|
85297
|
+
|
|
85298
|
+
/**
|
|
85299
|
+
* A JSON:API document with a list of resources
|
|
85300
|
+
*/
|
|
85301
|
+
export declare interface JsonApiPublisherDocumentOutList {
|
|
85302
|
+
'data': Array<JsonApiPublisherDocumentOutWithLinks>;
|
|
85303
|
+
/**
|
|
85304
|
+
* Included resources
|
|
85305
|
+
*/
|
|
85306
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
85307
|
+
'links'?: ListLinks;
|
|
85308
|
+
'meta'?: JsonApiPublisherDocumentOutListMeta;
|
|
85309
|
+
}
|
|
85310
|
+
|
|
85311
|
+
export declare interface JsonApiPublisherDocumentOutListMeta {
|
|
85312
|
+
'page'?: PageMetadata;
|
|
85313
|
+
/**
|
|
85314
|
+
* References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
|
|
85315
|
+
*/
|
|
85316
|
+
'restricted'?: Array<RestrictedObject>;
|
|
85317
|
+
}
|
|
85318
|
+
|
|
85319
|
+
export declare interface JsonApiPublisherDocumentOutMeta {
|
|
85320
|
+
'origin'?: JsonApiPublisherDocumentOutMetaOrigin;
|
|
85321
|
+
}
|
|
85322
|
+
|
|
85323
|
+
export declare interface JsonApiPublisherDocumentOutMetaOrigin {
|
|
85324
|
+
/**
|
|
85325
|
+
* defines id of the workspace where the entity comes from
|
|
85326
|
+
*/
|
|
85327
|
+
'originId': string;
|
|
85328
|
+
/**
|
|
85329
|
+
* defines type of the origin of the entity
|
|
85330
|
+
*/
|
|
85331
|
+
'originType': JsonApiPublisherDocumentOutMetaOriginOriginTypeEnum;
|
|
85332
|
+
}
|
|
85333
|
+
|
|
85334
|
+
export declare type JsonApiPublisherDocumentOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
85335
|
+
|
|
85336
|
+
export declare interface JsonApiPublisherDocumentOutRelationships {
|
|
85337
|
+
'createdBy'?: JsonApiPublisherDocumentOutRelationshipsCreatedBy;
|
|
85338
|
+
'modifiedBy'?: JsonApiPublisherDocumentOutRelationshipsModifiedBy;
|
|
85339
|
+
}
|
|
85340
|
+
|
|
85341
|
+
export declare interface JsonApiPublisherDocumentOutRelationshipsCreatedBy {
|
|
85342
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
85343
|
+
}
|
|
85344
|
+
|
|
85345
|
+
export declare interface JsonApiPublisherDocumentOutRelationshipsModifiedBy {
|
|
85346
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
85347
|
+
}
|
|
85348
|
+
|
|
85349
|
+
export declare type JsonApiPublisherDocumentOutTypeEnum = 'document';
|
|
85350
|
+
|
|
85351
|
+
export declare interface JsonApiPublisherDocumentOutWithLinks {
|
|
85352
|
+
'attributes': JsonApiPublisherDocumentOutAttributes;
|
|
85353
|
+
/**
|
|
85354
|
+
* API identifier of an object
|
|
85355
|
+
*/
|
|
85356
|
+
'id': string;
|
|
85357
|
+
'meta'?: JsonApiPublisherDocumentOutMeta;
|
|
85358
|
+
'relationships'?: JsonApiPublisherDocumentOutRelationships;
|
|
85359
|
+
/**
|
|
85360
|
+
* Object type
|
|
85361
|
+
*/
|
|
85362
|
+
'type': JsonApiPublisherDocumentOutWithLinksTypeEnum;
|
|
85363
|
+
'links'?: ObjectLinks;
|
|
85364
|
+
}
|
|
85365
|
+
|
|
85366
|
+
export declare type JsonApiPublisherDocumentOutWithLinksTypeEnum = 'document';
|
|
85367
|
+
|
|
85368
|
+
/**
|
|
85369
|
+
* JSON:API representation of pageTemplate entity.
|
|
85370
|
+
*/
|
|
85371
|
+
export declare interface JsonApiPublisherDocumentPageTemplateIn {
|
|
85372
|
+
'attributes': JsonApiPublisherDocumentPageTemplateInAttributes;
|
|
85373
|
+
/**
|
|
85374
|
+
* API identifier of an object
|
|
85375
|
+
*/
|
|
85376
|
+
'id': string;
|
|
85377
|
+
/**
|
|
85378
|
+
* Object type
|
|
85379
|
+
*/
|
|
85380
|
+
'type': JsonApiPublisherDocumentPageTemplateInTypeEnum;
|
|
85381
|
+
}
|
|
85382
|
+
|
|
85383
|
+
export declare interface JsonApiPublisherDocumentPageTemplateInAttributes {
|
|
85384
|
+
'areRelationsValid'?: boolean;
|
|
85385
|
+
/**
|
|
85386
|
+
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85387
|
+
*/
|
|
85388
|
+
'content': object;
|
|
85389
|
+
'description'?: string;
|
|
85390
|
+
'tags'?: Array<string>;
|
|
85391
|
+
'title': string;
|
|
85392
|
+
/**
|
|
85393
|
+
* Version of the content format.
|
|
85394
|
+
*/
|
|
85395
|
+
'version': string;
|
|
85396
|
+
}
|
|
85397
|
+
|
|
85398
|
+
export declare interface JsonApiPublisherDocumentPageTemplateInDocument {
|
|
85399
|
+
'data': JsonApiPublisherDocumentPageTemplateIn;
|
|
85400
|
+
}
|
|
85401
|
+
|
|
85402
|
+
export declare type JsonApiPublisherDocumentPageTemplateInTypeEnum = 'pageTemplate';
|
|
85403
|
+
|
|
85404
|
+
/**
|
|
85405
|
+
* JSON:API representation of pageTemplate entity.
|
|
85406
|
+
*/
|
|
85407
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOut {
|
|
85408
|
+
'attributes': JsonApiPublisherDocumentPageTemplateOutAttributes;
|
|
85409
|
+
/**
|
|
85410
|
+
* API identifier of an object
|
|
85411
|
+
*/
|
|
85412
|
+
'id': string;
|
|
85413
|
+
'meta'?: JsonApiPublisherDocumentPageTemplateOutMeta;
|
|
85414
|
+
'relationships'?: JsonApiPublisherDocumentPageTemplateOutRelationships;
|
|
85415
|
+
/**
|
|
85416
|
+
* Object type
|
|
85417
|
+
*/
|
|
85418
|
+
'type': JsonApiPublisherDocumentPageTemplateOutTypeEnum;
|
|
85419
|
+
}
|
|
85420
|
+
|
|
85421
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutAttributes {
|
|
85422
|
+
'areRelationsValid'?: boolean;
|
|
85423
|
+
/**
|
|
85424
|
+
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85425
|
+
*/
|
|
85426
|
+
'content': object;
|
|
85427
|
+
/**
|
|
85428
|
+
* Time of the entity creation.
|
|
85429
|
+
*/
|
|
85430
|
+
'createdAt'?: string | null;
|
|
85431
|
+
'description'?: string;
|
|
85432
|
+
/**
|
|
85433
|
+
* Time of the last entity modification.
|
|
85434
|
+
*/
|
|
85435
|
+
'modifiedAt'?: string | null;
|
|
85436
|
+
'tags'?: Array<string>;
|
|
85437
|
+
'title': string;
|
|
85438
|
+
/**
|
|
85439
|
+
* Version of the content format.
|
|
85440
|
+
*/
|
|
85441
|
+
'version': string;
|
|
85442
|
+
}
|
|
85443
|
+
|
|
85444
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutDocument {
|
|
85445
|
+
'data': JsonApiPublisherDocumentPageTemplateOut;
|
|
85446
|
+
/**
|
|
85447
|
+
* Included resources
|
|
85448
|
+
*/
|
|
85449
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
85450
|
+
'links'?: ObjectLinks;
|
|
85451
|
+
'meta'?: JsonApiPublisherDocumentPageTemplateOutDocumentMeta;
|
|
85452
|
+
}
|
|
85453
|
+
|
|
85454
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutDocumentMeta {
|
|
85455
|
+
/**
|
|
85456
|
+
* References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
|
|
85457
|
+
*/
|
|
85458
|
+
'restricted'?: Array<RestrictedObject>;
|
|
85459
|
+
}
|
|
85460
|
+
|
|
85461
|
+
/**
|
|
85462
|
+
* A JSON:API document with a list of resources
|
|
85463
|
+
*/
|
|
85464
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutList {
|
|
85465
|
+
'data': Array<JsonApiPublisherDocumentPageTemplateOutWithLinks>;
|
|
85466
|
+
/**
|
|
85467
|
+
* Included resources
|
|
85468
|
+
*/
|
|
85469
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
85470
|
+
'links'?: ListLinks;
|
|
85471
|
+
'meta'?: JsonApiPublisherDocumentPageTemplateOutListMeta;
|
|
85472
|
+
}
|
|
85473
|
+
|
|
85474
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutListMeta {
|
|
85475
|
+
'page'?: PageMetadata;
|
|
85476
|
+
/**
|
|
85477
|
+
* References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
|
|
85478
|
+
*/
|
|
85479
|
+
'restricted'?: Array<RestrictedObject>;
|
|
85480
|
+
}
|
|
85481
|
+
|
|
85482
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutMeta {
|
|
85483
|
+
'origin'?: JsonApiPublisherDocumentPageTemplateOutMetaOrigin;
|
|
85484
|
+
}
|
|
85485
|
+
|
|
85486
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutMetaOrigin {
|
|
85487
|
+
/**
|
|
85488
|
+
* defines id of the workspace where the entity comes from
|
|
85489
|
+
*/
|
|
85490
|
+
'originId': string;
|
|
85491
|
+
/**
|
|
85492
|
+
* defines type of the origin of the entity
|
|
85493
|
+
*/
|
|
85494
|
+
'originType': JsonApiPublisherDocumentPageTemplateOutMetaOriginOriginTypeEnum;
|
|
85495
|
+
}
|
|
85496
|
+
|
|
85497
|
+
export declare type JsonApiPublisherDocumentPageTemplateOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
85498
|
+
|
|
85499
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutRelationships {
|
|
85500
|
+
'createdBy'?: JsonApiPublisherDocumentPageTemplateOutRelationshipsCreatedBy;
|
|
85501
|
+
'modifiedBy'?: JsonApiPublisherDocumentPageTemplateOutRelationshipsModifiedBy;
|
|
85502
|
+
}
|
|
85503
|
+
|
|
85504
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutRelationshipsCreatedBy {
|
|
85505
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
85506
|
+
}
|
|
85507
|
+
|
|
85508
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutRelationshipsModifiedBy {
|
|
85509
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
85510
|
+
}
|
|
85511
|
+
|
|
85512
|
+
export declare type JsonApiPublisherDocumentPageTemplateOutTypeEnum = 'pageTemplate';
|
|
85513
|
+
|
|
85514
|
+
export declare interface JsonApiPublisherDocumentPageTemplateOutWithLinks {
|
|
85515
|
+
'attributes': JsonApiPublisherDocumentPageTemplateOutAttributes;
|
|
85516
|
+
/**
|
|
85517
|
+
* API identifier of an object
|
|
85518
|
+
*/
|
|
85519
|
+
'id': string;
|
|
85520
|
+
'meta'?: JsonApiPublisherDocumentPageTemplateOutMeta;
|
|
85521
|
+
'relationships'?: JsonApiPublisherDocumentPageTemplateOutRelationships;
|
|
85522
|
+
/**
|
|
85523
|
+
* Object type
|
|
85524
|
+
*/
|
|
85525
|
+
'type': JsonApiPublisherDocumentPageTemplateOutWithLinksTypeEnum;
|
|
85526
|
+
'links'?: ObjectLinks;
|
|
85527
|
+
}
|
|
85528
|
+
|
|
85529
|
+
export declare type JsonApiPublisherDocumentPageTemplateOutWithLinksTypeEnum = 'pageTemplate';
|
|
85530
|
+
|
|
85531
|
+
/**
|
|
85532
|
+
* JSON:API representation of patching pageTemplate entity.
|
|
85533
|
+
*/
|
|
85534
|
+
export declare interface JsonApiPublisherDocumentPageTemplatePatch {
|
|
85535
|
+
'attributes': JsonApiPublisherDocumentPageTemplatePatchAttributes;
|
|
85536
|
+
/**
|
|
85537
|
+
* API identifier of an object
|
|
85538
|
+
*/
|
|
85539
|
+
'id': string;
|
|
85540
|
+
/**
|
|
85541
|
+
* Object type
|
|
85542
|
+
*/
|
|
85543
|
+
'type': JsonApiPublisherDocumentPageTemplatePatchTypeEnum;
|
|
85544
|
+
}
|
|
85545
|
+
|
|
85546
|
+
export declare interface JsonApiPublisherDocumentPageTemplatePatchAttributes {
|
|
85547
|
+
'areRelationsValid'?: boolean;
|
|
85548
|
+
/**
|
|
85549
|
+
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85550
|
+
*/
|
|
85551
|
+
'content'?: object;
|
|
85552
|
+
'description'?: string;
|
|
85553
|
+
'tags'?: Array<string>;
|
|
85554
|
+
'title'?: string;
|
|
85555
|
+
/**
|
|
85556
|
+
* Version of the content format.
|
|
85557
|
+
*/
|
|
85558
|
+
'version'?: string;
|
|
85559
|
+
}
|
|
85560
|
+
|
|
85561
|
+
export declare interface JsonApiPublisherDocumentPageTemplatePatchDocument {
|
|
85562
|
+
'data': JsonApiPublisherDocumentPageTemplatePatch;
|
|
85563
|
+
}
|
|
85564
|
+
|
|
85565
|
+
export declare type JsonApiPublisherDocumentPageTemplatePatchTypeEnum = 'pageTemplate';
|
|
85566
|
+
|
|
85567
|
+
/**
|
|
85568
|
+
* JSON:API representation of pageTemplate entity.
|
|
85569
|
+
*/
|
|
85570
|
+
export declare interface JsonApiPublisherDocumentPageTemplatePostOptionalId {
|
|
85571
|
+
'attributes': JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributes;
|
|
85572
|
+
/**
|
|
85573
|
+
* API identifier of an object
|
|
85574
|
+
*/
|
|
85575
|
+
'id'?: string;
|
|
85576
|
+
/**
|
|
85577
|
+
* Object type
|
|
85578
|
+
*/
|
|
85579
|
+
'type': JsonApiPublisherDocumentPageTemplatePostOptionalIdTypeEnum;
|
|
85580
|
+
}
|
|
85581
|
+
|
|
85582
|
+
export declare interface JsonApiPublisherDocumentPageTemplatePostOptionalIdAttributes {
|
|
85583
|
+
'areRelationsValid'?: boolean;
|
|
85584
|
+
/**
|
|
85585
|
+
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85586
|
+
*/
|
|
85587
|
+
'content': object;
|
|
85588
|
+
'description'?: string;
|
|
85589
|
+
'tags'?: Array<string>;
|
|
85590
|
+
'title': string;
|
|
85591
|
+
/**
|
|
85592
|
+
* Version of the content format.
|
|
85593
|
+
*/
|
|
85594
|
+
'version': string;
|
|
85595
|
+
}
|
|
85596
|
+
|
|
85597
|
+
export declare interface JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument {
|
|
85598
|
+
'data': JsonApiPublisherDocumentPageTemplatePostOptionalId;
|
|
85599
|
+
}
|
|
85600
|
+
|
|
85601
|
+
export declare type JsonApiPublisherDocumentPageTemplatePostOptionalIdTypeEnum = 'pageTemplate';
|
|
85602
|
+
|
|
85603
|
+
/**
|
|
85604
|
+
* JSON:API representation of patching document entity.
|
|
85605
|
+
*/
|
|
85606
|
+
export declare interface JsonApiPublisherDocumentPatch {
|
|
85607
|
+
'attributes': JsonApiPublisherDocumentPatchAttributes;
|
|
85608
|
+
/**
|
|
85609
|
+
* API identifier of an object
|
|
85610
|
+
*/
|
|
85611
|
+
'id': string;
|
|
85612
|
+
/**
|
|
85613
|
+
* Object type
|
|
85614
|
+
*/
|
|
85615
|
+
'type': JsonApiPublisherDocumentPatchTypeEnum;
|
|
85616
|
+
}
|
|
85617
|
+
|
|
85618
|
+
export declare interface JsonApiPublisherDocumentPatchAttributes {
|
|
85619
|
+
'areRelationsValid'?: boolean;
|
|
85620
|
+
/**
|
|
85621
|
+
* Free-form document definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85622
|
+
*/
|
|
85623
|
+
'content'?: object;
|
|
85624
|
+
'description'?: string;
|
|
85625
|
+
'period'?: JsonApiPublisherDocumentPatchAttributesPeriod;
|
|
85626
|
+
'tags'?: Array<string>;
|
|
85627
|
+
'title'?: string;
|
|
85628
|
+
/**
|
|
85629
|
+
* Version of the content format.
|
|
85630
|
+
*/
|
|
85631
|
+
'version'?: string;
|
|
85632
|
+
}
|
|
85633
|
+
|
|
85634
|
+
/**
|
|
85635
|
+
* @type JsonApiPublisherDocumentPatchAttributesPeriod
|
|
85636
|
+
* The period the document covers, absolute or relative to today.
|
|
85637
|
+
*/
|
|
85638
|
+
export declare type JsonApiPublisherDocumentPatchAttributesPeriod = ({
|
|
85639
|
+
type: 'absolute';
|
|
85640
|
+
} & AbsolutePublisherDocumentPeriod) | ({
|
|
85641
|
+
type: 'relative';
|
|
85642
|
+
} & RelativePublisherDocumentPeriod);
|
|
85643
|
+
|
|
85644
|
+
export declare interface JsonApiPublisherDocumentPatchDocument {
|
|
85645
|
+
'data': JsonApiPublisherDocumentPatch;
|
|
85646
|
+
}
|
|
85647
|
+
|
|
85648
|
+
export declare type JsonApiPublisherDocumentPatchTypeEnum = 'document';
|
|
85649
|
+
|
|
85650
|
+
/**
|
|
85651
|
+
* JSON:API representation of document entity.
|
|
85652
|
+
*/
|
|
85653
|
+
export declare interface JsonApiPublisherDocumentPostOptionalId {
|
|
85654
|
+
'attributes': JsonApiPublisherDocumentPostOptionalIdAttributes;
|
|
85655
|
+
/**
|
|
85656
|
+
* API identifier of an object
|
|
85657
|
+
*/
|
|
85658
|
+
'id'?: string;
|
|
85659
|
+
/**
|
|
85660
|
+
* Object type
|
|
85661
|
+
*/
|
|
85662
|
+
'type': JsonApiPublisherDocumentPostOptionalIdTypeEnum;
|
|
85663
|
+
}
|
|
85664
|
+
|
|
85665
|
+
export declare interface JsonApiPublisherDocumentPostOptionalIdAttributes {
|
|
85666
|
+
'areRelationsValid'?: boolean;
|
|
85667
|
+
/**
|
|
85668
|
+
* Free-form document definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85669
|
+
*/
|
|
85670
|
+
'content': object;
|
|
85671
|
+
'description'?: string;
|
|
85672
|
+
'period': JsonApiPublisherDocumentPostOptionalIdAttributesPeriod;
|
|
85673
|
+
'tags'?: Array<string>;
|
|
85674
|
+
'title': string;
|
|
85675
|
+
/**
|
|
85676
|
+
* Version of the content format.
|
|
85677
|
+
*/
|
|
85678
|
+
'version': string;
|
|
85679
|
+
}
|
|
85680
|
+
|
|
85681
|
+
/**
|
|
85682
|
+
* @type JsonApiPublisherDocumentPostOptionalIdAttributesPeriod
|
|
85683
|
+
* The period the document covers, absolute or relative to today.
|
|
85684
|
+
*/
|
|
85685
|
+
export declare type JsonApiPublisherDocumentPostOptionalIdAttributesPeriod = ({
|
|
85686
|
+
type: 'absolute';
|
|
85687
|
+
} & AbsolutePublisherDocumentPeriod) | ({
|
|
85688
|
+
type: 'relative';
|
|
85689
|
+
} & RelativePublisherDocumentPeriod);
|
|
85690
|
+
|
|
85691
|
+
export declare interface JsonApiPublisherDocumentPostOptionalIdDocument {
|
|
85692
|
+
'data': JsonApiPublisherDocumentPostOptionalId;
|
|
85693
|
+
}
|
|
85694
|
+
|
|
85695
|
+
export declare type JsonApiPublisherDocumentPostOptionalIdTypeEnum = 'document';
|
|
85696
|
+
|
|
85697
|
+
/**
|
|
85698
|
+
* JSON:API representation of documentTemplate entity.
|
|
85699
|
+
*/
|
|
85700
|
+
export declare interface JsonApiPublisherDocumentTemplateIn {
|
|
85701
|
+
'attributes': JsonApiPublisherDocumentTemplateInAttributes;
|
|
85702
|
+
/**
|
|
85703
|
+
* API identifier of an object
|
|
85704
|
+
*/
|
|
85705
|
+
'id': string;
|
|
85706
|
+
/**
|
|
85707
|
+
* Object type
|
|
85708
|
+
*/
|
|
85709
|
+
'type': JsonApiPublisherDocumentTemplateInTypeEnum;
|
|
85710
|
+
}
|
|
85711
|
+
|
|
85712
|
+
export declare interface JsonApiPublisherDocumentTemplateInAttributes {
|
|
85713
|
+
'areRelationsValid'?: boolean;
|
|
85714
|
+
/**
|
|
85715
|
+
* Free-form document template definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85716
|
+
*/
|
|
85717
|
+
'content': object;
|
|
85718
|
+
'description'?: string;
|
|
85719
|
+
'tags'?: Array<string>;
|
|
85720
|
+
'title': string;
|
|
85721
|
+
/**
|
|
85722
|
+
* Version of the content format.
|
|
85723
|
+
*/
|
|
85724
|
+
'version': string;
|
|
85725
|
+
}
|
|
85726
|
+
|
|
85727
|
+
export declare interface JsonApiPublisherDocumentTemplateInDocument {
|
|
85728
|
+
'data': JsonApiPublisherDocumentTemplateIn;
|
|
85729
|
+
}
|
|
85730
|
+
|
|
85731
|
+
export declare type JsonApiPublisherDocumentTemplateInTypeEnum = 'documentTemplate';
|
|
85732
|
+
|
|
85733
|
+
/**
|
|
85734
|
+
* JSON:API representation of documentTemplate entity.
|
|
85735
|
+
*/
|
|
85736
|
+
export declare interface JsonApiPublisherDocumentTemplateOut {
|
|
85737
|
+
'attributes': JsonApiPublisherDocumentTemplateOutAttributes;
|
|
85738
|
+
/**
|
|
85739
|
+
* API identifier of an object
|
|
85740
|
+
*/
|
|
85741
|
+
'id': string;
|
|
85742
|
+
'meta'?: JsonApiPublisherDocumentTemplateOutMeta;
|
|
85743
|
+
'relationships'?: JsonApiPublisherDocumentTemplateOutRelationships;
|
|
85744
|
+
/**
|
|
85745
|
+
* Object type
|
|
85746
|
+
*/
|
|
85747
|
+
'type': JsonApiPublisherDocumentTemplateOutTypeEnum;
|
|
85748
|
+
}
|
|
85749
|
+
|
|
85750
|
+
export declare interface JsonApiPublisherDocumentTemplateOutAttributes {
|
|
85751
|
+
'areRelationsValid'?: boolean;
|
|
85752
|
+
/**
|
|
85753
|
+
* Free-form document template definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85754
|
+
*/
|
|
85755
|
+
'content': object;
|
|
85756
|
+
/**
|
|
85757
|
+
* Time of the entity creation.
|
|
85758
|
+
*/
|
|
85759
|
+
'createdAt'?: string | null;
|
|
85760
|
+
'description'?: string;
|
|
85761
|
+
/**
|
|
85762
|
+
* Time of the last entity modification.
|
|
85763
|
+
*/
|
|
85764
|
+
'modifiedAt'?: string | null;
|
|
85765
|
+
'tags'?: Array<string>;
|
|
85766
|
+
'title': string;
|
|
85767
|
+
/**
|
|
85768
|
+
* Version of the content format.
|
|
85769
|
+
*/
|
|
85770
|
+
'version': string;
|
|
85771
|
+
}
|
|
85772
|
+
|
|
85773
|
+
export declare interface JsonApiPublisherDocumentTemplateOutDocument {
|
|
85774
|
+
'data': JsonApiPublisherDocumentTemplateOut;
|
|
85775
|
+
/**
|
|
85776
|
+
* Included resources
|
|
85777
|
+
*/
|
|
85778
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
85779
|
+
'links'?: ObjectLinks;
|
|
85780
|
+
'meta'?: JsonApiPublisherDocumentTemplateOutDocumentMeta;
|
|
85781
|
+
}
|
|
85782
|
+
|
|
85783
|
+
export declare interface JsonApiPublisherDocumentTemplateOutDocumentMeta {
|
|
85784
|
+
/**
|
|
85785
|
+
* References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
|
|
85786
|
+
*/
|
|
85787
|
+
'restricted'?: Array<RestrictedObject>;
|
|
85788
|
+
}
|
|
85789
|
+
|
|
85790
|
+
/**
|
|
85791
|
+
* A JSON:API document with a list of resources
|
|
85792
|
+
*/
|
|
85793
|
+
export declare interface JsonApiPublisherDocumentTemplateOutList {
|
|
85794
|
+
'data': Array<JsonApiPublisherDocumentTemplateOutWithLinks>;
|
|
85795
|
+
/**
|
|
85796
|
+
* Included resources
|
|
85797
|
+
*/
|
|
85798
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
85799
|
+
'links'?: ListLinks;
|
|
85800
|
+
'meta'?: JsonApiPublisherDocumentTemplateOutListMeta;
|
|
85801
|
+
}
|
|
85802
|
+
|
|
85803
|
+
export declare interface JsonApiPublisherDocumentTemplateOutListMeta {
|
|
85804
|
+
'page'?: PageMetadata;
|
|
85805
|
+
/**
|
|
85806
|
+
* References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
|
|
85807
|
+
*/
|
|
85808
|
+
'restricted'?: Array<RestrictedObject>;
|
|
85809
|
+
}
|
|
85810
|
+
|
|
85811
|
+
export declare interface JsonApiPublisherDocumentTemplateOutMeta {
|
|
85812
|
+
'origin'?: JsonApiPublisherDocumentTemplateOutMetaOrigin;
|
|
85813
|
+
}
|
|
85814
|
+
|
|
85815
|
+
export declare interface JsonApiPublisherDocumentTemplateOutMetaOrigin {
|
|
85816
|
+
/**
|
|
85817
|
+
* defines id of the workspace where the entity comes from
|
|
85818
|
+
*/
|
|
85819
|
+
'originId': string;
|
|
85820
|
+
/**
|
|
85821
|
+
* defines type of the origin of the entity
|
|
85822
|
+
*/
|
|
85823
|
+
'originType': JsonApiPublisherDocumentTemplateOutMetaOriginOriginTypeEnum;
|
|
85824
|
+
}
|
|
85825
|
+
|
|
85826
|
+
export declare type JsonApiPublisherDocumentTemplateOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
85827
|
+
|
|
85828
|
+
export declare interface JsonApiPublisherDocumentTemplateOutRelationships {
|
|
85829
|
+
'createdBy'?: JsonApiPublisherDocumentTemplateOutRelationshipsCreatedBy;
|
|
85830
|
+
'modifiedBy'?: JsonApiPublisherDocumentTemplateOutRelationshipsModifiedBy;
|
|
85831
|
+
}
|
|
85832
|
+
|
|
85833
|
+
export declare interface JsonApiPublisherDocumentTemplateOutRelationshipsCreatedBy {
|
|
85834
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
85835
|
+
}
|
|
85836
|
+
|
|
85837
|
+
export declare interface JsonApiPublisherDocumentTemplateOutRelationshipsModifiedBy {
|
|
85838
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
85839
|
+
}
|
|
85840
|
+
|
|
85841
|
+
export declare type JsonApiPublisherDocumentTemplateOutTypeEnum = 'documentTemplate';
|
|
85842
|
+
|
|
85843
|
+
export declare interface JsonApiPublisherDocumentTemplateOutWithLinks {
|
|
85844
|
+
'attributes': JsonApiPublisherDocumentTemplateOutAttributes;
|
|
85845
|
+
/**
|
|
85846
|
+
* API identifier of an object
|
|
85847
|
+
*/
|
|
85848
|
+
'id': string;
|
|
85849
|
+
'meta'?: JsonApiPublisherDocumentTemplateOutMeta;
|
|
85850
|
+
'relationships'?: JsonApiPublisherDocumentTemplateOutRelationships;
|
|
85851
|
+
/**
|
|
85852
|
+
* Object type
|
|
85853
|
+
*/
|
|
85854
|
+
'type': JsonApiPublisherDocumentTemplateOutWithLinksTypeEnum;
|
|
85855
|
+
'links'?: ObjectLinks;
|
|
85856
|
+
}
|
|
85857
|
+
|
|
85858
|
+
export declare type JsonApiPublisherDocumentTemplateOutWithLinksTypeEnum = 'documentTemplate';
|
|
85859
|
+
|
|
85860
|
+
/**
|
|
85861
|
+
* JSON:API representation of patching documentTemplate entity.
|
|
85862
|
+
*/
|
|
85863
|
+
export declare interface JsonApiPublisherDocumentTemplatePatch {
|
|
85864
|
+
'attributes': JsonApiPublisherDocumentTemplatePatchAttributes;
|
|
85865
|
+
/**
|
|
85866
|
+
* API identifier of an object
|
|
85867
|
+
*/
|
|
85868
|
+
'id': string;
|
|
85869
|
+
/**
|
|
85870
|
+
* Object type
|
|
85871
|
+
*/
|
|
85872
|
+
'type': JsonApiPublisherDocumentTemplatePatchTypeEnum;
|
|
85873
|
+
}
|
|
85874
|
+
|
|
85875
|
+
export declare interface JsonApiPublisherDocumentTemplatePatchAttributes {
|
|
85876
|
+
'areRelationsValid'?: boolean;
|
|
85877
|
+
/**
|
|
85878
|
+
* Free-form document template definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85879
|
+
*/
|
|
85880
|
+
'content'?: object;
|
|
85881
|
+
'description'?: string;
|
|
85882
|
+
'tags'?: Array<string>;
|
|
85883
|
+
'title'?: string;
|
|
85884
|
+
/**
|
|
85885
|
+
* Version of the content format.
|
|
85886
|
+
*/
|
|
85887
|
+
'version'?: string;
|
|
85888
|
+
}
|
|
85889
|
+
|
|
85890
|
+
export declare interface JsonApiPublisherDocumentTemplatePatchDocument {
|
|
85891
|
+
'data': JsonApiPublisherDocumentTemplatePatch;
|
|
85892
|
+
}
|
|
85893
|
+
|
|
85894
|
+
export declare type JsonApiPublisherDocumentTemplatePatchTypeEnum = 'documentTemplate';
|
|
85895
|
+
|
|
85896
|
+
/**
|
|
85897
|
+
* JSON:API representation of documentTemplate entity.
|
|
85898
|
+
*/
|
|
85899
|
+
export declare interface JsonApiPublisherDocumentTemplatePostOptionalId {
|
|
85900
|
+
'attributes': JsonApiPublisherDocumentTemplatePostOptionalIdAttributes;
|
|
85901
|
+
/**
|
|
85902
|
+
* API identifier of an object
|
|
85903
|
+
*/
|
|
85904
|
+
'id'?: string;
|
|
85905
|
+
/**
|
|
85906
|
+
* Object type
|
|
85907
|
+
*/
|
|
85908
|
+
'type': JsonApiPublisherDocumentTemplatePostOptionalIdTypeEnum;
|
|
85909
|
+
}
|
|
85910
|
+
|
|
85911
|
+
export declare interface JsonApiPublisherDocumentTemplatePostOptionalIdAttributes {
|
|
85912
|
+
'areRelationsValid'?: boolean;
|
|
85913
|
+
/**
|
|
85914
|
+
* Free-form document template definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
85915
|
+
*/
|
|
85916
|
+
'content': object;
|
|
85917
|
+
'description'?: string;
|
|
85918
|
+
'tags'?: Array<string>;
|
|
85919
|
+
'title': string;
|
|
85920
|
+
/**
|
|
85921
|
+
* Version of the content format.
|
|
85922
|
+
*/
|
|
85923
|
+
'version': string;
|
|
85924
|
+
}
|
|
85925
|
+
|
|
85926
|
+
export declare interface JsonApiPublisherDocumentTemplatePostOptionalIdDocument {
|
|
85927
|
+
'data': JsonApiPublisherDocumentTemplatePostOptionalId;
|
|
85928
|
+
}
|
|
85929
|
+
|
|
85930
|
+
export declare type JsonApiPublisherDocumentTemplatePostOptionalIdTypeEnum = 'documentTemplate';
|
|
85931
|
+
|
|
83867
85932
|
/**
|
|
83868
85933
|
* JSON:API representation of report entity.
|
|
83869
85934
|
*/
|
|
@@ -94832,6 +96897,9 @@ export declare interface LocalizationDataStatistics {
|
|
|
94832
96897
|
'locales': Array<LocalizationStatisticsLocale>;
|
|
94833
96898
|
}
|
|
94834
96899
|
|
|
96900
|
+
/**
|
|
96901
|
+
* The value a workspace gets for one setting when it and its parents set nothing, and where it comes from. Null when that value has no language.
|
|
96902
|
+
*/
|
|
94835
96903
|
export declare interface LocalizationDefault {
|
|
94836
96904
|
'content': LocalizationContent;
|
|
94837
96905
|
/**
|
|
@@ -94840,9 +96908,6 @@ export declare interface LocalizationDefault {
|
|
|
94840
96908
|
'source': LocalizationDefaultSourceEnum;
|
|
94841
96909
|
}
|
|
94842
96910
|
|
|
94843
|
-
/**
|
|
94844
|
-
* The value a workspace gets when it and its parents set nothing. Null when the setting has no value.
|
|
94845
|
-
*/
|
|
94846
96911
|
export declare interface LocalizationDefaults {
|
|
94847
96912
|
'DATA_LOCALE'?: LocalizationDefault | null;
|
|
94848
96913
|
'LOCALE'?: LocalizationDefault | null;
|
|
@@ -94858,6 +96923,9 @@ export declare interface LocalizationMetadataStatistics {
|
|
|
94858
96923
|
'locales': Array<LocalizationStatisticsLocale>;
|
|
94859
96924
|
}
|
|
94860
96925
|
|
|
96926
|
+
/**
|
|
96927
|
+
* 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.
|
|
96928
|
+
*/
|
|
94861
96929
|
export declare interface LocalizationResolvedValue {
|
|
94862
96930
|
'content': LocalizationContent;
|
|
94863
96931
|
/**
|
|
@@ -94871,7 +96939,7 @@ export declare interface LocalizationResolvedValue {
|
|
|
94871
96939
|
}
|
|
94872
96940
|
|
|
94873
96941
|
/**
|
|
94874
|
-
* The value the
|
|
96942
|
+
* The value for each of the display, metadata and data language settings, with its source.
|
|
94875
96943
|
*/
|
|
94876
96944
|
export declare interface LocalizationResolvedValues {
|
|
94877
96945
|
'DATA_LOCALE': LocalizationResolvedValue;
|
|
@@ -94896,7 +96964,7 @@ export declare interface LocalizationSettingUsages {
|
|
|
94896
96964
|
}
|
|
94897
96965
|
|
|
94898
96966
|
/**
|
|
94899
|
-
* Counts per source. Sources without any count are left out.
|
|
96967
|
+
* Counts per source. Sources without any count are left out. In the organization, users without their own setting have no source and are only in the total.
|
|
94900
96968
|
*/
|
|
94901
96969
|
export declare interface LocalizationSourceCounts {
|
|
94902
96970
|
'DEFAULT'?: number;
|
|
@@ -94949,7 +97017,7 @@ export declare interface LocalizationUsageUsers {
|
|
|
94949
97017
|
export declare type LocalizationUsageUserSourceEnum = 'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT';
|
|
94950
97018
|
|
|
94951
97019
|
/**
|
|
94952
|
-
* One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who
|
|
97020
|
+
* One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting.
|
|
94953
97021
|
*/
|
|
94954
97022
|
export declare interface LocalizationUsageValue {
|
|
94955
97023
|
'bySetting': LocalizationSettingUsages;
|
|
@@ -94987,7 +97055,7 @@ export declare interface LocalizationUsageWorkspaces {
|
|
|
94987
97055
|
export declare type LocalizationUsageWorkspaceSourceEnum = 'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT';
|
|
94988
97056
|
|
|
94989
97057
|
/**
|
|
94990
|
-
*
|
|
97058
|
+
* The value a user gets for one setting, and where it comes from. In the organization users list, it is the value the user sets, with source USER. It is null when the user does not set the setting, because the value then depends on the workspace. In the workspace users list, it is never null. It is the value the user sets, with source USER. Otherwise it is the value the workspace gets, with the source of the workspace. For the origin of that value, see `originId` in the workspace usage. `content.value` is null when the user gets no language.
|
|
94991
97059
|
*/
|
|
94992
97060
|
export declare interface LocalizationUserValue {
|
|
94993
97061
|
'content': LocalizationContent;
|
|
@@ -94998,7 +97066,7 @@ export declare interface LocalizationUserValue {
|
|
|
94998
97066
|
}
|
|
94999
97067
|
|
|
95000
97068
|
/**
|
|
95001
|
-
* The value the user
|
|
97069
|
+
* The value the user gets for each setting.
|
|
95002
97070
|
*/
|
|
95003
97071
|
export declare interface LocalizationUserValues {
|
|
95004
97072
|
'DATA_LOCALE'?: LocalizationUserValue | null;
|
|
@@ -104789,6 +106857,16 @@ export declare type ProfileApiInterface = {
|
|
|
104789
106857
|
getCurrentWithDetails: () => Promise<IUserProfile>;
|
|
104790
106858
|
};
|
|
104791
106859
|
|
|
106860
|
+
/**
|
|
106861
|
+
* @type PublisherDocumentPeriod
|
|
106862
|
+
* The period the document covers, absolute or relative to today.
|
|
106863
|
+
*/
|
|
106864
|
+
export declare type PublisherDocumentPeriod = ({
|
|
106865
|
+
type: 'absolute';
|
|
106866
|
+
} & AbsolutePublisherDocumentPeriod) | ({
|
|
106867
|
+
type: 'relative';
|
|
106868
|
+
} & RelativePublisherDocumentPeriod);
|
|
106869
|
+
|
|
104792
106870
|
export declare type QualityIssueSeverityEnum = 'WARNING' | 'INFO';
|
|
104793
106871
|
|
|
104794
106872
|
declare interface Range_2 {
|
|
@@ -105202,6 +107280,29 @@ export declare type RelativeDateFilterRelativeDateFilterGranularityEnum = 'SECON
|
|
|
105202
107280
|
|
|
105203
107281
|
export declare type RelativeOperatorEnum = 'INCREASES_BY' | 'DECREASES_BY' | 'CHANGES_BY';
|
|
105204
107282
|
|
|
107283
|
+
/**
|
|
107284
|
+
* A period counted in granularity units from the current one, which is 0.
|
|
107285
|
+
*/
|
|
107286
|
+
export declare interface RelativePublisherDocumentPeriod {
|
|
107287
|
+
'type': RelativePublisherDocumentPeriodTypeEnum;
|
|
107288
|
+
/**
|
|
107289
|
+
* Start of the period, in units relative to the current one.
|
|
107290
|
+
*/
|
|
107291
|
+
'from': number;
|
|
107292
|
+
/**
|
|
107293
|
+
* Date granularity of the period.
|
|
107294
|
+
*/
|
|
107295
|
+
'granularity': RelativePublisherDocumentPeriodGranularityEnum;
|
|
107296
|
+
/**
|
|
107297
|
+
* End of the period, in units relative to the current one.
|
|
107298
|
+
*/
|
|
107299
|
+
'to': number;
|
|
107300
|
+
}
|
|
107301
|
+
|
|
107302
|
+
export declare type RelativePublisherDocumentPeriodGranularityEnum = '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';
|
|
107303
|
+
|
|
107304
|
+
export declare type RelativePublisherDocumentPeriodTypeEnum = 'relative';
|
|
107305
|
+
|
|
105205
107306
|
export declare interface RelativeWrapper {
|
|
105206
107307
|
'relative': Relative;
|
|
105207
107308
|
}
|
|
@@ -106219,6 +108320,10 @@ export declare interface ScanModelDeclarativeColumn {
|
|
|
106219
108320
|
* Column type
|
|
106220
108321
|
*/
|
|
106221
108322
|
'dataType': ScanModelDeclarativeColumnDataTypeEnum;
|
|
108323
|
+
/**
|
|
108324
|
+
* (EXPERIMENTAL) Name of the column whose values this column labels. Logical model generation makes this column the default label of the attribute on that column, sorted by that column.
|
|
108325
|
+
*/
|
|
108326
|
+
'defaultLabelOf'?: string;
|
|
106222
108327
|
/**
|
|
106223
108328
|
* Column description/comment from database
|
|
106224
108329
|
*/
|
|
@@ -117685,6 +119790,11 @@ export declare interface WorkspaceIdentifier {
|
|
|
117685
119790
|
|
|
117686
119791
|
export declare type WorkspaceIdentifierTypeEnum = 'workspace';
|
|
117687
119792
|
|
|
119793
|
+
export declare interface WorkspaceLocalizationUsage {
|
|
119794
|
+
'settings': LocalizationResolvedValues;
|
|
119795
|
+
'values': Array<LocalizationUsageValue>;
|
|
119796
|
+
}
|
|
119797
|
+
|
|
117688
119798
|
/**
|
|
117689
119799
|
* Workspace permission assignments
|
|
117690
119800
|
*/
|