@gooddata/api-client-tiger 11.58.0-alpha.0 → 11.58.0-alpha.2
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 +1067 -465
- package/esm/generated/ai-json-api/api.d.ts +940 -417
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +179 -74
- package/esm/generated/metadata-json-api/api.d.ts +41 -36
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +9 -9
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/package.json +5 -5
|
@@ -12953,7 +12953,12 @@ export interface JsonApiVisualizationObjectOutListMeta {
|
|
|
12953
12953
|
}
|
|
12954
12954
|
export interface JsonApiVisualizationObjectOutMeta {
|
|
12955
12955
|
'origin'?: JsonApiVisualizationObjectOutMetaOrigin;
|
|
12956
|
+
/**
|
|
12957
|
+
* List of valid permissions for a logged-in user.
|
|
12958
|
+
*/
|
|
12959
|
+
'permissions'?: Array<JsonApiVisualizationObjectOutMetaPermissionsEnum>;
|
|
12956
12960
|
}
|
|
12961
|
+
export type JsonApiVisualizationObjectOutMetaPermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
|
|
12957
12962
|
export interface JsonApiVisualizationObjectOutMetaOrigin {
|
|
12958
12963
|
/**
|
|
12959
12964
|
* defines id of the workspace where the entity comes from
|
|
@@ -37336,12 +37341,12 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityUsers(jsonApiUs
|
|
|
37336
37341
|
* @param {string} workspaceId
|
|
37337
37342
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
37338
37343
|
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37339
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
37344
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
37340
37345
|
* @param {*} [options] Override http request option.
|
|
37341
37346
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37342
37347
|
* @throws {RequiredError}
|
|
37343
37348
|
*/
|
|
37344
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37349
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37345
37350
|
/**
|
|
37346
37351
|
*
|
|
37347
37352
|
* @summary Post Workspace Color Palette
|
|
@@ -38582,12 +38587,12 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUsers(filter?
|
|
|
38582
38587
|
* @param {number} [size] The size of the page to be returned
|
|
38583
38588
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
38584
38589
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
38585
|
-
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38590
|
+
* @param {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38586
38591
|
* @param {*} [options] Override http request option.
|
|
38587
38592
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38588
38593
|
* @throws {RequiredError}
|
|
38589
38594
|
*/
|
|
38590
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38595
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38591
38596
|
/**
|
|
38592
38597
|
*
|
|
38593
38598
|
* @summary Get all Workspace Color Palettes
|
|
@@ -39313,12 +39318,12 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityUsers(id: string,
|
|
|
39313
39318
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
39314
39319
|
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
39315
39320
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
39316
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39321
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39317
39322
|
* @param {*} [options] Override http request option.
|
|
39318
39323
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39319
39324
|
* @throws {RequiredError}
|
|
39320
39325
|
*/
|
|
39321
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39326
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39322
39327
|
/**
|
|
39323
39328
|
*
|
|
39324
39329
|
* @summary Get a Workspace Color Palette
|
|
@@ -48147,10 +48152,10 @@ export interface EntitiesApiCreateEntityVisualizationObjectsRequest {
|
|
|
48147
48152
|
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
48148
48153
|
/**
|
|
48149
48154
|
* Include Meta objects.
|
|
48150
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
48155
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
48151
48156
|
* @memberof EntitiesApiCreateEntityVisualizationObjects
|
|
48152
48157
|
*/
|
|
48153
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
48158
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
48154
48159
|
}
|
|
48155
48160
|
/**
|
|
48156
48161
|
* Request parameters for createEntityWorkspaceColorPalettes operation in EntitiesApi.
|
|
@@ -51475,10 +51480,10 @@ export interface EntitiesApiGetAllEntitiesVisualizationObjectsRequest {
|
|
|
51475
51480
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
51476
51481
|
/**
|
|
51477
51482
|
* Include Meta objects.
|
|
51478
|
-
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
51483
|
+
* @type {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>}
|
|
51479
51484
|
* @memberof EntitiesApiGetAllEntitiesVisualizationObjects
|
|
51480
51485
|
*/
|
|
51481
|
-
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
51486
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>;
|
|
51482
51487
|
}
|
|
51483
51488
|
/**
|
|
51484
51489
|
* Request parameters for getAllEntitiesWorkspaceColorPalettes operation in EntitiesApi.
|
|
@@ -53428,10 +53433,10 @@ export interface EntitiesApiGetEntityVisualizationObjectsRequest {
|
|
|
53428
53433
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
53429
53434
|
/**
|
|
53430
53435
|
* Include Meta objects.
|
|
53431
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
53436
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
53432
53437
|
* @memberof EntitiesApiGetEntityVisualizationObjects
|
|
53433
53438
|
*/
|
|
53434
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
53439
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
53435
53440
|
}
|
|
53436
53441
|
/**
|
|
53437
53442
|
* Request parameters for getEntityWorkspaceColorPalettes operation in EntitiesApi.
|
|
@@ -93819,12 +93824,12 @@ export declare class UsersEntityAPIsApi extends BaseAPI implements UsersEntityAP
|
|
|
93819
93824
|
* @param {string} workspaceId
|
|
93820
93825
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
93821
93826
|
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
93822
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93827
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93823
93828
|
* @param {*} [options] Override http request option.
|
|
93824
93829
|
* @param {Configuration} [configuration] Optional configuration.
|
|
93825
93830
|
* @throws {RequiredError}
|
|
93826
93831
|
*/
|
|
93827
|
-
export declare function VisualizationObjectApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
93832
|
+
export declare function VisualizationObjectApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
93828
93833
|
/**
|
|
93829
93834
|
*
|
|
93830
93835
|
* @summary Delete a Visualization Object
|
|
@@ -93846,12 +93851,12 @@ export declare function VisualizationObjectApiAxiosParamCreator_DeleteEntityVisu
|
|
|
93846
93851
|
* @param {number} [size] The size of the page to be returned
|
|
93847
93852
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
93848
93853
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
93849
|
-
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93854
|
+
* @param {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93850
93855
|
* @param {*} [options] Override http request option.
|
|
93851
93856
|
* @param {Configuration} [configuration] Optional configuration.
|
|
93852
93857
|
* @throws {RequiredError}
|
|
93853
93858
|
*/
|
|
93854
|
-
export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
93859
|
+
export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
93855
93860
|
/**
|
|
93856
93861
|
*
|
|
93857
93862
|
* @summary Get a Visualization Object
|
|
@@ -93860,12 +93865,12 @@ export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVi
|
|
|
93860
93865
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
93861
93866
|
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
93862
93867
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
93863
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93868
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93864
93869
|
* @param {*} [options] Override http request option.
|
|
93865
93870
|
* @param {Configuration} [configuration] Optional configuration.
|
|
93866
93871
|
* @throws {RequiredError}
|
|
93867
93872
|
*/
|
|
93868
|
-
export declare function VisualizationObjectApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
93873
|
+
export declare function VisualizationObjectApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
93869
93874
|
/**
|
|
93870
93875
|
*
|
|
93871
93876
|
* @summary Patch a Visualization Object
|
|
@@ -94077,10 +94082,10 @@ export interface VisualizationObjectApiCreateEntityVisualizationObjectsRequest {
|
|
|
94077
94082
|
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
94078
94083
|
/**
|
|
94079
94084
|
* Include Meta objects.
|
|
94080
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
94085
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
94081
94086
|
* @memberof VisualizationObjectApiCreateEntityVisualizationObjects
|
|
94082
94087
|
*/
|
|
94083
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
94088
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
94084
94089
|
}
|
|
94085
94090
|
/**
|
|
94086
94091
|
* Request parameters for deleteEntityVisualizationObjects operation in VisualizationObjectApi.
|
|
@@ -94157,10 +94162,10 @@ export interface VisualizationObjectApiGetAllEntitiesVisualizationObjectsRequest
|
|
|
94157
94162
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
94158
94163
|
/**
|
|
94159
94164
|
* Include Meta objects.
|
|
94160
|
-
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
94165
|
+
* @type {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>}
|
|
94161
94166
|
* @memberof VisualizationObjectApiGetAllEntitiesVisualizationObjects
|
|
94162
94167
|
*/
|
|
94163
|
-
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
94168
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>;
|
|
94164
94169
|
}
|
|
94165
94170
|
/**
|
|
94166
94171
|
* Request parameters for getEntityVisualizationObjects operation in VisualizationObjectApi.
|
|
@@ -94200,10 +94205,10 @@ export interface VisualizationObjectApiGetEntityVisualizationObjectsRequest {
|
|
|
94200
94205
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
94201
94206
|
/**
|
|
94202
94207
|
* Include Meta objects.
|
|
94203
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
94208
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
94204
94209
|
* @memberof VisualizationObjectApiGetEntityVisualizationObjects
|
|
94205
94210
|
*/
|
|
94206
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
94211
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
94207
94212
|
}
|
|
94208
94213
|
/**
|
|
94209
94214
|
* Request parameters for patchEntityVisualizationObjects operation in VisualizationObjectApi.
|
|
@@ -94387,12 +94392,12 @@ export declare class VisualizationObjectApi extends BaseAPI implements Visualiza
|
|
|
94387
94392
|
* @param {string} workspaceId
|
|
94388
94393
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
94389
94394
|
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
94390
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
94395
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
94391
94396
|
* @param {*} [options] Override http request option.
|
|
94392
94397
|
* @param {Configuration} [configuration] Optional configuration.
|
|
94393
94398
|
* @throws {RequiredError}
|
|
94394
94399
|
*/
|
|
94395
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
94400
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
94396
94401
|
/**
|
|
94397
94402
|
*
|
|
94398
94403
|
* @summary Delete a Visualization Object
|
|
@@ -94414,12 +94419,12 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_Delete
|
|
|
94414
94419
|
* @param {number} [size] The size of the page to be returned
|
|
94415
94420
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
94416
94421
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
94417
|
-
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
94422
|
+
* @param {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
94418
94423
|
* @param {*} [options] Override http request option.
|
|
94419
94424
|
* @param {Configuration} [configuration] Optional configuration.
|
|
94420
94425
|
* @throws {RequiredError}
|
|
94421
94426
|
*/
|
|
94422
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
94427
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
94423
94428
|
/**
|
|
94424
94429
|
*
|
|
94425
94430
|
* @summary Get a Visualization Object
|
|
@@ -94428,12 +94433,12 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAll
|
|
|
94428
94433
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
94429
94434
|
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
94430
94435
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
94431
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
94436
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
94432
94437
|
* @param {*} [options] Override http request option.
|
|
94433
94438
|
* @param {Configuration} [configuration] Optional configuration.
|
|
94434
94439
|
* @throws {RequiredError}
|
|
94435
94440
|
*/
|
|
94436
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
94441
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
94437
94442
|
/**
|
|
94438
94443
|
*
|
|
94439
94444
|
* @summary Patch a Visualization Object
|
|
@@ -94645,10 +94650,10 @@ export interface VisualizationObjectControllerApiCreateEntityVisualizationObject
|
|
|
94645
94650
|
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
94646
94651
|
/**
|
|
94647
94652
|
* Include Meta objects.
|
|
94648
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
94653
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
94649
94654
|
* @memberof VisualizationObjectControllerApiCreateEntityVisualizationObjects
|
|
94650
94655
|
*/
|
|
94651
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
94656
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
94652
94657
|
}
|
|
94653
94658
|
/**
|
|
94654
94659
|
* Request parameters for deleteEntityVisualizationObjects operation in VisualizationObjectControllerApi.
|
|
@@ -94725,10 +94730,10 @@ export interface VisualizationObjectControllerApiGetAllEntitiesVisualizationObje
|
|
|
94725
94730
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
94726
94731
|
/**
|
|
94727
94732
|
* Include Meta objects.
|
|
94728
|
-
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
94733
|
+
* @type {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>}
|
|
94729
94734
|
* @memberof VisualizationObjectControllerApiGetAllEntitiesVisualizationObjects
|
|
94730
94735
|
*/
|
|
94731
|
-
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
94736
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>;
|
|
94732
94737
|
}
|
|
94733
94738
|
/**
|
|
94734
94739
|
* Request parameters for getEntityVisualizationObjects operation in VisualizationObjectControllerApi.
|
|
@@ -94768,10 +94773,10 @@ export interface VisualizationObjectControllerApiGetEntityVisualizationObjectsRe
|
|
|
94768
94773
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
94769
94774
|
/**
|
|
94770
94775
|
* Include Meta objects.
|
|
94771
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
94776
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
94772
94777
|
* @memberof VisualizationObjectControllerApiGetEntityVisualizationObjects
|
|
94773
94778
|
*/
|
|
94774
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
94779
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
94775
94780
|
}
|
|
94776
94781
|
/**
|
|
94777
94782
|
* Request parameters for patchEntityVisualizationObjects operation in VisualizationObjectControllerApi.
|