@gooddata/api-client-tiger 10.32.0-alpha.39 → 10.32.0-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +1133 -1481
- package/esm/generated/afm-rest-api/api.d.ts +2 -2
- package/esm/generated/afm-rest-api/openapi-spec.json +2 -2
- package/esm/generated/automation-json-api/api.d.ts +0 -6
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +0 -16
- package/esm/generated/export-json-api/openapi-spec.json +0 -6
- package/esm/generated/metadata-json-api/api.d.ts +1087 -1402
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +52 -240
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +8258 -8472
- package/package.json +3 -3
|
@@ -14305,12 +14305,6 @@ export declare interface AutomationTestDestinationRequest {
|
|
|
14305
14305
|
* @memberof AutomationTestDestinationRequest
|
|
14306
14306
|
*/
|
|
14307
14307
|
destination: AutomationDefaultSmtp | AutomationInPlatform | AutomationSmtp | AutomationWebhook;
|
|
14308
|
-
/**
|
|
14309
|
-
* External recipients of the test result.
|
|
14310
|
-
* @type {Array<AutomationAutomationExternalRecipient>}
|
|
14311
|
-
* @memberof AutomationTestDestinationRequest
|
|
14312
|
-
*/
|
|
14313
|
-
externalRecipients?: Array<AutomationAutomationExternalRecipient> | null;
|
|
14314
14308
|
}
|
|
14315
14309
|
|
|
14316
14310
|
/**
|
|
@@ -15172,13 +15166,13 @@ export declare interface ClusteringResult {
|
|
|
15172
15166
|
* @type {Array<number>}
|
|
15173
15167
|
* @memberof ClusteringResult
|
|
15174
15168
|
*/
|
|
15175
|
-
|
|
15169
|
+
ycoord: Array<number>;
|
|
15176
15170
|
/**
|
|
15177
15171
|
*
|
|
15178
15172
|
* @type {Array<number>}
|
|
15179
15173
|
* @memberof ClusteringResult
|
|
15180
15174
|
*/
|
|
15181
|
-
|
|
15175
|
+
xcoord: Array<number>;
|
|
15182
15176
|
}
|
|
15183
15177
|
|
|
15184
15178
|
/**
|
|
@@ -22195,12 +22189,6 @@ export declare interface DeclarativeDataset {
|
|
|
22195
22189
|
* @memberof DeclarativeDataset
|
|
22196
22190
|
*/
|
|
22197
22191
|
workspaceDataFilterReferences?: Array<DeclarativeWorkspaceDataFilterReferences>;
|
|
22198
|
-
/**
|
|
22199
|
-
* Precedence used in aggregate awareness.
|
|
22200
|
-
* @type {number}
|
|
22201
|
-
* @memberof DeclarativeDataset
|
|
22202
|
-
*/
|
|
22203
|
-
precedence?: number;
|
|
22204
22192
|
}
|
|
22205
22193
|
|
|
22206
22194
|
/**
|
|
@@ -22695,12 +22683,6 @@ export declare interface DeclarativeFact {
|
|
|
22695
22683
|
* @memberof DeclarativeFact
|
|
22696
22684
|
*/
|
|
22697
22685
|
tags?: Array<string>;
|
|
22698
|
-
/**
|
|
22699
|
-
*
|
|
22700
|
-
* @type {DeclarativeSourceFactReference}
|
|
22701
|
-
* @memberof DeclarativeFact
|
|
22702
|
-
*/
|
|
22703
|
-
sourceFactReference?: DeclarativeSourceFactReference;
|
|
22704
22686
|
}
|
|
22705
22687
|
|
|
22706
22688
|
export declare const DeclarativeFactSourceColumnDataTypeEnum: {
|
|
@@ -22822,11 +22804,11 @@ export declare interface DeclarativeIdentityProvider {
|
|
|
22822
22804
|
*/
|
|
22823
22805
|
id: string;
|
|
22824
22806
|
/**
|
|
22825
|
-
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
|
|
22807
|
+
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. In multiple provider setup, this field is mandatory.
|
|
22826
22808
|
* @type {Array<string>}
|
|
22827
22809
|
* @memberof DeclarativeIdentityProvider
|
|
22828
22810
|
*/
|
|
22829
|
-
identifiers
|
|
22811
|
+
identifiers: Array<string>;
|
|
22830
22812
|
/**
|
|
22831
22813
|
* Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
|
|
22832
22814
|
* @type {{ [key: string]: string; }}
|
|
@@ -22871,12 +22853,6 @@ export declare interface DeclarativeIdentityProvider {
|
|
|
22871
22853
|
* @memberof DeclarativeIdentityProvider
|
|
22872
22854
|
*/
|
|
22873
22855
|
oauthSubjectIdClaim?: string;
|
|
22874
|
-
/**
|
|
22875
|
-
* Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
|
|
22876
|
-
* @type {string}
|
|
22877
|
-
* @memberof DeclarativeIdentityProvider
|
|
22878
|
-
*/
|
|
22879
|
-
idpType?: DeclarativeIdentityProviderIdpTypeEnum;
|
|
22880
22856
|
/**
|
|
22881
22857
|
* Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
|
|
22882
22858
|
* @type {{ [key: string]: string; }}
|
|
@@ -22893,40 +22869,6 @@ export declare interface DeclarativeIdentityProvider {
|
|
|
22893
22869
|
oauthCustomScopes?: Array<string> | null;
|
|
22894
22870
|
}
|
|
22895
22871
|
|
|
22896
|
-
/**
|
|
22897
|
-
* An Identity Provider identifier.
|
|
22898
|
-
* @export
|
|
22899
|
-
* @interface DeclarativeIdentityProviderIdentifier
|
|
22900
|
-
*/
|
|
22901
|
-
export declare interface DeclarativeIdentityProviderIdentifier {
|
|
22902
|
-
/**
|
|
22903
|
-
* Identifier of the identity provider.
|
|
22904
|
-
* @type {string}
|
|
22905
|
-
* @memberof DeclarativeIdentityProviderIdentifier
|
|
22906
|
-
*/
|
|
22907
|
-
id: string;
|
|
22908
|
-
/**
|
|
22909
|
-
* A type.
|
|
22910
|
-
* @type {string}
|
|
22911
|
-
* @memberof DeclarativeIdentityProviderIdentifier
|
|
22912
|
-
*/
|
|
22913
|
-
type: DeclarativeIdentityProviderIdentifierTypeEnum;
|
|
22914
|
-
}
|
|
22915
|
-
|
|
22916
|
-
export declare const DeclarativeIdentityProviderIdentifierTypeEnum: {
|
|
22917
|
-
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
22918
|
-
};
|
|
22919
|
-
|
|
22920
|
-
export declare type DeclarativeIdentityProviderIdentifierTypeEnum = typeof DeclarativeIdentityProviderIdentifierTypeEnum[keyof typeof DeclarativeIdentityProviderIdentifierTypeEnum];
|
|
22921
|
-
|
|
22922
|
-
export declare const DeclarativeIdentityProviderIdpTypeEnum: {
|
|
22923
|
-
readonly MANAGED_IDP: "MANAGED_IDP";
|
|
22924
|
-
readonly FIM_IDP: "FIM_IDP";
|
|
22925
|
-
readonly CUSTOM_IDP: "CUSTOM_IDP";
|
|
22926
|
-
};
|
|
22927
|
-
|
|
22928
|
-
export declare type DeclarativeIdentityProviderIdpTypeEnum = typeof DeclarativeIdentityProviderIdpTypeEnum[keyof typeof DeclarativeIdentityProviderIdpTypeEnum];
|
|
22929
|
-
|
|
22930
22872
|
/**
|
|
22931
22873
|
* A declarative form of the JWK.
|
|
22932
22874
|
* @export
|
|
@@ -23454,12 +23396,6 @@ export declare interface DeclarativeOrganizationInfo {
|
|
|
23454
23396
|
* @memberof DeclarativeOrganizationInfo
|
|
23455
23397
|
*/
|
|
23456
23398
|
cspDirectives?: Array<DeclarativeCspDirective>;
|
|
23457
|
-
/**
|
|
23458
|
-
*
|
|
23459
|
-
* @type {DeclarativeIdentityProviderIdentifier}
|
|
23460
|
-
* @memberof DeclarativeOrganizationInfo
|
|
23461
|
-
*/
|
|
23462
|
-
identityProvider?: DeclarativeIdentityProviderIdentifier;
|
|
23463
23399
|
}
|
|
23464
23400
|
|
|
23465
23401
|
/**
|
|
@@ -23745,34 +23681,6 @@ export declare const DeclarativeSingleWorkspacePermissionNameEnum: {
|
|
|
23745
23681
|
|
|
23746
23682
|
export declare type DeclarativeSingleWorkspacePermissionNameEnum = typeof DeclarativeSingleWorkspacePermissionNameEnum[keyof typeof DeclarativeSingleWorkspacePermissionNameEnum];
|
|
23747
23683
|
|
|
23748
|
-
/**
|
|
23749
|
-
* Aggregated awareness source fact reference.
|
|
23750
|
-
* @export
|
|
23751
|
-
* @interface DeclarativeSourceFactReference
|
|
23752
|
-
*/
|
|
23753
|
-
export declare interface DeclarativeSourceFactReference {
|
|
23754
|
-
/**
|
|
23755
|
-
*
|
|
23756
|
-
* @type {FactIdentifier}
|
|
23757
|
-
* @memberof DeclarativeSourceFactReference
|
|
23758
|
-
*/
|
|
23759
|
-
reference: FactIdentifier;
|
|
23760
|
-
/**
|
|
23761
|
-
* Aggregation operation.
|
|
23762
|
-
* @type {string}
|
|
23763
|
-
* @memberof DeclarativeSourceFactReference
|
|
23764
|
-
*/
|
|
23765
|
-
operation: DeclarativeSourceFactReferenceOperationEnum;
|
|
23766
|
-
}
|
|
23767
|
-
|
|
23768
|
-
export declare const DeclarativeSourceFactReferenceOperationEnum: {
|
|
23769
|
-
readonly SUM: "SUM";
|
|
23770
|
-
readonly MIN: "MIN";
|
|
23771
|
-
readonly MAX: "MAX";
|
|
23772
|
-
};
|
|
23773
|
-
|
|
23774
|
-
export declare type DeclarativeSourceFactReferenceOperationEnum = typeof DeclarativeSourceFactReferenceOperationEnum[keyof typeof DeclarativeSourceFactReferenceOperationEnum];
|
|
23775
|
-
|
|
23776
23684
|
/**
|
|
23777
23685
|
* A database table.
|
|
23778
23686
|
* @export
|
|
@@ -27759,7 +27667,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27759
27667
|
* @param {string} workspaceId
|
|
27760
27668
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
27761
27669
|
* @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\').
|
|
27762
|
-
* @param {Array<'datasets' | '
|
|
27670
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
27763
27671
|
* @param {number} [page] Zero-based page index (0..N)
|
|
27764
27672
|
* @param {number} [size] The size of the page to be returned
|
|
27765
27673
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -27768,7 +27676,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27768
27676
|
* @param {*} [options] Override http request option.
|
|
27769
27677
|
* @throws {RequiredError}
|
|
27770
27678
|
*/
|
|
27771
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
27679
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
27772
27680
|
/**
|
|
27773
27681
|
*
|
|
27774
27682
|
* @summary Get all Context Filters
|
|
@@ -28257,13 +28165,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28257
28165
|
* @param {string} workspaceId
|
|
28258
28166
|
* @param {string} objectId
|
|
28259
28167
|
* @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\').
|
|
28260
|
-
* @param {Array<'datasets' | '
|
|
28168
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
28261
28169
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28262
28170
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28263
28171
|
* @param {*} [options] Override http request option.
|
|
28264
28172
|
* @throws {RequiredError}
|
|
28265
28173
|
*/
|
|
28266
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
28174
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28267
28175
|
/**
|
|
28268
28176
|
*
|
|
28269
28177
|
* @summary Get a Context Filter
|
|
@@ -28373,12 +28281,12 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28373
28281
|
* @summary Get Organizations
|
|
28374
28282
|
* @param {string} id
|
|
28375
28283
|
* @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\').
|
|
28376
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
28284
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
28377
28285
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28378
28286
|
* @param {*} [options] Override http request option.
|
|
28379
28287
|
* @throws {RequiredError}
|
|
28380
28288
|
*/
|
|
28381
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
28289
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28382
28290
|
/**
|
|
28383
28291
|
*
|
|
28384
28292
|
* @summary Get Theming
|
|
@@ -28723,11 +28631,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28723
28631
|
* @param {string} id
|
|
28724
28632
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
28725
28633
|
* @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\').
|
|
28726
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
28634
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
28727
28635
|
* @param {*} [options] Override http request option.
|
|
28728
28636
|
* @throws {RequiredError}
|
|
28729
28637
|
*/
|
|
28730
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
28638
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28731
28639
|
/**
|
|
28732
28640
|
*
|
|
28733
28641
|
* @summary Patch Theming
|
|
@@ -29043,11 +28951,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
29043
28951
|
* @param {string} id
|
|
29044
28952
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
29045
28953
|
* @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\').
|
|
29046
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
28954
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
29047
28955
|
* @param {*} [options] Override http request option.
|
|
29048
28956
|
* @throws {RequiredError}
|
|
29049
28957
|
*/
|
|
29050
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
28958
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
29051
28959
|
/**
|
|
29052
28960
|
*
|
|
29053
28961
|
* @summary Put Theming
|
|
@@ -32870,7 +32778,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
32870
32778
|
* @param {string} workspaceId
|
|
32871
32779
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
32872
32780
|
* @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\').
|
|
32873
|
-
* @param {Array<'datasets' | '
|
|
32781
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
32874
32782
|
* @param {number} [page] Zero-based page index (0..N)
|
|
32875
32783
|
* @param {number} [size] The size of the page to be returned
|
|
32876
32784
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -32879,7 +32787,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
32879
32787
|
* @param {*} [options] Override http request option.
|
|
32880
32788
|
* @throws {RequiredError}
|
|
32881
32789
|
*/
|
|
32882
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
32790
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
32883
32791
|
/**
|
|
32884
32792
|
*
|
|
32885
32793
|
* @summary Get all Context Filters
|
|
@@ -33370,13 +33278,13 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33370
33278
|
* @param {string} workspaceId
|
|
33371
33279
|
* @param {string} objectId
|
|
33372
33280
|
* @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\').
|
|
33373
|
-
* @param {Array<'datasets' | '
|
|
33281
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
33374
33282
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
33375
33283
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33376
33284
|
* @param {*} [options] Override http request option.
|
|
33377
33285
|
* @throws {RequiredError}
|
|
33378
33286
|
*/
|
|
33379
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
33287
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
33380
33288
|
/**
|
|
33381
33289
|
*
|
|
33382
33290
|
* @summary Get a Context Filter
|
|
@@ -33486,12 +33394,12 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33486
33394
|
* @summary Get Organizations
|
|
33487
33395
|
* @param {string} id
|
|
33488
33396
|
* @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\').
|
|
33489
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
33397
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
33490
33398
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33491
33399
|
* @param {*} [options] Override http request option.
|
|
33492
33400
|
* @throws {RequiredError}
|
|
33493
33401
|
*/
|
|
33494
|
-
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
33402
|
+
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
33495
33403
|
/**
|
|
33496
33404
|
*
|
|
33497
33405
|
* @summary Get Theming
|
|
@@ -33836,11 +33744,11 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33836
33744
|
* @param {string} id
|
|
33837
33745
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
33838
33746
|
* @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\').
|
|
33839
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
33747
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
33840
33748
|
* @param {*} [options] Override http request option.
|
|
33841
33749
|
* @throws {RequiredError}
|
|
33842
33750
|
*/
|
|
33843
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
33751
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
33844
33752
|
/**
|
|
33845
33753
|
*
|
|
33846
33754
|
* @summary Patch Theming
|
|
@@ -34156,11 +34064,11 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
34156
34064
|
* @param {string} id
|
|
34157
34065
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
34158
34066
|
* @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\').
|
|
34159
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
34067
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
34160
34068
|
* @param {*} [options] Override http request option.
|
|
34161
34069
|
* @throws {RequiredError}
|
|
34162
34070
|
*/
|
|
34163
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
34071
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
34164
34072
|
/**
|
|
34165
34073
|
*
|
|
34166
34074
|
* @summary Put Theming
|
|
@@ -35064,10 +34972,10 @@ export declare interface EntitiesApiGetAllEntitiesFactsRequest {
|
|
|
35064
34972
|
readonly filter?: string;
|
|
35065
34973
|
/**
|
|
35066
34974
|
* 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.
|
|
35067
|
-
* @type {Array<'datasets' | '
|
|
34975
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
35068
34976
|
* @memberof EntitiesApiGetAllEntitiesFacts
|
|
35069
34977
|
*/
|
|
35070
|
-
readonly include?: Array<"datasets" | "
|
|
34978
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
35071
34979
|
/**
|
|
35072
34980
|
* Zero-based page index (0..N)
|
|
35073
34981
|
* @type {number}
|
|
@@ -36682,10 +36590,10 @@ export declare interface EntitiesApiGetEntityFactsRequest {
|
|
|
36682
36590
|
readonly filter?: string;
|
|
36683
36591
|
/**
|
|
36684
36592
|
* 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.
|
|
36685
|
-
* @type {Array<'datasets' | '
|
|
36593
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
36686
36594
|
* @memberof EntitiesApiGetEntityFacts
|
|
36687
36595
|
*/
|
|
36688
|
-
readonly include?: Array<"datasets" | "
|
|
36596
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
36689
36597
|
/**
|
|
36690
36598
|
*
|
|
36691
36599
|
* @type {boolean}
|
|
@@ -37010,10 +36918,10 @@ export declare interface EntitiesApiGetEntityOrganizationsRequest {
|
|
|
37010
36918
|
readonly filter?: string;
|
|
37011
36919
|
/**
|
|
37012
36920
|
* 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.
|
|
37013
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
36921
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
37014
36922
|
* @memberof EntitiesApiGetEntityOrganizations
|
|
37015
36923
|
*/
|
|
37016
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
36924
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
37017
36925
|
/**
|
|
37018
36926
|
* Include Meta objects.
|
|
37019
36927
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -39791,10 +39699,10 @@ export declare interface EntitiesApiPatchEntityOrganizationsRequest {
|
|
|
39791
39699
|
readonly filter?: string;
|
|
39792
39700
|
/**
|
|
39793
39701
|
* 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.
|
|
39794
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
39702
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
39795
39703
|
* @memberof EntitiesApiPatchEntityOrganizations
|
|
39796
39704
|
*/
|
|
39797
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
39705
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
39798
39706
|
}
|
|
39799
39707
|
|
|
39800
39708
|
/**
|
|
@@ -40725,10 +40633,10 @@ export declare interface EntitiesApiUpdateEntityOrganizationsRequest {
|
|
|
40725
40633
|
readonly filter?: string;
|
|
40726
40634
|
/**
|
|
40727
40635
|
* 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.
|
|
40728
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
40636
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
40729
40637
|
* @memberof EntitiesApiUpdateEntityOrganizations
|
|
40730
40638
|
*/
|
|
40731
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
40639
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
40732
40640
|
}
|
|
40733
40641
|
|
|
40734
40642
|
/**
|
|
@@ -42517,32 +42425,6 @@ export declare interface ExportResponse {
|
|
|
42517
42425
|
exportResult: string;
|
|
42518
42426
|
}
|
|
42519
42427
|
|
|
42520
|
-
/**
|
|
42521
|
-
* A fact identifier.
|
|
42522
|
-
* @export
|
|
42523
|
-
* @interface FactIdentifier
|
|
42524
|
-
*/
|
|
42525
|
-
export declare interface FactIdentifier {
|
|
42526
|
-
/**
|
|
42527
|
-
* Fact ID.
|
|
42528
|
-
* @type {string}
|
|
42529
|
-
* @memberof FactIdentifier
|
|
42530
|
-
*/
|
|
42531
|
-
id: string;
|
|
42532
|
-
/**
|
|
42533
|
-
* A type of the fact.
|
|
42534
|
-
* @type {string}
|
|
42535
|
-
* @memberof FactIdentifier
|
|
42536
|
-
*/
|
|
42537
|
-
type: FactIdentifierTypeEnum;
|
|
42538
|
-
}
|
|
42539
|
-
|
|
42540
|
-
export declare const FactIdentifierTypeEnum: {
|
|
42541
|
-
readonly FACT: "fact";
|
|
42542
|
-
};
|
|
42543
|
-
|
|
42544
|
-
export declare type FactIdentifierTypeEnum = typeof FactIdentifierTypeEnum[keyof typeof FactIdentifierTypeEnum];
|
|
42545
|
-
|
|
42546
42428
|
/**
|
|
42547
42429
|
* FactsApi - object-oriented interface
|
|
42548
42430
|
* @export
|
|
@@ -42581,7 +42463,7 @@ export declare const FactsApiAxiosParamCreator: (configuration?: MetadataConfigu
|
|
|
42581
42463
|
* @param {string} workspaceId
|
|
42582
42464
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
42583
42465
|
* @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\').
|
|
42584
|
-
* @param {Array<'datasets' | '
|
|
42466
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
42585
42467
|
* @param {number} [page] Zero-based page index (0..N)
|
|
42586
42468
|
* @param {number} [size] The size of the page to be returned
|
|
42587
42469
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -42590,20 +42472,20 @@ export declare const FactsApiAxiosParamCreator: (configuration?: MetadataConfigu
|
|
|
42590
42472
|
* @param {*} [options] Override http request option.
|
|
42591
42473
|
* @throws {RequiredError}
|
|
42592
42474
|
*/
|
|
42593
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
42475
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
42594
42476
|
/**
|
|
42595
42477
|
*
|
|
42596
42478
|
* @summary Get a Fact
|
|
42597
42479
|
* @param {string} workspaceId
|
|
42598
42480
|
* @param {string} objectId
|
|
42599
42481
|
* @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\').
|
|
42600
|
-
* @param {Array<'datasets' | '
|
|
42482
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
42601
42483
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
42602
42484
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
42603
42485
|
* @param {*} [options] Override http request option.
|
|
42604
42486
|
* @throws {RequiredError}
|
|
42605
42487
|
*/
|
|
42606
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
42488
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
42607
42489
|
};
|
|
42608
42490
|
|
|
42609
42491
|
/**
|
|
@@ -42640,7 +42522,7 @@ export declare const FactsApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
42640
42522
|
* @param {string} workspaceId
|
|
42641
42523
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
42642
42524
|
* @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\').
|
|
42643
|
-
* @param {Array<'datasets' | '
|
|
42525
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
42644
42526
|
* @param {number} [page] Zero-based page index (0..N)
|
|
42645
42527
|
* @param {number} [size] The size of the page to be returned
|
|
42646
42528
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -42649,20 +42531,20 @@ export declare const FactsApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
42649
42531
|
* @param {*} [options] Override http request option.
|
|
42650
42532
|
* @throws {RequiredError}
|
|
42651
42533
|
*/
|
|
42652
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
42534
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
42653
42535
|
/**
|
|
42654
42536
|
*
|
|
42655
42537
|
* @summary Get a Fact
|
|
42656
42538
|
* @param {string} workspaceId
|
|
42657
42539
|
* @param {string} objectId
|
|
42658
42540
|
* @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\').
|
|
42659
|
-
* @param {Array<'datasets' | '
|
|
42541
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
42660
42542
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
42661
42543
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
42662
42544
|
* @param {*} [options] Override http request option.
|
|
42663
42545
|
* @throws {RequiredError}
|
|
42664
42546
|
*/
|
|
42665
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
42547
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
42666
42548
|
};
|
|
42667
42549
|
|
|
42668
42550
|
/**
|
|
@@ -42691,10 +42573,10 @@ export declare interface FactsApiGetAllEntitiesFactsRequest {
|
|
|
42691
42573
|
readonly filter?: string;
|
|
42692
42574
|
/**
|
|
42693
42575
|
* 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.
|
|
42694
|
-
* @type {Array<'datasets' | '
|
|
42576
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
42695
42577
|
* @memberof FactsApiGetAllEntitiesFacts
|
|
42696
42578
|
*/
|
|
42697
|
-
readonly include?: Array<"datasets" | "
|
|
42579
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
42698
42580
|
/**
|
|
42699
42581
|
* Zero-based page index (0..N)
|
|
42700
42582
|
* @type {number}
|
|
@@ -42753,10 +42635,10 @@ export declare interface FactsApiGetEntityFactsRequest {
|
|
|
42753
42635
|
readonly filter?: string;
|
|
42754
42636
|
/**
|
|
42755
42637
|
* 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.
|
|
42756
|
-
* @type {Array<'datasets' | '
|
|
42638
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
42757
42639
|
* @memberof FactsApiGetEntityFacts
|
|
42758
42640
|
*/
|
|
42759
|
-
readonly include?: Array<"datasets" | "
|
|
42641
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
42760
42642
|
/**
|
|
42761
42643
|
*
|
|
42762
42644
|
* @type {boolean}
|
|
@@ -47410,10 +47292,10 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
47410
47292
|
details?: any;
|
|
47411
47293
|
/**
|
|
47412
47294
|
*
|
|
47413
|
-
* @type {
|
|
47295
|
+
* @type {JsonApiAutomationPatchAttributesMetadata}
|
|
47414
47296
|
* @memberof JsonApiAutomationOutAttributes
|
|
47415
47297
|
*/
|
|
47416
|
-
metadata?:
|
|
47298
|
+
metadata?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
47417
47299
|
/**
|
|
47418
47300
|
* Current state of the automation.
|
|
47419
47301
|
* @type {string}
|
|
@@ -47422,52 +47304,52 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
47422
47304
|
state?: JsonApiAutomationOutAttributesStateEnum;
|
|
47423
47305
|
/**
|
|
47424
47306
|
*
|
|
47425
|
-
* @type {
|
|
47307
|
+
* @type {JsonApiAutomationPatchAttributesSchedule}
|
|
47426
47308
|
* @memberof JsonApiAutomationOutAttributes
|
|
47427
47309
|
*/
|
|
47428
|
-
schedule?:
|
|
47310
|
+
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
47429
47311
|
/**
|
|
47430
47312
|
*
|
|
47431
|
-
* @type {
|
|
47313
|
+
* @type {JsonApiAutomationPatchAttributesAlert}
|
|
47432
47314
|
* @memberof JsonApiAutomationOutAttributes
|
|
47433
47315
|
*/
|
|
47434
|
-
alert?:
|
|
47316
|
+
alert?: JsonApiAutomationPatchAttributesAlert;
|
|
47435
47317
|
/**
|
|
47436
47318
|
*
|
|
47437
|
-
* @type {Array<
|
|
47319
|
+
* @type {Array<JsonApiAutomationPatchAttributesTabularExports>}
|
|
47438
47320
|
* @memberof JsonApiAutomationOutAttributes
|
|
47439
47321
|
*/
|
|
47440
|
-
tabularExports?: Array<
|
|
47322
|
+
tabularExports?: Array<JsonApiAutomationPatchAttributesTabularExports>;
|
|
47441
47323
|
/**
|
|
47442
47324
|
*
|
|
47443
|
-
* @type {Array<
|
|
47325
|
+
* @type {Array<JsonApiAutomationPatchAttributesVisualExports>}
|
|
47444
47326
|
* @memberof JsonApiAutomationOutAttributes
|
|
47445
47327
|
*/
|
|
47446
|
-
visualExports?: Array<
|
|
47328
|
+
visualExports?: Array<JsonApiAutomationPatchAttributesVisualExports>;
|
|
47447
47329
|
/**
|
|
47448
47330
|
*
|
|
47449
|
-
* @type {Array<
|
|
47331
|
+
* @type {Array<JsonApiAutomationPatchAttributesImageExports>}
|
|
47450
47332
|
* @memberof JsonApiAutomationOutAttributes
|
|
47451
47333
|
*/
|
|
47452
|
-
imageExports?: Array<
|
|
47334
|
+
imageExports?: Array<JsonApiAutomationPatchAttributesImageExports>;
|
|
47453
47335
|
/**
|
|
47454
47336
|
*
|
|
47455
|
-
* @type {Array<
|
|
47337
|
+
* @type {Array<JsonApiAutomationPatchAttributesRawExports>}
|
|
47456
47338
|
* @memberof JsonApiAutomationOutAttributes
|
|
47457
47339
|
*/
|
|
47458
|
-
rawExports?: Array<
|
|
47340
|
+
rawExports?: Array<JsonApiAutomationPatchAttributesRawExports>;
|
|
47459
47341
|
/**
|
|
47460
47342
|
*
|
|
47461
|
-
* @type {Array<
|
|
47343
|
+
* @type {Array<JsonApiAutomationPatchAttributesSlidesExports>}
|
|
47462
47344
|
* @memberof JsonApiAutomationOutAttributes
|
|
47463
47345
|
*/
|
|
47464
|
-
slidesExports?: Array<
|
|
47346
|
+
slidesExports?: Array<JsonApiAutomationPatchAttributesSlidesExports>;
|
|
47465
47347
|
/**
|
|
47466
47348
|
* External recipients of the automation action results.
|
|
47467
|
-
* @type {Array<
|
|
47349
|
+
* @type {Array<JsonApiAutomationPatchAttributesExternalRecipients>}
|
|
47468
47350
|
* @memberof JsonApiAutomationOutAttributes
|
|
47469
47351
|
*/
|
|
47470
|
-
externalRecipients?: Array<
|
|
47352
|
+
externalRecipients?: Array<JsonApiAutomationPatchAttributesExternalRecipients>;
|
|
47471
47353
|
/**
|
|
47472
47354
|
*
|
|
47473
47355
|
* @type {string}
|
|
@@ -47482,147 +47364,6 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
47482
47364
|
modifiedAt?: string;
|
|
47483
47365
|
}
|
|
47484
47366
|
|
|
47485
|
-
/**
|
|
47486
|
-
*
|
|
47487
|
-
* @export
|
|
47488
|
-
* @interface JsonApiAutomationOutAttributesAlert
|
|
47489
|
-
*/
|
|
47490
|
-
export declare interface JsonApiAutomationOutAttributesAlert {
|
|
47491
|
-
/**
|
|
47492
|
-
*
|
|
47493
|
-
* @type {AlertAfm}
|
|
47494
|
-
* @memberof JsonApiAutomationOutAttributesAlert
|
|
47495
|
-
*/
|
|
47496
|
-
execution: AlertAfm;
|
|
47497
|
-
/**
|
|
47498
|
-
*
|
|
47499
|
-
* @type {AlertCondition}
|
|
47500
|
-
* @memberof JsonApiAutomationOutAttributesAlert
|
|
47501
|
-
*/
|
|
47502
|
-
condition: AlertCondition;
|
|
47503
|
-
/**
|
|
47504
|
-
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
|
|
47505
|
-
* @type {string}
|
|
47506
|
-
* @memberof JsonApiAutomationOutAttributesAlert
|
|
47507
|
-
*/
|
|
47508
|
-
trigger?: JsonApiAutomationOutAttributesAlertTriggerEnum;
|
|
47509
|
-
}
|
|
47510
|
-
|
|
47511
|
-
export declare const JsonApiAutomationOutAttributesAlertTriggerEnum: {
|
|
47512
|
-
readonly ALWAYS: "ALWAYS";
|
|
47513
|
-
readonly ONCE: "ONCE";
|
|
47514
|
-
};
|
|
47515
|
-
|
|
47516
|
-
export declare type JsonApiAutomationOutAttributesAlertTriggerEnum = typeof JsonApiAutomationOutAttributesAlertTriggerEnum[keyof typeof JsonApiAutomationOutAttributesAlertTriggerEnum];
|
|
47517
|
-
|
|
47518
|
-
/**
|
|
47519
|
-
*
|
|
47520
|
-
* @export
|
|
47521
|
-
* @interface JsonApiAutomationOutAttributesExternalRecipients
|
|
47522
|
-
*/
|
|
47523
|
-
export declare interface JsonApiAutomationOutAttributesExternalRecipients {
|
|
47524
|
-
/**
|
|
47525
|
-
* E-mail address to send notifications from.
|
|
47526
|
-
* @type {string}
|
|
47527
|
-
* @memberof JsonApiAutomationOutAttributesExternalRecipients
|
|
47528
|
-
*/
|
|
47529
|
-
email: string;
|
|
47530
|
-
}
|
|
47531
|
-
|
|
47532
|
-
/**
|
|
47533
|
-
*
|
|
47534
|
-
* @export
|
|
47535
|
-
* @interface JsonApiAutomationOutAttributesImageExports
|
|
47536
|
-
*/
|
|
47537
|
-
export declare interface JsonApiAutomationOutAttributesImageExports {
|
|
47538
|
-
/**
|
|
47539
|
-
*
|
|
47540
|
-
* @type {ImageExportRequest}
|
|
47541
|
-
* @memberof JsonApiAutomationOutAttributesImageExports
|
|
47542
|
-
*/
|
|
47543
|
-
requestPayload: ImageExportRequest;
|
|
47544
|
-
}
|
|
47545
|
-
|
|
47546
|
-
/**
|
|
47547
|
-
* Additional information for the automation.
|
|
47548
|
-
* @export
|
|
47549
|
-
* @interface JsonApiAutomationOutAttributesMetadata
|
|
47550
|
-
*/
|
|
47551
|
-
export declare interface JsonApiAutomationOutAttributesMetadata {
|
|
47552
|
-
/**
|
|
47553
|
-
*
|
|
47554
|
-
* @type {string}
|
|
47555
|
-
* @memberof JsonApiAutomationOutAttributesMetadata
|
|
47556
|
-
*/
|
|
47557
|
-
widget?: string;
|
|
47558
|
-
/**
|
|
47559
|
-
*
|
|
47560
|
-
* @type {Array<VisibleFilter>}
|
|
47561
|
-
* @memberof JsonApiAutomationOutAttributesMetadata
|
|
47562
|
-
*/
|
|
47563
|
-
visibleFilters?: Array<VisibleFilter>;
|
|
47564
|
-
}
|
|
47565
|
-
|
|
47566
|
-
/**
|
|
47567
|
-
*
|
|
47568
|
-
* @export
|
|
47569
|
-
* @interface JsonApiAutomationOutAttributesRawExports
|
|
47570
|
-
*/
|
|
47571
|
-
export declare interface JsonApiAutomationOutAttributesRawExports {
|
|
47572
|
-
/**
|
|
47573
|
-
*
|
|
47574
|
-
* @type {RawExportRequest}
|
|
47575
|
-
* @memberof JsonApiAutomationOutAttributesRawExports
|
|
47576
|
-
*/
|
|
47577
|
-
requestPayload: RawExportRequest;
|
|
47578
|
-
}
|
|
47579
|
-
|
|
47580
|
-
/**
|
|
47581
|
-
*
|
|
47582
|
-
* @export
|
|
47583
|
-
* @interface JsonApiAutomationOutAttributesSchedule
|
|
47584
|
-
*/
|
|
47585
|
-
export declare interface JsonApiAutomationOutAttributesSchedule {
|
|
47586
|
-
/**
|
|
47587
|
-
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
47588
|
-
* @type {string}
|
|
47589
|
-
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
47590
|
-
*/
|
|
47591
|
-
cron: string;
|
|
47592
|
-
/**
|
|
47593
|
-
* Human-readable description of the cron expression.
|
|
47594
|
-
* @type {string}
|
|
47595
|
-
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
47596
|
-
*/
|
|
47597
|
-
cronDescription?: string;
|
|
47598
|
-
/**
|
|
47599
|
-
* Timezone in which the schedule is defined.
|
|
47600
|
-
* @type {string}
|
|
47601
|
-
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
47602
|
-
*/
|
|
47603
|
-
timezone: string;
|
|
47604
|
-
/**
|
|
47605
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
47606
|
-
* @type {string}
|
|
47607
|
-
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
47608
|
-
*/
|
|
47609
|
-
firstRun?: string;
|
|
47610
|
-
}
|
|
47611
|
-
|
|
47612
|
-
/**
|
|
47613
|
-
*
|
|
47614
|
-
* @export
|
|
47615
|
-
* @interface JsonApiAutomationOutAttributesSlidesExports
|
|
47616
|
-
*/
|
|
47617
|
-
export declare interface JsonApiAutomationOutAttributesSlidesExports {
|
|
47618
|
-
/**
|
|
47619
|
-
*
|
|
47620
|
-
* @type {SlidesExportRequest}
|
|
47621
|
-
* @memberof JsonApiAutomationOutAttributesSlidesExports
|
|
47622
|
-
*/
|
|
47623
|
-
requestPayload: SlidesExportRequest;
|
|
47624
|
-
}
|
|
47625
|
-
|
|
47626
47367
|
export declare const JsonApiAutomationOutAttributesStateEnum: {
|
|
47627
47368
|
readonly ACTIVE: "ACTIVE";
|
|
47628
47369
|
readonly PAUSED: "PAUSED";
|
|
@@ -47630,34 +47371,6 @@ export declare const JsonApiAutomationOutAttributesStateEnum: {
|
|
|
47630
47371
|
|
|
47631
47372
|
export declare type JsonApiAutomationOutAttributesStateEnum = typeof JsonApiAutomationOutAttributesStateEnum[keyof typeof JsonApiAutomationOutAttributesStateEnum];
|
|
47632
47373
|
|
|
47633
|
-
/**
|
|
47634
|
-
*
|
|
47635
|
-
* @export
|
|
47636
|
-
* @interface JsonApiAutomationOutAttributesTabularExports
|
|
47637
|
-
*/
|
|
47638
|
-
export declare interface JsonApiAutomationOutAttributesTabularExports {
|
|
47639
|
-
/**
|
|
47640
|
-
*
|
|
47641
|
-
* @type {TabularExportRequest}
|
|
47642
|
-
* @memberof JsonApiAutomationOutAttributesTabularExports
|
|
47643
|
-
*/
|
|
47644
|
-
requestPayload: TabularExportRequest;
|
|
47645
|
-
}
|
|
47646
|
-
|
|
47647
|
-
/**
|
|
47648
|
-
*
|
|
47649
|
-
* @export
|
|
47650
|
-
* @interface JsonApiAutomationOutAttributesVisualExports
|
|
47651
|
-
*/
|
|
47652
|
-
export declare interface JsonApiAutomationOutAttributesVisualExports {
|
|
47653
|
-
/**
|
|
47654
|
-
*
|
|
47655
|
-
* @type {VisualExportRequest}
|
|
47656
|
-
* @memberof JsonApiAutomationOutAttributesVisualExports
|
|
47657
|
-
*/
|
|
47658
|
-
requestPayload: VisualExportRequest;
|
|
47659
|
-
}
|
|
47660
|
-
|
|
47661
47374
|
/**
|
|
47662
47375
|
*
|
|
47663
47376
|
* @export
|
|
@@ -47730,16 +47443,16 @@ export declare interface JsonApiAutomationOutList {
|
|
|
47730
47443
|
export declare interface JsonApiAutomationOutRelationships {
|
|
47731
47444
|
/**
|
|
47732
47445
|
*
|
|
47733
|
-
* @type {
|
|
47446
|
+
* @type {JsonApiAutomationPatchRelationshipsNotificationChannel}
|
|
47734
47447
|
* @memberof JsonApiAutomationOutRelationships
|
|
47735
47448
|
*/
|
|
47736
|
-
notificationChannel?:
|
|
47449
|
+
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
47737
47450
|
/**
|
|
47738
47451
|
*
|
|
47739
|
-
* @type {
|
|
47452
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
47740
47453
|
* @memberof JsonApiAutomationOutRelationships
|
|
47741
47454
|
*/
|
|
47742
|
-
analyticalDashboard?:
|
|
47455
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
47743
47456
|
/**
|
|
47744
47457
|
*
|
|
47745
47458
|
* @type {JsonApiVisualizationObjectOutRelationshipsCreatedBy}
|
|
@@ -47754,58 +47467,16 @@ export declare interface JsonApiAutomationOutRelationships {
|
|
|
47754
47467
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
47755
47468
|
/**
|
|
47756
47469
|
*
|
|
47757
|
-
* @type {
|
|
47470
|
+
* @type {JsonApiAutomationPatchRelationshipsExportDefinitions}
|
|
47758
47471
|
* @memberof JsonApiAutomationOutRelationships
|
|
47759
47472
|
*/
|
|
47760
|
-
exportDefinitions?:
|
|
47473
|
+
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
47761
47474
|
/**
|
|
47762
47475
|
*
|
|
47763
|
-
* @type {
|
|
47476
|
+
* @type {JsonApiAutomationPatchRelationshipsRecipients}
|
|
47764
47477
|
* @memberof JsonApiAutomationOutRelationships
|
|
47765
47478
|
*/
|
|
47766
|
-
recipients?:
|
|
47767
|
-
}
|
|
47768
|
-
|
|
47769
|
-
/**
|
|
47770
|
-
*
|
|
47771
|
-
* @export
|
|
47772
|
-
* @interface JsonApiAutomationOutRelationshipsExportDefinitions
|
|
47773
|
-
*/
|
|
47774
|
-
export declare interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
47775
|
-
/**
|
|
47776
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
47777
|
-
* @type {Array<JsonApiExportDefinitionLinkage>}
|
|
47778
|
-
* @memberof JsonApiAutomationOutRelationshipsExportDefinitions
|
|
47779
|
-
*/
|
|
47780
|
-
data: Array<JsonApiExportDefinitionLinkage>;
|
|
47781
|
-
}
|
|
47782
|
-
|
|
47783
|
-
/**
|
|
47784
|
-
*
|
|
47785
|
-
* @export
|
|
47786
|
-
* @interface JsonApiAutomationOutRelationshipsNotificationChannel
|
|
47787
|
-
*/
|
|
47788
|
-
export declare interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
47789
|
-
/**
|
|
47790
|
-
*
|
|
47791
|
-
* @type {JsonApiNotificationChannelToOneLinkage}
|
|
47792
|
-
* @memberof JsonApiAutomationOutRelationshipsNotificationChannel
|
|
47793
|
-
*/
|
|
47794
|
-
data: JsonApiNotificationChannelToOneLinkage | null;
|
|
47795
|
-
}
|
|
47796
|
-
|
|
47797
|
-
/**
|
|
47798
|
-
*
|
|
47799
|
-
* @export
|
|
47800
|
-
* @interface JsonApiAutomationOutRelationshipsRecipients
|
|
47801
|
-
*/
|
|
47802
|
-
export declare interface JsonApiAutomationOutRelationshipsRecipients {
|
|
47803
|
-
/**
|
|
47804
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
47805
|
-
* @type {Array<JsonApiUserLinkage>}
|
|
47806
|
-
* @memberof JsonApiAutomationOutRelationshipsRecipients
|
|
47807
|
-
*/
|
|
47808
|
-
data: Array<JsonApiUserLinkage>;
|
|
47479
|
+
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
47809
47480
|
}
|
|
47810
47481
|
|
|
47811
47482
|
export declare const JsonApiAutomationOutTypeEnum: {
|
|
@@ -47934,10 +47605,10 @@ export declare interface JsonApiAutomationPatchAttributes {
|
|
|
47934
47605
|
details?: any;
|
|
47935
47606
|
/**
|
|
47936
47607
|
*
|
|
47937
|
-
* @type {
|
|
47608
|
+
* @type {JsonApiAutomationPatchAttributesMetadata}
|
|
47938
47609
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47939
47610
|
*/
|
|
47940
|
-
metadata?:
|
|
47611
|
+
metadata?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
47941
47612
|
/**
|
|
47942
47613
|
* Current state of the automation.
|
|
47943
47614
|
* @type {string}
|
|
@@ -47946,52 +47617,193 @@ export declare interface JsonApiAutomationPatchAttributes {
|
|
|
47946
47617
|
state?: JsonApiAutomationPatchAttributesStateEnum;
|
|
47947
47618
|
/**
|
|
47948
47619
|
*
|
|
47949
|
-
* @type {
|
|
47620
|
+
* @type {JsonApiAutomationPatchAttributesSchedule}
|
|
47950
47621
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47951
47622
|
*/
|
|
47952
|
-
schedule?:
|
|
47623
|
+
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
47953
47624
|
/**
|
|
47954
47625
|
*
|
|
47955
|
-
* @type {
|
|
47626
|
+
* @type {JsonApiAutomationPatchAttributesAlert}
|
|
47956
47627
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47957
47628
|
*/
|
|
47958
|
-
alert?:
|
|
47629
|
+
alert?: JsonApiAutomationPatchAttributesAlert;
|
|
47959
47630
|
/**
|
|
47960
47631
|
*
|
|
47961
|
-
* @type {Array<
|
|
47632
|
+
* @type {Array<JsonApiAutomationPatchAttributesTabularExports>}
|
|
47962
47633
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47963
47634
|
*/
|
|
47964
|
-
tabularExports?: Array<
|
|
47635
|
+
tabularExports?: Array<JsonApiAutomationPatchAttributesTabularExports>;
|
|
47965
47636
|
/**
|
|
47966
47637
|
*
|
|
47967
|
-
* @type {Array<
|
|
47638
|
+
* @type {Array<JsonApiAutomationPatchAttributesVisualExports>}
|
|
47968
47639
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47969
47640
|
*/
|
|
47970
|
-
visualExports?: Array<
|
|
47641
|
+
visualExports?: Array<JsonApiAutomationPatchAttributesVisualExports>;
|
|
47971
47642
|
/**
|
|
47972
47643
|
*
|
|
47973
|
-
* @type {Array<
|
|
47644
|
+
* @type {Array<JsonApiAutomationPatchAttributesImageExports>}
|
|
47974
47645
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47975
47646
|
*/
|
|
47976
|
-
imageExports?: Array<
|
|
47647
|
+
imageExports?: Array<JsonApiAutomationPatchAttributesImageExports>;
|
|
47977
47648
|
/**
|
|
47978
47649
|
*
|
|
47979
|
-
* @type {Array<
|
|
47650
|
+
* @type {Array<JsonApiAutomationPatchAttributesRawExports>}
|
|
47980
47651
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47981
47652
|
*/
|
|
47982
|
-
rawExports?: Array<
|
|
47653
|
+
rawExports?: Array<JsonApiAutomationPatchAttributesRawExports>;
|
|
47983
47654
|
/**
|
|
47984
47655
|
*
|
|
47985
|
-
* @type {Array<
|
|
47656
|
+
* @type {Array<JsonApiAutomationPatchAttributesSlidesExports>}
|
|
47986
47657
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47987
47658
|
*/
|
|
47988
|
-
slidesExports?: Array<
|
|
47659
|
+
slidesExports?: Array<JsonApiAutomationPatchAttributesSlidesExports>;
|
|
47989
47660
|
/**
|
|
47990
47661
|
* External recipients of the automation action results.
|
|
47991
|
-
* @type {Array<
|
|
47662
|
+
* @type {Array<JsonApiAutomationPatchAttributesExternalRecipients>}
|
|
47992
47663
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47993
47664
|
*/
|
|
47994
|
-
externalRecipients?: Array<
|
|
47665
|
+
externalRecipients?: Array<JsonApiAutomationPatchAttributesExternalRecipients>;
|
|
47666
|
+
}
|
|
47667
|
+
|
|
47668
|
+
/**
|
|
47669
|
+
*
|
|
47670
|
+
* @export
|
|
47671
|
+
* @interface JsonApiAutomationPatchAttributesAlert
|
|
47672
|
+
*/
|
|
47673
|
+
export declare interface JsonApiAutomationPatchAttributesAlert {
|
|
47674
|
+
/**
|
|
47675
|
+
*
|
|
47676
|
+
* @type {AlertAfm}
|
|
47677
|
+
* @memberof JsonApiAutomationPatchAttributesAlert
|
|
47678
|
+
*/
|
|
47679
|
+
execution: AlertAfm;
|
|
47680
|
+
/**
|
|
47681
|
+
*
|
|
47682
|
+
* @type {AlertCondition}
|
|
47683
|
+
* @memberof JsonApiAutomationPatchAttributesAlert
|
|
47684
|
+
*/
|
|
47685
|
+
condition: AlertCondition;
|
|
47686
|
+
/**
|
|
47687
|
+
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
|
|
47688
|
+
* @type {string}
|
|
47689
|
+
* @memberof JsonApiAutomationPatchAttributesAlert
|
|
47690
|
+
*/
|
|
47691
|
+
trigger?: JsonApiAutomationPatchAttributesAlertTriggerEnum;
|
|
47692
|
+
}
|
|
47693
|
+
|
|
47694
|
+
export declare const JsonApiAutomationPatchAttributesAlertTriggerEnum: {
|
|
47695
|
+
readonly ALWAYS: "ALWAYS";
|
|
47696
|
+
readonly ONCE: "ONCE";
|
|
47697
|
+
};
|
|
47698
|
+
|
|
47699
|
+
export declare type JsonApiAutomationPatchAttributesAlertTriggerEnum = typeof JsonApiAutomationPatchAttributesAlertTriggerEnum[keyof typeof JsonApiAutomationPatchAttributesAlertTriggerEnum];
|
|
47700
|
+
|
|
47701
|
+
/**
|
|
47702
|
+
*
|
|
47703
|
+
* @export
|
|
47704
|
+
* @interface JsonApiAutomationPatchAttributesExternalRecipients
|
|
47705
|
+
*/
|
|
47706
|
+
export declare interface JsonApiAutomationPatchAttributesExternalRecipients {
|
|
47707
|
+
/**
|
|
47708
|
+
* E-mail address to send notifications from.
|
|
47709
|
+
* @type {string}
|
|
47710
|
+
* @memberof JsonApiAutomationPatchAttributesExternalRecipients
|
|
47711
|
+
*/
|
|
47712
|
+
email: string;
|
|
47713
|
+
}
|
|
47714
|
+
|
|
47715
|
+
/**
|
|
47716
|
+
*
|
|
47717
|
+
* @export
|
|
47718
|
+
* @interface JsonApiAutomationPatchAttributesImageExports
|
|
47719
|
+
*/
|
|
47720
|
+
export declare interface JsonApiAutomationPatchAttributesImageExports {
|
|
47721
|
+
/**
|
|
47722
|
+
*
|
|
47723
|
+
* @type {ImageExportRequest}
|
|
47724
|
+
* @memberof JsonApiAutomationPatchAttributesImageExports
|
|
47725
|
+
*/
|
|
47726
|
+
requestPayload: ImageExportRequest;
|
|
47727
|
+
}
|
|
47728
|
+
|
|
47729
|
+
/**
|
|
47730
|
+
* Additional information for the automation.
|
|
47731
|
+
* @export
|
|
47732
|
+
* @interface JsonApiAutomationPatchAttributesMetadata
|
|
47733
|
+
*/
|
|
47734
|
+
export declare interface JsonApiAutomationPatchAttributesMetadata {
|
|
47735
|
+
/**
|
|
47736
|
+
*
|
|
47737
|
+
* @type {string}
|
|
47738
|
+
* @memberof JsonApiAutomationPatchAttributesMetadata
|
|
47739
|
+
*/
|
|
47740
|
+
widget?: string;
|
|
47741
|
+
/**
|
|
47742
|
+
*
|
|
47743
|
+
* @type {Array<VisibleFilter>}
|
|
47744
|
+
* @memberof JsonApiAutomationPatchAttributesMetadata
|
|
47745
|
+
*/
|
|
47746
|
+
visibleFilters?: Array<VisibleFilter>;
|
|
47747
|
+
}
|
|
47748
|
+
|
|
47749
|
+
/**
|
|
47750
|
+
*
|
|
47751
|
+
* @export
|
|
47752
|
+
* @interface JsonApiAutomationPatchAttributesRawExports
|
|
47753
|
+
*/
|
|
47754
|
+
export declare interface JsonApiAutomationPatchAttributesRawExports {
|
|
47755
|
+
/**
|
|
47756
|
+
*
|
|
47757
|
+
* @type {RawExportRequest}
|
|
47758
|
+
* @memberof JsonApiAutomationPatchAttributesRawExports
|
|
47759
|
+
*/
|
|
47760
|
+
requestPayload: RawExportRequest;
|
|
47761
|
+
}
|
|
47762
|
+
|
|
47763
|
+
/**
|
|
47764
|
+
*
|
|
47765
|
+
* @export
|
|
47766
|
+
* @interface JsonApiAutomationPatchAttributesSchedule
|
|
47767
|
+
*/
|
|
47768
|
+
export declare interface JsonApiAutomationPatchAttributesSchedule {
|
|
47769
|
+
/**
|
|
47770
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
47771
|
+
* @type {string}
|
|
47772
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
47773
|
+
*/
|
|
47774
|
+
cron: string;
|
|
47775
|
+
/**
|
|
47776
|
+
* Human-readable description of the cron expression.
|
|
47777
|
+
* @type {string}
|
|
47778
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
47779
|
+
*/
|
|
47780
|
+
cronDescription?: string;
|
|
47781
|
+
/**
|
|
47782
|
+
* Timezone in which the schedule is defined.
|
|
47783
|
+
* @type {string}
|
|
47784
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
47785
|
+
*/
|
|
47786
|
+
timezone: string;
|
|
47787
|
+
/**
|
|
47788
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
47789
|
+
* @type {string}
|
|
47790
|
+
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
47791
|
+
*/
|
|
47792
|
+
firstRun?: string;
|
|
47793
|
+
}
|
|
47794
|
+
|
|
47795
|
+
/**
|
|
47796
|
+
*
|
|
47797
|
+
* @export
|
|
47798
|
+
* @interface JsonApiAutomationPatchAttributesSlidesExports
|
|
47799
|
+
*/
|
|
47800
|
+
export declare interface JsonApiAutomationPatchAttributesSlidesExports {
|
|
47801
|
+
/**
|
|
47802
|
+
*
|
|
47803
|
+
* @type {SlidesExportRequest}
|
|
47804
|
+
* @memberof JsonApiAutomationPatchAttributesSlidesExports
|
|
47805
|
+
*/
|
|
47806
|
+
requestPayload: SlidesExportRequest;
|
|
47995
47807
|
}
|
|
47996
47808
|
|
|
47997
47809
|
export declare const JsonApiAutomationPatchAttributesStateEnum: {
|
|
@@ -48001,6 +47813,34 @@ export declare const JsonApiAutomationPatchAttributesStateEnum: {
|
|
|
48001
47813
|
|
|
48002
47814
|
export declare type JsonApiAutomationPatchAttributesStateEnum = typeof JsonApiAutomationPatchAttributesStateEnum[keyof typeof JsonApiAutomationPatchAttributesStateEnum];
|
|
48003
47815
|
|
|
47816
|
+
/**
|
|
47817
|
+
*
|
|
47818
|
+
* @export
|
|
47819
|
+
* @interface JsonApiAutomationPatchAttributesTabularExports
|
|
47820
|
+
*/
|
|
47821
|
+
export declare interface JsonApiAutomationPatchAttributesTabularExports {
|
|
47822
|
+
/**
|
|
47823
|
+
*
|
|
47824
|
+
* @type {TabularExportRequest}
|
|
47825
|
+
* @memberof JsonApiAutomationPatchAttributesTabularExports
|
|
47826
|
+
*/
|
|
47827
|
+
requestPayload: TabularExportRequest;
|
|
47828
|
+
}
|
|
47829
|
+
|
|
47830
|
+
/**
|
|
47831
|
+
*
|
|
47832
|
+
* @export
|
|
47833
|
+
* @interface JsonApiAutomationPatchAttributesVisualExports
|
|
47834
|
+
*/
|
|
47835
|
+
export declare interface JsonApiAutomationPatchAttributesVisualExports {
|
|
47836
|
+
/**
|
|
47837
|
+
*
|
|
47838
|
+
* @type {VisualExportRequest}
|
|
47839
|
+
* @memberof JsonApiAutomationPatchAttributesVisualExports
|
|
47840
|
+
*/
|
|
47841
|
+
requestPayload: VisualExportRequest;
|
|
47842
|
+
}
|
|
47843
|
+
|
|
48004
47844
|
/**
|
|
48005
47845
|
*
|
|
48006
47846
|
* @export
|
|
@@ -48023,28 +47863,84 @@ export declare interface JsonApiAutomationPatchDocument {
|
|
|
48023
47863
|
export declare interface JsonApiAutomationPatchRelationships {
|
|
48024
47864
|
/**
|
|
48025
47865
|
*
|
|
48026
|
-
* @type {
|
|
47866
|
+
* @type {JsonApiAutomationPatchRelationshipsNotificationChannel}
|
|
48027
47867
|
* @memberof JsonApiAutomationPatchRelationships
|
|
48028
47868
|
*/
|
|
48029
|
-
notificationChannel?:
|
|
47869
|
+
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
48030
47870
|
/**
|
|
48031
47871
|
*
|
|
48032
|
-
* @type {
|
|
47872
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
48033
47873
|
* @memberof JsonApiAutomationPatchRelationships
|
|
48034
47874
|
*/
|
|
48035
|
-
analyticalDashboard?:
|
|
47875
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
48036
47876
|
/**
|
|
48037
47877
|
*
|
|
48038
|
-
* @type {
|
|
47878
|
+
* @type {JsonApiAutomationPatchRelationshipsExportDefinitions}
|
|
48039
47879
|
* @memberof JsonApiAutomationPatchRelationships
|
|
48040
47880
|
*/
|
|
48041
|
-
exportDefinitions?:
|
|
47881
|
+
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
48042
47882
|
/**
|
|
48043
47883
|
*
|
|
48044
|
-
* @type {
|
|
47884
|
+
* @type {JsonApiAutomationPatchRelationshipsRecipients}
|
|
48045
47885
|
* @memberof JsonApiAutomationPatchRelationships
|
|
48046
47886
|
*/
|
|
48047
|
-
recipients?:
|
|
47887
|
+
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
47888
|
+
}
|
|
47889
|
+
|
|
47890
|
+
/**
|
|
47891
|
+
*
|
|
47892
|
+
* @export
|
|
47893
|
+
* @interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard
|
|
47894
|
+
*/
|
|
47895
|
+
export declare interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard {
|
|
47896
|
+
/**
|
|
47897
|
+
*
|
|
47898
|
+
* @type {JsonApiAnalyticalDashboardToOneLinkage}
|
|
47899
|
+
* @memberof JsonApiAutomationPatchRelationshipsAnalyticalDashboard
|
|
47900
|
+
*/
|
|
47901
|
+
data: JsonApiAnalyticalDashboardToOneLinkage | null;
|
|
47902
|
+
}
|
|
47903
|
+
|
|
47904
|
+
/**
|
|
47905
|
+
*
|
|
47906
|
+
* @export
|
|
47907
|
+
* @interface JsonApiAutomationPatchRelationshipsExportDefinitions
|
|
47908
|
+
*/
|
|
47909
|
+
export declare interface JsonApiAutomationPatchRelationshipsExportDefinitions {
|
|
47910
|
+
/**
|
|
47911
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
47912
|
+
* @type {Array<JsonApiExportDefinitionLinkage>}
|
|
47913
|
+
* @memberof JsonApiAutomationPatchRelationshipsExportDefinitions
|
|
47914
|
+
*/
|
|
47915
|
+
data: Array<JsonApiExportDefinitionLinkage>;
|
|
47916
|
+
}
|
|
47917
|
+
|
|
47918
|
+
/**
|
|
47919
|
+
*
|
|
47920
|
+
* @export
|
|
47921
|
+
* @interface JsonApiAutomationPatchRelationshipsNotificationChannel
|
|
47922
|
+
*/
|
|
47923
|
+
export declare interface JsonApiAutomationPatchRelationshipsNotificationChannel {
|
|
47924
|
+
/**
|
|
47925
|
+
*
|
|
47926
|
+
* @type {JsonApiNotificationChannelToOneLinkage}
|
|
47927
|
+
* @memberof JsonApiAutomationPatchRelationshipsNotificationChannel
|
|
47928
|
+
*/
|
|
47929
|
+
data: JsonApiNotificationChannelToOneLinkage | null;
|
|
47930
|
+
}
|
|
47931
|
+
|
|
47932
|
+
/**
|
|
47933
|
+
*
|
|
47934
|
+
* @export
|
|
47935
|
+
* @interface JsonApiAutomationPatchRelationshipsRecipients
|
|
47936
|
+
*/
|
|
47937
|
+
export declare interface JsonApiAutomationPatchRelationshipsRecipients {
|
|
47938
|
+
/**
|
|
47939
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
47940
|
+
* @type {Array<JsonApiUserLinkage>}
|
|
47941
|
+
* @memberof JsonApiAutomationPatchRelationshipsRecipients
|
|
47942
|
+
*/
|
|
47943
|
+
data: Array<JsonApiUserLinkage>;
|
|
48048
47944
|
}
|
|
48049
47945
|
|
|
48050
47946
|
export declare const JsonApiAutomationPatchTypeEnum: {
|
|
@@ -48080,10 +47976,30 @@ export declare interface JsonApiColorPaletteIn {
|
|
|
48080
47976
|
id: string;
|
|
48081
47977
|
/**
|
|
48082
47978
|
*
|
|
48083
|
-
* @type {
|
|
47979
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
48084
47980
|
* @memberof JsonApiColorPaletteIn
|
|
48085
47981
|
*/
|
|
48086
|
-
attributes:
|
|
47982
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
47983
|
+
}
|
|
47984
|
+
|
|
47985
|
+
/**
|
|
47986
|
+
*
|
|
47987
|
+
* @export
|
|
47988
|
+
* @interface JsonApiColorPaletteInAttributes
|
|
47989
|
+
*/
|
|
47990
|
+
export declare interface JsonApiColorPaletteInAttributes {
|
|
47991
|
+
/**
|
|
47992
|
+
*
|
|
47993
|
+
* @type {string}
|
|
47994
|
+
* @memberof JsonApiColorPaletteInAttributes
|
|
47995
|
+
*/
|
|
47996
|
+
name: string;
|
|
47997
|
+
/**
|
|
47998
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
47999
|
+
* @type {object}
|
|
48000
|
+
* @memberof JsonApiColorPaletteInAttributes
|
|
48001
|
+
*/
|
|
48002
|
+
content: object;
|
|
48087
48003
|
}
|
|
48088
48004
|
|
|
48089
48005
|
/**
|
|
@@ -48126,30 +48042,10 @@ export declare interface JsonApiColorPaletteOut {
|
|
|
48126
48042
|
id: string;
|
|
48127
48043
|
/**
|
|
48128
48044
|
*
|
|
48129
|
-
* @type {
|
|
48045
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
48130
48046
|
* @memberof JsonApiColorPaletteOut
|
|
48131
48047
|
*/
|
|
48132
|
-
attributes:
|
|
48133
|
-
}
|
|
48134
|
-
|
|
48135
|
-
/**
|
|
48136
|
-
*
|
|
48137
|
-
* @export
|
|
48138
|
-
* @interface JsonApiColorPaletteOutAttributes
|
|
48139
|
-
*/
|
|
48140
|
-
export declare interface JsonApiColorPaletteOutAttributes {
|
|
48141
|
-
/**
|
|
48142
|
-
*
|
|
48143
|
-
* @type {string}
|
|
48144
|
-
* @memberof JsonApiColorPaletteOutAttributes
|
|
48145
|
-
*/
|
|
48146
|
-
name: string;
|
|
48147
|
-
/**
|
|
48148
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
48149
|
-
* @type {object}
|
|
48150
|
-
* @memberof JsonApiColorPaletteOutAttributes
|
|
48151
|
-
*/
|
|
48152
|
-
content: object;
|
|
48048
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
48153
48049
|
}
|
|
48154
48050
|
|
|
48155
48051
|
/**
|
|
@@ -48224,10 +48120,10 @@ export declare interface JsonApiColorPaletteOutWithLinks {
|
|
|
48224
48120
|
id: string;
|
|
48225
48121
|
/**
|
|
48226
48122
|
*
|
|
48227
|
-
* @type {
|
|
48123
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
48228
48124
|
* @memberof JsonApiColorPaletteOutWithLinks
|
|
48229
48125
|
*/
|
|
48230
|
-
attributes:
|
|
48126
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
48231
48127
|
/**
|
|
48232
48128
|
*
|
|
48233
48129
|
* @type {ObjectLinks}
|
|
@@ -48328,10 +48224,10 @@ export declare interface JsonApiCookieSecurityConfigurationIn {
|
|
|
48328
48224
|
id: string;
|
|
48329
48225
|
/**
|
|
48330
48226
|
*
|
|
48331
|
-
* @type {
|
|
48227
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
48332
48228
|
* @memberof JsonApiCookieSecurityConfigurationIn
|
|
48333
48229
|
*/
|
|
48334
|
-
attributes?:
|
|
48230
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
48335
48231
|
}
|
|
48336
48232
|
|
|
48337
48233
|
/**
|
|
@@ -48374,10 +48270,30 @@ export declare interface JsonApiCookieSecurityConfigurationOut {
|
|
|
48374
48270
|
id: string;
|
|
48375
48271
|
/**
|
|
48376
48272
|
*
|
|
48377
|
-
* @type {
|
|
48273
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
48378
48274
|
* @memberof JsonApiCookieSecurityConfigurationOut
|
|
48379
48275
|
*/
|
|
48380
|
-
attributes?:
|
|
48276
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
48277
|
+
}
|
|
48278
|
+
|
|
48279
|
+
/**
|
|
48280
|
+
*
|
|
48281
|
+
* @export
|
|
48282
|
+
* @interface JsonApiCookieSecurityConfigurationOutAttributes
|
|
48283
|
+
*/
|
|
48284
|
+
export declare interface JsonApiCookieSecurityConfigurationOutAttributes {
|
|
48285
|
+
/**
|
|
48286
|
+
*
|
|
48287
|
+
* @type {string}
|
|
48288
|
+
* @memberof JsonApiCookieSecurityConfigurationOutAttributes
|
|
48289
|
+
*/
|
|
48290
|
+
lastRotation?: string;
|
|
48291
|
+
/**
|
|
48292
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
48293
|
+
* @type {string}
|
|
48294
|
+
* @memberof JsonApiCookieSecurityConfigurationOutAttributes
|
|
48295
|
+
*/
|
|
48296
|
+
rotationInterval?: string;
|
|
48381
48297
|
}
|
|
48382
48298
|
|
|
48383
48299
|
/**
|
|
@@ -48426,30 +48342,10 @@ export declare interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
48426
48342
|
id: string;
|
|
48427
48343
|
/**
|
|
48428
48344
|
*
|
|
48429
|
-
* @type {
|
|
48345
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
48430
48346
|
* @memberof JsonApiCookieSecurityConfigurationPatch
|
|
48431
48347
|
*/
|
|
48432
|
-
attributes?:
|
|
48433
|
-
}
|
|
48434
|
-
|
|
48435
|
-
/**
|
|
48436
|
-
*
|
|
48437
|
-
* @export
|
|
48438
|
-
* @interface JsonApiCookieSecurityConfigurationPatchAttributes
|
|
48439
|
-
*/
|
|
48440
|
-
export declare interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
48441
|
-
/**
|
|
48442
|
-
*
|
|
48443
|
-
* @type {string}
|
|
48444
|
-
* @memberof JsonApiCookieSecurityConfigurationPatchAttributes
|
|
48445
|
-
*/
|
|
48446
|
-
lastRotation?: string;
|
|
48447
|
-
/**
|
|
48448
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
48449
|
-
* @type {string}
|
|
48450
|
-
* @memberof JsonApiCookieSecurityConfigurationPatchAttributes
|
|
48451
|
-
*/
|
|
48452
|
-
rotationInterval?: string;
|
|
48348
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
48453
48349
|
}
|
|
48454
48350
|
|
|
48455
48351
|
/**
|
|
@@ -48492,10 +48388,24 @@ export declare interface JsonApiCspDirectiveIn {
|
|
|
48492
48388
|
id: string;
|
|
48493
48389
|
/**
|
|
48494
48390
|
*
|
|
48495
|
-
* @type {
|
|
48391
|
+
* @type {JsonApiCspDirectiveInAttributes}
|
|
48496
48392
|
* @memberof JsonApiCspDirectiveIn
|
|
48497
48393
|
*/
|
|
48498
|
-
attributes:
|
|
48394
|
+
attributes: JsonApiCspDirectiveInAttributes;
|
|
48395
|
+
}
|
|
48396
|
+
|
|
48397
|
+
/**
|
|
48398
|
+
*
|
|
48399
|
+
* @export
|
|
48400
|
+
* @interface JsonApiCspDirectiveInAttributes
|
|
48401
|
+
*/
|
|
48402
|
+
export declare interface JsonApiCspDirectiveInAttributes {
|
|
48403
|
+
/**
|
|
48404
|
+
*
|
|
48405
|
+
* @type {Array<string>}
|
|
48406
|
+
* @memberof JsonApiCspDirectiveInAttributes
|
|
48407
|
+
*/
|
|
48408
|
+
sources: Array<string>;
|
|
48499
48409
|
}
|
|
48500
48410
|
|
|
48501
48411
|
/**
|
|
@@ -48538,24 +48448,10 @@ export declare interface JsonApiCspDirectiveOut {
|
|
|
48538
48448
|
id: string;
|
|
48539
48449
|
/**
|
|
48540
48450
|
*
|
|
48541
|
-
* @type {
|
|
48451
|
+
* @type {JsonApiCspDirectiveInAttributes}
|
|
48542
48452
|
* @memberof JsonApiCspDirectiveOut
|
|
48543
48453
|
*/
|
|
48544
|
-
attributes:
|
|
48545
|
-
}
|
|
48546
|
-
|
|
48547
|
-
/**
|
|
48548
|
-
*
|
|
48549
|
-
* @export
|
|
48550
|
-
* @interface JsonApiCspDirectiveOutAttributes
|
|
48551
|
-
*/
|
|
48552
|
-
export declare interface JsonApiCspDirectiveOutAttributes {
|
|
48553
|
-
/**
|
|
48554
|
-
*
|
|
48555
|
-
* @type {Array<string>}
|
|
48556
|
-
* @memberof JsonApiCspDirectiveOutAttributes
|
|
48557
|
-
*/
|
|
48558
|
-
sources: Array<string>;
|
|
48454
|
+
attributes: JsonApiCspDirectiveInAttributes;
|
|
48559
48455
|
}
|
|
48560
48456
|
|
|
48561
48457
|
/**
|
|
@@ -48630,10 +48526,10 @@ export declare interface JsonApiCspDirectiveOutWithLinks {
|
|
|
48630
48526
|
id: string;
|
|
48631
48527
|
/**
|
|
48632
48528
|
*
|
|
48633
|
-
* @type {
|
|
48529
|
+
* @type {JsonApiCspDirectiveInAttributes}
|
|
48634
48530
|
* @memberof JsonApiCspDirectiveOutWithLinks
|
|
48635
48531
|
*/
|
|
48636
|
-
attributes:
|
|
48532
|
+
attributes: JsonApiCspDirectiveInAttributes;
|
|
48637
48533
|
/**
|
|
48638
48534
|
*
|
|
48639
48535
|
* @type {ObjectLinks}
|
|
@@ -49562,12 +49458,6 @@ export declare interface JsonApiDatasetOutAttributes {
|
|
|
49562
49458
|
* @memberof JsonApiDatasetOutAttributes
|
|
49563
49459
|
*/
|
|
49564
49460
|
sql?: JsonApiDatasetOutAttributesSql;
|
|
49565
|
-
/**
|
|
49566
|
-
*
|
|
49567
|
-
* @type {number}
|
|
49568
|
-
* @memberof JsonApiDatasetOutAttributes
|
|
49569
|
-
*/
|
|
49570
|
-
precedence?: number;
|
|
49571
49461
|
/**
|
|
49572
49462
|
*
|
|
49573
49463
|
* @type {boolean}
|
|
@@ -49955,10 +49845,10 @@ export declare interface JsonApiDataSourceIdentifierOut {
|
|
|
49955
49845
|
id: string;
|
|
49956
49846
|
/**
|
|
49957
49847
|
*
|
|
49958
|
-
* @type {
|
|
49848
|
+
* @type {JsonApiDataSourceOutMeta}
|
|
49959
49849
|
* @memberof JsonApiDataSourceIdentifierOut
|
|
49960
49850
|
*/
|
|
49961
|
-
meta?:
|
|
49851
|
+
meta?: JsonApiDataSourceOutMeta;
|
|
49962
49852
|
/**
|
|
49963
49853
|
*
|
|
49964
49854
|
* @type {JsonApiDataSourceIdentifierOutAttributes}
|
|
@@ -50069,27 +49959,6 @@ export declare interface JsonApiDataSourceIdentifierOutList {
|
|
|
50069
49959
|
meta?: JsonApiApiTokenOutListMeta;
|
|
50070
49960
|
}
|
|
50071
49961
|
|
|
50072
|
-
/**
|
|
50073
|
-
*
|
|
50074
|
-
* @export
|
|
50075
|
-
* @interface JsonApiDataSourceIdentifierOutMeta
|
|
50076
|
-
*/
|
|
50077
|
-
export declare interface JsonApiDataSourceIdentifierOutMeta {
|
|
50078
|
-
/**
|
|
50079
|
-
* List of valid permissions for a logged-in user.
|
|
50080
|
-
* @type {Array<string>}
|
|
50081
|
-
* @memberof JsonApiDataSourceIdentifierOutMeta
|
|
50082
|
-
*/
|
|
50083
|
-
permissions?: Array<JsonApiDataSourceIdentifierOutMetaPermissionsEnum>;
|
|
50084
|
-
}
|
|
50085
|
-
|
|
50086
|
-
export declare const JsonApiDataSourceIdentifierOutMetaPermissionsEnum: {
|
|
50087
|
-
readonly MANAGE: "MANAGE";
|
|
50088
|
-
readonly USE: "USE";
|
|
50089
|
-
};
|
|
50090
|
-
|
|
50091
|
-
export declare type JsonApiDataSourceIdentifierOutMetaPermissionsEnum = typeof JsonApiDataSourceIdentifierOutMetaPermissionsEnum[keyof typeof JsonApiDataSourceIdentifierOutMetaPermissionsEnum];
|
|
50092
|
-
|
|
50093
49962
|
export declare const JsonApiDataSourceIdentifierOutTypeEnum: {
|
|
50094
49963
|
readonly DATA_SOURCE_IDENTIFIER: "dataSourceIdentifier";
|
|
50095
49964
|
};
|
|
@@ -50116,10 +49985,10 @@ export declare interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
|
50116
49985
|
id: string;
|
|
50117
49986
|
/**
|
|
50118
49987
|
*
|
|
50119
|
-
* @type {
|
|
49988
|
+
* @type {JsonApiDataSourceOutMeta}
|
|
50120
49989
|
* @memberof JsonApiDataSourceIdentifierOutWithLinks
|
|
50121
49990
|
*/
|
|
50122
|
-
meta?:
|
|
49991
|
+
meta?: JsonApiDataSourceOutMeta;
|
|
50123
49992
|
/**
|
|
50124
49993
|
*
|
|
50125
49994
|
* @type {JsonApiDataSourceIdentifierOutAttributes}
|
|
@@ -50240,10 +50109,10 @@ export declare interface JsonApiDataSourceInAttributes {
|
|
|
50240
50109
|
clientSecret?: string | null;
|
|
50241
50110
|
/**
|
|
50242
50111
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50243
|
-
* @type {Array<
|
|
50112
|
+
* @type {Array<JsonApiDataSourceInAttributesParameters>}
|
|
50244
50113
|
* @memberof JsonApiDataSourceInAttributes
|
|
50245
50114
|
*/
|
|
50246
|
-
parameters?: Array<
|
|
50115
|
+
parameters?: Array<JsonApiDataSourceInAttributesParameters> | null;
|
|
50247
50116
|
/**
|
|
50248
50117
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50249
50118
|
* @type {string}
|
|
@@ -50259,6 +50128,26 @@ export declare const JsonApiDataSourceInAttributesCacheStrategyEnum: {
|
|
|
50259
50128
|
|
|
50260
50129
|
export declare type JsonApiDataSourceInAttributesCacheStrategyEnum = typeof JsonApiDataSourceInAttributesCacheStrategyEnum[keyof typeof JsonApiDataSourceInAttributesCacheStrategyEnum];
|
|
50261
50130
|
|
|
50131
|
+
/**
|
|
50132
|
+
*
|
|
50133
|
+
* @export
|
|
50134
|
+
* @interface JsonApiDataSourceInAttributesParameters
|
|
50135
|
+
*/
|
|
50136
|
+
export declare interface JsonApiDataSourceInAttributesParameters {
|
|
50137
|
+
/**
|
|
50138
|
+
*
|
|
50139
|
+
* @type {string}
|
|
50140
|
+
* @memberof JsonApiDataSourceInAttributesParameters
|
|
50141
|
+
*/
|
|
50142
|
+
name: string;
|
|
50143
|
+
/**
|
|
50144
|
+
*
|
|
50145
|
+
* @type {string}
|
|
50146
|
+
* @memberof JsonApiDataSourceInAttributesParameters
|
|
50147
|
+
*/
|
|
50148
|
+
value: string;
|
|
50149
|
+
}
|
|
50150
|
+
|
|
50262
50151
|
export declare const JsonApiDataSourceInAttributesTypeEnum: {
|
|
50263
50152
|
readonly POSTGRESQL: "POSTGRESQL";
|
|
50264
50153
|
readonly REDSHIFT: "REDSHIFT";
|
|
@@ -50329,10 +50218,10 @@ export declare interface JsonApiDataSourceOut {
|
|
|
50329
50218
|
id: string;
|
|
50330
50219
|
/**
|
|
50331
50220
|
*
|
|
50332
|
-
* @type {
|
|
50221
|
+
* @type {JsonApiDataSourceOutMeta}
|
|
50333
50222
|
* @memberof JsonApiDataSourceOut
|
|
50334
50223
|
*/
|
|
50335
|
-
meta?:
|
|
50224
|
+
meta?: JsonApiDataSourceOutMeta;
|
|
50336
50225
|
/**
|
|
50337
50226
|
*
|
|
50338
50227
|
* @type {JsonApiDataSourceOutAttributes}
|
|
@@ -50385,16 +50274,16 @@ export declare interface JsonApiDataSourceOutAttributes {
|
|
|
50385
50274
|
clientId?: string | null;
|
|
50386
50275
|
/**
|
|
50387
50276
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50388
|
-
* @type {Array<
|
|
50277
|
+
* @type {Array<JsonApiDataSourceInAttributesParameters>}
|
|
50389
50278
|
* @memberof JsonApiDataSourceOutAttributes
|
|
50390
50279
|
*/
|
|
50391
|
-
parameters?: Array<
|
|
50280
|
+
parameters?: Array<JsonApiDataSourceInAttributesParameters> | null;
|
|
50392
50281
|
/**
|
|
50393
50282
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
50394
|
-
* @type {Array<
|
|
50283
|
+
* @type {Array<JsonApiDataSourceInAttributesParameters>}
|
|
50395
50284
|
* @memberof JsonApiDataSourceOutAttributes
|
|
50396
50285
|
*/
|
|
50397
|
-
decodedParameters?: Array<
|
|
50286
|
+
decodedParameters?: Array<JsonApiDataSourceInAttributesParameters> | null;
|
|
50398
50287
|
/**
|
|
50399
50288
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50400
50289
|
* @type {string}
|
|
@@ -50426,26 +50315,6 @@ export declare const JsonApiDataSourceOutAttributesCacheStrategyEnum: {
|
|
|
50426
50315
|
|
|
50427
50316
|
export declare type JsonApiDataSourceOutAttributesCacheStrategyEnum = typeof JsonApiDataSourceOutAttributesCacheStrategyEnum[keyof typeof JsonApiDataSourceOutAttributesCacheStrategyEnum];
|
|
50428
50317
|
|
|
50429
|
-
/**
|
|
50430
|
-
*
|
|
50431
|
-
* @export
|
|
50432
|
-
* @interface JsonApiDataSourceOutAttributesParameters
|
|
50433
|
-
*/
|
|
50434
|
-
export declare interface JsonApiDataSourceOutAttributesParameters {
|
|
50435
|
-
/**
|
|
50436
|
-
*
|
|
50437
|
-
* @type {string}
|
|
50438
|
-
* @memberof JsonApiDataSourceOutAttributesParameters
|
|
50439
|
-
*/
|
|
50440
|
-
name: string;
|
|
50441
|
-
/**
|
|
50442
|
-
*
|
|
50443
|
-
* @type {string}
|
|
50444
|
-
* @memberof JsonApiDataSourceOutAttributesParameters
|
|
50445
|
-
*/
|
|
50446
|
-
value: string;
|
|
50447
|
-
}
|
|
50448
|
-
|
|
50449
50318
|
export declare const JsonApiDataSourceOutAttributesTypeEnum: {
|
|
50450
50319
|
readonly POSTGRESQL: "POSTGRESQL";
|
|
50451
50320
|
readonly REDSHIFT: "REDSHIFT";
|
|
@@ -50522,6 +50391,27 @@ export declare interface JsonApiDataSourceOutList {
|
|
|
50522
50391
|
meta?: JsonApiApiTokenOutListMeta;
|
|
50523
50392
|
}
|
|
50524
50393
|
|
|
50394
|
+
/**
|
|
50395
|
+
*
|
|
50396
|
+
* @export
|
|
50397
|
+
* @interface JsonApiDataSourceOutMeta
|
|
50398
|
+
*/
|
|
50399
|
+
export declare interface JsonApiDataSourceOutMeta {
|
|
50400
|
+
/**
|
|
50401
|
+
* List of valid permissions for a logged-in user.
|
|
50402
|
+
* @type {Array<string>}
|
|
50403
|
+
* @memberof JsonApiDataSourceOutMeta
|
|
50404
|
+
*/
|
|
50405
|
+
permissions?: Array<JsonApiDataSourceOutMetaPermissionsEnum>;
|
|
50406
|
+
}
|
|
50407
|
+
|
|
50408
|
+
export declare const JsonApiDataSourceOutMetaPermissionsEnum: {
|
|
50409
|
+
readonly MANAGE: "MANAGE";
|
|
50410
|
+
readonly USE: "USE";
|
|
50411
|
+
};
|
|
50412
|
+
|
|
50413
|
+
export declare type JsonApiDataSourceOutMetaPermissionsEnum = typeof JsonApiDataSourceOutMetaPermissionsEnum[keyof typeof JsonApiDataSourceOutMetaPermissionsEnum];
|
|
50414
|
+
|
|
50525
50415
|
export declare const JsonApiDataSourceOutTypeEnum: {
|
|
50526
50416
|
readonly DATA_SOURCE: "dataSource";
|
|
50527
50417
|
};
|
|
@@ -50548,10 +50438,10 @@ export declare interface JsonApiDataSourceOutWithLinks {
|
|
|
50548
50438
|
id: string;
|
|
50549
50439
|
/**
|
|
50550
50440
|
*
|
|
50551
|
-
* @type {
|
|
50441
|
+
* @type {JsonApiDataSourceOutMeta}
|
|
50552
50442
|
* @memberof JsonApiDataSourceOutWithLinks
|
|
50553
50443
|
*/
|
|
50554
|
-
meta?:
|
|
50444
|
+
meta?: JsonApiDataSourceOutMeta;
|
|
50555
50445
|
/**
|
|
50556
50446
|
*
|
|
50557
50447
|
* @type {JsonApiDataSourceOutAttributes}
|
|
@@ -50672,10 +50562,10 @@ export declare interface JsonApiDataSourcePatchAttributes {
|
|
|
50672
50562
|
clientSecret?: string | null;
|
|
50673
50563
|
/**
|
|
50674
50564
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50675
|
-
* @type {Array<
|
|
50565
|
+
* @type {Array<JsonApiDataSourceInAttributesParameters>}
|
|
50676
50566
|
* @memberof JsonApiDataSourcePatchAttributes
|
|
50677
50567
|
*/
|
|
50678
|
-
parameters?: Array<
|
|
50568
|
+
parameters?: Array<JsonApiDataSourceInAttributesParameters> | null;
|
|
50679
50569
|
/**
|
|
50680
50570
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50681
50571
|
* @type {string}
|
|
@@ -51121,10 +51011,10 @@ export declare interface JsonApiExportDefinitionOutRelationships {
|
|
|
51121
51011
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
51122
51012
|
/**
|
|
51123
51013
|
*
|
|
51124
|
-
* @type {
|
|
51014
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
51125
51015
|
* @memberof JsonApiExportDefinitionOutRelationships
|
|
51126
51016
|
*/
|
|
51127
|
-
analyticalDashboard?:
|
|
51017
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
51128
51018
|
/**
|
|
51129
51019
|
*
|
|
51130
51020
|
* @type {JsonApiExportDefinitionOutRelationshipsAutomation}
|
|
@@ -51145,20 +51035,6 @@ export declare interface JsonApiExportDefinitionOutRelationships {
|
|
|
51145
51035
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
51146
51036
|
}
|
|
51147
51037
|
|
|
51148
|
-
/**
|
|
51149
|
-
*
|
|
51150
|
-
* @export
|
|
51151
|
-
* @interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard
|
|
51152
|
-
*/
|
|
51153
|
-
export declare interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
51154
|
-
/**
|
|
51155
|
-
*
|
|
51156
|
-
* @type {JsonApiAnalyticalDashboardToOneLinkage}
|
|
51157
|
-
* @memberof JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard
|
|
51158
|
-
*/
|
|
51159
|
-
data: JsonApiAnalyticalDashboardToOneLinkage | null;
|
|
51160
|
-
}
|
|
51161
|
-
|
|
51162
51038
|
/**
|
|
51163
51039
|
*
|
|
51164
51040
|
* @export
|
|
@@ -51341,10 +51217,10 @@ export declare interface JsonApiExportDefinitionPatchRelationships {
|
|
|
51341
51217
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
51342
51218
|
/**
|
|
51343
51219
|
*
|
|
51344
|
-
* @type {
|
|
51220
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
51345
51221
|
* @memberof JsonApiExportDefinitionPatchRelationships
|
|
51346
51222
|
*/
|
|
51347
|
-
analyticalDashboard?:
|
|
51223
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
51348
51224
|
}
|
|
51349
51225
|
|
|
51350
51226
|
export declare const JsonApiExportDefinitionPatchTypeEnum: {
|
|
@@ -51425,10 +51301,10 @@ export declare interface JsonApiExportTemplateIn {
|
|
|
51425
51301
|
id: string;
|
|
51426
51302
|
/**
|
|
51427
51303
|
*
|
|
51428
|
-
* @type {
|
|
51304
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributes}
|
|
51429
51305
|
* @memberof JsonApiExportTemplateIn
|
|
51430
51306
|
*/
|
|
51431
|
-
attributes:
|
|
51307
|
+
attributes: JsonApiExportTemplatePostOptionalIdAttributes;
|
|
51432
51308
|
}
|
|
51433
51309
|
|
|
51434
51310
|
/**
|
|
@@ -51471,110 +51347,12 @@ export declare interface JsonApiExportTemplateOut {
|
|
|
51471
51347
|
id: string;
|
|
51472
51348
|
/**
|
|
51473
51349
|
*
|
|
51474
|
-
* @type {
|
|
51350
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributes}
|
|
51475
51351
|
* @memberof JsonApiExportTemplateOut
|
|
51476
51352
|
*/
|
|
51477
|
-
attributes:
|
|
51478
|
-
}
|
|
51479
|
-
|
|
51480
|
-
/**
|
|
51481
|
-
*
|
|
51482
|
-
* @export
|
|
51483
|
-
* @interface JsonApiExportTemplateOutAttributes
|
|
51484
|
-
*/
|
|
51485
|
-
export declare interface JsonApiExportTemplateOutAttributes {
|
|
51486
|
-
/**
|
|
51487
|
-
* User-facing name of the Slides template.
|
|
51488
|
-
* @type {string}
|
|
51489
|
-
* @memberof JsonApiExportTemplateOutAttributes
|
|
51490
|
-
*/
|
|
51491
|
-
name: string;
|
|
51492
|
-
/**
|
|
51493
|
-
*
|
|
51494
|
-
* @type {JsonApiExportTemplateOutAttributesDashboardSlidesTemplate}
|
|
51495
|
-
* @memberof JsonApiExportTemplateOutAttributes
|
|
51496
|
-
*/
|
|
51497
|
-
dashboardSlidesTemplate?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
51498
|
-
/**
|
|
51499
|
-
*
|
|
51500
|
-
* @type {JsonApiExportTemplateOutAttributesWidgetSlidesTemplate}
|
|
51501
|
-
* @memberof JsonApiExportTemplateOutAttributes
|
|
51502
|
-
*/
|
|
51503
|
-
widgetSlidesTemplate?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
51504
|
-
}
|
|
51505
|
-
|
|
51506
|
-
/**
|
|
51507
|
-
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
51508
|
-
* @export
|
|
51509
|
-
* @interface JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
51510
|
-
*/
|
|
51511
|
-
export declare interface JsonApiExportTemplateOutAttributesDashboardSlidesTemplate {
|
|
51512
|
-
/**
|
|
51513
|
-
* Export types this template applies to.
|
|
51514
|
-
* @type {Array<string>}
|
|
51515
|
-
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
51516
|
-
*/
|
|
51517
|
-
appliedOn: Array<JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
51518
|
-
/**
|
|
51519
|
-
*
|
|
51520
|
-
* @type {CoverSlideTemplate}
|
|
51521
|
-
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
51522
|
-
*/
|
|
51523
|
-
coverSlide?: CoverSlideTemplate | null;
|
|
51524
|
-
/**
|
|
51525
|
-
*
|
|
51526
|
-
* @type {IntroSlideTemplate}
|
|
51527
|
-
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
51528
|
-
*/
|
|
51529
|
-
introSlide?: IntroSlideTemplate | null;
|
|
51530
|
-
/**
|
|
51531
|
-
*
|
|
51532
|
-
* @type {SectionSlideTemplate}
|
|
51533
|
-
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
51534
|
-
*/
|
|
51535
|
-
sectionSlide?: SectionSlideTemplate | null;
|
|
51536
|
-
/**
|
|
51537
|
-
*
|
|
51538
|
-
* @type {ContentSlideTemplate}
|
|
51539
|
-
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
51540
|
-
*/
|
|
51541
|
-
contentSlide?: ContentSlideTemplate | null;
|
|
51353
|
+
attributes: JsonApiExportTemplatePostOptionalIdAttributes;
|
|
51542
51354
|
}
|
|
51543
51355
|
|
|
51544
|
-
export declare const JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum: {
|
|
51545
|
-
readonly PDF: "PDF";
|
|
51546
|
-
readonly PPTX: "PPTX";
|
|
51547
|
-
};
|
|
51548
|
-
|
|
51549
|
-
export declare type JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum = typeof JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum[keyof typeof JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum];
|
|
51550
|
-
|
|
51551
|
-
/**
|
|
51552
|
-
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
51553
|
-
* @export
|
|
51554
|
-
* @interface JsonApiExportTemplateOutAttributesWidgetSlidesTemplate
|
|
51555
|
-
*/
|
|
51556
|
-
export declare interface JsonApiExportTemplateOutAttributesWidgetSlidesTemplate {
|
|
51557
|
-
/**
|
|
51558
|
-
* Export types this template applies to.
|
|
51559
|
-
* @type {Array<string>}
|
|
51560
|
-
* @memberof JsonApiExportTemplateOutAttributesWidgetSlidesTemplate
|
|
51561
|
-
*/
|
|
51562
|
-
appliedOn: Array<JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
51563
|
-
/**
|
|
51564
|
-
*
|
|
51565
|
-
* @type {ContentSlideTemplate}
|
|
51566
|
-
* @memberof JsonApiExportTemplateOutAttributesWidgetSlidesTemplate
|
|
51567
|
-
*/
|
|
51568
|
-
contentSlide?: ContentSlideTemplate | null;
|
|
51569
|
-
}
|
|
51570
|
-
|
|
51571
|
-
export declare const JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum: {
|
|
51572
|
-
readonly PDF: "PDF";
|
|
51573
|
-
readonly PPTX: "PPTX";
|
|
51574
|
-
};
|
|
51575
|
-
|
|
51576
|
-
export declare type JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum = typeof JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum[keyof typeof JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum];
|
|
51577
|
-
|
|
51578
51356
|
/**
|
|
51579
51357
|
*
|
|
51580
51358
|
* @export
|
|
@@ -51647,10 +51425,10 @@ export declare interface JsonApiExportTemplateOutWithLinks {
|
|
|
51647
51425
|
id: string;
|
|
51648
51426
|
/**
|
|
51649
51427
|
*
|
|
51650
|
-
* @type {
|
|
51428
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributes}
|
|
51651
51429
|
* @memberof JsonApiExportTemplateOutWithLinks
|
|
51652
51430
|
*/
|
|
51653
|
-
attributes:
|
|
51431
|
+
attributes: JsonApiExportTemplatePostOptionalIdAttributes;
|
|
51654
51432
|
/**
|
|
51655
51433
|
*
|
|
51656
51434
|
* @type {ObjectLinks}
|
|
@@ -51705,16 +51483,16 @@ export declare interface JsonApiExportTemplatePatchAttributes {
|
|
|
51705
51483
|
name?: string;
|
|
51706
51484
|
/**
|
|
51707
51485
|
*
|
|
51708
|
-
* @type {
|
|
51486
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate}
|
|
51709
51487
|
* @memberof JsonApiExportTemplatePatchAttributes
|
|
51710
51488
|
*/
|
|
51711
|
-
dashboardSlidesTemplate?:
|
|
51489
|
+
dashboardSlidesTemplate?: JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate | null;
|
|
51712
51490
|
/**
|
|
51713
51491
|
*
|
|
51714
|
-
* @type {
|
|
51492
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate}
|
|
51715
51493
|
* @memberof JsonApiExportTemplatePatchAttributes
|
|
51716
51494
|
*/
|
|
51717
|
-
widgetSlidesTemplate?:
|
|
51495
|
+
widgetSlidesTemplate?: JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate | null;
|
|
51718
51496
|
}
|
|
51719
51497
|
|
|
51720
51498
|
/**
|
|
@@ -51757,12 +51535,110 @@ export declare interface JsonApiExportTemplatePostOptionalId {
|
|
|
51757
51535
|
id?: string;
|
|
51758
51536
|
/**
|
|
51759
51537
|
*
|
|
51760
|
-
* @type {
|
|
51538
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributes}
|
|
51761
51539
|
* @memberof JsonApiExportTemplatePostOptionalId
|
|
51762
51540
|
*/
|
|
51763
|
-
attributes:
|
|
51541
|
+
attributes: JsonApiExportTemplatePostOptionalIdAttributes;
|
|
51542
|
+
}
|
|
51543
|
+
|
|
51544
|
+
/**
|
|
51545
|
+
*
|
|
51546
|
+
* @export
|
|
51547
|
+
* @interface JsonApiExportTemplatePostOptionalIdAttributes
|
|
51548
|
+
*/
|
|
51549
|
+
export declare interface JsonApiExportTemplatePostOptionalIdAttributes {
|
|
51550
|
+
/**
|
|
51551
|
+
* User-facing name of the Slides template.
|
|
51552
|
+
* @type {string}
|
|
51553
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributes
|
|
51554
|
+
*/
|
|
51555
|
+
name: string;
|
|
51556
|
+
/**
|
|
51557
|
+
*
|
|
51558
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate}
|
|
51559
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributes
|
|
51560
|
+
*/
|
|
51561
|
+
dashboardSlidesTemplate?: JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate | null;
|
|
51562
|
+
/**
|
|
51563
|
+
*
|
|
51564
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate}
|
|
51565
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributes
|
|
51566
|
+
*/
|
|
51567
|
+
widgetSlidesTemplate?: JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate | null;
|
|
51568
|
+
}
|
|
51569
|
+
|
|
51570
|
+
/**
|
|
51571
|
+
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
51572
|
+
* @export
|
|
51573
|
+
* @interface JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
51574
|
+
*/
|
|
51575
|
+
export declare interface JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate {
|
|
51576
|
+
/**
|
|
51577
|
+
* Export types this template applies to.
|
|
51578
|
+
* @type {Array<string>}
|
|
51579
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
51580
|
+
*/
|
|
51581
|
+
appliedOn: Array<JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
51582
|
+
/**
|
|
51583
|
+
*
|
|
51584
|
+
* @type {CoverSlideTemplate}
|
|
51585
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
51586
|
+
*/
|
|
51587
|
+
coverSlide?: CoverSlideTemplate | null;
|
|
51588
|
+
/**
|
|
51589
|
+
*
|
|
51590
|
+
* @type {IntroSlideTemplate}
|
|
51591
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
51592
|
+
*/
|
|
51593
|
+
introSlide?: IntroSlideTemplate | null;
|
|
51594
|
+
/**
|
|
51595
|
+
*
|
|
51596
|
+
* @type {SectionSlideTemplate}
|
|
51597
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
51598
|
+
*/
|
|
51599
|
+
sectionSlide?: SectionSlideTemplate | null;
|
|
51600
|
+
/**
|
|
51601
|
+
*
|
|
51602
|
+
* @type {ContentSlideTemplate}
|
|
51603
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
51604
|
+
*/
|
|
51605
|
+
contentSlide?: ContentSlideTemplate | null;
|
|
51764
51606
|
}
|
|
51765
51607
|
|
|
51608
|
+
export declare const JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum: {
|
|
51609
|
+
readonly PDF: "PDF";
|
|
51610
|
+
readonly PPTX: "PPTX";
|
|
51611
|
+
};
|
|
51612
|
+
|
|
51613
|
+
export declare type JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum = typeof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum[keyof typeof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum];
|
|
51614
|
+
|
|
51615
|
+
/**
|
|
51616
|
+
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
51617
|
+
* @export
|
|
51618
|
+
* @interface JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate
|
|
51619
|
+
*/
|
|
51620
|
+
export declare interface JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate {
|
|
51621
|
+
/**
|
|
51622
|
+
* Export types this template applies to.
|
|
51623
|
+
* @type {Array<string>}
|
|
51624
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate
|
|
51625
|
+
*/
|
|
51626
|
+
appliedOn: Array<JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
51627
|
+
/**
|
|
51628
|
+
*
|
|
51629
|
+
* @type {ContentSlideTemplate}
|
|
51630
|
+
* @memberof JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate
|
|
51631
|
+
*/
|
|
51632
|
+
contentSlide?: ContentSlideTemplate | null;
|
|
51633
|
+
}
|
|
51634
|
+
|
|
51635
|
+
export declare const JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum: {
|
|
51636
|
+
readonly PDF: "PDF";
|
|
51637
|
+
readonly PPTX: "PPTX";
|
|
51638
|
+
};
|
|
51639
|
+
|
|
51640
|
+
export declare type JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum = typeof JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum[keyof typeof JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum];
|
|
51641
|
+
|
|
51766
51642
|
/**
|
|
51767
51643
|
*
|
|
51768
51644
|
* @export
|
|
@@ -51889,22 +51765,8 @@ export declare interface JsonApiFactOutAttributes {
|
|
|
51889
51765
|
* @memberof JsonApiFactOutAttributes
|
|
51890
51766
|
*/
|
|
51891
51767
|
areRelationsValid?: boolean;
|
|
51892
|
-
/**
|
|
51893
|
-
*
|
|
51894
|
-
* @type {string}
|
|
51895
|
-
* @memberof JsonApiFactOutAttributes
|
|
51896
|
-
*/
|
|
51897
|
-
operation?: JsonApiFactOutAttributesOperationEnum;
|
|
51898
51768
|
}
|
|
51899
51769
|
|
|
51900
|
-
export declare const JsonApiFactOutAttributesOperationEnum: {
|
|
51901
|
-
readonly SUM: "SUM";
|
|
51902
|
-
readonly MIN: "MIN";
|
|
51903
|
-
readonly MAX: "MAX";
|
|
51904
|
-
};
|
|
51905
|
-
|
|
51906
|
-
export declare type JsonApiFactOutAttributesOperationEnum = typeof JsonApiFactOutAttributesOperationEnum[keyof typeof JsonApiFactOutAttributesOperationEnum];
|
|
51907
|
-
|
|
51908
51770
|
export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
51909
51771
|
readonly INT: "INT";
|
|
51910
51772
|
readonly STRING: "STRING";
|
|
@@ -51937,18 +51799,12 @@ export declare interface JsonApiFactOutDocument {
|
|
|
51937
51799
|
links?: ObjectLinks;
|
|
51938
51800
|
/**
|
|
51939
51801
|
* Included resources
|
|
51940
|
-
* @type {Array<
|
|
51802
|
+
* @type {Array<JsonApiDatasetOutWithLinks>}
|
|
51941
51803
|
* @memberof JsonApiFactOutDocument
|
|
51942
51804
|
*/
|
|
51943
|
-
included?: Array<
|
|
51805
|
+
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
51944
51806
|
}
|
|
51945
51807
|
|
|
51946
|
-
/**
|
|
51947
|
-
* @type JsonApiFactOutIncludes
|
|
51948
|
-
* @export
|
|
51949
|
-
*/
|
|
51950
|
-
export declare type JsonApiFactOutIncludes = JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks;
|
|
51951
|
-
|
|
51952
51808
|
/**
|
|
51953
51809
|
* A JSON:API document with a list of resources
|
|
51954
51810
|
* @export
|
|
@@ -51975,10 +51831,10 @@ export declare interface JsonApiFactOutList {
|
|
|
51975
51831
|
meta?: JsonApiApiTokenOutListMeta;
|
|
51976
51832
|
/**
|
|
51977
51833
|
* Included resources
|
|
51978
|
-
* @type {Array<
|
|
51834
|
+
* @type {Array<JsonApiDatasetOutWithLinks>}
|
|
51979
51835
|
* @memberof JsonApiFactOutList
|
|
51980
51836
|
*/
|
|
51981
|
-
included?: Array<
|
|
51837
|
+
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
51982
51838
|
}
|
|
51983
51839
|
|
|
51984
51840
|
/**
|
|
@@ -51993,26 +51849,6 @@ export declare interface JsonApiFactOutRelationships {
|
|
|
51993
51849
|
* @memberof JsonApiFactOutRelationships
|
|
51994
51850
|
*/
|
|
51995
51851
|
dataset?: JsonApiAttributeOutRelationshipsDataset;
|
|
51996
|
-
/**
|
|
51997
|
-
*
|
|
51998
|
-
* @type {JsonApiFactOutRelationshipsSourceFact}
|
|
51999
|
-
* @memberof JsonApiFactOutRelationships
|
|
52000
|
-
*/
|
|
52001
|
-
sourceFact?: JsonApiFactOutRelationshipsSourceFact;
|
|
52002
|
-
}
|
|
52003
|
-
|
|
52004
|
-
/**
|
|
52005
|
-
*
|
|
52006
|
-
* @export
|
|
52007
|
-
* @interface JsonApiFactOutRelationshipsSourceFact
|
|
52008
|
-
*/
|
|
52009
|
-
export declare interface JsonApiFactOutRelationshipsSourceFact {
|
|
52010
|
-
/**
|
|
52011
|
-
*
|
|
52012
|
-
* @type {JsonApiFactToOneLinkage}
|
|
52013
|
-
* @memberof JsonApiFactOutRelationshipsSourceFact
|
|
52014
|
-
*/
|
|
52015
|
-
data: JsonApiFactToOneLinkage | null;
|
|
52016
51852
|
}
|
|
52017
51853
|
|
|
52018
51854
|
export declare const JsonApiFactOutTypeEnum: {
|
|
@@ -52071,13 +51907,6 @@ export declare const JsonApiFactOutWithLinksTypeEnum: {
|
|
|
52071
51907
|
|
|
52072
51908
|
export declare type JsonApiFactOutWithLinksTypeEnum = typeof JsonApiFactOutWithLinksTypeEnum[keyof typeof JsonApiFactOutWithLinksTypeEnum];
|
|
52073
51909
|
|
|
52074
|
-
/**
|
|
52075
|
-
* @type JsonApiFactToOneLinkage
|
|
52076
|
-
* References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
52077
|
-
* @export
|
|
52078
|
-
*/
|
|
52079
|
-
export declare type JsonApiFactToOneLinkage = JsonApiFactLinkage;
|
|
52080
|
-
|
|
52081
51910
|
/**
|
|
52082
51911
|
* JSON:API representation of filterContext entity.
|
|
52083
51912
|
* @export
|
|
@@ -52490,10 +52319,10 @@ export declare interface JsonApiFilterViewIn {
|
|
|
52490
52319
|
attributes: JsonApiFilterViewOutAttributes;
|
|
52491
52320
|
/**
|
|
52492
52321
|
*
|
|
52493
|
-
* @type {
|
|
52322
|
+
* @type {JsonApiFilterViewPatchRelationships}
|
|
52494
52323
|
* @memberof JsonApiFilterViewIn
|
|
52495
52324
|
*/
|
|
52496
|
-
relationships?:
|
|
52325
|
+
relationships?: JsonApiFilterViewPatchRelationships;
|
|
52497
52326
|
}
|
|
52498
52327
|
|
|
52499
52328
|
/**
|
|
@@ -52542,10 +52371,10 @@ export declare interface JsonApiFilterViewOut {
|
|
|
52542
52371
|
attributes: JsonApiFilterViewOutAttributes;
|
|
52543
52372
|
/**
|
|
52544
52373
|
*
|
|
52545
|
-
* @type {
|
|
52374
|
+
* @type {JsonApiFilterViewPatchRelationships}
|
|
52546
52375
|
* @memberof JsonApiFilterViewOut
|
|
52547
52376
|
*/
|
|
52548
|
-
relationships?:
|
|
52377
|
+
relationships?: JsonApiFilterViewPatchRelationships;
|
|
52549
52378
|
}
|
|
52550
52379
|
|
|
52551
52380
|
/**
|
|
@@ -52656,26 +52485,6 @@ export declare interface JsonApiFilterViewOutList {
|
|
|
52656
52485
|
included?: Array<JsonApiFilterViewOutIncludes>;
|
|
52657
52486
|
}
|
|
52658
52487
|
|
|
52659
|
-
/**
|
|
52660
|
-
*
|
|
52661
|
-
* @export
|
|
52662
|
-
* @interface JsonApiFilterViewOutRelationships
|
|
52663
|
-
*/
|
|
52664
|
-
export declare interface JsonApiFilterViewOutRelationships {
|
|
52665
|
-
/**
|
|
52666
|
-
*
|
|
52667
|
-
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
52668
|
-
* @memberof JsonApiFilterViewOutRelationships
|
|
52669
|
-
*/
|
|
52670
|
-
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
52671
|
-
/**
|
|
52672
|
-
*
|
|
52673
|
-
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
52674
|
-
* @memberof JsonApiFilterViewOutRelationships
|
|
52675
|
-
*/
|
|
52676
|
-
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
52677
|
-
}
|
|
52678
|
-
|
|
52679
52488
|
export declare const JsonApiFilterViewOutTypeEnum: {
|
|
52680
52489
|
readonly FILTER_VIEW: "filterView";
|
|
52681
52490
|
};
|
|
@@ -52708,10 +52517,10 @@ export declare interface JsonApiFilterViewOutWithLinks {
|
|
|
52708
52517
|
attributes: JsonApiFilterViewOutAttributes;
|
|
52709
52518
|
/**
|
|
52710
52519
|
*
|
|
52711
|
-
* @type {
|
|
52520
|
+
* @type {JsonApiFilterViewPatchRelationships}
|
|
52712
52521
|
* @memberof JsonApiFilterViewOutWithLinks
|
|
52713
52522
|
*/
|
|
52714
|
-
relationships?:
|
|
52523
|
+
relationships?: JsonApiFilterViewPatchRelationships;
|
|
52715
52524
|
/**
|
|
52716
52525
|
*
|
|
52717
52526
|
* @type {ObjectLinks}
|
|
@@ -52752,10 +52561,10 @@ export declare interface JsonApiFilterViewPatch {
|
|
|
52752
52561
|
attributes: JsonApiFilterViewPatchAttributes;
|
|
52753
52562
|
/**
|
|
52754
52563
|
*
|
|
52755
|
-
* @type {
|
|
52564
|
+
* @type {JsonApiFilterViewPatchRelationships}
|
|
52756
52565
|
* @memberof JsonApiFilterViewPatch
|
|
52757
52566
|
*/
|
|
52758
|
-
relationships?:
|
|
52567
|
+
relationships?: JsonApiFilterViewPatchRelationships;
|
|
52759
52568
|
}
|
|
52760
52569
|
|
|
52761
52570
|
/**
|
|
@@ -52816,6 +52625,40 @@ export declare interface JsonApiFilterViewPatchDocument {
|
|
|
52816
52625
|
data: JsonApiFilterViewPatch;
|
|
52817
52626
|
}
|
|
52818
52627
|
|
|
52628
|
+
/**
|
|
52629
|
+
*
|
|
52630
|
+
* @export
|
|
52631
|
+
* @interface JsonApiFilterViewPatchRelationships
|
|
52632
|
+
*/
|
|
52633
|
+
export declare interface JsonApiFilterViewPatchRelationships {
|
|
52634
|
+
/**
|
|
52635
|
+
*
|
|
52636
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
52637
|
+
* @memberof JsonApiFilterViewPatchRelationships
|
|
52638
|
+
*/
|
|
52639
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
52640
|
+
/**
|
|
52641
|
+
*
|
|
52642
|
+
* @type {JsonApiFilterViewPatchRelationshipsUser}
|
|
52643
|
+
* @memberof JsonApiFilterViewPatchRelationships
|
|
52644
|
+
*/
|
|
52645
|
+
user?: JsonApiFilterViewPatchRelationshipsUser;
|
|
52646
|
+
}
|
|
52647
|
+
|
|
52648
|
+
/**
|
|
52649
|
+
*
|
|
52650
|
+
* @export
|
|
52651
|
+
* @interface JsonApiFilterViewPatchRelationshipsUser
|
|
52652
|
+
*/
|
|
52653
|
+
export declare interface JsonApiFilterViewPatchRelationshipsUser {
|
|
52654
|
+
/**
|
|
52655
|
+
*
|
|
52656
|
+
* @type {JsonApiUserToOneLinkage}
|
|
52657
|
+
* @memberof JsonApiFilterViewPatchRelationshipsUser
|
|
52658
|
+
*/
|
|
52659
|
+
data: JsonApiUserToOneLinkage | null;
|
|
52660
|
+
}
|
|
52661
|
+
|
|
52819
52662
|
export declare const JsonApiFilterViewPatchTypeEnum: {
|
|
52820
52663
|
readonly FILTER_VIEW: "filterView";
|
|
52821
52664
|
};
|
|
@@ -52847,57 +52690,103 @@ export declare interface JsonApiIdentityProviderIn {
|
|
|
52847
52690
|
id: string;
|
|
52848
52691
|
/**
|
|
52849
52692
|
*
|
|
52850
|
-
* @type {
|
|
52693
|
+
* @type {JsonApiIdentityProviderInAttributes}
|
|
52851
52694
|
* @memberof JsonApiIdentityProviderIn
|
|
52852
52695
|
*/
|
|
52853
|
-
attributes
|
|
52696
|
+
attributes: JsonApiIdentityProviderInAttributes;
|
|
52854
52697
|
}
|
|
52855
52698
|
|
|
52856
52699
|
/**
|
|
52857
52700
|
*
|
|
52858
52701
|
* @export
|
|
52859
|
-
* @interface
|
|
52702
|
+
* @interface JsonApiIdentityProviderInAttributes
|
|
52860
52703
|
*/
|
|
52861
|
-
export declare interface
|
|
52704
|
+
export declare interface JsonApiIdentityProviderInAttributes {
|
|
52862
52705
|
/**
|
|
52863
|
-
*
|
|
52864
|
-
* @type {
|
|
52865
|
-
* @memberof
|
|
52706
|
+
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. In multiple provider setup, this field is mandatory.
|
|
52707
|
+
* @type {Array<string>}
|
|
52708
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52866
52709
|
*/
|
|
52867
|
-
|
|
52710
|
+
identifiers: Array<string>;
|
|
52711
|
+
/**
|
|
52712
|
+
* Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
|
|
52713
|
+
* @type {{ [key: string]: string; }}
|
|
52714
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52715
|
+
*/
|
|
52716
|
+
customClaimMapping?: {
|
|
52717
|
+
[key: string]: string;
|
|
52718
|
+
};
|
|
52719
|
+
/**
|
|
52720
|
+
* Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer\'s name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.
|
|
52721
|
+
* @type {string}
|
|
52722
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52723
|
+
*/
|
|
52724
|
+
samlMetadata?: string;
|
|
52725
|
+
/**
|
|
52726
|
+
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
52727
|
+
* @type {string}
|
|
52728
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52729
|
+
*/
|
|
52730
|
+
oauthClientId?: string;
|
|
52731
|
+
/**
|
|
52732
|
+
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
52733
|
+
* @type {string}
|
|
52734
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52735
|
+
*/
|
|
52736
|
+
oauthClientSecret?: string;
|
|
52737
|
+
/**
|
|
52738
|
+
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
52739
|
+
* @type {string}
|
|
52740
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52741
|
+
*/
|
|
52742
|
+
oauthIssuerLocation?: string;
|
|
52743
|
+
/**
|
|
52744
|
+
* Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
|
|
52745
|
+
* @type {string}
|
|
52746
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52747
|
+
*/
|
|
52748
|
+
oauthIssuerId?: string;
|
|
52749
|
+
/**
|
|
52750
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
52751
|
+
* @type {string}
|
|
52752
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52753
|
+
*/
|
|
52754
|
+
oauthSubjectIdClaim?: string;
|
|
52755
|
+
/**
|
|
52756
|
+
* Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
|
|
52757
|
+
* @type {{ [key: string]: string; }}
|
|
52758
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52759
|
+
*/
|
|
52760
|
+
oauthCustomAuthAttributes?: {
|
|
52761
|
+
[key: string]: string;
|
|
52762
|
+
};
|
|
52763
|
+
/**
|
|
52764
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
52765
|
+
* @type {Array<string>}
|
|
52766
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
52767
|
+
*/
|
|
52768
|
+
oauthCustomScopes?: Array<string> | null;
|
|
52868
52769
|
}
|
|
52869
52770
|
|
|
52870
|
-
export declare const JsonApiIdentityProviderInTypeEnum: {
|
|
52871
|
-
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
52872
|
-
};
|
|
52873
|
-
|
|
52874
|
-
export declare type JsonApiIdentityProviderInTypeEnum = typeof JsonApiIdentityProviderInTypeEnum[keyof typeof JsonApiIdentityProviderInTypeEnum];
|
|
52875
|
-
|
|
52876
52771
|
/**
|
|
52877
|
-
*
|
|
52772
|
+
*
|
|
52878
52773
|
* @export
|
|
52879
|
-
* @interface
|
|
52774
|
+
* @interface JsonApiIdentityProviderInDocument
|
|
52880
52775
|
*/
|
|
52881
|
-
export declare interface
|
|
52882
|
-
/**
|
|
52883
|
-
*
|
|
52884
|
-
* @type {string}
|
|
52885
|
-
* @memberof JsonApiIdentityProviderLinkage
|
|
52886
|
-
*/
|
|
52887
|
-
id: string;
|
|
52776
|
+
export declare interface JsonApiIdentityProviderInDocument {
|
|
52888
52777
|
/**
|
|
52889
52778
|
*
|
|
52890
|
-
* @type {
|
|
52891
|
-
* @memberof
|
|
52779
|
+
* @type {JsonApiIdentityProviderIn}
|
|
52780
|
+
* @memberof JsonApiIdentityProviderInDocument
|
|
52892
52781
|
*/
|
|
52893
|
-
|
|
52782
|
+
data: JsonApiIdentityProviderIn;
|
|
52894
52783
|
}
|
|
52895
52784
|
|
|
52896
|
-
export declare const
|
|
52785
|
+
export declare const JsonApiIdentityProviderInTypeEnum: {
|
|
52897
52786
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
52898
52787
|
};
|
|
52899
52788
|
|
|
52900
|
-
export declare type
|
|
52789
|
+
export declare type JsonApiIdentityProviderInTypeEnum = typeof JsonApiIdentityProviderInTypeEnum[keyof typeof JsonApiIdentityProviderInTypeEnum];
|
|
52901
52790
|
|
|
52902
52791
|
/**
|
|
52903
52792
|
* JSON:API representation of identityProvider entity.
|
|
@@ -52922,7 +52811,7 @@ export declare interface JsonApiIdentityProviderOut {
|
|
|
52922
52811
|
* @type {JsonApiIdentityProviderOutAttributes}
|
|
52923
52812
|
* @memberof JsonApiIdentityProviderOut
|
|
52924
52813
|
*/
|
|
52925
|
-
attributes
|
|
52814
|
+
attributes: JsonApiIdentityProviderOutAttributes;
|
|
52926
52815
|
}
|
|
52927
52816
|
|
|
52928
52817
|
/**
|
|
@@ -52932,11 +52821,11 @@ export declare interface JsonApiIdentityProviderOut {
|
|
|
52932
52821
|
*/
|
|
52933
52822
|
export declare interface JsonApiIdentityProviderOutAttributes {
|
|
52934
52823
|
/**
|
|
52935
|
-
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
|
|
52824
|
+
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. In multiple provider setup, this field is mandatory.
|
|
52936
52825
|
* @type {Array<string>}
|
|
52937
52826
|
* @memberof JsonApiIdentityProviderOutAttributes
|
|
52938
52827
|
*/
|
|
52939
|
-
identifiers
|
|
52828
|
+
identifiers: Array<string>;
|
|
52940
52829
|
/**
|
|
52941
52830
|
* Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
|
|
52942
52831
|
* @type {{ [key: string]: string; }}
|
|
@@ -52983,22 +52872,8 @@ export declare interface JsonApiIdentityProviderOutAttributes {
|
|
|
52983
52872
|
* @memberof JsonApiIdentityProviderOutAttributes
|
|
52984
52873
|
*/
|
|
52985
52874
|
oauthCustomScopes?: Array<string> | null;
|
|
52986
|
-
/**
|
|
52987
|
-
* Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
|
|
52988
|
-
* @type {string}
|
|
52989
|
-
* @memberof JsonApiIdentityProviderOutAttributes
|
|
52990
|
-
*/
|
|
52991
|
-
idpType?: JsonApiIdentityProviderOutAttributesIdpTypeEnum;
|
|
52992
52875
|
}
|
|
52993
52876
|
|
|
52994
|
-
export declare const JsonApiIdentityProviderOutAttributesIdpTypeEnum: {
|
|
52995
|
-
readonly MANAGED_IDP: "MANAGED_IDP";
|
|
52996
|
-
readonly FIM_IDP: "FIM_IDP";
|
|
52997
|
-
readonly CUSTOM_IDP: "CUSTOM_IDP";
|
|
52998
|
-
};
|
|
52999
|
-
|
|
53000
|
-
export declare type JsonApiIdentityProviderOutAttributesIdpTypeEnum = typeof JsonApiIdentityProviderOutAttributesIdpTypeEnum[keyof typeof JsonApiIdentityProviderOutAttributesIdpTypeEnum];
|
|
53001
|
-
|
|
53002
52877
|
/**
|
|
53003
52878
|
*
|
|
53004
52879
|
* @export
|
|
@@ -53074,7 +52949,7 @@ export declare interface JsonApiIdentityProviderOutWithLinks {
|
|
|
53074
52949
|
* @type {JsonApiIdentityProviderOutAttributes}
|
|
53075
52950
|
* @memberof JsonApiIdentityProviderOutWithLinks
|
|
53076
52951
|
*/
|
|
53077
|
-
attributes
|
|
52952
|
+
attributes: JsonApiIdentityProviderOutAttributes;
|
|
53078
52953
|
/**
|
|
53079
52954
|
*
|
|
53080
52955
|
* @type {ObjectLinks}
|
|
@@ -53112,7 +52987,7 @@ export declare interface JsonApiIdentityProviderPatch {
|
|
|
53112
52987
|
* @type {JsonApiIdentityProviderPatchAttributes}
|
|
53113
52988
|
* @memberof JsonApiIdentityProviderPatch
|
|
53114
52989
|
*/
|
|
53115
|
-
attributes
|
|
52990
|
+
attributes: JsonApiIdentityProviderPatchAttributes;
|
|
53116
52991
|
}
|
|
53117
52992
|
|
|
53118
52993
|
/**
|
|
@@ -53122,7 +52997,7 @@ export declare interface JsonApiIdentityProviderPatch {
|
|
|
53122
52997
|
*/
|
|
53123
52998
|
export declare interface JsonApiIdentityProviderPatchAttributes {
|
|
53124
52999
|
/**
|
|
53125
|
-
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
|
|
53000
|
+
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. In multiple provider setup, this field is mandatory.
|
|
53126
53001
|
* @type {Array<string>}
|
|
53127
53002
|
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
53128
53003
|
*/
|
|
@@ -53185,22 +53060,8 @@ export declare interface JsonApiIdentityProviderPatchAttributes {
|
|
|
53185
53060
|
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
53186
53061
|
*/
|
|
53187
53062
|
oauthCustomScopes?: Array<string> | null;
|
|
53188
|
-
/**
|
|
53189
|
-
* Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
|
|
53190
|
-
* @type {string}
|
|
53191
|
-
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
53192
|
-
*/
|
|
53193
|
-
idpType?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
|
|
53194
53063
|
}
|
|
53195
53064
|
|
|
53196
|
-
export declare const JsonApiIdentityProviderPatchAttributesIdpTypeEnum: {
|
|
53197
|
-
readonly MANAGED_IDP: "MANAGED_IDP";
|
|
53198
|
-
readonly FIM_IDP: "FIM_IDP";
|
|
53199
|
-
readonly CUSTOM_IDP: "CUSTOM_IDP";
|
|
53200
|
-
};
|
|
53201
|
-
|
|
53202
|
-
export declare type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = typeof JsonApiIdentityProviderPatchAttributesIdpTypeEnum[keyof typeof JsonApiIdentityProviderPatchAttributesIdpTypeEnum];
|
|
53203
|
-
|
|
53204
53065
|
/**
|
|
53205
53066
|
*
|
|
53206
53067
|
* @export
|
|
@@ -53221,13 +53082,6 @@ export declare const JsonApiIdentityProviderPatchTypeEnum: {
|
|
|
53221
53082
|
|
|
53222
53083
|
export declare type JsonApiIdentityProviderPatchTypeEnum = typeof JsonApiIdentityProviderPatchTypeEnum[keyof typeof JsonApiIdentityProviderPatchTypeEnum];
|
|
53223
53084
|
|
|
53224
|
-
/**
|
|
53225
|
-
* @type JsonApiIdentityProviderToOneLinkage
|
|
53226
|
-
* References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
53227
|
-
* @export
|
|
53228
|
-
*/
|
|
53229
|
-
export declare type JsonApiIdentityProviderToOneLinkage = JsonApiIdentityProviderLinkage;
|
|
53230
|
-
|
|
53231
53085
|
/**
|
|
53232
53086
|
* JSON:API representation of jwk entity.
|
|
53233
53087
|
* @export
|
|
@@ -53248,10 +53102,24 @@ export declare interface JsonApiJwkIn {
|
|
|
53248
53102
|
id: string;
|
|
53249
53103
|
/**
|
|
53250
53104
|
*
|
|
53251
|
-
* @type {
|
|
53105
|
+
* @type {JsonApiJwkInAttributes}
|
|
53252
53106
|
* @memberof JsonApiJwkIn
|
|
53253
53107
|
*/
|
|
53254
|
-
attributes?:
|
|
53108
|
+
attributes?: JsonApiJwkInAttributes;
|
|
53109
|
+
}
|
|
53110
|
+
|
|
53111
|
+
/**
|
|
53112
|
+
*
|
|
53113
|
+
* @export
|
|
53114
|
+
* @interface JsonApiJwkInAttributes
|
|
53115
|
+
*/
|
|
53116
|
+
export declare interface JsonApiJwkInAttributes {
|
|
53117
|
+
/**
|
|
53118
|
+
* Specification of the cryptographic key
|
|
53119
|
+
* @type {RsaSpecification}
|
|
53120
|
+
* @memberof JsonApiJwkInAttributes
|
|
53121
|
+
*/
|
|
53122
|
+
content?: RsaSpecification;
|
|
53255
53123
|
}
|
|
53256
53124
|
|
|
53257
53125
|
/**
|
|
@@ -53294,24 +53162,10 @@ export declare interface JsonApiJwkOut {
|
|
|
53294
53162
|
id: string;
|
|
53295
53163
|
/**
|
|
53296
53164
|
*
|
|
53297
|
-
* @type {
|
|
53165
|
+
* @type {JsonApiJwkInAttributes}
|
|
53298
53166
|
* @memberof JsonApiJwkOut
|
|
53299
53167
|
*/
|
|
53300
|
-
attributes?:
|
|
53301
|
-
}
|
|
53302
|
-
|
|
53303
|
-
/**
|
|
53304
|
-
*
|
|
53305
|
-
* @export
|
|
53306
|
-
* @interface JsonApiJwkOutAttributes
|
|
53307
|
-
*/
|
|
53308
|
-
export declare interface JsonApiJwkOutAttributes {
|
|
53309
|
-
/**
|
|
53310
|
-
* Specification of the cryptographic key
|
|
53311
|
-
* @type {RsaSpecification}
|
|
53312
|
-
* @memberof JsonApiJwkOutAttributes
|
|
53313
|
-
*/
|
|
53314
|
-
content?: RsaSpecification;
|
|
53168
|
+
attributes?: JsonApiJwkInAttributes;
|
|
53315
53169
|
}
|
|
53316
53170
|
|
|
53317
53171
|
/**
|
|
@@ -53386,10 +53240,10 @@ export declare interface JsonApiJwkOutWithLinks {
|
|
|
53386
53240
|
id: string;
|
|
53387
53241
|
/**
|
|
53388
53242
|
*
|
|
53389
|
-
* @type {
|
|
53243
|
+
* @type {JsonApiJwkInAttributes}
|
|
53390
53244
|
* @memberof JsonApiJwkOutWithLinks
|
|
53391
53245
|
*/
|
|
53392
|
-
attributes?:
|
|
53246
|
+
attributes?: JsonApiJwkInAttributes;
|
|
53393
53247
|
/**
|
|
53394
53248
|
*
|
|
53395
53249
|
* @type {ObjectLinks}
|
|
@@ -53424,10 +53278,10 @@ export declare interface JsonApiJwkPatch {
|
|
|
53424
53278
|
id: string;
|
|
53425
53279
|
/**
|
|
53426
53280
|
*
|
|
53427
|
-
* @type {
|
|
53281
|
+
* @type {JsonApiJwkInAttributes}
|
|
53428
53282
|
* @memberof JsonApiJwkPatch
|
|
53429
53283
|
*/
|
|
53430
|
-
attributes?:
|
|
53284
|
+
attributes?: JsonApiJwkInAttributes;
|
|
53431
53285
|
}
|
|
53432
53286
|
|
|
53433
53287
|
/**
|
|
@@ -54747,10 +54601,10 @@ export declare interface JsonApiNotificationChannelIn {
|
|
|
54747
54601
|
id: string;
|
|
54748
54602
|
/**
|
|
54749
54603
|
*
|
|
54750
|
-
* @type {
|
|
54604
|
+
* @type {JsonApiNotificationChannelPostOptionalIdAttributes}
|
|
54751
54605
|
* @memberof JsonApiNotificationChannelIn
|
|
54752
54606
|
*/
|
|
54753
|
-
attributes?:
|
|
54607
|
+
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
54754
54608
|
}
|
|
54755
54609
|
|
|
54756
54610
|
/**
|
|
@@ -55029,136 +54883,136 @@ export declare interface JsonApiNotificationChannelPatch {
|
|
|
55029
54883
|
id: string;
|
|
55030
54884
|
/**
|
|
55031
54885
|
*
|
|
55032
|
-
* @type {
|
|
54886
|
+
* @type {JsonApiNotificationChannelPostOptionalIdAttributes}
|
|
55033
54887
|
* @memberof JsonApiNotificationChannelPatch
|
|
55034
54888
|
*/
|
|
55035
|
-
attributes?:
|
|
54889
|
+
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
55036
54890
|
}
|
|
55037
54891
|
|
|
55038
54892
|
/**
|
|
55039
54893
|
*
|
|
55040
54894
|
* @export
|
|
55041
|
-
* @interface
|
|
54895
|
+
* @interface JsonApiNotificationChannelPatchDocument
|
|
55042
54896
|
*/
|
|
55043
|
-
export declare interface
|
|
54897
|
+
export declare interface JsonApiNotificationChannelPatchDocument {
|
|
55044
54898
|
/**
|
|
55045
54899
|
*
|
|
54900
|
+
* @type {JsonApiNotificationChannelPatch}
|
|
54901
|
+
* @memberof JsonApiNotificationChannelPatchDocument
|
|
54902
|
+
*/
|
|
54903
|
+
data: JsonApiNotificationChannelPatch;
|
|
54904
|
+
}
|
|
54905
|
+
|
|
54906
|
+
export declare const JsonApiNotificationChannelPatchTypeEnum: {
|
|
54907
|
+
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
54908
|
+
};
|
|
54909
|
+
|
|
54910
|
+
export declare type JsonApiNotificationChannelPatchTypeEnum = typeof JsonApiNotificationChannelPatchTypeEnum[keyof typeof JsonApiNotificationChannelPatchTypeEnum];
|
|
54911
|
+
|
|
54912
|
+
/**
|
|
54913
|
+
* JSON:API representation of notificationChannel entity.
|
|
54914
|
+
* @export
|
|
54915
|
+
* @interface JsonApiNotificationChannelPostOptionalId
|
|
54916
|
+
*/
|
|
54917
|
+
export declare interface JsonApiNotificationChannelPostOptionalId {
|
|
54918
|
+
/**
|
|
54919
|
+
* Object type
|
|
55046
54920
|
* @type {string}
|
|
55047
|
-
* @memberof
|
|
54921
|
+
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
54922
|
+
*/
|
|
54923
|
+
type: JsonApiNotificationChannelPostOptionalIdTypeEnum;
|
|
54924
|
+
/**
|
|
54925
|
+
* API identifier of an object
|
|
54926
|
+
* @type {string}
|
|
54927
|
+
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
54928
|
+
*/
|
|
54929
|
+
id?: string;
|
|
54930
|
+
/**
|
|
54931
|
+
*
|
|
54932
|
+
* @type {JsonApiNotificationChannelPostOptionalIdAttributes}
|
|
54933
|
+
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
54934
|
+
*/
|
|
54935
|
+
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
54936
|
+
}
|
|
54937
|
+
|
|
54938
|
+
/**
|
|
54939
|
+
*
|
|
54940
|
+
* @export
|
|
54941
|
+
* @interface JsonApiNotificationChannelPostOptionalIdAttributes
|
|
54942
|
+
*/
|
|
54943
|
+
export declare interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
54944
|
+
/**
|
|
54945
|
+
*
|
|
54946
|
+
* @type {string}
|
|
54947
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
55048
54948
|
*/
|
|
55049
54949
|
name?: string | null;
|
|
55050
54950
|
/**
|
|
55051
54951
|
*
|
|
55052
54952
|
* @type {string}
|
|
55053
|
-
* @memberof
|
|
54953
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
55054
54954
|
*/
|
|
55055
54955
|
description?: string | null;
|
|
55056
54956
|
/**
|
|
55057
54957
|
* The destination where the notifications are to be sent.
|
|
55058
54958
|
* @type {DefaultSmtp | InPlatform | Smtp | Webhook}
|
|
55059
|
-
* @memberof
|
|
54959
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
55060
54960
|
*/
|
|
55061
54961
|
destination?: DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
55062
54962
|
/**
|
|
55063
54963
|
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
55064
54964
|
* @type {string}
|
|
55065
|
-
* @memberof
|
|
54965
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
55066
54966
|
*/
|
|
55067
54967
|
customDashboardUrl?: string;
|
|
55068
54968
|
/**
|
|
55069
54969
|
* Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
|
|
55070
54970
|
* @type {string}
|
|
55071
|
-
* @memberof
|
|
54971
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
55072
54972
|
*/
|
|
55073
|
-
dashboardLinkVisibility?:
|
|
54973
|
+
dashboardLinkVisibility?: JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum;
|
|
55074
54974
|
/**
|
|
55075
54975
|
* Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
|
|
55076
54976
|
* @type {string}
|
|
55077
|
-
* @memberof
|
|
54977
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
55078
54978
|
*/
|
|
55079
54979
|
notificationSource?: string;
|
|
55080
54980
|
/**
|
|
55081
54981
|
* Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
|
|
55082
54982
|
* @type {string}
|
|
55083
|
-
* @memberof
|
|
54983
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
55084
54984
|
*/
|
|
55085
|
-
allowedRecipients?:
|
|
54985
|
+
allowedRecipients?: JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum;
|
|
55086
54986
|
/**
|
|
55087
54987
|
* In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
|
|
55088
54988
|
* @type {string}
|
|
55089
|
-
* @memberof
|
|
54989
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
55090
54990
|
*/
|
|
55091
|
-
inPlatformNotification?:
|
|
54991
|
+
inPlatformNotification?: JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum;
|
|
55092
54992
|
}
|
|
55093
54993
|
|
|
55094
|
-
export declare const
|
|
54994
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum: {
|
|
55095
54995
|
readonly CREATOR: "CREATOR";
|
|
55096
54996
|
readonly INTERNAL: "INTERNAL";
|
|
55097
54997
|
readonly EXTERNAL: "EXTERNAL";
|
|
55098
54998
|
};
|
|
55099
54999
|
|
|
55100
|
-
export declare type
|
|
55000
|
+
export declare type JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum = typeof JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum];
|
|
55101
55001
|
|
|
55102
|
-
export declare const
|
|
55002
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum: {
|
|
55103
55003
|
readonly HIDDEN: "HIDDEN";
|
|
55104
55004
|
readonly INTERNAL_ONLY: "INTERNAL_ONLY";
|
|
55105
55005
|
readonly ALL: "ALL";
|
|
55106
55006
|
};
|
|
55107
55007
|
|
|
55108
|
-
export declare type
|
|
55008
|
+
export declare type JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum = typeof JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum];
|
|
55109
55009
|
|
|
55110
|
-
export declare const
|
|
55010
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum: {
|
|
55111
55011
|
readonly DISABLED: "DISABLED";
|
|
55112
55012
|
readonly ENABLED: "ENABLED";
|
|
55113
55013
|
};
|
|
55114
55014
|
|
|
55115
|
-
export declare type
|
|
55116
|
-
|
|
55117
|
-
/**
|
|
55118
|
-
*
|
|
55119
|
-
* @export
|
|
55120
|
-
* @interface JsonApiNotificationChannelPatchDocument
|
|
55121
|
-
*/
|
|
55122
|
-
export declare interface JsonApiNotificationChannelPatchDocument {
|
|
55123
|
-
/**
|
|
55124
|
-
*
|
|
55125
|
-
* @type {JsonApiNotificationChannelPatch}
|
|
55126
|
-
* @memberof JsonApiNotificationChannelPatchDocument
|
|
55127
|
-
*/
|
|
55128
|
-
data: JsonApiNotificationChannelPatch;
|
|
55129
|
-
}
|
|
55130
|
-
|
|
55131
|
-
export declare const JsonApiNotificationChannelPatchTypeEnum: {
|
|
55132
|
-
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
55133
|
-
};
|
|
55134
|
-
|
|
55135
|
-
export declare type JsonApiNotificationChannelPatchTypeEnum = typeof JsonApiNotificationChannelPatchTypeEnum[keyof typeof JsonApiNotificationChannelPatchTypeEnum];
|
|
55136
|
-
|
|
55137
|
-
/**
|
|
55138
|
-
* JSON:API representation of notificationChannel entity.
|
|
55139
|
-
* @export
|
|
55140
|
-
* @interface JsonApiNotificationChannelPostOptionalId
|
|
55141
|
-
*/
|
|
55142
|
-
export declare interface JsonApiNotificationChannelPostOptionalId {
|
|
55143
|
-
/**
|
|
55144
|
-
* Object type
|
|
55145
|
-
* @type {string}
|
|
55146
|
-
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
55147
|
-
*/
|
|
55148
|
-
type: JsonApiNotificationChannelPostOptionalIdTypeEnum;
|
|
55149
|
-
/**
|
|
55150
|
-
* API identifier of an object
|
|
55151
|
-
* @type {string}
|
|
55152
|
-
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
55153
|
-
*/
|
|
55154
|
-
id?: string;
|
|
55155
|
-
/**
|
|
55156
|
-
*
|
|
55157
|
-
* @type {JsonApiNotificationChannelPatchAttributes}
|
|
55158
|
-
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
55159
|
-
*/
|
|
55160
|
-
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
55161
|
-
}
|
|
55015
|
+
export declare type JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum = typeof JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum];
|
|
55162
55016
|
|
|
55163
55017
|
/**
|
|
55164
55018
|
*
|
|
@@ -55207,16 +55061,93 @@ export declare interface JsonApiOrganizationIn {
|
|
|
55207
55061
|
id: string;
|
|
55208
55062
|
/**
|
|
55209
55063
|
*
|
|
55210
|
-
* @type {
|
|
55064
|
+
* @type {JsonApiOrganizationInAttributes}
|
|
55211
55065
|
* @memberof JsonApiOrganizationIn
|
|
55212
55066
|
*/
|
|
55213
|
-
attributes?:
|
|
55067
|
+
attributes?: JsonApiOrganizationInAttributes;
|
|
55068
|
+
}
|
|
55069
|
+
|
|
55070
|
+
/**
|
|
55071
|
+
*
|
|
55072
|
+
* @export
|
|
55073
|
+
* @interface JsonApiOrganizationInAttributes
|
|
55074
|
+
*/
|
|
55075
|
+
export declare interface JsonApiOrganizationInAttributes {
|
|
55214
55076
|
/**
|
|
55215
55077
|
*
|
|
55216
|
-
* @type {
|
|
55217
|
-
* @memberof
|
|
55078
|
+
* @type {string}
|
|
55079
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55080
|
+
*/
|
|
55081
|
+
name?: string | null;
|
|
55082
|
+
/**
|
|
55083
|
+
*
|
|
55084
|
+
* @type {string}
|
|
55085
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55086
|
+
*/
|
|
55087
|
+
hostname?: string;
|
|
55088
|
+
/**
|
|
55089
|
+
*
|
|
55090
|
+
* @type {Array<string>}
|
|
55091
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55092
|
+
*/
|
|
55093
|
+
allowedOrigins?: Array<string>;
|
|
55094
|
+
/**
|
|
55095
|
+
*
|
|
55096
|
+
* @type {string}
|
|
55097
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55098
|
+
*/
|
|
55099
|
+
oauthIssuerLocation?: string;
|
|
55100
|
+
/**
|
|
55101
|
+
*
|
|
55102
|
+
* @type {string}
|
|
55103
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55104
|
+
*/
|
|
55105
|
+
oauthClientId?: string;
|
|
55106
|
+
/**
|
|
55107
|
+
*
|
|
55108
|
+
* @type {string}
|
|
55109
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55110
|
+
*/
|
|
55111
|
+
oauthClientSecret?: string;
|
|
55112
|
+
/**
|
|
55113
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
55114
|
+
* @type {string}
|
|
55115
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55116
|
+
* @deprecated
|
|
55117
|
+
*/
|
|
55118
|
+
earlyAccess?: string | null;
|
|
55119
|
+
/**
|
|
55120
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
55121
|
+
* @type {Array<string>}
|
|
55122
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55218
55123
|
*/
|
|
55219
|
-
|
|
55124
|
+
earlyAccessValues?: Array<string> | null;
|
|
55125
|
+
/**
|
|
55126
|
+
* Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
|
|
55127
|
+
* @type {string}
|
|
55128
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55129
|
+
*/
|
|
55130
|
+
oauthIssuerId?: string;
|
|
55131
|
+
/**
|
|
55132
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
55133
|
+
* @type {string}
|
|
55134
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55135
|
+
*/
|
|
55136
|
+
oauthSubjectIdClaim?: string;
|
|
55137
|
+
/**
|
|
55138
|
+
* Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
|
|
55139
|
+
* @type {{ [key: string]: string; }}
|
|
55140
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55141
|
+
*/
|
|
55142
|
+
oauthCustomAuthAttributes?: {
|
|
55143
|
+
[key: string]: string;
|
|
55144
|
+
};
|
|
55145
|
+
/**
|
|
55146
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
55147
|
+
* @type {Array<string>}
|
|
55148
|
+
* @memberof JsonApiOrganizationInAttributes
|
|
55149
|
+
*/
|
|
55150
|
+
oauthCustomScopes?: Array<string> | null;
|
|
55220
55151
|
}
|
|
55221
55152
|
|
|
55222
55153
|
/**
|
|
@@ -55417,7 +55348,7 @@ export declare interface JsonApiOrganizationOutDocument {
|
|
|
55417
55348
|
* @type JsonApiOrganizationOutIncludes
|
|
55418
55349
|
* @export
|
|
55419
55350
|
*/
|
|
55420
|
-
export declare type JsonApiOrganizationOutIncludes =
|
|
55351
|
+
export declare type JsonApiOrganizationOutIncludes = JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
55421
55352
|
|
|
55422
55353
|
/**
|
|
55423
55354
|
*
|
|
@@ -55448,50 +55379,16 @@ export declare type JsonApiOrganizationOutMetaPermissionsEnum = typeof JsonApiOr
|
|
|
55448
55379
|
export declare interface JsonApiOrganizationOutRelationships {
|
|
55449
55380
|
/**
|
|
55450
55381
|
*
|
|
55451
|
-
* @type {
|
|
55382
|
+
* @type {JsonApiFilterViewPatchRelationshipsUser}
|
|
55452
55383
|
* @memberof JsonApiOrganizationOutRelationships
|
|
55453
55384
|
*/
|
|
55454
|
-
bootstrapUser?:
|
|
55385
|
+
bootstrapUser?: JsonApiFilterViewPatchRelationshipsUser;
|
|
55455
55386
|
/**
|
|
55456
55387
|
*
|
|
55457
|
-
* @type {
|
|
55388
|
+
* @type {JsonApiUserDataFilterPatchRelationshipsUserGroup}
|
|
55458
55389
|
* @memberof JsonApiOrganizationOutRelationships
|
|
55459
55390
|
*/
|
|
55460
|
-
bootstrapUserGroup?:
|
|
55461
|
-
/**
|
|
55462
|
-
*
|
|
55463
|
-
* @type {JsonApiOrganizationPatchRelationshipsIdentityProvider}
|
|
55464
|
-
* @memberof JsonApiOrganizationOutRelationships
|
|
55465
|
-
*/
|
|
55466
|
-
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
55467
|
-
}
|
|
55468
|
-
|
|
55469
|
-
/**
|
|
55470
|
-
*
|
|
55471
|
-
* @export
|
|
55472
|
-
* @interface JsonApiOrganizationOutRelationshipsBootstrapUser
|
|
55473
|
-
*/
|
|
55474
|
-
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
55475
|
-
/**
|
|
55476
|
-
*
|
|
55477
|
-
* @type {JsonApiUserToOneLinkage}
|
|
55478
|
-
* @memberof JsonApiOrganizationOutRelationshipsBootstrapUser
|
|
55479
|
-
*/
|
|
55480
|
-
data: JsonApiUserToOneLinkage | null;
|
|
55481
|
-
}
|
|
55482
|
-
|
|
55483
|
-
/**
|
|
55484
|
-
*
|
|
55485
|
-
* @export
|
|
55486
|
-
* @interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup
|
|
55487
|
-
*/
|
|
55488
|
-
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
55489
|
-
/**
|
|
55490
|
-
*
|
|
55491
|
-
* @type {JsonApiUserGroupToOneLinkage}
|
|
55492
|
-
* @memberof JsonApiOrganizationOutRelationshipsBootstrapUserGroup
|
|
55493
|
-
*/
|
|
55494
|
-
data: JsonApiUserGroupToOneLinkage | null;
|
|
55391
|
+
bootstrapUserGroup?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
55495
55392
|
}
|
|
55496
55393
|
|
|
55497
55394
|
export declare const JsonApiOrganizationOutTypeEnum: {
|
|
@@ -55520,99 +55417,10 @@ export declare interface JsonApiOrganizationPatch {
|
|
|
55520
55417
|
id: string;
|
|
55521
55418
|
/**
|
|
55522
55419
|
*
|
|
55523
|
-
* @type {
|
|
55524
|
-
* @memberof JsonApiOrganizationPatch
|
|
55525
|
-
*/
|
|
55526
|
-
attributes?: JsonApiOrganizationPatchAttributes;
|
|
55527
|
-
/**
|
|
55528
|
-
*
|
|
55529
|
-
* @type {JsonApiOrganizationPatchRelationships}
|
|
55420
|
+
* @type {JsonApiOrganizationInAttributes}
|
|
55530
55421
|
* @memberof JsonApiOrganizationPatch
|
|
55531
55422
|
*/
|
|
55532
|
-
|
|
55533
|
-
}
|
|
55534
|
-
|
|
55535
|
-
/**
|
|
55536
|
-
*
|
|
55537
|
-
* @export
|
|
55538
|
-
* @interface JsonApiOrganizationPatchAttributes
|
|
55539
|
-
*/
|
|
55540
|
-
export declare interface JsonApiOrganizationPatchAttributes {
|
|
55541
|
-
/**
|
|
55542
|
-
*
|
|
55543
|
-
* @type {string}
|
|
55544
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55545
|
-
*/
|
|
55546
|
-
name?: string | null;
|
|
55547
|
-
/**
|
|
55548
|
-
*
|
|
55549
|
-
* @type {string}
|
|
55550
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55551
|
-
*/
|
|
55552
|
-
hostname?: string;
|
|
55553
|
-
/**
|
|
55554
|
-
*
|
|
55555
|
-
* @type {Array<string>}
|
|
55556
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55557
|
-
*/
|
|
55558
|
-
allowedOrigins?: Array<string>;
|
|
55559
|
-
/**
|
|
55560
|
-
*
|
|
55561
|
-
* @type {string}
|
|
55562
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55563
|
-
*/
|
|
55564
|
-
oauthIssuerLocation?: string;
|
|
55565
|
-
/**
|
|
55566
|
-
*
|
|
55567
|
-
* @type {string}
|
|
55568
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55569
|
-
*/
|
|
55570
|
-
oauthClientId?: string;
|
|
55571
|
-
/**
|
|
55572
|
-
*
|
|
55573
|
-
* @type {string}
|
|
55574
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55575
|
-
*/
|
|
55576
|
-
oauthClientSecret?: string;
|
|
55577
|
-
/**
|
|
55578
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
55579
|
-
* @type {string}
|
|
55580
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55581
|
-
* @deprecated
|
|
55582
|
-
*/
|
|
55583
|
-
earlyAccess?: string | null;
|
|
55584
|
-
/**
|
|
55585
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
55586
|
-
* @type {Array<string>}
|
|
55587
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55588
|
-
*/
|
|
55589
|
-
earlyAccessValues?: Array<string> | null;
|
|
55590
|
-
/**
|
|
55591
|
-
* Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
|
|
55592
|
-
* @type {string}
|
|
55593
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55594
|
-
*/
|
|
55595
|
-
oauthIssuerId?: string;
|
|
55596
|
-
/**
|
|
55597
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
55598
|
-
* @type {string}
|
|
55599
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55600
|
-
*/
|
|
55601
|
-
oauthSubjectIdClaim?: string;
|
|
55602
|
-
/**
|
|
55603
|
-
* Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
|
|
55604
|
-
* @type {{ [key: string]: string; }}
|
|
55605
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55606
|
-
*/
|
|
55607
|
-
oauthCustomAuthAttributes?: {
|
|
55608
|
-
[key: string]: string;
|
|
55609
|
-
};
|
|
55610
|
-
/**
|
|
55611
|
-
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
55612
|
-
* @type {Array<string>}
|
|
55613
|
-
* @memberof JsonApiOrganizationPatchAttributes
|
|
55614
|
-
*/
|
|
55615
|
-
oauthCustomScopes?: Array<string> | null;
|
|
55423
|
+
attributes?: JsonApiOrganizationInAttributes;
|
|
55616
55424
|
}
|
|
55617
55425
|
|
|
55618
55426
|
/**
|
|
@@ -55629,34 +55437,6 @@ export declare interface JsonApiOrganizationPatchDocument {
|
|
|
55629
55437
|
data: JsonApiOrganizationPatch;
|
|
55630
55438
|
}
|
|
55631
55439
|
|
|
55632
|
-
/**
|
|
55633
|
-
*
|
|
55634
|
-
* @export
|
|
55635
|
-
* @interface JsonApiOrganizationPatchRelationships
|
|
55636
|
-
*/
|
|
55637
|
-
export declare interface JsonApiOrganizationPatchRelationships {
|
|
55638
|
-
/**
|
|
55639
|
-
*
|
|
55640
|
-
* @type {JsonApiOrganizationPatchRelationshipsIdentityProvider}
|
|
55641
|
-
* @memberof JsonApiOrganizationPatchRelationships
|
|
55642
|
-
*/
|
|
55643
|
-
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
55644
|
-
}
|
|
55645
|
-
|
|
55646
|
-
/**
|
|
55647
|
-
*
|
|
55648
|
-
* @export
|
|
55649
|
-
* @interface JsonApiOrganizationPatchRelationshipsIdentityProvider
|
|
55650
|
-
*/
|
|
55651
|
-
export declare interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
55652
|
-
/**
|
|
55653
|
-
*
|
|
55654
|
-
* @type {JsonApiIdentityProviderToOneLinkage}
|
|
55655
|
-
* @memberof JsonApiOrganizationPatchRelationshipsIdentityProvider
|
|
55656
|
-
*/
|
|
55657
|
-
data: JsonApiIdentityProviderToOneLinkage | null;
|
|
55658
|
-
}
|
|
55659
|
-
|
|
55660
55440
|
export declare const JsonApiOrganizationPatchTypeEnum: {
|
|
55661
55441
|
readonly ORGANIZATION: "organization";
|
|
55662
55442
|
};
|
|
@@ -55891,10 +55671,10 @@ export declare interface JsonApiThemeIn {
|
|
|
55891
55671
|
id: string;
|
|
55892
55672
|
/**
|
|
55893
55673
|
*
|
|
55894
|
-
* @type {
|
|
55674
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
55895
55675
|
* @memberof JsonApiThemeIn
|
|
55896
55676
|
*/
|
|
55897
|
-
attributes:
|
|
55677
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
55898
55678
|
}
|
|
55899
55679
|
|
|
55900
55680
|
/**
|
|
@@ -55937,10 +55717,10 @@ export declare interface JsonApiThemeOut {
|
|
|
55937
55717
|
id: string;
|
|
55938
55718
|
/**
|
|
55939
55719
|
*
|
|
55940
|
-
* @type {
|
|
55720
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
55941
55721
|
* @memberof JsonApiThemeOut
|
|
55942
55722
|
*/
|
|
55943
|
-
attributes:
|
|
55723
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
55944
55724
|
}
|
|
55945
55725
|
|
|
55946
55726
|
/**
|
|
@@ -56015,10 +55795,10 @@ export declare interface JsonApiThemeOutWithLinks {
|
|
|
56015
55795
|
id: string;
|
|
56016
55796
|
/**
|
|
56017
55797
|
*
|
|
56018
|
-
* @type {
|
|
55798
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
56019
55799
|
* @memberof JsonApiThemeOutWithLinks
|
|
56020
55800
|
*/
|
|
56021
|
-
attributes:
|
|
55801
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
56022
55802
|
/**
|
|
56023
55803
|
*
|
|
56024
55804
|
* @type {ObjectLinks}
|
|
@@ -56279,16 +56059,16 @@ export declare interface JsonApiUserDataFilterOutList {
|
|
|
56279
56059
|
export declare interface JsonApiUserDataFilterOutRelationships {
|
|
56280
56060
|
/**
|
|
56281
56061
|
*
|
|
56282
|
-
* @type {
|
|
56062
|
+
* @type {JsonApiFilterViewPatchRelationshipsUser}
|
|
56283
56063
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
56284
56064
|
*/
|
|
56285
|
-
user?:
|
|
56065
|
+
user?: JsonApiFilterViewPatchRelationshipsUser;
|
|
56286
56066
|
/**
|
|
56287
56067
|
*
|
|
56288
|
-
* @type {
|
|
56068
|
+
* @type {JsonApiUserDataFilterPatchRelationshipsUserGroup}
|
|
56289
56069
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
56290
56070
|
*/
|
|
56291
|
-
userGroup?:
|
|
56071
|
+
userGroup?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
56292
56072
|
/**
|
|
56293
56073
|
*
|
|
56294
56074
|
* @type {JsonApiVisualizationObjectOutRelationshipsFacts}
|
|
@@ -56469,16 +56249,30 @@ export declare interface JsonApiUserDataFilterPatchDocument {
|
|
|
56469
56249
|
export declare interface JsonApiUserDataFilterPatchRelationships {
|
|
56470
56250
|
/**
|
|
56471
56251
|
*
|
|
56472
|
-
* @type {
|
|
56252
|
+
* @type {JsonApiFilterViewPatchRelationshipsUser}
|
|
56473
56253
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
56474
56254
|
*/
|
|
56475
|
-
user?:
|
|
56255
|
+
user?: JsonApiFilterViewPatchRelationshipsUser;
|
|
56476
56256
|
/**
|
|
56477
56257
|
*
|
|
56478
|
-
* @type {
|
|
56258
|
+
* @type {JsonApiUserDataFilterPatchRelationshipsUserGroup}
|
|
56479
56259
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
56480
56260
|
*/
|
|
56481
|
-
userGroup?:
|
|
56261
|
+
userGroup?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
56262
|
+
}
|
|
56263
|
+
|
|
56264
|
+
/**
|
|
56265
|
+
*
|
|
56266
|
+
* @export
|
|
56267
|
+
* @interface JsonApiUserDataFilterPatchRelationshipsUserGroup
|
|
56268
|
+
*/
|
|
56269
|
+
export declare interface JsonApiUserDataFilterPatchRelationshipsUserGroup {
|
|
56270
|
+
/**
|
|
56271
|
+
*
|
|
56272
|
+
* @type {JsonApiUserGroupToOneLinkage}
|
|
56273
|
+
* @memberof JsonApiUserDataFilterPatchRelationshipsUserGroup
|
|
56274
|
+
*/
|
|
56275
|
+
data: JsonApiUserGroupToOneLinkage | null;
|
|
56482
56276
|
}
|
|
56483
56277
|
|
|
56484
56278
|
export declare const JsonApiUserDataFilterPatchTypeEnum: {
|
|
@@ -58472,16 +58266,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
58472
58266
|
id: string;
|
|
58473
58267
|
/**
|
|
58474
58268
|
*
|
|
58475
|
-
* @type {
|
|
58269
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
58476
58270
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
58477
58271
|
*/
|
|
58478
|
-
attributes?:
|
|
58272
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
58479
58273
|
/**
|
|
58480
58274
|
*
|
|
58481
|
-
* @type {
|
|
58275
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
58482
58276
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
58483
58277
|
*/
|
|
58484
|
-
relationships?:
|
|
58278
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
58485
58279
|
}
|
|
58486
58280
|
|
|
58487
58281
|
/**
|
|
@@ -58556,42 +58350,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
58556
58350
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
58557
58351
|
/**
|
|
58558
58352
|
*
|
|
58559
|
-
* @type {
|
|
58353
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
58560
58354
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
58561
58355
|
*/
|
|
58562
|
-
attributes?:
|
|
58356
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
58563
58357
|
/**
|
|
58564
58358
|
*
|
|
58565
|
-
* @type {
|
|
58359
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
58566
58360
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
58567
58361
|
*/
|
|
58568
|
-
relationships?:
|
|
58569
|
-
}
|
|
58570
|
-
|
|
58571
|
-
/**
|
|
58572
|
-
*
|
|
58573
|
-
* @export
|
|
58574
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
58575
|
-
*/
|
|
58576
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutAttributes {
|
|
58577
|
-
/**
|
|
58578
|
-
*
|
|
58579
|
-
* @type {string}
|
|
58580
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
58581
|
-
*/
|
|
58582
|
-
title?: string;
|
|
58583
|
-
/**
|
|
58584
|
-
*
|
|
58585
|
-
* @type {string}
|
|
58586
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
58587
|
-
*/
|
|
58588
|
-
description?: string;
|
|
58589
|
-
/**
|
|
58590
|
-
*
|
|
58591
|
-
* @type {Array<string>}
|
|
58592
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
58593
|
-
*/
|
|
58594
|
-
filterValues?: Array<string>;
|
|
58362
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
58595
58363
|
}
|
|
58596
58364
|
|
|
58597
58365
|
/**
|
|
@@ -58652,34 +58420,6 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
|
58652
58420
|
included?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
58653
58421
|
}
|
|
58654
58422
|
|
|
58655
|
-
/**
|
|
58656
|
-
*
|
|
58657
|
-
* @export
|
|
58658
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutRelationships
|
|
58659
|
-
*/
|
|
58660
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutRelationships {
|
|
58661
|
-
/**
|
|
58662
|
-
*
|
|
58663
|
-
* @type {JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter}
|
|
58664
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutRelationships
|
|
58665
|
-
*/
|
|
58666
|
-
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter;
|
|
58667
|
-
}
|
|
58668
|
-
|
|
58669
|
-
/**
|
|
58670
|
-
*
|
|
58671
|
-
* @export
|
|
58672
|
-
* @interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter
|
|
58673
|
-
*/
|
|
58674
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter {
|
|
58675
|
-
/**
|
|
58676
|
-
*
|
|
58677
|
-
* @type {JsonApiWorkspaceDataFilterToOneLinkage}
|
|
58678
|
-
* @memberof JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter
|
|
58679
|
-
*/
|
|
58680
|
-
data: JsonApiWorkspaceDataFilterToOneLinkage | null;
|
|
58681
|
-
}
|
|
58682
|
-
|
|
58683
58423
|
export declare const JsonApiWorkspaceDataFilterSettingOutTypeEnum: {
|
|
58684
58424
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
58685
58425
|
};
|
|
@@ -58712,16 +58452,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
58712
58452
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
58713
58453
|
/**
|
|
58714
58454
|
*
|
|
58715
|
-
* @type {
|
|
58455
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
58716
58456
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
58717
58457
|
*/
|
|
58718
|
-
attributes?:
|
|
58458
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
58719
58459
|
/**
|
|
58720
58460
|
*
|
|
58721
|
-
* @type {
|
|
58461
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
58722
58462
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
58723
58463
|
*/
|
|
58724
|
-
relationships?:
|
|
58464
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
58725
58465
|
/**
|
|
58726
58466
|
*
|
|
58727
58467
|
* @type {ObjectLinks}
|
|
@@ -58756,16 +58496,42 @@ export declare interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
58756
58496
|
id: string;
|
|
58757
58497
|
/**
|
|
58758
58498
|
*
|
|
58759
|
-
* @type {
|
|
58499
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
58760
58500
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
58761
58501
|
*/
|
|
58762
|
-
attributes?:
|
|
58502
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
58763
58503
|
/**
|
|
58764
58504
|
*
|
|
58765
|
-
* @type {
|
|
58505
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
58766
58506
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
58767
58507
|
*/
|
|
58768
|
-
relationships?:
|
|
58508
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
58509
|
+
}
|
|
58510
|
+
|
|
58511
|
+
/**
|
|
58512
|
+
*
|
|
58513
|
+
* @export
|
|
58514
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
58515
|
+
*/
|
|
58516
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchAttributes {
|
|
58517
|
+
/**
|
|
58518
|
+
*
|
|
58519
|
+
* @type {string}
|
|
58520
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
58521
|
+
*/
|
|
58522
|
+
title?: string;
|
|
58523
|
+
/**
|
|
58524
|
+
*
|
|
58525
|
+
* @type {string}
|
|
58526
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
58527
|
+
*/
|
|
58528
|
+
description?: string;
|
|
58529
|
+
/**
|
|
58530
|
+
*
|
|
58531
|
+
* @type {Array<string>}
|
|
58532
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
58533
|
+
*/
|
|
58534
|
+
filterValues?: Array<string>;
|
|
58769
58535
|
}
|
|
58770
58536
|
|
|
58771
58537
|
/**
|
|
@@ -58782,6 +58548,34 @@ export declare interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
|
58782
58548
|
data: JsonApiWorkspaceDataFilterSettingPatch;
|
|
58783
58549
|
}
|
|
58784
58550
|
|
|
58551
|
+
/**
|
|
58552
|
+
*
|
|
58553
|
+
* @export
|
|
58554
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchRelationships
|
|
58555
|
+
*/
|
|
58556
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchRelationships {
|
|
58557
|
+
/**
|
|
58558
|
+
*
|
|
58559
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter}
|
|
58560
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchRelationships
|
|
58561
|
+
*/
|
|
58562
|
+
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter;
|
|
58563
|
+
}
|
|
58564
|
+
|
|
58565
|
+
/**
|
|
58566
|
+
*
|
|
58567
|
+
* @export
|
|
58568
|
+
* @interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter
|
|
58569
|
+
*/
|
|
58570
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter {
|
|
58571
|
+
/**
|
|
58572
|
+
*
|
|
58573
|
+
* @type {JsonApiWorkspaceDataFilterToOneLinkage}
|
|
58574
|
+
* @memberof JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter
|
|
58575
|
+
*/
|
|
58576
|
+
data: JsonApiWorkspaceDataFilterToOneLinkage | null;
|
|
58577
|
+
}
|
|
58578
|
+
|
|
58785
58579
|
export declare const JsonApiWorkspaceDataFilterSettingPatchTypeEnum: {
|
|
58786
58580
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
58787
58581
|
};
|
|
@@ -58815,16 +58609,87 @@ export declare interface JsonApiWorkspaceIn {
|
|
|
58815
58609
|
id: string;
|
|
58816
58610
|
/**
|
|
58817
58611
|
*
|
|
58818
|
-
* @type {
|
|
58612
|
+
* @type {JsonApiWorkspaceInAttributes}
|
|
58819
58613
|
* @memberof JsonApiWorkspaceIn
|
|
58820
58614
|
*/
|
|
58821
|
-
attributes?:
|
|
58615
|
+
attributes?: JsonApiWorkspaceInAttributes;
|
|
58822
58616
|
/**
|
|
58823
58617
|
*
|
|
58824
|
-
* @type {
|
|
58618
|
+
* @type {JsonApiWorkspaceInRelationships}
|
|
58825
58619
|
* @memberof JsonApiWorkspaceIn
|
|
58826
58620
|
*/
|
|
58827
|
-
relationships?:
|
|
58621
|
+
relationships?: JsonApiWorkspaceInRelationships;
|
|
58622
|
+
}
|
|
58623
|
+
|
|
58624
|
+
/**
|
|
58625
|
+
*
|
|
58626
|
+
* @export
|
|
58627
|
+
* @interface JsonApiWorkspaceInAttributes
|
|
58628
|
+
*/
|
|
58629
|
+
export declare interface JsonApiWorkspaceInAttributes {
|
|
58630
|
+
/**
|
|
58631
|
+
*
|
|
58632
|
+
* @type {string}
|
|
58633
|
+
* @memberof JsonApiWorkspaceInAttributes
|
|
58634
|
+
*/
|
|
58635
|
+
name?: string | null;
|
|
58636
|
+
/**
|
|
58637
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
58638
|
+
* @type {string}
|
|
58639
|
+
* @memberof JsonApiWorkspaceInAttributes
|
|
58640
|
+
* @deprecated
|
|
58641
|
+
*/
|
|
58642
|
+
earlyAccess?: string | null;
|
|
58643
|
+
/**
|
|
58644
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
58645
|
+
* @type {Array<string>}
|
|
58646
|
+
* @memberof JsonApiWorkspaceInAttributes
|
|
58647
|
+
*/
|
|
58648
|
+
earlyAccessValues?: Array<string> | null;
|
|
58649
|
+
/**
|
|
58650
|
+
*
|
|
58651
|
+
* @type {string}
|
|
58652
|
+
* @memberof JsonApiWorkspaceInAttributes
|
|
58653
|
+
*/
|
|
58654
|
+
description?: string | null;
|
|
58655
|
+
/**
|
|
58656
|
+
* Custom prefix of entity identifiers in workspace
|
|
58657
|
+
* @type {string}
|
|
58658
|
+
* @memberof JsonApiWorkspaceInAttributes
|
|
58659
|
+
*/
|
|
58660
|
+
prefix?: string | null;
|
|
58661
|
+
/**
|
|
58662
|
+
*
|
|
58663
|
+
* @type {number}
|
|
58664
|
+
* @memberof JsonApiWorkspaceInAttributes
|
|
58665
|
+
*/
|
|
58666
|
+
cacheExtraLimit?: number;
|
|
58667
|
+
/**
|
|
58668
|
+
*
|
|
58669
|
+
* @type {JsonApiWorkspaceInAttributesDataSource}
|
|
58670
|
+
* @memberof JsonApiWorkspaceInAttributes
|
|
58671
|
+
*/
|
|
58672
|
+
dataSource?: JsonApiWorkspaceInAttributesDataSource;
|
|
58673
|
+
}
|
|
58674
|
+
|
|
58675
|
+
/**
|
|
58676
|
+
* The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
|
|
58677
|
+
* @export
|
|
58678
|
+
* @interface JsonApiWorkspaceInAttributesDataSource
|
|
58679
|
+
*/
|
|
58680
|
+
export declare interface JsonApiWorkspaceInAttributesDataSource {
|
|
58681
|
+
/**
|
|
58682
|
+
* The ID of the used data source.
|
|
58683
|
+
* @type {string}
|
|
58684
|
+
* @memberof JsonApiWorkspaceInAttributesDataSource
|
|
58685
|
+
*/
|
|
58686
|
+
id: string;
|
|
58687
|
+
/**
|
|
58688
|
+
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
58689
|
+
* @type {Array<string>}
|
|
58690
|
+
* @memberof JsonApiWorkspaceInAttributesDataSource
|
|
58691
|
+
*/
|
|
58692
|
+
schemaPath?: Array<string>;
|
|
58828
58693
|
}
|
|
58829
58694
|
|
|
58830
58695
|
/**
|
|
@@ -58841,6 +58706,34 @@ export declare interface JsonApiWorkspaceInDocument {
|
|
|
58841
58706
|
data: JsonApiWorkspaceIn;
|
|
58842
58707
|
}
|
|
58843
58708
|
|
|
58709
|
+
/**
|
|
58710
|
+
*
|
|
58711
|
+
* @export
|
|
58712
|
+
* @interface JsonApiWorkspaceInRelationships
|
|
58713
|
+
*/
|
|
58714
|
+
export declare interface JsonApiWorkspaceInRelationships {
|
|
58715
|
+
/**
|
|
58716
|
+
*
|
|
58717
|
+
* @type {JsonApiWorkspaceInRelationshipsParent}
|
|
58718
|
+
* @memberof JsonApiWorkspaceInRelationships
|
|
58719
|
+
*/
|
|
58720
|
+
parent?: JsonApiWorkspaceInRelationshipsParent;
|
|
58721
|
+
}
|
|
58722
|
+
|
|
58723
|
+
/**
|
|
58724
|
+
*
|
|
58725
|
+
* @export
|
|
58726
|
+
* @interface JsonApiWorkspaceInRelationshipsParent
|
|
58727
|
+
*/
|
|
58728
|
+
export declare interface JsonApiWorkspaceInRelationshipsParent {
|
|
58729
|
+
/**
|
|
58730
|
+
*
|
|
58731
|
+
* @type {JsonApiWorkspaceToOneLinkage}
|
|
58732
|
+
* @memberof JsonApiWorkspaceInRelationshipsParent
|
|
58733
|
+
*/
|
|
58734
|
+
data: JsonApiWorkspaceToOneLinkage | null;
|
|
58735
|
+
}
|
|
58736
|
+
|
|
58844
58737
|
export declare const JsonApiWorkspaceInTypeEnum: {
|
|
58845
58738
|
readonly WORKSPACE: "workspace";
|
|
58846
58739
|
};
|
|
@@ -58899,87 +58792,16 @@ export declare interface JsonApiWorkspaceOut {
|
|
|
58899
58792
|
meta?: JsonApiWorkspaceOutMeta;
|
|
58900
58793
|
/**
|
|
58901
58794
|
*
|
|
58902
|
-
* @type {
|
|
58795
|
+
* @type {JsonApiWorkspaceInAttributes}
|
|
58903
58796
|
* @memberof JsonApiWorkspaceOut
|
|
58904
58797
|
*/
|
|
58905
|
-
attributes?:
|
|
58798
|
+
attributes?: JsonApiWorkspaceInAttributes;
|
|
58906
58799
|
/**
|
|
58907
58800
|
*
|
|
58908
|
-
* @type {
|
|
58801
|
+
* @type {JsonApiWorkspaceInRelationships}
|
|
58909
58802
|
* @memberof JsonApiWorkspaceOut
|
|
58910
58803
|
*/
|
|
58911
|
-
relationships?:
|
|
58912
|
-
}
|
|
58913
|
-
|
|
58914
|
-
/**
|
|
58915
|
-
*
|
|
58916
|
-
* @export
|
|
58917
|
-
* @interface JsonApiWorkspaceOutAttributes
|
|
58918
|
-
*/
|
|
58919
|
-
export declare interface JsonApiWorkspaceOutAttributes {
|
|
58920
|
-
/**
|
|
58921
|
-
*
|
|
58922
|
-
* @type {string}
|
|
58923
|
-
* @memberof JsonApiWorkspaceOutAttributes
|
|
58924
|
-
*/
|
|
58925
|
-
name?: string | null;
|
|
58926
|
-
/**
|
|
58927
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
58928
|
-
* @type {string}
|
|
58929
|
-
* @memberof JsonApiWorkspaceOutAttributes
|
|
58930
|
-
* @deprecated
|
|
58931
|
-
*/
|
|
58932
|
-
earlyAccess?: string | null;
|
|
58933
|
-
/**
|
|
58934
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
58935
|
-
* @type {Array<string>}
|
|
58936
|
-
* @memberof JsonApiWorkspaceOutAttributes
|
|
58937
|
-
*/
|
|
58938
|
-
earlyAccessValues?: Array<string> | null;
|
|
58939
|
-
/**
|
|
58940
|
-
*
|
|
58941
|
-
* @type {string}
|
|
58942
|
-
* @memberof JsonApiWorkspaceOutAttributes
|
|
58943
|
-
*/
|
|
58944
|
-
description?: string | null;
|
|
58945
|
-
/**
|
|
58946
|
-
* Custom prefix of entity identifiers in workspace
|
|
58947
|
-
* @type {string}
|
|
58948
|
-
* @memberof JsonApiWorkspaceOutAttributes
|
|
58949
|
-
*/
|
|
58950
|
-
prefix?: string | null;
|
|
58951
|
-
/**
|
|
58952
|
-
*
|
|
58953
|
-
* @type {number}
|
|
58954
|
-
* @memberof JsonApiWorkspaceOutAttributes
|
|
58955
|
-
*/
|
|
58956
|
-
cacheExtraLimit?: number;
|
|
58957
|
-
/**
|
|
58958
|
-
*
|
|
58959
|
-
* @type {JsonApiWorkspaceOutAttributesDataSource}
|
|
58960
|
-
* @memberof JsonApiWorkspaceOutAttributes
|
|
58961
|
-
*/
|
|
58962
|
-
dataSource?: JsonApiWorkspaceOutAttributesDataSource;
|
|
58963
|
-
}
|
|
58964
|
-
|
|
58965
|
-
/**
|
|
58966
|
-
* The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
|
|
58967
|
-
* @export
|
|
58968
|
-
* @interface JsonApiWorkspaceOutAttributesDataSource
|
|
58969
|
-
*/
|
|
58970
|
-
export declare interface JsonApiWorkspaceOutAttributesDataSource {
|
|
58971
|
-
/**
|
|
58972
|
-
* The ID of the used data source.
|
|
58973
|
-
* @type {string}
|
|
58974
|
-
* @memberof JsonApiWorkspaceOutAttributesDataSource
|
|
58975
|
-
*/
|
|
58976
|
-
id: string;
|
|
58977
|
-
/**
|
|
58978
|
-
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
58979
|
-
* @type {Array<string>}
|
|
58980
|
-
* @memberof JsonApiWorkspaceOutAttributesDataSource
|
|
58981
|
-
*/
|
|
58982
|
-
schemaPath?: Array<string>;
|
|
58804
|
+
relationships?: JsonApiWorkspaceInRelationships;
|
|
58983
58805
|
}
|
|
58984
58806
|
|
|
58985
58807
|
/**
|
|
@@ -59140,34 +58962,6 @@ export declare const JsonApiWorkspaceOutMetaPermissionsEnum: {
|
|
|
59140
58962
|
|
|
59141
58963
|
export declare type JsonApiWorkspaceOutMetaPermissionsEnum = typeof JsonApiWorkspaceOutMetaPermissionsEnum[keyof typeof JsonApiWorkspaceOutMetaPermissionsEnum];
|
|
59142
58964
|
|
|
59143
|
-
/**
|
|
59144
|
-
*
|
|
59145
|
-
* @export
|
|
59146
|
-
* @interface JsonApiWorkspaceOutRelationships
|
|
59147
|
-
*/
|
|
59148
|
-
export declare interface JsonApiWorkspaceOutRelationships {
|
|
59149
|
-
/**
|
|
59150
|
-
*
|
|
59151
|
-
* @type {JsonApiWorkspaceOutRelationshipsParent}
|
|
59152
|
-
* @memberof JsonApiWorkspaceOutRelationships
|
|
59153
|
-
*/
|
|
59154
|
-
parent?: JsonApiWorkspaceOutRelationshipsParent;
|
|
59155
|
-
}
|
|
59156
|
-
|
|
59157
|
-
/**
|
|
59158
|
-
*
|
|
59159
|
-
* @export
|
|
59160
|
-
* @interface JsonApiWorkspaceOutRelationshipsParent
|
|
59161
|
-
*/
|
|
59162
|
-
export declare interface JsonApiWorkspaceOutRelationshipsParent {
|
|
59163
|
-
/**
|
|
59164
|
-
*
|
|
59165
|
-
* @type {JsonApiWorkspaceToOneLinkage}
|
|
59166
|
-
* @memberof JsonApiWorkspaceOutRelationshipsParent
|
|
59167
|
-
*/
|
|
59168
|
-
data: JsonApiWorkspaceToOneLinkage | null;
|
|
59169
|
-
}
|
|
59170
|
-
|
|
59171
58965
|
export declare const JsonApiWorkspaceOutTypeEnum: {
|
|
59172
58966
|
readonly WORKSPACE: "workspace";
|
|
59173
58967
|
};
|
|
@@ -59200,16 +58994,16 @@ export declare interface JsonApiWorkspaceOutWithLinks {
|
|
|
59200
58994
|
meta?: JsonApiWorkspaceOutMeta;
|
|
59201
58995
|
/**
|
|
59202
58996
|
*
|
|
59203
|
-
* @type {
|
|
58997
|
+
* @type {JsonApiWorkspaceInAttributes}
|
|
59204
58998
|
* @memberof JsonApiWorkspaceOutWithLinks
|
|
59205
58999
|
*/
|
|
59206
|
-
attributes?:
|
|
59000
|
+
attributes?: JsonApiWorkspaceInAttributes;
|
|
59207
59001
|
/**
|
|
59208
59002
|
*
|
|
59209
|
-
* @type {
|
|
59003
|
+
* @type {JsonApiWorkspaceInRelationships}
|
|
59210
59004
|
* @memberof JsonApiWorkspaceOutWithLinks
|
|
59211
59005
|
*/
|
|
59212
|
-
relationships?:
|
|
59006
|
+
relationships?: JsonApiWorkspaceInRelationships;
|
|
59213
59007
|
/**
|
|
59214
59008
|
*
|
|
59215
59009
|
* @type {ObjectLinks}
|
|
@@ -59244,16 +59038,16 @@ export declare interface JsonApiWorkspacePatch {
|
|
|
59244
59038
|
id: string;
|
|
59245
59039
|
/**
|
|
59246
59040
|
*
|
|
59247
|
-
* @type {
|
|
59041
|
+
* @type {JsonApiWorkspaceInAttributes}
|
|
59248
59042
|
* @memberof JsonApiWorkspacePatch
|
|
59249
59043
|
*/
|
|
59250
|
-
attributes?:
|
|
59044
|
+
attributes?: JsonApiWorkspaceInAttributes;
|
|
59251
59045
|
/**
|
|
59252
59046
|
*
|
|
59253
|
-
* @type {
|
|
59047
|
+
* @type {JsonApiWorkspaceInRelationships}
|
|
59254
59048
|
* @memberof JsonApiWorkspacePatch
|
|
59255
59049
|
*/
|
|
59256
|
-
relationships?:
|
|
59050
|
+
relationships?: JsonApiWorkspaceInRelationships;
|
|
59257
59051
|
}
|
|
59258
59052
|
|
|
59259
59053
|
/**
|
|
@@ -65168,14 +64962,6 @@ export declare class NotificationChannelsApi extends MetadataBaseApi implements
|
|
|
65168
64962
|
* @memberof NotificationChannelsApi
|
|
65169
64963
|
*/
|
|
65170
64964
|
deleteEntityNotificationChannels(requestParameters: NotificationChannelsApiDeleteEntityNotificationChannelsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
65171
|
-
/**
|
|
65172
|
-
*
|
|
65173
|
-
* @param {NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
65174
|
-
* @param {*} [options] Override http request option.
|
|
65175
|
-
* @throws {RequiredError}
|
|
65176
|
-
* @memberof NotificationChannelsApi
|
|
65177
|
-
*/
|
|
65178
|
-
getAllEntitiesNotificationChannelIdentifiers(requestParameters?: NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiNotificationChannelIdentifierOutList, any>>;
|
|
65179
64965
|
/**
|
|
65180
64966
|
*
|
|
65181
64967
|
* @summary Get all Notification Channel entities
|
|
@@ -65185,14 +64971,6 @@ export declare class NotificationChannelsApi extends MetadataBaseApi implements
|
|
|
65185
64971
|
* @memberof NotificationChannelsApi
|
|
65186
64972
|
*/
|
|
65187
64973
|
getAllEntitiesNotificationChannels(requestParameters?: NotificationChannelsApiGetAllEntitiesNotificationChannelsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiNotificationChannelOutList, any>>;
|
|
65188
|
-
/**
|
|
65189
|
-
*
|
|
65190
|
-
* @param {NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
65191
|
-
* @param {*} [options] Override http request option.
|
|
65192
|
-
* @throws {RequiredError}
|
|
65193
|
-
* @memberof NotificationChannelsApi
|
|
65194
|
-
*/
|
|
65195
|
-
getEntityNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiNotificationChannelIdentifierOutDocument, any>>;
|
|
65196
64974
|
/**
|
|
65197
64975
|
*
|
|
65198
64976
|
* @summary Get Notification Channel entity
|
|
@@ -65278,17 +65056,6 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
65278
65056
|
* @throws {RequiredError}
|
|
65279
65057
|
*/
|
|
65280
65058
|
deleteEntityNotificationChannels: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
65281
|
-
/**
|
|
65282
|
-
*
|
|
65283
|
-
* @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\').
|
|
65284
|
-
* @param {number} [page] Zero-based page index (0..N)
|
|
65285
|
-
* @param {number} [size] The size of the page to be returned
|
|
65286
|
-
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
65287
|
-
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
65288
|
-
* @param {*} [options] Override http request option.
|
|
65289
|
-
* @throws {RequiredError}
|
|
65290
|
-
*/
|
|
65291
|
-
getAllEntitiesNotificationChannelIdentifiers: (filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
65292
65059
|
/**
|
|
65293
65060
|
*
|
|
65294
65061
|
* @summary Get all Notification Channel entities
|
|
@@ -65301,14 +65068,6 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
65301
65068
|
* @throws {RequiredError}
|
|
65302
65069
|
*/
|
|
65303
65070
|
getAllEntitiesNotificationChannels: (filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
65304
|
-
/**
|
|
65305
|
-
*
|
|
65306
|
-
* @param {string} id
|
|
65307
|
-
* @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\').
|
|
65308
|
-
* @param {*} [options] Override http request option.
|
|
65309
|
-
* @throws {RequiredError}
|
|
65310
|
-
*/
|
|
65311
|
-
getEntityNotificationChannelIdentifiers: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
65312
65071
|
/**
|
|
65313
65072
|
*
|
|
65314
65073
|
* @summary Get Notification Channel entity
|
|
@@ -65425,13 +65184,6 @@ export declare const NotificationChannelsApiFactory: (configuration?: MetadataCo
|
|
|
65425
65184
|
* @throws {RequiredError}
|
|
65426
65185
|
*/
|
|
65427
65186
|
deleteEntityNotificationChannels(requestParameters: NotificationChannelsApiDeleteEntityNotificationChannelsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
65428
|
-
/**
|
|
65429
|
-
*
|
|
65430
|
-
* @param {NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
65431
|
-
* @param {*} [options] Override http request option.
|
|
65432
|
-
* @throws {RequiredError}
|
|
65433
|
-
*/
|
|
65434
|
-
getAllEntitiesNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelIdentifierOutList>;
|
|
65435
65187
|
/**
|
|
65436
65188
|
*
|
|
65437
65189
|
* @summary Get all Notification Channel entities
|
|
@@ -65440,13 +65192,6 @@ export declare const NotificationChannelsApiFactory: (configuration?: MetadataCo
|
|
|
65440
65192
|
* @throws {RequiredError}
|
|
65441
65193
|
*/
|
|
65442
65194
|
getAllEntitiesNotificationChannels(requestParameters: NotificationChannelsApiGetAllEntitiesNotificationChannelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelOutList>;
|
|
65443
|
-
/**
|
|
65444
|
-
*
|
|
65445
|
-
* @param {NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
65446
|
-
* @param {*} [options] Override http request option.
|
|
65447
|
-
* @throws {RequiredError}
|
|
65448
|
-
*/
|
|
65449
|
-
getEntityNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelIdentifierOutDocument>;
|
|
65450
65195
|
/**
|
|
65451
65196
|
*
|
|
65452
65197
|
* @summary Get Notification Channel entity
|
|
@@ -65525,17 +65270,6 @@ export declare const NotificationChannelsApiFp: (configuration?: MetadataConfigu
|
|
|
65525
65270
|
* @throws {RequiredError}
|
|
65526
65271
|
*/
|
|
65527
65272
|
deleteEntityNotificationChannels(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
65528
|
-
/**
|
|
65529
|
-
*
|
|
65530
|
-
* @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\').
|
|
65531
|
-
* @param {number} [page] Zero-based page index (0..N)
|
|
65532
|
-
* @param {number} [size] The size of the page to be returned
|
|
65533
|
-
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
65534
|
-
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
65535
|
-
* @param {*} [options] Override http request option.
|
|
65536
|
-
* @throws {RequiredError}
|
|
65537
|
-
*/
|
|
65538
|
-
getAllEntitiesNotificationChannelIdentifiers(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiNotificationChannelIdentifierOutList>>;
|
|
65539
65273
|
/**
|
|
65540
65274
|
*
|
|
65541
65275
|
* @summary Get all Notification Channel entities
|
|
@@ -65548,14 +65282,6 @@ export declare const NotificationChannelsApiFp: (configuration?: MetadataConfigu
|
|
|
65548
65282
|
* @throws {RequiredError}
|
|
65549
65283
|
*/
|
|
65550
65284
|
getAllEntitiesNotificationChannels(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiNotificationChannelOutList>>;
|
|
65551
|
-
/**
|
|
65552
|
-
*
|
|
65553
|
-
* @param {string} id
|
|
65554
|
-
* @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\').
|
|
65555
|
-
* @param {*} [options] Override http request option.
|
|
65556
|
-
* @throws {RequiredError}
|
|
65557
|
-
*/
|
|
65558
|
-
getEntityNotificationChannelIdentifiers(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiNotificationChannelIdentifierOutDocument>>;
|
|
65559
65285
|
/**
|
|
65560
65286
|
*
|
|
65561
65287
|
* @summary Get Notification Channel entity
|
|
@@ -65617,44 +65343,6 @@ export declare const NotificationChannelsApiFp: (configuration?: MetadataConfigu
|
|
|
65617
65343
|
updateEntityNotificationChannels(id: string, jsonApiNotificationChannelInDocument: JsonApiNotificationChannelInDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiNotificationChannelOutDocument>>;
|
|
65618
65344
|
};
|
|
65619
65345
|
|
|
65620
|
-
/**
|
|
65621
|
-
* Request parameters for getAllEntitiesNotificationChannelIdentifiers operation in NotificationChannelsApi.
|
|
65622
|
-
* @export
|
|
65623
|
-
* @interface NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest
|
|
65624
|
-
*/
|
|
65625
|
-
export declare interface NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest {
|
|
65626
|
-
/**
|
|
65627
|
-
* 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\').
|
|
65628
|
-
* @type {string}
|
|
65629
|
-
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
65630
|
-
*/
|
|
65631
|
-
readonly filter?: string;
|
|
65632
|
-
/**
|
|
65633
|
-
* Zero-based page index (0..N)
|
|
65634
|
-
* @type {number}
|
|
65635
|
-
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
65636
|
-
*/
|
|
65637
|
-
readonly page?: number;
|
|
65638
|
-
/**
|
|
65639
|
-
* The size of the page to be returned
|
|
65640
|
-
* @type {number}
|
|
65641
|
-
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
65642
|
-
*/
|
|
65643
|
-
readonly size?: number;
|
|
65644
|
-
/**
|
|
65645
|
-
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
65646
|
-
* @type {Array<string>}
|
|
65647
|
-
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
65648
|
-
*/
|
|
65649
|
-
readonly sort?: Array<string>;
|
|
65650
|
-
/**
|
|
65651
|
-
* Include Meta objects.
|
|
65652
|
-
* @type {Array<'page' | 'all' | 'ALL'>}
|
|
65653
|
-
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
65654
|
-
*/
|
|
65655
|
-
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
65656
|
-
}
|
|
65657
|
-
|
|
65658
65346
|
/**
|
|
65659
65347
|
* Request parameters for getAllEntitiesNotificationChannels operation in NotificationChannelsApi.
|
|
65660
65348
|
* @export
|
|
@@ -65693,26 +65381,6 @@ export declare interface NotificationChannelsApiGetAllEntitiesNotificationChanne
|
|
|
65693
65381
|
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
65694
65382
|
}
|
|
65695
65383
|
|
|
65696
|
-
/**
|
|
65697
|
-
* Request parameters for getEntityNotificationChannelIdentifiers operation in NotificationChannelsApi.
|
|
65698
|
-
* @export
|
|
65699
|
-
* @interface NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest
|
|
65700
|
-
*/
|
|
65701
|
-
export declare interface NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest {
|
|
65702
|
-
/**
|
|
65703
|
-
*
|
|
65704
|
-
* @type {string}
|
|
65705
|
-
* @memberof NotificationChannelsApiGetEntityNotificationChannelIdentifiers
|
|
65706
|
-
*/
|
|
65707
|
-
readonly id: string;
|
|
65708
|
-
/**
|
|
65709
|
-
* 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\').
|
|
65710
|
-
* @type {string}
|
|
65711
|
-
* @memberof NotificationChannelsApiGetEntityNotificationChannelIdentifiers
|
|
65712
|
-
*/
|
|
65713
|
-
readonly filter?: string;
|
|
65714
|
-
}
|
|
65715
|
-
|
|
65716
65384
|
/**
|
|
65717
65385
|
* Request parameters for getEntityNotificationChannels operation in NotificationChannelsApi.
|
|
65718
65386
|
* @export
|
|
@@ -65757,14 +65425,6 @@ export declare interface NotificationChannelsApiInterface {
|
|
|
65757
65425
|
* @memberof NotificationChannelsApiInterface
|
|
65758
65426
|
*/
|
|
65759
65427
|
deleteEntityNotificationChannels(requestParameters: NotificationChannelsApiDeleteEntityNotificationChannelsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
65760
|
-
/**
|
|
65761
|
-
*
|
|
65762
|
-
* @param {NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
65763
|
-
* @param {*} [options] Override http request option.
|
|
65764
|
-
* @throws {RequiredError}
|
|
65765
|
-
* @memberof NotificationChannelsApiInterface
|
|
65766
|
-
*/
|
|
65767
|
-
getAllEntitiesNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelIdentifierOutList>;
|
|
65768
65428
|
/**
|
|
65769
65429
|
*
|
|
65770
65430
|
* @summary Get all Notification Channel entities
|
|
@@ -65774,14 +65434,6 @@ export declare interface NotificationChannelsApiInterface {
|
|
|
65774
65434
|
* @memberof NotificationChannelsApiInterface
|
|
65775
65435
|
*/
|
|
65776
65436
|
getAllEntitiesNotificationChannels(requestParameters: NotificationChannelsApiGetAllEntitiesNotificationChannelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelOutList>;
|
|
65777
|
-
/**
|
|
65778
|
-
*
|
|
65779
|
-
* @param {NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
65780
|
-
* @param {*} [options] Override http request option.
|
|
65781
|
-
* @throws {RequiredError}
|
|
65782
|
-
* @memberof NotificationChannelsApiInterface
|
|
65783
|
-
*/
|
|
65784
|
-
getEntityNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelIdentifierOutDocument>;
|
|
65785
65437
|
/**
|
|
65786
65438
|
*
|
|
65787
65439
|
* @summary Get Notification Channel entity
|
|
@@ -66508,12 +66160,12 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
66508
66160
|
* @summary Get Organizations
|
|
66509
66161
|
* @param {string} id
|
|
66510
66162
|
* @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\').
|
|
66511
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66163
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
66512
66164
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
66513
66165
|
* @param {*} [options] Override http request option.
|
|
66514
66166
|
* @throws {RequiredError}
|
|
66515
66167
|
*/
|
|
66516
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66168
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66517
66169
|
/**
|
|
66518
66170
|
*
|
|
66519
66171
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -66530,11 +66182,11 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
66530
66182
|
* @param {string} id
|
|
66531
66183
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
66532
66184
|
* @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\').
|
|
66533
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66185
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
66534
66186
|
* @param {*} [options] Override http request option.
|
|
66535
66187
|
* @throws {RequiredError}
|
|
66536
66188
|
*/
|
|
66537
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66189
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66538
66190
|
/**
|
|
66539
66191
|
*
|
|
66540
66192
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -66551,11 +66203,11 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
66551
66203
|
* @param {string} id
|
|
66552
66204
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
66553
66205
|
* @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\').
|
|
66554
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66206
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
66555
66207
|
* @param {*} [options] Override http request option.
|
|
66556
66208
|
* @throws {RequiredError}
|
|
66557
66209
|
*/
|
|
66558
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66210
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66559
66211
|
};
|
|
66560
66212
|
|
|
66561
66213
|
/**
|
|
@@ -66632,12 +66284,12 @@ export declare const OrganizationControllerApiFp: (configuration?: MetadataConfi
|
|
|
66632
66284
|
* @summary Get Organizations
|
|
66633
66285
|
* @param {string} id
|
|
66634
66286
|
* @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\').
|
|
66635
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66287
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
66636
66288
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
66637
66289
|
* @param {*} [options] Override http request option.
|
|
66638
66290
|
* @throws {RequiredError}
|
|
66639
66291
|
*/
|
|
66640
|
-
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66292
|
+
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
66641
66293
|
/**
|
|
66642
66294
|
*
|
|
66643
66295
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -66654,11 +66306,11 @@ export declare const OrganizationControllerApiFp: (configuration?: MetadataConfi
|
|
|
66654
66306
|
* @param {string} id
|
|
66655
66307
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
66656
66308
|
* @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\').
|
|
66657
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66309
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
66658
66310
|
* @param {*} [options] Override http request option.
|
|
66659
66311
|
* @throws {RequiredError}
|
|
66660
66312
|
*/
|
|
66661
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66313
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
66662
66314
|
/**
|
|
66663
66315
|
*
|
|
66664
66316
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -66675,11 +66327,11 @@ export declare const OrganizationControllerApiFp: (configuration?: MetadataConfi
|
|
|
66675
66327
|
* @param {string} id
|
|
66676
66328
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
66677
66329
|
* @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\').
|
|
66678
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66330
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
66679
66331
|
* @param {*} [options] Override http request option.
|
|
66680
66332
|
* @throws {RequiredError}
|
|
66681
66333
|
*/
|
|
66682
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66334
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
66683
66335
|
};
|
|
66684
66336
|
|
|
66685
66337
|
/**
|
|
@@ -66722,10 +66374,10 @@ export declare interface OrganizationControllerApiGetEntityOrganizationsRequest
|
|
|
66722
66374
|
readonly filter?: string;
|
|
66723
66375
|
/**
|
|
66724
66376
|
* 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.
|
|
66725
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
66377
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
66726
66378
|
* @memberof OrganizationControllerApiGetEntityOrganizations
|
|
66727
66379
|
*/
|
|
66728
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
66380
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
66729
66381
|
/**
|
|
66730
66382
|
* Include Meta objects.
|
|
66731
66383
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -66848,10 +66500,10 @@ export declare interface OrganizationControllerApiPatchEntityOrganizationsReques
|
|
|
66848
66500
|
readonly filter?: string;
|
|
66849
66501
|
/**
|
|
66850
66502
|
* 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.
|
|
66851
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
66503
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
66852
66504
|
* @memberof OrganizationControllerApiPatchEntityOrganizations
|
|
66853
66505
|
*/
|
|
66854
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
66506
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
66855
66507
|
}
|
|
66856
66508
|
|
|
66857
66509
|
/**
|
|
@@ -66906,10 +66558,10 @@ export declare interface OrganizationControllerApiUpdateEntityOrganizationsReque
|
|
|
66906
66558
|
readonly filter?: string;
|
|
66907
66559
|
/**
|
|
66908
66560
|
* 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.
|
|
66909
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
66561
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
66910
66562
|
* @memberof OrganizationControllerApiUpdateEntityOrganizations
|
|
66911
66563
|
*/
|
|
66912
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
66564
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
66913
66565
|
}
|
|
66914
66566
|
|
|
66915
66567
|
/**
|
|
@@ -67235,12 +66887,12 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
67235
66887
|
* @summary Get Organizations
|
|
67236
66888
|
* @param {string} id
|
|
67237
66889
|
* @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\').
|
|
67238
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66890
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
67239
66891
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
67240
66892
|
* @param {*} [options] Override http request option.
|
|
67241
66893
|
* @throws {RequiredError}
|
|
67242
66894
|
*/
|
|
67243
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66895
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
67244
66896
|
/**
|
|
67245
66897
|
* Gets a basic information about organization.
|
|
67246
66898
|
* @summary Get current organization info
|
|
@@ -67265,11 +66917,11 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
67265
66917
|
* @param {string} id
|
|
67266
66918
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
67267
66919
|
* @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\').
|
|
67268
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66920
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
67269
66921
|
* @param {*} [options] Override http request option.
|
|
67270
66922
|
* @throws {RequiredError}
|
|
67271
66923
|
*/
|
|
67272
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66924
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
67273
66925
|
/**
|
|
67274
66926
|
*
|
|
67275
66927
|
* @summary Put Organization entity
|
|
@@ -67286,11 +66938,11 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
67286
66938
|
* @param {string} id
|
|
67287
66939
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
67288
66940
|
* @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\').
|
|
67289
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
66941
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
67290
66942
|
* @param {*} [options] Override http request option.
|
|
67291
66943
|
* @throws {RequiredError}
|
|
67292
66944
|
*/
|
|
67293
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
66945
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
67294
66946
|
};
|
|
67295
66947
|
|
|
67296
66948
|
/**
|
|
@@ -67462,12 +67114,12 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: MetadataConfi
|
|
|
67462
67114
|
* @summary Get Organizations
|
|
67463
67115
|
* @param {string} id
|
|
67464
67116
|
* @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\').
|
|
67465
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
67117
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
67466
67118
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
67467
67119
|
* @param {*} [options] Override http request option.
|
|
67468
67120
|
* @throws {RequiredError}
|
|
67469
67121
|
*/
|
|
67470
|
-
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
67122
|
+
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
67471
67123
|
/**
|
|
67472
67124
|
* Gets a basic information about organization.
|
|
67473
67125
|
* @summary Get current organization info
|
|
@@ -67492,11 +67144,11 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: MetadataConfi
|
|
|
67492
67144
|
* @param {string} id
|
|
67493
67145
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
67494
67146
|
* @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\').
|
|
67495
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
67147
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
67496
67148
|
* @param {*} [options] Override http request option.
|
|
67497
67149
|
* @throws {RequiredError}
|
|
67498
67150
|
*/
|
|
67499
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
67151
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
67500
67152
|
/**
|
|
67501
67153
|
*
|
|
67502
67154
|
* @summary Put Organization entity
|
|
@@ -67513,11 +67165,11 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: MetadataConfi
|
|
|
67513
67165
|
* @param {string} id
|
|
67514
67166
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
67515
67167
|
* @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\').
|
|
67516
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
67168
|
+
* @param {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | '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.
|
|
67517
67169
|
* @param {*} [options] Override http request option.
|
|
67518
67170
|
* @throws {RequiredError}
|
|
67519
67171
|
*/
|
|
67520
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
67172
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
67521
67173
|
};
|
|
67522
67174
|
|
|
67523
67175
|
/**
|
|
@@ -67598,10 +67250,10 @@ export declare interface OrganizationEntityAPIsApiGetEntityOrganizationsRequest
|
|
|
67598
67250
|
readonly filter?: string;
|
|
67599
67251
|
/**
|
|
67600
67252
|
* 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.
|
|
67601
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
67253
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
67602
67254
|
* @memberof OrganizationEntityAPIsApiGetEntityOrganizations
|
|
67603
67255
|
*/
|
|
67604
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
67256
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
67605
67257
|
/**
|
|
67606
67258
|
* Include Meta objects.
|
|
67607
67259
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -67774,10 +67426,10 @@ export declare interface OrganizationEntityAPIsApiPatchEntityOrganizationsReques
|
|
|
67774
67426
|
readonly filter?: string;
|
|
67775
67427
|
/**
|
|
67776
67428
|
* 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.
|
|
67777
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
67429
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
67778
67430
|
* @memberof OrganizationEntityAPIsApiPatchEntityOrganizations
|
|
67779
67431
|
*/
|
|
67780
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
67432
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
67781
67433
|
}
|
|
67782
67434
|
|
|
67783
67435
|
/**
|
|
@@ -67832,10 +67484,10 @@ export declare interface OrganizationEntityAPIsApiUpdateEntityOrganizationsReque
|
|
|
67832
67484
|
readonly filter?: string;
|
|
67833
67485
|
/**
|
|
67834
67486
|
* 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.
|
|
67835
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
67487
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
67836
67488
|
* @memberof OrganizationEntityAPIsApiUpdateEntityOrganizations
|
|
67837
67489
|
*/
|
|
67838
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
67490
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
67839
67491
|
}
|
|
67840
67492
|
|
|
67841
67493
|
/**
|
|
@@ -85847,7 +85499,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
85847
85499
|
* @param {string} workspaceId
|
|
85848
85500
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
85849
85501
|
* @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\').
|
|
85850
|
-
* @param {Array<'datasets' | '
|
|
85502
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
85851
85503
|
* @param {number} [page] Zero-based page index (0..N)
|
|
85852
85504
|
* @param {number} [size] The size of the page to be returned
|
|
85853
85505
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -85856,7 +85508,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
85856
85508
|
* @param {*} [options] Override http request option.
|
|
85857
85509
|
* @throws {RequiredError}
|
|
85858
85510
|
*/
|
|
85859
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
85511
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
85860
85512
|
/**
|
|
85861
85513
|
*
|
|
85862
85514
|
* @summary Get all Context Filters
|
|
@@ -86109,13 +85761,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
86109
85761
|
* @param {string} workspaceId
|
|
86110
85762
|
* @param {string} objectId
|
|
86111
85763
|
* @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\').
|
|
86112
|
-
* @param {Array<'datasets' | '
|
|
85764
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
86113
85765
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
86114
85766
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
86115
85767
|
* @param {*} [options] Override http request option.
|
|
86116
85768
|
* @throws {RequiredError}
|
|
86117
85769
|
*/
|
|
86118
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
85770
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
86119
85771
|
/**
|
|
86120
85772
|
*
|
|
86121
85773
|
* @summary Get a Context Filter
|
|
@@ -88531,7 +88183,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
88531
88183
|
* @param {string} workspaceId
|
|
88532
88184
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
88533
88185
|
* @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\').
|
|
88534
|
-
* @param {Array<'datasets' | '
|
|
88186
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
88535
88187
|
* @param {number} [page] Zero-based page index (0..N)
|
|
88536
88188
|
* @param {number} [size] The size of the page to be returned
|
|
88537
88189
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -88540,7 +88192,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
88540
88192
|
* @param {*} [options] Override http request option.
|
|
88541
88193
|
* @throws {RequiredError}
|
|
88542
88194
|
*/
|
|
88543
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
88195
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
88544
88196
|
/**
|
|
88545
88197
|
*
|
|
88546
88198
|
* @summary Get all Context Filters
|
|
@@ -88793,13 +88445,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
88793
88445
|
* @param {string} workspaceId
|
|
88794
88446
|
* @param {string} objectId
|
|
88795
88447
|
* @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\').
|
|
88796
|
-
* @param {Array<'datasets' | '
|
|
88448
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
88797
88449
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
88798
88450
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
88799
88451
|
* @param {*} [options] Override http request option.
|
|
88800
88452
|
* @throws {RequiredError}
|
|
88801
88453
|
*/
|
|
88802
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
88454
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
88803
88455
|
/**
|
|
88804
88456
|
*
|
|
88805
88457
|
* @summary Get a Context Filter
|
|
@@ -89765,10 +89417,10 @@ export declare interface WorkspaceObjectControllerApiGetAllEntitiesFactsRequest
|
|
|
89765
89417
|
readonly filter?: string;
|
|
89766
89418
|
/**
|
|
89767
89419
|
* 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.
|
|
89768
|
-
* @type {Array<'datasets' | '
|
|
89420
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
89769
89421
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesFacts
|
|
89770
89422
|
*/
|
|
89771
|
-
readonly include?: Array<"datasets" | "
|
|
89423
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
89772
89424
|
/**
|
|
89773
89425
|
* Zero-based page index (0..N)
|
|
89774
89426
|
* @type {number}
|
|
@@ -90725,10 +90377,10 @@ export declare interface WorkspaceObjectControllerApiGetEntityFactsRequest {
|
|
|
90725
90377
|
readonly filter?: string;
|
|
90726
90378
|
/**
|
|
90727
90379
|
* 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.
|
|
90728
|
-
* @type {Array<'datasets' | '
|
|
90380
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
90729
90381
|
* @memberof WorkspaceObjectControllerApiGetEntityFacts
|
|
90730
90382
|
*/
|
|
90731
|
-
readonly include?: Array<"datasets" | "
|
|
90383
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
90732
90384
|
/**
|
|
90733
90385
|
*
|
|
90734
90386
|
* @type {boolean}
|