@gooddata/api-client-tiger 10.32.0-alpha.2 → 10.32.0-alpha.21
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 +1481 -1133
- 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 +6 -0
- 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 +16 -0
- package/esm/generated/export-json-api/openapi-spec.json +6 -0
- package/esm/generated/metadata-json-api/api.d.ts +1402 -1087
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +240 -52
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +9167 -8953
- package/package.json +3 -3
|
@@ -14305,6 +14305,12 @@ 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;
|
|
14308
14314
|
}
|
|
14309
14315
|
|
|
14310
14316
|
/**
|
|
@@ -15166,13 +15172,13 @@ export declare interface ClusteringResult {
|
|
|
15166
15172
|
* @type {Array<number>}
|
|
15167
15173
|
* @memberof ClusteringResult
|
|
15168
15174
|
*/
|
|
15169
|
-
|
|
15175
|
+
xcoord: Array<number>;
|
|
15170
15176
|
/**
|
|
15171
15177
|
*
|
|
15172
15178
|
* @type {Array<number>}
|
|
15173
15179
|
* @memberof ClusteringResult
|
|
15174
15180
|
*/
|
|
15175
|
-
|
|
15181
|
+
ycoord: Array<number>;
|
|
15176
15182
|
}
|
|
15177
15183
|
|
|
15178
15184
|
/**
|
|
@@ -22189,6 +22195,12 @@ export declare interface DeclarativeDataset {
|
|
|
22189
22195
|
* @memberof DeclarativeDataset
|
|
22190
22196
|
*/
|
|
22191
22197
|
workspaceDataFilterReferences?: Array<DeclarativeWorkspaceDataFilterReferences>;
|
|
22198
|
+
/**
|
|
22199
|
+
* Precedence used in aggregate awareness.
|
|
22200
|
+
* @type {number}
|
|
22201
|
+
* @memberof DeclarativeDataset
|
|
22202
|
+
*/
|
|
22203
|
+
precedence?: number;
|
|
22192
22204
|
}
|
|
22193
22205
|
|
|
22194
22206
|
/**
|
|
@@ -22683,6 +22695,12 @@ export declare interface DeclarativeFact {
|
|
|
22683
22695
|
* @memberof DeclarativeFact
|
|
22684
22696
|
*/
|
|
22685
22697
|
tags?: Array<string>;
|
|
22698
|
+
/**
|
|
22699
|
+
*
|
|
22700
|
+
* @type {DeclarativeSourceFactReference}
|
|
22701
|
+
* @memberof DeclarativeFact
|
|
22702
|
+
*/
|
|
22703
|
+
sourceFactReference?: DeclarativeSourceFactReference;
|
|
22686
22704
|
}
|
|
22687
22705
|
|
|
22688
22706
|
export declare const DeclarativeFactSourceColumnDataTypeEnum: {
|
|
@@ -22804,11 +22822,11 @@ export declare interface DeclarativeIdentityProvider {
|
|
|
22804
22822
|
*/
|
|
22805
22823
|
id: string;
|
|
22806
22824
|
/**
|
|
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.
|
|
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.
|
|
22808
22826
|
* @type {Array<string>}
|
|
22809
22827
|
* @memberof DeclarativeIdentityProvider
|
|
22810
22828
|
*/
|
|
22811
|
-
identifiers
|
|
22829
|
+
identifiers?: Array<string>;
|
|
22812
22830
|
/**
|
|
22813
22831
|
* 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.
|
|
22814
22832
|
* @type {{ [key: string]: string; }}
|
|
@@ -22853,6 +22871,12 @@ export declare interface DeclarativeIdentityProvider {
|
|
|
22853
22871
|
* @memberof DeclarativeIdentityProvider
|
|
22854
22872
|
*/
|
|
22855
22873
|
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;
|
|
22856
22880
|
/**
|
|
22857
22881
|
* 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.
|
|
22858
22882
|
* @type {{ [key: string]: string; }}
|
|
@@ -22869,6 +22893,40 @@ export declare interface DeclarativeIdentityProvider {
|
|
|
22869
22893
|
oauthCustomScopes?: Array<string> | null;
|
|
22870
22894
|
}
|
|
22871
22895
|
|
|
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
|
+
|
|
22872
22930
|
/**
|
|
22873
22931
|
* A declarative form of the JWK.
|
|
22874
22932
|
* @export
|
|
@@ -23396,6 +23454,12 @@ export declare interface DeclarativeOrganizationInfo {
|
|
|
23396
23454
|
* @memberof DeclarativeOrganizationInfo
|
|
23397
23455
|
*/
|
|
23398
23456
|
cspDirectives?: Array<DeclarativeCspDirective>;
|
|
23457
|
+
/**
|
|
23458
|
+
*
|
|
23459
|
+
* @type {DeclarativeIdentityProviderIdentifier}
|
|
23460
|
+
* @memberof DeclarativeOrganizationInfo
|
|
23461
|
+
*/
|
|
23462
|
+
identityProvider?: DeclarativeIdentityProviderIdentifier;
|
|
23399
23463
|
}
|
|
23400
23464
|
|
|
23401
23465
|
/**
|
|
@@ -23681,6 +23745,34 @@ export declare const DeclarativeSingleWorkspacePermissionNameEnum: {
|
|
|
23681
23745
|
|
|
23682
23746
|
export declare type DeclarativeSingleWorkspacePermissionNameEnum = typeof DeclarativeSingleWorkspacePermissionNameEnum[keyof typeof DeclarativeSingleWorkspacePermissionNameEnum];
|
|
23683
23747
|
|
|
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
|
+
|
|
23684
23776
|
/**
|
|
23685
23777
|
* A database table.
|
|
23686
23778
|
* @export
|
|
@@ -27667,7 +27759,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27667
27759
|
* @param {string} workspaceId
|
|
27668
27760
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
27669
27761
|
* @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\').
|
|
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.
|
|
27762
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
27671
27763
|
* @param {number} [page] Zero-based page index (0..N)
|
|
27672
27764
|
* @param {number} [size] The size of the page to be returned
|
|
27673
27765
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -27676,7 +27768,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27676
27768
|
* @param {*} [options] Override http request option.
|
|
27677
27769
|
* @throws {RequiredError}
|
|
27678
27770
|
*/
|
|
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>;
|
|
27771
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
27680
27772
|
/**
|
|
27681
27773
|
*
|
|
27682
27774
|
* @summary Get all Context Filters
|
|
@@ -28165,13 +28257,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28165
28257
|
* @param {string} workspaceId
|
|
28166
28258
|
* @param {string} objectId
|
|
28167
28259
|
* @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\').
|
|
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.
|
|
28260
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
28169
28261
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28170
28262
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28171
28263
|
* @param {*} [options] Override http request option.
|
|
28172
28264
|
* @throws {RequiredError}
|
|
28173
28265
|
*/
|
|
28174
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28266
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28175
28267
|
/**
|
|
28176
28268
|
*
|
|
28177
28269
|
* @summary Get a Context Filter
|
|
@@ -28281,12 +28373,12 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28281
28373
|
* @summary Get Organizations
|
|
28282
28374
|
* @param {string} id
|
|
28283
28375
|
* @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\').
|
|
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.
|
|
28376
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
28285
28377
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28286
28378
|
* @param {*} [options] Override http request option.
|
|
28287
28379
|
* @throws {RequiredError}
|
|
28288
28380
|
*/
|
|
28289
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28381
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28290
28382
|
/**
|
|
28291
28383
|
*
|
|
28292
28384
|
* @summary Get Theming
|
|
@@ -28631,11 +28723,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28631
28723
|
* @param {string} id
|
|
28632
28724
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
28633
28725
|
* @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\').
|
|
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.
|
|
28726
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
28635
28727
|
* @param {*} [options] Override http request option.
|
|
28636
28728
|
* @throws {RequiredError}
|
|
28637
28729
|
*/
|
|
28638
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28730
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28639
28731
|
/**
|
|
28640
28732
|
*
|
|
28641
28733
|
* @summary Patch Theming
|
|
@@ -28951,11 +29043,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28951
29043
|
* @param {string} id
|
|
28952
29044
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
28953
29045
|
* @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\').
|
|
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.
|
|
29046
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
28955
29047
|
* @param {*} [options] Override http request option.
|
|
28956
29048
|
* @throws {RequiredError}
|
|
28957
29049
|
*/
|
|
28958
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
29050
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28959
29051
|
/**
|
|
28960
29052
|
*
|
|
28961
29053
|
* @summary Put Theming
|
|
@@ -32778,7 +32870,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
32778
32870
|
* @param {string} workspaceId
|
|
32779
32871
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
32780
32872
|
* @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\').
|
|
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.
|
|
32873
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
32782
32874
|
* @param {number} [page] Zero-based page index (0..N)
|
|
32783
32875
|
* @param {number} [size] The size of the page to be returned
|
|
32784
32876
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -32787,7 +32879,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
32787
32879
|
* @param {*} [options] Override http request option.
|
|
32788
32880
|
* @throws {RequiredError}
|
|
32789
32881
|
*/
|
|
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>>;
|
|
32882
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "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>>;
|
|
32791
32883
|
/**
|
|
32792
32884
|
*
|
|
32793
32885
|
* @summary Get all Context Filters
|
|
@@ -33278,13 +33370,13 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33278
33370
|
* @param {string} workspaceId
|
|
33279
33371
|
* @param {string} objectId
|
|
33280
33372
|
* @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\').
|
|
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.
|
|
33373
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
33282
33374
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
33283
33375
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33284
33376
|
* @param {*} [options] Override http request option.
|
|
33285
33377
|
* @throws {RequiredError}
|
|
33286
33378
|
*/
|
|
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>>;
|
|
33379
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
33288
33380
|
/**
|
|
33289
33381
|
*
|
|
33290
33382
|
* @summary Get a Context Filter
|
|
@@ -33394,12 +33486,12 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33394
33486
|
* @summary Get Organizations
|
|
33395
33487
|
* @param {string} id
|
|
33396
33488
|
* @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\').
|
|
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.
|
|
33489
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
33398
33490
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33399
33491
|
* @param {*} [options] Override http request option.
|
|
33400
33492
|
* @throws {RequiredError}
|
|
33401
33493
|
*/
|
|
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>>;
|
|
33494
|
+
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
33403
33495
|
/**
|
|
33404
33496
|
*
|
|
33405
33497
|
* @summary Get Theming
|
|
@@ -33744,11 +33836,11 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33744
33836
|
* @param {string} id
|
|
33745
33837
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
33746
33838
|
* @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\').
|
|
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.
|
|
33839
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
33748
33840
|
* @param {*} [options] Override http request option.
|
|
33749
33841
|
* @throws {RequiredError}
|
|
33750
33842
|
*/
|
|
33751
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
33843
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
33752
33844
|
/**
|
|
33753
33845
|
*
|
|
33754
33846
|
* @summary Patch Theming
|
|
@@ -34064,11 +34156,11 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
34064
34156
|
* @param {string} id
|
|
34065
34157
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
34066
34158
|
* @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\').
|
|
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.
|
|
34159
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
34068
34160
|
* @param {*} [options] Override http request option.
|
|
34069
34161
|
* @throws {RequiredError}
|
|
34070
34162
|
*/
|
|
34071
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
34163
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
34072
34164
|
/**
|
|
34073
34165
|
*
|
|
34074
34166
|
* @summary Put Theming
|
|
@@ -34972,10 +35064,10 @@ export declare interface EntitiesApiGetAllEntitiesFactsRequest {
|
|
|
34972
35064
|
readonly filter?: string;
|
|
34973
35065
|
/**
|
|
34974
35066
|
* 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.
|
|
34975
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
35067
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
34976
35068
|
* @memberof EntitiesApiGetAllEntitiesFacts
|
|
34977
35069
|
*/
|
|
34978
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
35070
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
34979
35071
|
/**
|
|
34980
35072
|
* Zero-based page index (0..N)
|
|
34981
35073
|
* @type {number}
|
|
@@ -36590,10 +36682,10 @@ export declare interface EntitiesApiGetEntityFactsRequest {
|
|
|
36590
36682
|
readonly filter?: string;
|
|
36591
36683
|
/**
|
|
36592
36684
|
* 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.
|
|
36593
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
36685
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
36594
36686
|
* @memberof EntitiesApiGetEntityFacts
|
|
36595
36687
|
*/
|
|
36596
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
36688
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
36597
36689
|
/**
|
|
36598
36690
|
*
|
|
36599
36691
|
* @type {boolean}
|
|
@@ -36918,10 +37010,10 @@ export declare interface EntitiesApiGetEntityOrganizationsRequest {
|
|
|
36918
37010
|
readonly filter?: string;
|
|
36919
37011
|
/**
|
|
36920
37012
|
* 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.
|
|
36921
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
37013
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
36922
37014
|
* @memberof EntitiesApiGetEntityOrganizations
|
|
36923
37015
|
*/
|
|
36924
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
37016
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
36925
37017
|
/**
|
|
36926
37018
|
* Include Meta objects.
|
|
36927
37019
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -39699,10 +39791,10 @@ export declare interface EntitiesApiPatchEntityOrganizationsRequest {
|
|
|
39699
39791
|
readonly filter?: string;
|
|
39700
39792
|
/**
|
|
39701
39793
|
* 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.
|
|
39702
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
39794
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
39703
39795
|
* @memberof EntitiesApiPatchEntityOrganizations
|
|
39704
39796
|
*/
|
|
39705
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
39797
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
39706
39798
|
}
|
|
39707
39799
|
|
|
39708
39800
|
/**
|
|
@@ -40633,10 +40725,10 @@ export declare interface EntitiesApiUpdateEntityOrganizationsRequest {
|
|
|
40633
40725
|
readonly filter?: string;
|
|
40634
40726
|
/**
|
|
40635
40727
|
* 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.
|
|
40636
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
40728
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
40637
40729
|
* @memberof EntitiesApiUpdateEntityOrganizations
|
|
40638
40730
|
*/
|
|
40639
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
40731
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
40640
40732
|
}
|
|
40641
40733
|
|
|
40642
40734
|
/**
|
|
@@ -42425,6 +42517,32 @@ export declare interface ExportResponse {
|
|
|
42425
42517
|
exportResult: string;
|
|
42426
42518
|
}
|
|
42427
42519
|
|
|
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
|
+
|
|
42428
42546
|
/**
|
|
42429
42547
|
* FactsApi - object-oriented interface
|
|
42430
42548
|
* @export
|
|
@@ -42463,7 +42581,7 @@ export declare const FactsApiAxiosParamCreator: (configuration?: MetadataConfigu
|
|
|
42463
42581
|
* @param {string} workspaceId
|
|
42464
42582
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
42465
42583
|
* @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\').
|
|
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.
|
|
42584
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
42467
42585
|
* @param {number} [page] Zero-based page index (0..N)
|
|
42468
42586
|
* @param {number} [size] The size of the page to be returned
|
|
42469
42587
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -42472,20 +42590,20 @@ export declare const FactsApiAxiosParamCreator: (configuration?: MetadataConfigu
|
|
|
42472
42590
|
* @param {*} [options] Override http request option.
|
|
42473
42591
|
* @throws {RequiredError}
|
|
42474
42592
|
*/
|
|
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>;
|
|
42593
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
42476
42594
|
/**
|
|
42477
42595
|
*
|
|
42478
42596
|
* @summary Get a Fact
|
|
42479
42597
|
* @param {string} workspaceId
|
|
42480
42598
|
* @param {string} objectId
|
|
42481
42599
|
* @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\').
|
|
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.
|
|
42600
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
42483
42601
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
42484
42602
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
42485
42603
|
* @param {*} [options] Override http request option.
|
|
42486
42604
|
* @throws {RequiredError}
|
|
42487
42605
|
*/
|
|
42488
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
42606
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
42489
42607
|
};
|
|
42490
42608
|
|
|
42491
42609
|
/**
|
|
@@ -42522,7 +42640,7 @@ export declare const FactsApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
42522
42640
|
* @param {string} workspaceId
|
|
42523
42641
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
42524
42642
|
* @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\').
|
|
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.
|
|
42643
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
42526
42644
|
* @param {number} [page] Zero-based page index (0..N)
|
|
42527
42645
|
* @param {number} [size] The size of the page to be returned
|
|
42528
42646
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -42531,20 +42649,20 @@ export declare const FactsApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
42531
42649
|
* @param {*} [options] Override http request option.
|
|
42532
42650
|
* @throws {RequiredError}
|
|
42533
42651
|
*/
|
|
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>>;
|
|
42652
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "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>>;
|
|
42535
42653
|
/**
|
|
42536
42654
|
*
|
|
42537
42655
|
* @summary Get a Fact
|
|
42538
42656
|
* @param {string} workspaceId
|
|
42539
42657
|
* @param {string} objectId
|
|
42540
42658
|
* @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\').
|
|
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.
|
|
42659
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
42542
42660
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
42543
42661
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
42544
42662
|
* @param {*} [options] Override http request option.
|
|
42545
42663
|
* @throws {RequiredError}
|
|
42546
42664
|
*/
|
|
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>>;
|
|
42665
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
42548
42666
|
};
|
|
42549
42667
|
|
|
42550
42668
|
/**
|
|
@@ -42573,10 +42691,10 @@ export declare interface FactsApiGetAllEntitiesFactsRequest {
|
|
|
42573
42691
|
readonly filter?: string;
|
|
42574
42692
|
/**
|
|
42575
42693
|
* 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.
|
|
42576
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
42694
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
42577
42695
|
* @memberof FactsApiGetAllEntitiesFacts
|
|
42578
42696
|
*/
|
|
42579
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
42697
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
42580
42698
|
/**
|
|
42581
42699
|
* Zero-based page index (0..N)
|
|
42582
42700
|
* @type {number}
|
|
@@ -42635,10 +42753,10 @@ export declare interface FactsApiGetEntityFactsRequest {
|
|
|
42635
42753
|
readonly filter?: string;
|
|
42636
42754
|
/**
|
|
42637
42755
|
* 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.
|
|
42638
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
42756
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
42639
42757
|
* @memberof FactsApiGetEntityFacts
|
|
42640
42758
|
*/
|
|
42641
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
42759
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
42642
42760
|
/**
|
|
42643
42761
|
*
|
|
42644
42762
|
* @type {boolean}
|
|
@@ -47292,10 +47410,10 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
47292
47410
|
details?: any;
|
|
47293
47411
|
/**
|
|
47294
47412
|
*
|
|
47295
|
-
* @type {
|
|
47413
|
+
* @type {JsonApiAutomationOutAttributesMetadata}
|
|
47296
47414
|
* @memberof JsonApiAutomationOutAttributes
|
|
47297
47415
|
*/
|
|
47298
|
-
metadata?:
|
|
47416
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
47299
47417
|
/**
|
|
47300
47418
|
* Current state of the automation.
|
|
47301
47419
|
* @type {string}
|
|
@@ -47304,52 +47422,52 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
47304
47422
|
state?: JsonApiAutomationOutAttributesStateEnum;
|
|
47305
47423
|
/**
|
|
47306
47424
|
*
|
|
47307
|
-
* @type {
|
|
47425
|
+
* @type {JsonApiAutomationOutAttributesSchedule}
|
|
47308
47426
|
* @memberof JsonApiAutomationOutAttributes
|
|
47309
47427
|
*/
|
|
47310
|
-
schedule?:
|
|
47428
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
47311
47429
|
/**
|
|
47312
47430
|
*
|
|
47313
|
-
* @type {
|
|
47431
|
+
* @type {JsonApiAutomationOutAttributesAlert}
|
|
47314
47432
|
* @memberof JsonApiAutomationOutAttributes
|
|
47315
47433
|
*/
|
|
47316
|
-
alert?:
|
|
47434
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
47317
47435
|
/**
|
|
47318
47436
|
*
|
|
47319
|
-
* @type {Array<
|
|
47437
|
+
* @type {Array<JsonApiAutomationOutAttributesTabularExports>}
|
|
47320
47438
|
* @memberof JsonApiAutomationOutAttributes
|
|
47321
47439
|
*/
|
|
47322
|
-
tabularExports?: Array<
|
|
47440
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExports>;
|
|
47323
47441
|
/**
|
|
47324
47442
|
*
|
|
47325
|
-
* @type {Array<
|
|
47443
|
+
* @type {Array<JsonApiAutomationOutAttributesVisualExports>}
|
|
47326
47444
|
* @memberof JsonApiAutomationOutAttributes
|
|
47327
47445
|
*/
|
|
47328
|
-
visualExports?: Array<
|
|
47446
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExports>;
|
|
47329
47447
|
/**
|
|
47330
47448
|
*
|
|
47331
|
-
* @type {Array<
|
|
47449
|
+
* @type {Array<JsonApiAutomationOutAttributesImageExports>}
|
|
47332
47450
|
* @memberof JsonApiAutomationOutAttributes
|
|
47333
47451
|
*/
|
|
47334
|
-
imageExports?: Array<
|
|
47452
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExports>;
|
|
47335
47453
|
/**
|
|
47336
47454
|
*
|
|
47337
|
-
* @type {Array<
|
|
47455
|
+
* @type {Array<JsonApiAutomationOutAttributesRawExports>}
|
|
47338
47456
|
* @memberof JsonApiAutomationOutAttributes
|
|
47339
47457
|
*/
|
|
47340
|
-
rawExports?: Array<
|
|
47458
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExports>;
|
|
47341
47459
|
/**
|
|
47342
47460
|
*
|
|
47343
|
-
* @type {Array<
|
|
47461
|
+
* @type {Array<JsonApiAutomationOutAttributesSlidesExports>}
|
|
47344
47462
|
* @memberof JsonApiAutomationOutAttributes
|
|
47345
47463
|
*/
|
|
47346
|
-
slidesExports?: Array<
|
|
47464
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExports>;
|
|
47347
47465
|
/**
|
|
47348
47466
|
* External recipients of the automation action results.
|
|
47349
|
-
* @type {Array<
|
|
47467
|
+
* @type {Array<JsonApiAutomationOutAttributesExternalRecipients>}
|
|
47350
47468
|
* @memberof JsonApiAutomationOutAttributes
|
|
47351
47469
|
*/
|
|
47352
|
-
externalRecipients?: Array<
|
|
47470
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipients>;
|
|
47353
47471
|
/**
|
|
47354
47472
|
*
|
|
47355
47473
|
* @type {string}
|
|
@@ -47364,6 +47482,147 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
47364
47482
|
modifiedAt?: string;
|
|
47365
47483
|
}
|
|
47366
47484
|
|
|
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
|
+
|
|
47367
47626
|
export declare const JsonApiAutomationOutAttributesStateEnum: {
|
|
47368
47627
|
readonly ACTIVE: "ACTIVE";
|
|
47369
47628
|
readonly PAUSED: "PAUSED";
|
|
@@ -47371,6 +47630,34 @@ export declare const JsonApiAutomationOutAttributesStateEnum: {
|
|
|
47371
47630
|
|
|
47372
47631
|
export declare type JsonApiAutomationOutAttributesStateEnum = typeof JsonApiAutomationOutAttributesStateEnum[keyof typeof JsonApiAutomationOutAttributesStateEnum];
|
|
47373
47632
|
|
|
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
|
+
|
|
47374
47661
|
/**
|
|
47375
47662
|
*
|
|
47376
47663
|
* @export
|
|
@@ -47443,16 +47730,16 @@ export declare interface JsonApiAutomationOutList {
|
|
|
47443
47730
|
export declare interface JsonApiAutomationOutRelationships {
|
|
47444
47731
|
/**
|
|
47445
47732
|
*
|
|
47446
|
-
* @type {
|
|
47733
|
+
* @type {JsonApiAutomationOutRelationshipsNotificationChannel}
|
|
47447
47734
|
* @memberof JsonApiAutomationOutRelationships
|
|
47448
47735
|
*/
|
|
47449
|
-
notificationChannel?:
|
|
47736
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
47450
47737
|
/**
|
|
47451
47738
|
*
|
|
47452
|
-
* @type {
|
|
47739
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
47453
47740
|
* @memberof JsonApiAutomationOutRelationships
|
|
47454
47741
|
*/
|
|
47455
|
-
analyticalDashboard?:
|
|
47742
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
47456
47743
|
/**
|
|
47457
47744
|
*
|
|
47458
47745
|
* @type {JsonApiVisualizationObjectOutRelationshipsCreatedBy}
|
|
@@ -47467,16 +47754,58 @@ export declare interface JsonApiAutomationOutRelationships {
|
|
|
47467
47754
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
47468
47755
|
/**
|
|
47469
47756
|
*
|
|
47470
|
-
* @type {
|
|
47757
|
+
* @type {JsonApiAutomationOutRelationshipsExportDefinitions}
|
|
47471
47758
|
* @memberof JsonApiAutomationOutRelationships
|
|
47472
47759
|
*/
|
|
47473
|
-
exportDefinitions?:
|
|
47760
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
47474
47761
|
/**
|
|
47475
47762
|
*
|
|
47476
|
-
* @type {
|
|
47763
|
+
* @type {JsonApiAutomationOutRelationshipsRecipients}
|
|
47477
47764
|
* @memberof JsonApiAutomationOutRelationships
|
|
47478
47765
|
*/
|
|
47479
|
-
recipients?:
|
|
47766
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
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>;
|
|
47480
47809
|
}
|
|
47481
47810
|
|
|
47482
47811
|
export declare const JsonApiAutomationOutTypeEnum: {
|
|
@@ -47605,10 +47934,10 @@ export declare interface JsonApiAutomationPatchAttributes {
|
|
|
47605
47934
|
details?: any;
|
|
47606
47935
|
/**
|
|
47607
47936
|
*
|
|
47608
|
-
* @type {
|
|
47937
|
+
* @type {JsonApiAutomationOutAttributesMetadata}
|
|
47609
47938
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47610
47939
|
*/
|
|
47611
|
-
metadata?:
|
|
47940
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
47612
47941
|
/**
|
|
47613
47942
|
* Current state of the automation.
|
|
47614
47943
|
* @type {string}
|
|
@@ -47617,193 +47946,52 @@ export declare interface JsonApiAutomationPatchAttributes {
|
|
|
47617
47946
|
state?: JsonApiAutomationPatchAttributesStateEnum;
|
|
47618
47947
|
/**
|
|
47619
47948
|
*
|
|
47620
|
-
* @type {
|
|
47949
|
+
* @type {JsonApiAutomationOutAttributesSchedule}
|
|
47621
47950
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47622
47951
|
*/
|
|
47623
|
-
schedule?:
|
|
47952
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
47624
47953
|
/**
|
|
47625
47954
|
*
|
|
47626
|
-
* @type {
|
|
47955
|
+
* @type {JsonApiAutomationOutAttributesAlert}
|
|
47627
47956
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47628
47957
|
*/
|
|
47629
|
-
alert?:
|
|
47958
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
47630
47959
|
/**
|
|
47631
47960
|
*
|
|
47632
|
-
* @type {Array<
|
|
47961
|
+
* @type {Array<JsonApiAutomationOutAttributesTabularExports>}
|
|
47633
47962
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47634
47963
|
*/
|
|
47635
|
-
tabularExports?: Array<
|
|
47964
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExports>;
|
|
47636
47965
|
/**
|
|
47637
47966
|
*
|
|
47638
|
-
* @type {Array<
|
|
47967
|
+
* @type {Array<JsonApiAutomationOutAttributesVisualExports>}
|
|
47639
47968
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47640
47969
|
*/
|
|
47641
|
-
visualExports?: Array<
|
|
47970
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExports>;
|
|
47642
47971
|
/**
|
|
47643
47972
|
*
|
|
47644
|
-
* @type {Array<
|
|
47973
|
+
* @type {Array<JsonApiAutomationOutAttributesImageExports>}
|
|
47645
47974
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47646
47975
|
*/
|
|
47647
|
-
imageExports?: Array<
|
|
47976
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExports>;
|
|
47648
47977
|
/**
|
|
47649
47978
|
*
|
|
47650
|
-
* @type {Array<
|
|
47979
|
+
* @type {Array<JsonApiAutomationOutAttributesRawExports>}
|
|
47651
47980
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47652
47981
|
*/
|
|
47653
|
-
rawExports?: Array<
|
|
47982
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExports>;
|
|
47654
47983
|
/**
|
|
47655
47984
|
*
|
|
47656
|
-
* @type {Array<
|
|
47985
|
+
* @type {Array<JsonApiAutomationOutAttributesSlidesExports>}
|
|
47657
47986
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47658
47987
|
*/
|
|
47659
|
-
slidesExports?: Array<
|
|
47988
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExports>;
|
|
47660
47989
|
/**
|
|
47661
47990
|
* External recipients of the automation action results.
|
|
47662
|
-
* @type {Array<
|
|
47991
|
+
* @type {Array<JsonApiAutomationOutAttributesExternalRecipients>}
|
|
47663
47992
|
* @memberof JsonApiAutomationPatchAttributes
|
|
47664
47993
|
*/
|
|
47665
|
-
externalRecipients?: Array<
|
|
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;
|
|
47994
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipients>;
|
|
47807
47995
|
}
|
|
47808
47996
|
|
|
47809
47997
|
export declare const JsonApiAutomationPatchAttributesStateEnum: {
|
|
@@ -47813,34 +48001,6 @@ export declare const JsonApiAutomationPatchAttributesStateEnum: {
|
|
|
47813
48001
|
|
|
47814
48002
|
export declare type JsonApiAutomationPatchAttributesStateEnum = typeof JsonApiAutomationPatchAttributesStateEnum[keyof typeof JsonApiAutomationPatchAttributesStateEnum];
|
|
47815
48003
|
|
|
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
|
-
|
|
47844
48004
|
/**
|
|
47845
48005
|
*
|
|
47846
48006
|
* @export
|
|
@@ -47863,84 +48023,28 @@ export declare interface JsonApiAutomationPatchDocument {
|
|
|
47863
48023
|
export declare interface JsonApiAutomationPatchRelationships {
|
|
47864
48024
|
/**
|
|
47865
48025
|
*
|
|
47866
|
-
* @type {
|
|
48026
|
+
* @type {JsonApiAutomationOutRelationshipsNotificationChannel}
|
|
47867
48027
|
* @memberof JsonApiAutomationPatchRelationships
|
|
47868
48028
|
*/
|
|
47869
|
-
notificationChannel?:
|
|
48029
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
47870
48030
|
/**
|
|
47871
48031
|
*
|
|
47872
|
-
* @type {
|
|
48032
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
47873
48033
|
* @memberof JsonApiAutomationPatchRelationships
|
|
47874
48034
|
*/
|
|
47875
|
-
analyticalDashboard?:
|
|
48035
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
47876
48036
|
/**
|
|
47877
48037
|
*
|
|
47878
|
-
* @type {
|
|
48038
|
+
* @type {JsonApiAutomationOutRelationshipsExportDefinitions}
|
|
47879
48039
|
* @memberof JsonApiAutomationPatchRelationships
|
|
47880
48040
|
*/
|
|
47881
|
-
exportDefinitions?:
|
|
48041
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
47882
48042
|
/**
|
|
47883
48043
|
*
|
|
47884
|
-
* @type {
|
|
48044
|
+
* @type {JsonApiAutomationOutRelationshipsRecipients}
|
|
47885
48045
|
* @memberof JsonApiAutomationPatchRelationships
|
|
47886
48046
|
*/
|
|
47887
|
-
recipients?:
|
|
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>;
|
|
48047
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
47944
48048
|
}
|
|
47945
48049
|
|
|
47946
48050
|
export declare const JsonApiAutomationPatchTypeEnum: {
|
|
@@ -47976,30 +48080,10 @@ export declare interface JsonApiColorPaletteIn {
|
|
|
47976
48080
|
id: string;
|
|
47977
48081
|
/**
|
|
47978
48082
|
*
|
|
47979
|
-
* @type {
|
|
48083
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
47980
48084
|
* @memberof JsonApiColorPaletteIn
|
|
47981
48085
|
*/
|
|
47982
|
-
attributes:
|
|
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;
|
|
48086
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
48003
48087
|
}
|
|
48004
48088
|
|
|
48005
48089
|
/**
|
|
@@ -48042,10 +48126,30 @@ export declare interface JsonApiColorPaletteOut {
|
|
|
48042
48126
|
id: string;
|
|
48043
48127
|
/**
|
|
48044
48128
|
*
|
|
48045
|
-
* @type {
|
|
48129
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
48046
48130
|
* @memberof JsonApiColorPaletteOut
|
|
48047
48131
|
*/
|
|
48048
|
-
attributes:
|
|
48132
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
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;
|
|
48049
48153
|
}
|
|
48050
48154
|
|
|
48051
48155
|
/**
|
|
@@ -48120,10 +48224,10 @@ export declare interface JsonApiColorPaletteOutWithLinks {
|
|
|
48120
48224
|
id: string;
|
|
48121
48225
|
/**
|
|
48122
48226
|
*
|
|
48123
|
-
* @type {
|
|
48227
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
48124
48228
|
* @memberof JsonApiColorPaletteOutWithLinks
|
|
48125
48229
|
*/
|
|
48126
|
-
attributes:
|
|
48230
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
48127
48231
|
/**
|
|
48128
48232
|
*
|
|
48129
48233
|
* @type {ObjectLinks}
|
|
@@ -48224,10 +48328,10 @@ export declare interface JsonApiCookieSecurityConfigurationIn {
|
|
|
48224
48328
|
id: string;
|
|
48225
48329
|
/**
|
|
48226
48330
|
*
|
|
48227
|
-
* @type {
|
|
48331
|
+
* @type {JsonApiCookieSecurityConfigurationPatchAttributes}
|
|
48228
48332
|
* @memberof JsonApiCookieSecurityConfigurationIn
|
|
48229
48333
|
*/
|
|
48230
|
-
attributes?:
|
|
48334
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
48231
48335
|
}
|
|
48232
48336
|
|
|
48233
48337
|
/**
|
|
@@ -48270,30 +48374,10 @@ export declare interface JsonApiCookieSecurityConfigurationOut {
|
|
|
48270
48374
|
id: string;
|
|
48271
48375
|
/**
|
|
48272
48376
|
*
|
|
48273
|
-
* @type {
|
|
48377
|
+
* @type {JsonApiCookieSecurityConfigurationPatchAttributes}
|
|
48274
48378
|
* @memberof JsonApiCookieSecurityConfigurationOut
|
|
48275
48379
|
*/
|
|
48276
|
-
attributes?:
|
|
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;
|
|
48380
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
48297
48381
|
}
|
|
48298
48382
|
|
|
48299
48383
|
/**
|
|
@@ -48342,10 +48426,30 @@ export declare interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
48342
48426
|
id: string;
|
|
48343
48427
|
/**
|
|
48344
48428
|
*
|
|
48345
|
-
* @type {
|
|
48429
|
+
* @type {JsonApiCookieSecurityConfigurationPatchAttributes}
|
|
48346
48430
|
* @memberof JsonApiCookieSecurityConfigurationPatch
|
|
48347
48431
|
*/
|
|
48348
|
-
attributes?:
|
|
48432
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
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;
|
|
48349
48453
|
}
|
|
48350
48454
|
|
|
48351
48455
|
/**
|
|
@@ -48388,24 +48492,10 @@ export declare interface JsonApiCspDirectiveIn {
|
|
|
48388
48492
|
id: string;
|
|
48389
48493
|
/**
|
|
48390
48494
|
*
|
|
48391
|
-
* @type {
|
|
48495
|
+
* @type {JsonApiCspDirectiveOutAttributes}
|
|
48392
48496
|
* @memberof JsonApiCspDirectiveIn
|
|
48393
48497
|
*/
|
|
48394
|
-
attributes:
|
|
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>;
|
|
48498
|
+
attributes: JsonApiCspDirectiveOutAttributes;
|
|
48409
48499
|
}
|
|
48410
48500
|
|
|
48411
48501
|
/**
|
|
@@ -48448,10 +48538,24 @@ export declare interface JsonApiCspDirectiveOut {
|
|
|
48448
48538
|
id: string;
|
|
48449
48539
|
/**
|
|
48450
48540
|
*
|
|
48451
|
-
* @type {
|
|
48541
|
+
* @type {JsonApiCspDirectiveOutAttributes}
|
|
48452
48542
|
* @memberof JsonApiCspDirectiveOut
|
|
48453
48543
|
*/
|
|
48454
|
-
attributes:
|
|
48544
|
+
attributes: JsonApiCspDirectiveOutAttributes;
|
|
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>;
|
|
48455
48559
|
}
|
|
48456
48560
|
|
|
48457
48561
|
/**
|
|
@@ -48526,10 +48630,10 @@ export declare interface JsonApiCspDirectiveOutWithLinks {
|
|
|
48526
48630
|
id: string;
|
|
48527
48631
|
/**
|
|
48528
48632
|
*
|
|
48529
|
-
* @type {
|
|
48633
|
+
* @type {JsonApiCspDirectiveOutAttributes}
|
|
48530
48634
|
* @memberof JsonApiCspDirectiveOutWithLinks
|
|
48531
48635
|
*/
|
|
48532
|
-
attributes:
|
|
48636
|
+
attributes: JsonApiCspDirectiveOutAttributes;
|
|
48533
48637
|
/**
|
|
48534
48638
|
*
|
|
48535
48639
|
* @type {ObjectLinks}
|
|
@@ -49458,6 +49562,12 @@ export declare interface JsonApiDatasetOutAttributes {
|
|
|
49458
49562
|
* @memberof JsonApiDatasetOutAttributes
|
|
49459
49563
|
*/
|
|
49460
49564
|
sql?: JsonApiDatasetOutAttributesSql;
|
|
49565
|
+
/**
|
|
49566
|
+
*
|
|
49567
|
+
* @type {number}
|
|
49568
|
+
* @memberof JsonApiDatasetOutAttributes
|
|
49569
|
+
*/
|
|
49570
|
+
precedence?: number;
|
|
49461
49571
|
/**
|
|
49462
49572
|
*
|
|
49463
49573
|
* @type {boolean}
|
|
@@ -49845,10 +49955,10 @@ export declare interface JsonApiDataSourceIdentifierOut {
|
|
|
49845
49955
|
id: string;
|
|
49846
49956
|
/**
|
|
49847
49957
|
*
|
|
49848
|
-
* @type {
|
|
49958
|
+
* @type {JsonApiDataSourceIdentifierOutMeta}
|
|
49849
49959
|
* @memberof JsonApiDataSourceIdentifierOut
|
|
49850
49960
|
*/
|
|
49851
|
-
meta?:
|
|
49961
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
49852
49962
|
/**
|
|
49853
49963
|
*
|
|
49854
49964
|
* @type {JsonApiDataSourceIdentifierOutAttributes}
|
|
@@ -49959,6 +50069,27 @@ export declare interface JsonApiDataSourceIdentifierOutList {
|
|
|
49959
50069
|
meta?: JsonApiApiTokenOutListMeta;
|
|
49960
50070
|
}
|
|
49961
50071
|
|
|
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
|
+
|
|
49962
50093
|
export declare const JsonApiDataSourceIdentifierOutTypeEnum: {
|
|
49963
50094
|
readonly DATA_SOURCE_IDENTIFIER: "dataSourceIdentifier";
|
|
49964
50095
|
};
|
|
@@ -49985,10 +50116,10 @@ export declare interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
|
49985
50116
|
id: string;
|
|
49986
50117
|
/**
|
|
49987
50118
|
*
|
|
49988
|
-
* @type {
|
|
50119
|
+
* @type {JsonApiDataSourceIdentifierOutMeta}
|
|
49989
50120
|
* @memberof JsonApiDataSourceIdentifierOutWithLinks
|
|
49990
50121
|
*/
|
|
49991
|
-
meta?:
|
|
50122
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
49992
50123
|
/**
|
|
49993
50124
|
*
|
|
49994
50125
|
* @type {JsonApiDataSourceIdentifierOutAttributes}
|
|
@@ -50109,10 +50240,10 @@ export declare interface JsonApiDataSourceInAttributes {
|
|
|
50109
50240
|
clientSecret?: string | null;
|
|
50110
50241
|
/**
|
|
50111
50242
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50112
|
-
* @type {Array<
|
|
50243
|
+
* @type {Array<JsonApiDataSourceOutAttributesParameters>}
|
|
50113
50244
|
* @memberof JsonApiDataSourceInAttributes
|
|
50114
50245
|
*/
|
|
50115
|
-
parameters?: Array<
|
|
50246
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParameters> | null;
|
|
50116
50247
|
/**
|
|
50117
50248
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50118
50249
|
* @type {string}
|
|
@@ -50128,26 +50259,6 @@ export declare const JsonApiDataSourceInAttributesCacheStrategyEnum: {
|
|
|
50128
50259
|
|
|
50129
50260
|
export declare type JsonApiDataSourceInAttributesCacheStrategyEnum = typeof JsonApiDataSourceInAttributesCacheStrategyEnum[keyof typeof JsonApiDataSourceInAttributesCacheStrategyEnum];
|
|
50130
50261
|
|
|
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
|
-
|
|
50151
50262
|
export declare const JsonApiDataSourceInAttributesTypeEnum: {
|
|
50152
50263
|
readonly POSTGRESQL: "POSTGRESQL";
|
|
50153
50264
|
readonly REDSHIFT: "REDSHIFT";
|
|
@@ -50218,10 +50329,10 @@ export declare interface JsonApiDataSourceOut {
|
|
|
50218
50329
|
id: string;
|
|
50219
50330
|
/**
|
|
50220
50331
|
*
|
|
50221
|
-
* @type {
|
|
50332
|
+
* @type {JsonApiDataSourceIdentifierOutMeta}
|
|
50222
50333
|
* @memberof JsonApiDataSourceOut
|
|
50223
50334
|
*/
|
|
50224
|
-
meta?:
|
|
50335
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
50225
50336
|
/**
|
|
50226
50337
|
*
|
|
50227
50338
|
* @type {JsonApiDataSourceOutAttributes}
|
|
@@ -50274,16 +50385,16 @@ export declare interface JsonApiDataSourceOutAttributes {
|
|
|
50274
50385
|
clientId?: string | null;
|
|
50275
50386
|
/**
|
|
50276
50387
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50277
|
-
* @type {Array<
|
|
50388
|
+
* @type {Array<JsonApiDataSourceOutAttributesParameters>}
|
|
50278
50389
|
* @memberof JsonApiDataSourceOutAttributes
|
|
50279
50390
|
*/
|
|
50280
|
-
parameters?: Array<
|
|
50391
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParameters> | null;
|
|
50281
50392
|
/**
|
|
50282
50393
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
50283
|
-
* @type {Array<
|
|
50394
|
+
* @type {Array<JsonApiDataSourceOutAttributesParameters>}
|
|
50284
50395
|
* @memberof JsonApiDataSourceOutAttributes
|
|
50285
50396
|
*/
|
|
50286
|
-
decodedParameters?: Array<
|
|
50397
|
+
decodedParameters?: Array<JsonApiDataSourceOutAttributesParameters> | null;
|
|
50287
50398
|
/**
|
|
50288
50399
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50289
50400
|
* @type {string}
|
|
@@ -50315,6 +50426,26 @@ export declare const JsonApiDataSourceOutAttributesCacheStrategyEnum: {
|
|
|
50315
50426
|
|
|
50316
50427
|
export declare type JsonApiDataSourceOutAttributesCacheStrategyEnum = typeof JsonApiDataSourceOutAttributesCacheStrategyEnum[keyof typeof JsonApiDataSourceOutAttributesCacheStrategyEnum];
|
|
50317
50428
|
|
|
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
|
+
|
|
50318
50449
|
export declare const JsonApiDataSourceOutAttributesTypeEnum: {
|
|
50319
50450
|
readonly POSTGRESQL: "POSTGRESQL";
|
|
50320
50451
|
readonly REDSHIFT: "REDSHIFT";
|
|
@@ -50391,27 +50522,6 @@ export declare interface JsonApiDataSourceOutList {
|
|
|
50391
50522
|
meta?: JsonApiApiTokenOutListMeta;
|
|
50392
50523
|
}
|
|
50393
50524
|
|
|
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
|
-
|
|
50415
50525
|
export declare const JsonApiDataSourceOutTypeEnum: {
|
|
50416
50526
|
readonly DATA_SOURCE: "dataSource";
|
|
50417
50527
|
};
|
|
@@ -50438,10 +50548,10 @@ export declare interface JsonApiDataSourceOutWithLinks {
|
|
|
50438
50548
|
id: string;
|
|
50439
50549
|
/**
|
|
50440
50550
|
*
|
|
50441
|
-
* @type {
|
|
50551
|
+
* @type {JsonApiDataSourceIdentifierOutMeta}
|
|
50442
50552
|
* @memberof JsonApiDataSourceOutWithLinks
|
|
50443
50553
|
*/
|
|
50444
|
-
meta?:
|
|
50554
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
50445
50555
|
/**
|
|
50446
50556
|
*
|
|
50447
50557
|
* @type {JsonApiDataSourceOutAttributes}
|
|
@@ -50562,10 +50672,10 @@ export declare interface JsonApiDataSourcePatchAttributes {
|
|
|
50562
50672
|
clientSecret?: string | null;
|
|
50563
50673
|
/**
|
|
50564
50674
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50565
|
-
* @type {Array<
|
|
50675
|
+
* @type {Array<JsonApiDataSourceOutAttributesParameters>}
|
|
50566
50676
|
* @memberof JsonApiDataSourcePatchAttributes
|
|
50567
50677
|
*/
|
|
50568
|
-
parameters?: Array<
|
|
50678
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParameters> | null;
|
|
50569
50679
|
/**
|
|
50570
50680
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50571
50681
|
* @type {string}
|
|
@@ -51011,10 +51121,10 @@ export declare interface JsonApiExportDefinitionOutRelationships {
|
|
|
51011
51121
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
51012
51122
|
/**
|
|
51013
51123
|
*
|
|
51014
|
-
* @type {
|
|
51124
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
51015
51125
|
* @memberof JsonApiExportDefinitionOutRelationships
|
|
51016
51126
|
*/
|
|
51017
|
-
analyticalDashboard?:
|
|
51127
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
51018
51128
|
/**
|
|
51019
51129
|
*
|
|
51020
51130
|
* @type {JsonApiExportDefinitionOutRelationshipsAutomation}
|
|
@@ -51035,6 +51145,20 @@ export declare interface JsonApiExportDefinitionOutRelationships {
|
|
|
51035
51145
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
51036
51146
|
}
|
|
51037
51147
|
|
|
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
|
+
|
|
51038
51162
|
/**
|
|
51039
51163
|
*
|
|
51040
51164
|
* @export
|
|
@@ -51217,10 +51341,10 @@ export declare interface JsonApiExportDefinitionPatchRelationships {
|
|
|
51217
51341
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
51218
51342
|
/**
|
|
51219
51343
|
*
|
|
51220
|
-
* @type {
|
|
51344
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
51221
51345
|
* @memberof JsonApiExportDefinitionPatchRelationships
|
|
51222
51346
|
*/
|
|
51223
|
-
analyticalDashboard?:
|
|
51347
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
51224
51348
|
}
|
|
51225
51349
|
|
|
51226
51350
|
export declare const JsonApiExportDefinitionPatchTypeEnum: {
|
|
@@ -51301,10 +51425,10 @@ export declare interface JsonApiExportTemplateIn {
|
|
|
51301
51425
|
id: string;
|
|
51302
51426
|
/**
|
|
51303
51427
|
*
|
|
51304
|
-
* @type {
|
|
51428
|
+
* @type {JsonApiExportTemplateOutAttributes}
|
|
51305
51429
|
* @memberof JsonApiExportTemplateIn
|
|
51306
51430
|
*/
|
|
51307
|
-
attributes:
|
|
51431
|
+
attributes: JsonApiExportTemplateOutAttributes;
|
|
51308
51432
|
}
|
|
51309
51433
|
|
|
51310
51434
|
/**
|
|
@@ -51347,12 +51471,110 @@ export declare interface JsonApiExportTemplateOut {
|
|
|
51347
51471
|
id: string;
|
|
51348
51472
|
/**
|
|
51349
51473
|
*
|
|
51350
|
-
* @type {
|
|
51474
|
+
* @type {JsonApiExportTemplateOutAttributes}
|
|
51351
51475
|
* @memberof JsonApiExportTemplateOut
|
|
51352
51476
|
*/
|
|
51353
|
-
attributes:
|
|
51477
|
+
attributes: JsonApiExportTemplateOutAttributes;
|
|
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;
|
|
51354
51542
|
}
|
|
51355
51543
|
|
|
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
|
+
|
|
51356
51578
|
/**
|
|
51357
51579
|
*
|
|
51358
51580
|
* @export
|
|
@@ -51425,10 +51647,10 @@ export declare interface JsonApiExportTemplateOutWithLinks {
|
|
|
51425
51647
|
id: string;
|
|
51426
51648
|
/**
|
|
51427
51649
|
*
|
|
51428
|
-
* @type {
|
|
51650
|
+
* @type {JsonApiExportTemplateOutAttributes}
|
|
51429
51651
|
* @memberof JsonApiExportTemplateOutWithLinks
|
|
51430
51652
|
*/
|
|
51431
|
-
attributes:
|
|
51653
|
+
attributes: JsonApiExportTemplateOutAttributes;
|
|
51432
51654
|
/**
|
|
51433
51655
|
*
|
|
51434
51656
|
* @type {ObjectLinks}
|
|
@@ -51483,16 +51705,16 @@ export declare interface JsonApiExportTemplatePatchAttributes {
|
|
|
51483
51705
|
name?: string;
|
|
51484
51706
|
/**
|
|
51485
51707
|
*
|
|
51486
|
-
* @type {
|
|
51708
|
+
* @type {JsonApiExportTemplateOutAttributesDashboardSlidesTemplate}
|
|
51487
51709
|
* @memberof JsonApiExportTemplatePatchAttributes
|
|
51488
51710
|
*/
|
|
51489
|
-
dashboardSlidesTemplate?:
|
|
51711
|
+
dashboardSlidesTemplate?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
51490
51712
|
/**
|
|
51491
51713
|
*
|
|
51492
|
-
* @type {
|
|
51714
|
+
* @type {JsonApiExportTemplateOutAttributesWidgetSlidesTemplate}
|
|
51493
51715
|
* @memberof JsonApiExportTemplatePatchAttributes
|
|
51494
51716
|
*/
|
|
51495
|
-
widgetSlidesTemplate?:
|
|
51717
|
+
widgetSlidesTemplate?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
51496
51718
|
}
|
|
51497
51719
|
|
|
51498
51720
|
/**
|
|
@@ -51535,110 +51757,12 @@ export declare interface JsonApiExportTemplatePostOptionalId {
|
|
|
51535
51757
|
id?: string;
|
|
51536
51758
|
/**
|
|
51537
51759
|
*
|
|
51538
|
-
* @type {
|
|
51760
|
+
* @type {JsonApiExportTemplateOutAttributes}
|
|
51539
51761
|
* @memberof JsonApiExportTemplatePostOptionalId
|
|
51540
51762
|
*/
|
|
51541
|
-
attributes:
|
|
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;
|
|
51763
|
+
attributes: JsonApiExportTemplateOutAttributes;
|
|
51606
51764
|
}
|
|
51607
51765
|
|
|
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
|
-
|
|
51642
51766
|
/**
|
|
51643
51767
|
*
|
|
51644
51768
|
* @export
|
|
@@ -51765,8 +51889,22 @@ export declare interface JsonApiFactOutAttributes {
|
|
|
51765
51889
|
* @memberof JsonApiFactOutAttributes
|
|
51766
51890
|
*/
|
|
51767
51891
|
areRelationsValid?: boolean;
|
|
51892
|
+
/**
|
|
51893
|
+
*
|
|
51894
|
+
* @type {string}
|
|
51895
|
+
* @memberof JsonApiFactOutAttributes
|
|
51896
|
+
*/
|
|
51897
|
+
operation?: JsonApiFactOutAttributesOperationEnum;
|
|
51768
51898
|
}
|
|
51769
51899
|
|
|
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
|
+
|
|
51770
51908
|
export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
51771
51909
|
readonly INT: "INT";
|
|
51772
51910
|
readonly STRING: "STRING";
|
|
@@ -51799,12 +51937,18 @@ export declare interface JsonApiFactOutDocument {
|
|
|
51799
51937
|
links?: ObjectLinks;
|
|
51800
51938
|
/**
|
|
51801
51939
|
* Included resources
|
|
51802
|
-
* @type {Array<
|
|
51940
|
+
* @type {Array<JsonApiFactOutIncludes>}
|
|
51803
51941
|
* @memberof JsonApiFactOutDocument
|
|
51804
51942
|
*/
|
|
51805
|
-
included?: Array<
|
|
51943
|
+
included?: Array<JsonApiFactOutIncludes>;
|
|
51806
51944
|
}
|
|
51807
51945
|
|
|
51946
|
+
/**
|
|
51947
|
+
* @type JsonApiFactOutIncludes
|
|
51948
|
+
* @export
|
|
51949
|
+
*/
|
|
51950
|
+
export declare type JsonApiFactOutIncludes = JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks;
|
|
51951
|
+
|
|
51808
51952
|
/**
|
|
51809
51953
|
* A JSON:API document with a list of resources
|
|
51810
51954
|
* @export
|
|
@@ -51831,10 +51975,10 @@ export declare interface JsonApiFactOutList {
|
|
|
51831
51975
|
meta?: JsonApiApiTokenOutListMeta;
|
|
51832
51976
|
/**
|
|
51833
51977
|
* Included resources
|
|
51834
|
-
* @type {Array<
|
|
51978
|
+
* @type {Array<JsonApiFactOutIncludes>}
|
|
51835
51979
|
* @memberof JsonApiFactOutList
|
|
51836
51980
|
*/
|
|
51837
|
-
included?: Array<
|
|
51981
|
+
included?: Array<JsonApiFactOutIncludes>;
|
|
51838
51982
|
}
|
|
51839
51983
|
|
|
51840
51984
|
/**
|
|
@@ -51849,6 +51993,26 @@ export declare interface JsonApiFactOutRelationships {
|
|
|
51849
51993
|
* @memberof JsonApiFactOutRelationships
|
|
51850
51994
|
*/
|
|
51851
51995
|
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;
|
|
51852
52016
|
}
|
|
51853
52017
|
|
|
51854
52018
|
export declare const JsonApiFactOutTypeEnum: {
|
|
@@ -51907,6 +52071,13 @@ export declare const JsonApiFactOutWithLinksTypeEnum: {
|
|
|
51907
52071
|
|
|
51908
52072
|
export declare type JsonApiFactOutWithLinksTypeEnum = typeof JsonApiFactOutWithLinksTypeEnum[keyof typeof JsonApiFactOutWithLinksTypeEnum];
|
|
51909
52073
|
|
|
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
|
+
|
|
51910
52081
|
/**
|
|
51911
52082
|
* JSON:API representation of filterContext entity.
|
|
51912
52083
|
* @export
|
|
@@ -52319,10 +52490,10 @@ export declare interface JsonApiFilterViewIn {
|
|
|
52319
52490
|
attributes: JsonApiFilterViewOutAttributes;
|
|
52320
52491
|
/**
|
|
52321
52492
|
*
|
|
52322
|
-
* @type {
|
|
52493
|
+
* @type {JsonApiFilterViewOutRelationships}
|
|
52323
52494
|
* @memberof JsonApiFilterViewIn
|
|
52324
52495
|
*/
|
|
52325
|
-
relationships?:
|
|
52496
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
52326
52497
|
}
|
|
52327
52498
|
|
|
52328
52499
|
/**
|
|
@@ -52371,10 +52542,10 @@ export declare interface JsonApiFilterViewOut {
|
|
|
52371
52542
|
attributes: JsonApiFilterViewOutAttributes;
|
|
52372
52543
|
/**
|
|
52373
52544
|
*
|
|
52374
|
-
* @type {
|
|
52545
|
+
* @type {JsonApiFilterViewOutRelationships}
|
|
52375
52546
|
* @memberof JsonApiFilterViewOut
|
|
52376
52547
|
*/
|
|
52377
|
-
relationships?:
|
|
52548
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
52378
52549
|
}
|
|
52379
52550
|
|
|
52380
52551
|
/**
|
|
@@ -52485,6 +52656,26 @@ export declare interface JsonApiFilterViewOutList {
|
|
|
52485
52656
|
included?: Array<JsonApiFilterViewOutIncludes>;
|
|
52486
52657
|
}
|
|
52487
52658
|
|
|
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
|
+
|
|
52488
52679
|
export declare const JsonApiFilterViewOutTypeEnum: {
|
|
52489
52680
|
readonly FILTER_VIEW: "filterView";
|
|
52490
52681
|
};
|
|
@@ -52517,10 +52708,10 @@ export declare interface JsonApiFilterViewOutWithLinks {
|
|
|
52517
52708
|
attributes: JsonApiFilterViewOutAttributes;
|
|
52518
52709
|
/**
|
|
52519
52710
|
*
|
|
52520
|
-
* @type {
|
|
52711
|
+
* @type {JsonApiFilterViewOutRelationships}
|
|
52521
52712
|
* @memberof JsonApiFilterViewOutWithLinks
|
|
52522
52713
|
*/
|
|
52523
|
-
relationships?:
|
|
52714
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
52524
52715
|
/**
|
|
52525
52716
|
*
|
|
52526
52717
|
* @type {ObjectLinks}
|
|
@@ -52561,10 +52752,10 @@ export declare interface JsonApiFilterViewPatch {
|
|
|
52561
52752
|
attributes: JsonApiFilterViewPatchAttributes;
|
|
52562
52753
|
/**
|
|
52563
52754
|
*
|
|
52564
|
-
* @type {
|
|
52755
|
+
* @type {JsonApiFilterViewOutRelationships}
|
|
52565
52756
|
* @memberof JsonApiFilterViewPatch
|
|
52566
52757
|
*/
|
|
52567
|
-
relationships?:
|
|
52758
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
52568
52759
|
}
|
|
52569
52760
|
|
|
52570
52761
|
/**
|
|
@@ -52625,40 +52816,6 @@ export declare interface JsonApiFilterViewPatchDocument {
|
|
|
52625
52816
|
data: JsonApiFilterViewPatch;
|
|
52626
52817
|
}
|
|
52627
52818
|
|
|
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
|
-
|
|
52662
52819
|
export declare const JsonApiFilterViewPatchTypeEnum: {
|
|
52663
52820
|
readonly FILTER_VIEW: "filterView";
|
|
52664
52821
|
};
|
|
@@ -52690,82 +52847,10 @@ export declare interface JsonApiIdentityProviderIn {
|
|
|
52690
52847
|
id: string;
|
|
52691
52848
|
/**
|
|
52692
52849
|
*
|
|
52693
|
-
* @type {
|
|
52850
|
+
* @type {JsonApiIdentityProviderPatchAttributes}
|
|
52694
52851
|
* @memberof JsonApiIdentityProviderIn
|
|
52695
52852
|
*/
|
|
52696
|
-
attributes
|
|
52697
|
-
}
|
|
52698
|
-
|
|
52699
|
-
/**
|
|
52700
|
-
*
|
|
52701
|
-
* @export
|
|
52702
|
-
* @interface JsonApiIdentityProviderInAttributes
|
|
52703
|
-
*/
|
|
52704
|
-
export declare interface JsonApiIdentityProviderInAttributes {
|
|
52705
|
-
/**
|
|
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
|
|
52709
|
-
*/
|
|
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;
|
|
52853
|
+
attributes?: JsonApiIdentityProviderPatchAttributes;
|
|
52769
52854
|
}
|
|
52770
52855
|
|
|
52771
52856
|
/**
|
|
@@ -52788,6 +52873,32 @@ export declare const JsonApiIdentityProviderInTypeEnum: {
|
|
|
52788
52873
|
|
|
52789
52874
|
export declare type JsonApiIdentityProviderInTypeEnum = typeof JsonApiIdentityProviderInTypeEnum[keyof typeof JsonApiIdentityProviderInTypeEnum];
|
|
52790
52875
|
|
|
52876
|
+
/**
|
|
52877
|
+
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
52878
|
+
* @export
|
|
52879
|
+
* @interface JsonApiIdentityProviderLinkage
|
|
52880
|
+
*/
|
|
52881
|
+
export declare interface JsonApiIdentityProviderLinkage {
|
|
52882
|
+
/**
|
|
52883
|
+
*
|
|
52884
|
+
* @type {string}
|
|
52885
|
+
* @memberof JsonApiIdentityProviderLinkage
|
|
52886
|
+
*/
|
|
52887
|
+
id: string;
|
|
52888
|
+
/**
|
|
52889
|
+
*
|
|
52890
|
+
* @type {string}
|
|
52891
|
+
* @memberof JsonApiIdentityProviderLinkage
|
|
52892
|
+
*/
|
|
52893
|
+
type: JsonApiIdentityProviderLinkageTypeEnum;
|
|
52894
|
+
}
|
|
52895
|
+
|
|
52896
|
+
export declare const JsonApiIdentityProviderLinkageTypeEnum: {
|
|
52897
|
+
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
52898
|
+
};
|
|
52899
|
+
|
|
52900
|
+
export declare type JsonApiIdentityProviderLinkageTypeEnum = typeof JsonApiIdentityProviderLinkageTypeEnum[keyof typeof JsonApiIdentityProviderLinkageTypeEnum];
|
|
52901
|
+
|
|
52791
52902
|
/**
|
|
52792
52903
|
* JSON:API representation of identityProvider entity.
|
|
52793
52904
|
* @export
|
|
@@ -52811,7 +52922,7 @@ export declare interface JsonApiIdentityProviderOut {
|
|
|
52811
52922
|
* @type {JsonApiIdentityProviderOutAttributes}
|
|
52812
52923
|
* @memberof JsonApiIdentityProviderOut
|
|
52813
52924
|
*/
|
|
52814
|
-
attributes
|
|
52925
|
+
attributes?: JsonApiIdentityProviderOutAttributes;
|
|
52815
52926
|
}
|
|
52816
52927
|
|
|
52817
52928
|
/**
|
|
@@ -52821,11 +52932,11 @@ export declare interface JsonApiIdentityProviderOut {
|
|
|
52821
52932
|
*/
|
|
52822
52933
|
export declare interface JsonApiIdentityProviderOutAttributes {
|
|
52823
52934
|
/**
|
|
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.
|
|
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.
|
|
52825
52936
|
* @type {Array<string>}
|
|
52826
52937
|
* @memberof JsonApiIdentityProviderOutAttributes
|
|
52827
52938
|
*/
|
|
52828
|
-
identifiers
|
|
52939
|
+
identifiers?: Array<string>;
|
|
52829
52940
|
/**
|
|
52830
52941
|
* 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.
|
|
52831
52942
|
* @type {{ [key: string]: string; }}
|
|
@@ -52872,8 +52983,22 @@ export declare interface JsonApiIdentityProviderOutAttributes {
|
|
|
52872
52983
|
* @memberof JsonApiIdentityProviderOutAttributes
|
|
52873
52984
|
*/
|
|
52874
52985
|
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;
|
|
52875
52992
|
}
|
|
52876
52993
|
|
|
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
|
+
|
|
52877
53002
|
/**
|
|
52878
53003
|
*
|
|
52879
53004
|
* @export
|
|
@@ -52949,7 +53074,7 @@ export declare interface JsonApiIdentityProviderOutWithLinks {
|
|
|
52949
53074
|
* @type {JsonApiIdentityProviderOutAttributes}
|
|
52950
53075
|
* @memberof JsonApiIdentityProviderOutWithLinks
|
|
52951
53076
|
*/
|
|
52952
|
-
attributes
|
|
53077
|
+
attributes?: JsonApiIdentityProviderOutAttributes;
|
|
52953
53078
|
/**
|
|
52954
53079
|
*
|
|
52955
53080
|
* @type {ObjectLinks}
|
|
@@ -52987,7 +53112,7 @@ export declare interface JsonApiIdentityProviderPatch {
|
|
|
52987
53112
|
* @type {JsonApiIdentityProviderPatchAttributes}
|
|
52988
53113
|
* @memberof JsonApiIdentityProviderPatch
|
|
52989
53114
|
*/
|
|
52990
|
-
attributes
|
|
53115
|
+
attributes?: JsonApiIdentityProviderPatchAttributes;
|
|
52991
53116
|
}
|
|
52992
53117
|
|
|
52993
53118
|
/**
|
|
@@ -52997,7 +53122,7 @@ export declare interface JsonApiIdentityProviderPatch {
|
|
|
52997
53122
|
*/
|
|
52998
53123
|
export declare interface JsonApiIdentityProviderPatchAttributes {
|
|
52999
53124
|
/**
|
|
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.
|
|
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.
|
|
53001
53126
|
* @type {Array<string>}
|
|
53002
53127
|
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
53003
53128
|
*/
|
|
@@ -53060,8 +53185,22 @@ export declare interface JsonApiIdentityProviderPatchAttributes {
|
|
|
53060
53185
|
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
53061
53186
|
*/
|
|
53062
53187
|
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;
|
|
53063
53194
|
}
|
|
53064
53195
|
|
|
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
|
+
|
|
53065
53204
|
/**
|
|
53066
53205
|
*
|
|
53067
53206
|
* @export
|
|
@@ -53082,6 +53221,13 @@ export declare const JsonApiIdentityProviderPatchTypeEnum: {
|
|
|
53082
53221
|
|
|
53083
53222
|
export declare type JsonApiIdentityProviderPatchTypeEnum = typeof JsonApiIdentityProviderPatchTypeEnum[keyof typeof JsonApiIdentityProviderPatchTypeEnum];
|
|
53084
53223
|
|
|
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
|
+
|
|
53085
53231
|
/**
|
|
53086
53232
|
* JSON:API representation of jwk entity.
|
|
53087
53233
|
* @export
|
|
@@ -53102,24 +53248,10 @@ export declare interface JsonApiJwkIn {
|
|
|
53102
53248
|
id: string;
|
|
53103
53249
|
/**
|
|
53104
53250
|
*
|
|
53105
|
-
* @type {
|
|
53251
|
+
* @type {JsonApiJwkOutAttributes}
|
|
53106
53252
|
* @memberof JsonApiJwkIn
|
|
53107
53253
|
*/
|
|
53108
|
-
attributes?:
|
|
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;
|
|
53254
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
53123
53255
|
}
|
|
53124
53256
|
|
|
53125
53257
|
/**
|
|
@@ -53162,10 +53294,24 @@ export declare interface JsonApiJwkOut {
|
|
|
53162
53294
|
id: string;
|
|
53163
53295
|
/**
|
|
53164
53296
|
*
|
|
53165
|
-
* @type {
|
|
53297
|
+
* @type {JsonApiJwkOutAttributes}
|
|
53166
53298
|
* @memberof JsonApiJwkOut
|
|
53167
53299
|
*/
|
|
53168
|
-
attributes?:
|
|
53300
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
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;
|
|
53169
53315
|
}
|
|
53170
53316
|
|
|
53171
53317
|
/**
|
|
@@ -53240,10 +53386,10 @@ export declare interface JsonApiJwkOutWithLinks {
|
|
|
53240
53386
|
id: string;
|
|
53241
53387
|
/**
|
|
53242
53388
|
*
|
|
53243
|
-
* @type {
|
|
53389
|
+
* @type {JsonApiJwkOutAttributes}
|
|
53244
53390
|
* @memberof JsonApiJwkOutWithLinks
|
|
53245
53391
|
*/
|
|
53246
|
-
attributes?:
|
|
53392
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
53247
53393
|
/**
|
|
53248
53394
|
*
|
|
53249
53395
|
* @type {ObjectLinks}
|
|
@@ -53278,10 +53424,10 @@ export declare interface JsonApiJwkPatch {
|
|
|
53278
53424
|
id: string;
|
|
53279
53425
|
/**
|
|
53280
53426
|
*
|
|
53281
|
-
* @type {
|
|
53427
|
+
* @type {JsonApiJwkOutAttributes}
|
|
53282
53428
|
* @memberof JsonApiJwkPatch
|
|
53283
53429
|
*/
|
|
53284
|
-
attributes?:
|
|
53430
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
53285
53431
|
}
|
|
53286
53432
|
|
|
53287
53433
|
/**
|
|
@@ -54601,10 +54747,10 @@ export declare interface JsonApiNotificationChannelIn {
|
|
|
54601
54747
|
id: string;
|
|
54602
54748
|
/**
|
|
54603
54749
|
*
|
|
54604
|
-
* @type {
|
|
54750
|
+
* @type {JsonApiNotificationChannelPatchAttributes}
|
|
54605
54751
|
* @memberof JsonApiNotificationChannelIn
|
|
54606
54752
|
*/
|
|
54607
|
-
attributes?:
|
|
54753
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
54608
54754
|
}
|
|
54609
54755
|
|
|
54610
54756
|
/**
|
|
@@ -54883,136 +55029,136 @@ export declare interface JsonApiNotificationChannelPatch {
|
|
|
54883
55029
|
id: string;
|
|
54884
55030
|
/**
|
|
54885
55031
|
*
|
|
54886
|
-
* @type {
|
|
55032
|
+
* @type {JsonApiNotificationChannelPatchAttributes}
|
|
54887
55033
|
* @memberof JsonApiNotificationChannelPatch
|
|
54888
55034
|
*/
|
|
54889
|
-
attributes?:
|
|
55035
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
54890
55036
|
}
|
|
54891
55037
|
|
|
54892
55038
|
/**
|
|
54893
55039
|
*
|
|
54894
55040
|
* @export
|
|
54895
|
-
* @interface
|
|
55041
|
+
* @interface JsonApiNotificationChannelPatchAttributes
|
|
54896
55042
|
*/
|
|
54897
|
-
export declare interface
|
|
55043
|
+
export declare interface JsonApiNotificationChannelPatchAttributes {
|
|
54898
55044
|
/**
|
|
54899
55045
|
*
|
|
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
|
|
54920
55046
|
* @type {string}
|
|
54921
|
-
* @memberof
|
|
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
|
|
55047
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
54948
55048
|
*/
|
|
54949
55049
|
name?: string | null;
|
|
54950
55050
|
/**
|
|
54951
55051
|
*
|
|
54952
55052
|
* @type {string}
|
|
54953
|
-
* @memberof
|
|
55053
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
54954
55054
|
*/
|
|
54955
55055
|
description?: string | null;
|
|
54956
55056
|
/**
|
|
54957
55057
|
* The destination where the notifications are to be sent.
|
|
54958
55058
|
* @type {DefaultSmtp | InPlatform | Smtp | Webhook}
|
|
54959
|
-
* @memberof
|
|
55059
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
54960
55060
|
*/
|
|
54961
55061
|
destination?: DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
54962
55062
|
/**
|
|
54963
55063
|
* 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}
|
|
54964
55064
|
* @type {string}
|
|
54965
|
-
* @memberof
|
|
55065
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
54966
55066
|
*/
|
|
54967
55067
|
customDashboardUrl?: string;
|
|
54968
55068
|
/**
|
|
54969
55069
|
* 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
|
|
54970
55070
|
* @type {string}
|
|
54971
|
-
* @memberof
|
|
55071
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
54972
55072
|
*/
|
|
54973
|
-
dashboardLinkVisibility?:
|
|
55073
|
+
dashboardLinkVisibility?: JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum;
|
|
54974
55074
|
/**
|
|
54975
55075
|
* 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}}
|
|
54976
55076
|
* @type {string}
|
|
54977
|
-
* @memberof
|
|
55077
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
54978
55078
|
*/
|
|
54979
55079
|
notificationSource?: string;
|
|
54980
55080
|
/**
|
|
54981
55081
|
* 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
|
|
54982
55082
|
* @type {string}
|
|
54983
|
-
* @memberof
|
|
55083
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
54984
55084
|
*/
|
|
54985
|
-
allowedRecipients?:
|
|
55085
|
+
allowedRecipients?: JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum;
|
|
54986
55086
|
/**
|
|
54987
55087
|
* 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
|
|
54988
55088
|
* @type {string}
|
|
54989
|
-
* @memberof
|
|
55089
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
54990
55090
|
*/
|
|
54991
|
-
inPlatformNotification?:
|
|
55091
|
+
inPlatformNotification?: JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum;
|
|
54992
55092
|
}
|
|
54993
55093
|
|
|
54994
|
-
export declare const
|
|
55094
|
+
export declare const JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum: {
|
|
54995
55095
|
readonly CREATOR: "CREATOR";
|
|
54996
55096
|
readonly INTERNAL: "INTERNAL";
|
|
54997
55097
|
readonly EXTERNAL: "EXTERNAL";
|
|
54998
55098
|
};
|
|
54999
55099
|
|
|
55000
|
-
export declare type
|
|
55100
|
+
export declare type JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum = typeof JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum[keyof typeof JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum];
|
|
55001
55101
|
|
|
55002
|
-
export declare const
|
|
55102
|
+
export declare const JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum: {
|
|
55003
55103
|
readonly HIDDEN: "HIDDEN";
|
|
55004
55104
|
readonly INTERNAL_ONLY: "INTERNAL_ONLY";
|
|
55005
55105
|
readonly ALL: "ALL";
|
|
55006
55106
|
};
|
|
55007
55107
|
|
|
55008
|
-
export declare type
|
|
55108
|
+
export declare type JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum = typeof JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum[keyof typeof JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum];
|
|
55009
55109
|
|
|
55010
|
-
export declare const
|
|
55110
|
+
export declare const JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum: {
|
|
55011
55111
|
readonly DISABLED: "DISABLED";
|
|
55012
55112
|
readonly ENABLED: "ENABLED";
|
|
55013
55113
|
};
|
|
55014
55114
|
|
|
55015
|
-
export declare type
|
|
55115
|
+
export declare type JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum = typeof JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum[keyof typeof JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum];
|
|
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
|
+
}
|
|
55016
55162
|
|
|
55017
55163
|
/**
|
|
55018
55164
|
*
|
|
@@ -55061,93 +55207,16 @@ export declare interface JsonApiOrganizationIn {
|
|
|
55061
55207
|
id: string;
|
|
55062
55208
|
/**
|
|
55063
55209
|
*
|
|
55064
|
-
* @type {
|
|
55210
|
+
* @type {JsonApiOrganizationPatchAttributes}
|
|
55065
55211
|
* @memberof JsonApiOrganizationIn
|
|
55066
55212
|
*/
|
|
55067
|
-
attributes?:
|
|
55068
|
-
}
|
|
55069
|
-
|
|
55070
|
-
/**
|
|
55071
|
-
*
|
|
55072
|
-
* @export
|
|
55073
|
-
* @interface JsonApiOrganizationInAttributes
|
|
55074
|
-
*/
|
|
55075
|
-
export declare interface JsonApiOrganizationInAttributes {
|
|
55076
|
-
/**
|
|
55077
|
-
*
|
|
55078
|
-
* @type {string}
|
|
55079
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
55080
|
-
*/
|
|
55081
|
-
name?: string | null;
|
|
55213
|
+
attributes?: JsonApiOrganizationPatchAttributes;
|
|
55082
55214
|
/**
|
|
55083
55215
|
*
|
|
55084
|
-
* @type {
|
|
55085
|
-
* @memberof
|
|
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
|
|
55123
|
-
*/
|
|
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
|
|
55216
|
+
* @type {JsonApiOrganizationPatchRelationships}
|
|
55217
|
+
* @memberof JsonApiOrganizationIn
|
|
55149
55218
|
*/
|
|
55150
|
-
|
|
55219
|
+
relationships?: JsonApiOrganizationPatchRelationships;
|
|
55151
55220
|
}
|
|
55152
55221
|
|
|
55153
55222
|
/**
|
|
@@ -55348,7 +55417,7 @@ export declare interface JsonApiOrganizationOutDocument {
|
|
|
55348
55417
|
* @type JsonApiOrganizationOutIncludes
|
|
55349
55418
|
* @export
|
|
55350
55419
|
*/
|
|
55351
|
-
export declare type JsonApiOrganizationOutIncludes = JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
55420
|
+
export declare type JsonApiOrganizationOutIncludes = JsonApiIdentityProviderOutWithLinks | JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
55352
55421
|
|
|
55353
55422
|
/**
|
|
55354
55423
|
*
|
|
@@ -55379,16 +55448,50 @@ export declare type JsonApiOrganizationOutMetaPermissionsEnum = typeof JsonApiOr
|
|
|
55379
55448
|
export declare interface JsonApiOrganizationOutRelationships {
|
|
55380
55449
|
/**
|
|
55381
55450
|
*
|
|
55382
|
-
* @type {
|
|
55451
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
55383
55452
|
* @memberof JsonApiOrganizationOutRelationships
|
|
55384
55453
|
*/
|
|
55385
|
-
bootstrapUser?:
|
|
55454
|
+
bootstrapUser?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
55386
55455
|
/**
|
|
55387
55456
|
*
|
|
55388
|
-
* @type {
|
|
55457
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
55389
55458
|
* @memberof JsonApiOrganizationOutRelationships
|
|
55390
55459
|
*/
|
|
55391
|
-
bootstrapUserGroup?:
|
|
55460
|
+
bootstrapUserGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
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;
|
|
55392
55495
|
}
|
|
55393
55496
|
|
|
55394
55497
|
export declare const JsonApiOrganizationOutTypeEnum: {
|
|
@@ -55417,10 +55520,99 @@ export declare interface JsonApiOrganizationPatch {
|
|
|
55417
55520
|
id: string;
|
|
55418
55521
|
/**
|
|
55419
55522
|
*
|
|
55420
|
-
* @type {
|
|
55523
|
+
* @type {JsonApiOrganizationPatchAttributes}
|
|
55524
|
+
* @memberof JsonApiOrganizationPatch
|
|
55525
|
+
*/
|
|
55526
|
+
attributes?: JsonApiOrganizationPatchAttributes;
|
|
55527
|
+
/**
|
|
55528
|
+
*
|
|
55529
|
+
* @type {JsonApiOrganizationPatchRelationships}
|
|
55421
55530
|
* @memberof JsonApiOrganizationPatch
|
|
55422
55531
|
*/
|
|
55423
|
-
|
|
55532
|
+
relationships?: JsonApiOrganizationPatchRelationships;
|
|
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;
|
|
55424
55616
|
}
|
|
55425
55617
|
|
|
55426
55618
|
/**
|
|
@@ -55437,6 +55629,34 @@ export declare interface JsonApiOrganizationPatchDocument {
|
|
|
55437
55629
|
data: JsonApiOrganizationPatch;
|
|
55438
55630
|
}
|
|
55439
55631
|
|
|
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
|
+
|
|
55440
55660
|
export declare const JsonApiOrganizationPatchTypeEnum: {
|
|
55441
55661
|
readonly ORGANIZATION: "organization";
|
|
55442
55662
|
};
|
|
@@ -55671,10 +55891,10 @@ export declare interface JsonApiThemeIn {
|
|
|
55671
55891
|
id: string;
|
|
55672
55892
|
/**
|
|
55673
55893
|
*
|
|
55674
|
-
* @type {
|
|
55894
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
55675
55895
|
* @memberof JsonApiThemeIn
|
|
55676
55896
|
*/
|
|
55677
|
-
attributes:
|
|
55897
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
55678
55898
|
}
|
|
55679
55899
|
|
|
55680
55900
|
/**
|
|
@@ -55717,10 +55937,10 @@ export declare interface JsonApiThemeOut {
|
|
|
55717
55937
|
id: string;
|
|
55718
55938
|
/**
|
|
55719
55939
|
*
|
|
55720
|
-
* @type {
|
|
55940
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
55721
55941
|
* @memberof JsonApiThemeOut
|
|
55722
55942
|
*/
|
|
55723
|
-
attributes:
|
|
55943
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
55724
55944
|
}
|
|
55725
55945
|
|
|
55726
55946
|
/**
|
|
@@ -55795,10 +56015,10 @@ export declare interface JsonApiThemeOutWithLinks {
|
|
|
55795
56015
|
id: string;
|
|
55796
56016
|
/**
|
|
55797
56017
|
*
|
|
55798
|
-
* @type {
|
|
56018
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
55799
56019
|
* @memberof JsonApiThemeOutWithLinks
|
|
55800
56020
|
*/
|
|
55801
|
-
attributes:
|
|
56021
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
55802
56022
|
/**
|
|
55803
56023
|
*
|
|
55804
56024
|
* @type {ObjectLinks}
|
|
@@ -56059,16 +56279,16 @@ export declare interface JsonApiUserDataFilterOutList {
|
|
|
56059
56279
|
export declare interface JsonApiUserDataFilterOutRelationships {
|
|
56060
56280
|
/**
|
|
56061
56281
|
*
|
|
56062
|
-
* @type {
|
|
56282
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
56063
56283
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
56064
56284
|
*/
|
|
56065
|
-
user?:
|
|
56285
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
56066
56286
|
/**
|
|
56067
56287
|
*
|
|
56068
|
-
* @type {
|
|
56288
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
56069
56289
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
56070
56290
|
*/
|
|
56071
|
-
userGroup?:
|
|
56291
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
56072
56292
|
/**
|
|
56073
56293
|
*
|
|
56074
56294
|
* @type {JsonApiVisualizationObjectOutRelationshipsFacts}
|
|
@@ -56249,30 +56469,16 @@ export declare interface JsonApiUserDataFilterPatchDocument {
|
|
|
56249
56469
|
export declare interface JsonApiUserDataFilterPatchRelationships {
|
|
56250
56470
|
/**
|
|
56251
56471
|
*
|
|
56252
|
-
* @type {
|
|
56472
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
56253
56473
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
56254
56474
|
*/
|
|
56255
|
-
user?:
|
|
56475
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
56256
56476
|
/**
|
|
56257
56477
|
*
|
|
56258
|
-
* @type {
|
|
56478
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
56259
56479
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
56260
56480
|
*/
|
|
56261
|
-
userGroup?:
|
|
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;
|
|
56481
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
56276
56482
|
}
|
|
56277
56483
|
|
|
56278
56484
|
export declare const JsonApiUserDataFilterPatchTypeEnum: {
|
|
@@ -58266,16 +58472,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
58266
58472
|
id: string;
|
|
58267
58473
|
/**
|
|
58268
58474
|
*
|
|
58269
|
-
* @type {
|
|
58475
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutAttributes}
|
|
58270
58476
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
58271
58477
|
*/
|
|
58272
|
-
attributes?:
|
|
58478
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
58273
58479
|
/**
|
|
58274
58480
|
*
|
|
58275
|
-
* @type {
|
|
58481
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationships}
|
|
58276
58482
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
58277
58483
|
*/
|
|
58278
|
-
relationships?:
|
|
58484
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
58279
58485
|
}
|
|
58280
58486
|
|
|
58281
58487
|
/**
|
|
@@ -58350,16 +58556,42 @@ export declare interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
58350
58556
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
58351
58557
|
/**
|
|
58352
58558
|
*
|
|
58353
|
-
* @type {
|
|
58559
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutAttributes}
|
|
58354
58560
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
58355
58561
|
*/
|
|
58356
|
-
attributes?:
|
|
58562
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
58357
58563
|
/**
|
|
58358
58564
|
*
|
|
58359
|
-
* @type {
|
|
58565
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationships}
|
|
58360
58566
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
58361
58567
|
*/
|
|
58362
|
-
relationships?:
|
|
58568
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
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>;
|
|
58363
58595
|
}
|
|
58364
58596
|
|
|
58365
58597
|
/**
|
|
@@ -58420,6 +58652,34 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
|
58420
58652
|
included?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
58421
58653
|
}
|
|
58422
58654
|
|
|
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
|
+
|
|
58423
58683
|
export declare const JsonApiWorkspaceDataFilterSettingOutTypeEnum: {
|
|
58424
58684
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
58425
58685
|
};
|
|
@@ -58452,16 +58712,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
58452
58712
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
58453
58713
|
/**
|
|
58454
58714
|
*
|
|
58455
|
-
* @type {
|
|
58715
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutAttributes}
|
|
58456
58716
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
58457
58717
|
*/
|
|
58458
|
-
attributes?:
|
|
58718
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
58459
58719
|
/**
|
|
58460
58720
|
*
|
|
58461
|
-
* @type {
|
|
58721
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationships}
|
|
58462
58722
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
58463
58723
|
*/
|
|
58464
|
-
relationships?:
|
|
58724
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
58465
58725
|
/**
|
|
58466
58726
|
*
|
|
58467
58727
|
* @type {ObjectLinks}
|
|
@@ -58496,42 +58756,16 @@ export declare interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
58496
58756
|
id: string;
|
|
58497
58757
|
/**
|
|
58498
58758
|
*
|
|
58499
|
-
* @type {
|
|
58759
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutAttributes}
|
|
58500
58760
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
58501
58761
|
*/
|
|
58502
|
-
attributes?:
|
|
58762
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
58503
58763
|
/**
|
|
58504
58764
|
*
|
|
58505
|
-
* @type {
|
|
58765
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationships}
|
|
58506
58766
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
58507
58767
|
*/
|
|
58508
|
-
relationships?:
|
|
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>;
|
|
58768
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
58535
58769
|
}
|
|
58536
58770
|
|
|
58537
58771
|
/**
|
|
@@ -58548,34 +58782,6 @@ export declare interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
|
58548
58782
|
data: JsonApiWorkspaceDataFilterSettingPatch;
|
|
58549
58783
|
}
|
|
58550
58784
|
|
|
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
|
-
|
|
58579
58785
|
export declare const JsonApiWorkspaceDataFilterSettingPatchTypeEnum: {
|
|
58580
58786
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
58581
58787
|
};
|
|
@@ -58609,87 +58815,16 @@ export declare interface JsonApiWorkspaceIn {
|
|
|
58609
58815
|
id: string;
|
|
58610
58816
|
/**
|
|
58611
58817
|
*
|
|
58612
|
-
* @type {
|
|
58818
|
+
* @type {JsonApiWorkspaceOutAttributes}
|
|
58613
58819
|
* @memberof JsonApiWorkspaceIn
|
|
58614
58820
|
*/
|
|
58615
|
-
attributes?:
|
|
58821
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
58616
58822
|
/**
|
|
58617
58823
|
*
|
|
58618
|
-
* @type {
|
|
58824
|
+
* @type {JsonApiWorkspaceOutRelationships}
|
|
58619
58825
|
* @memberof JsonApiWorkspaceIn
|
|
58620
58826
|
*/
|
|
58621
|
-
relationships?:
|
|
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>;
|
|
58827
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
58693
58828
|
}
|
|
58694
58829
|
|
|
58695
58830
|
/**
|
|
@@ -58706,34 +58841,6 @@ export declare interface JsonApiWorkspaceInDocument {
|
|
|
58706
58841
|
data: JsonApiWorkspaceIn;
|
|
58707
58842
|
}
|
|
58708
58843
|
|
|
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
|
-
|
|
58737
58844
|
export declare const JsonApiWorkspaceInTypeEnum: {
|
|
58738
58845
|
readonly WORKSPACE: "workspace";
|
|
58739
58846
|
};
|
|
@@ -58792,16 +58899,87 @@ export declare interface JsonApiWorkspaceOut {
|
|
|
58792
58899
|
meta?: JsonApiWorkspaceOutMeta;
|
|
58793
58900
|
/**
|
|
58794
58901
|
*
|
|
58795
|
-
* @type {
|
|
58902
|
+
* @type {JsonApiWorkspaceOutAttributes}
|
|
58796
58903
|
* @memberof JsonApiWorkspaceOut
|
|
58797
58904
|
*/
|
|
58798
|
-
attributes?:
|
|
58905
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
58799
58906
|
/**
|
|
58800
58907
|
*
|
|
58801
|
-
* @type {
|
|
58908
|
+
* @type {JsonApiWorkspaceOutRelationships}
|
|
58802
58909
|
* @memberof JsonApiWorkspaceOut
|
|
58803
58910
|
*/
|
|
58804
|
-
relationships?:
|
|
58911
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
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>;
|
|
58805
58983
|
}
|
|
58806
58984
|
|
|
58807
58985
|
/**
|
|
@@ -58962,6 +59140,34 @@ export declare const JsonApiWorkspaceOutMetaPermissionsEnum: {
|
|
|
58962
59140
|
|
|
58963
59141
|
export declare type JsonApiWorkspaceOutMetaPermissionsEnum = typeof JsonApiWorkspaceOutMetaPermissionsEnum[keyof typeof JsonApiWorkspaceOutMetaPermissionsEnum];
|
|
58964
59142
|
|
|
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
|
+
|
|
58965
59171
|
export declare const JsonApiWorkspaceOutTypeEnum: {
|
|
58966
59172
|
readonly WORKSPACE: "workspace";
|
|
58967
59173
|
};
|
|
@@ -58994,16 +59200,16 @@ export declare interface JsonApiWorkspaceOutWithLinks {
|
|
|
58994
59200
|
meta?: JsonApiWorkspaceOutMeta;
|
|
58995
59201
|
/**
|
|
58996
59202
|
*
|
|
58997
|
-
* @type {
|
|
59203
|
+
* @type {JsonApiWorkspaceOutAttributes}
|
|
58998
59204
|
* @memberof JsonApiWorkspaceOutWithLinks
|
|
58999
59205
|
*/
|
|
59000
|
-
attributes?:
|
|
59206
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
59001
59207
|
/**
|
|
59002
59208
|
*
|
|
59003
|
-
* @type {
|
|
59209
|
+
* @type {JsonApiWorkspaceOutRelationships}
|
|
59004
59210
|
* @memberof JsonApiWorkspaceOutWithLinks
|
|
59005
59211
|
*/
|
|
59006
|
-
relationships?:
|
|
59212
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
59007
59213
|
/**
|
|
59008
59214
|
*
|
|
59009
59215
|
* @type {ObjectLinks}
|
|
@@ -59038,16 +59244,16 @@ export declare interface JsonApiWorkspacePatch {
|
|
|
59038
59244
|
id: string;
|
|
59039
59245
|
/**
|
|
59040
59246
|
*
|
|
59041
|
-
* @type {
|
|
59247
|
+
* @type {JsonApiWorkspaceOutAttributes}
|
|
59042
59248
|
* @memberof JsonApiWorkspacePatch
|
|
59043
59249
|
*/
|
|
59044
|
-
attributes?:
|
|
59250
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
59045
59251
|
/**
|
|
59046
59252
|
*
|
|
59047
|
-
* @type {
|
|
59253
|
+
* @type {JsonApiWorkspaceOutRelationships}
|
|
59048
59254
|
* @memberof JsonApiWorkspacePatch
|
|
59049
59255
|
*/
|
|
59050
|
-
relationships?:
|
|
59256
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
59051
59257
|
}
|
|
59052
59258
|
|
|
59053
59259
|
/**
|
|
@@ -64962,6 +65168,14 @@ export declare class NotificationChannelsApi extends MetadataBaseApi implements
|
|
|
64962
65168
|
* @memberof NotificationChannelsApi
|
|
64963
65169
|
*/
|
|
64964
65170
|
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>>;
|
|
64965
65179
|
/**
|
|
64966
65180
|
*
|
|
64967
65181
|
* @summary Get all Notification Channel entities
|
|
@@ -64971,6 +65185,14 @@ export declare class NotificationChannelsApi extends MetadataBaseApi implements
|
|
|
64971
65185
|
* @memberof NotificationChannelsApi
|
|
64972
65186
|
*/
|
|
64973
65187
|
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>>;
|
|
64974
65196
|
/**
|
|
64975
65197
|
*
|
|
64976
65198
|
* @summary Get Notification Channel entity
|
|
@@ -65056,6 +65278,17 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
65056
65278
|
* @throws {RequiredError}
|
|
65057
65279
|
*/
|
|
65058
65280
|
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>;
|
|
65059
65292
|
/**
|
|
65060
65293
|
*
|
|
65061
65294
|
* @summary Get all Notification Channel entities
|
|
@@ -65068,6 +65301,14 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
65068
65301
|
* @throws {RequiredError}
|
|
65069
65302
|
*/
|
|
65070
65303
|
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>;
|
|
65071
65312
|
/**
|
|
65072
65313
|
*
|
|
65073
65314
|
* @summary Get Notification Channel entity
|
|
@@ -65184,6 +65425,13 @@ export declare const NotificationChannelsApiFactory: (configuration?: MetadataCo
|
|
|
65184
65425
|
* @throws {RequiredError}
|
|
65185
65426
|
*/
|
|
65186
65427
|
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>;
|
|
65187
65435
|
/**
|
|
65188
65436
|
*
|
|
65189
65437
|
* @summary Get all Notification Channel entities
|
|
@@ -65192,6 +65440,13 @@ export declare const NotificationChannelsApiFactory: (configuration?: MetadataCo
|
|
|
65192
65440
|
* @throws {RequiredError}
|
|
65193
65441
|
*/
|
|
65194
65442
|
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>;
|
|
65195
65450
|
/**
|
|
65196
65451
|
*
|
|
65197
65452
|
* @summary Get Notification Channel entity
|
|
@@ -65270,6 +65525,17 @@ export declare const NotificationChannelsApiFp: (configuration?: MetadataConfigu
|
|
|
65270
65525
|
* @throws {RequiredError}
|
|
65271
65526
|
*/
|
|
65272
65527
|
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>>;
|
|
65273
65539
|
/**
|
|
65274
65540
|
*
|
|
65275
65541
|
* @summary Get all Notification Channel entities
|
|
@@ -65282,6 +65548,14 @@ export declare const NotificationChannelsApiFp: (configuration?: MetadataConfigu
|
|
|
65282
65548
|
* @throws {RequiredError}
|
|
65283
65549
|
*/
|
|
65284
65550
|
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>>;
|
|
65285
65559
|
/**
|
|
65286
65560
|
*
|
|
65287
65561
|
* @summary Get Notification Channel entity
|
|
@@ -65343,6 +65617,44 @@ export declare const NotificationChannelsApiFp: (configuration?: MetadataConfigu
|
|
|
65343
65617
|
updateEntityNotificationChannels(id: string, jsonApiNotificationChannelInDocument: JsonApiNotificationChannelInDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiNotificationChannelOutDocument>>;
|
|
65344
65618
|
};
|
|
65345
65619
|
|
|
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
|
+
|
|
65346
65658
|
/**
|
|
65347
65659
|
* Request parameters for getAllEntitiesNotificationChannels operation in NotificationChannelsApi.
|
|
65348
65660
|
* @export
|
|
@@ -65381,6 +65693,26 @@ export declare interface NotificationChannelsApiGetAllEntitiesNotificationChanne
|
|
|
65381
65693
|
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
65382
65694
|
}
|
|
65383
65695
|
|
|
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
|
+
|
|
65384
65716
|
/**
|
|
65385
65717
|
* Request parameters for getEntityNotificationChannels operation in NotificationChannelsApi.
|
|
65386
65718
|
* @export
|
|
@@ -65425,6 +65757,14 @@ export declare interface NotificationChannelsApiInterface {
|
|
|
65425
65757
|
* @memberof NotificationChannelsApiInterface
|
|
65426
65758
|
*/
|
|
65427
65759
|
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>;
|
|
65428
65768
|
/**
|
|
65429
65769
|
*
|
|
65430
65770
|
* @summary Get all Notification Channel entities
|
|
@@ -65434,6 +65774,14 @@ export declare interface NotificationChannelsApiInterface {
|
|
|
65434
65774
|
* @memberof NotificationChannelsApiInterface
|
|
65435
65775
|
*/
|
|
65436
65776
|
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>;
|
|
65437
65785
|
/**
|
|
65438
65786
|
*
|
|
65439
65787
|
* @summary Get Notification Channel entity
|
|
@@ -66160,12 +66508,12 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
66160
66508
|
* @summary Get Organizations
|
|
66161
66509
|
* @param {string} id
|
|
66162
66510
|
* @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\').
|
|
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.
|
|
66511
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66164
66512
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
66165
66513
|
* @param {*} [options] Override http request option.
|
|
66166
66514
|
* @throws {RequiredError}
|
|
66167
66515
|
*/
|
|
66168
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66516
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66169
66517
|
/**
|
|
66170
66518
|
*
|
|
66171
66519
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -66182,11 +66530,11 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
66182
66530
|
* @param {string} id
|
|
66183
66531
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
66184
66532
|
* @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\').
|
|
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.
|
|
66533
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66186
66534
|
* @param {*} [options] Override http request option.
|
|
66187
66535
|
* @throws {RequiredError}
|
|
66188
66536
|
*/
|
|
66189
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66537
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66190
66538
|
/**
|
|
66191
66539
|
*
|
|
66192
66540
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -66203,11 +66551,11 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
66203
66551
|
* @param {string} id
|
|
66204
66552
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
66205
66553
|
* @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\').
|
|
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.
|
|
66554
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66207
66555
|
* @param {*} [options] Override http request option.
|
|
66208
66556
|
* @throws {RequiredError}
|
|
66209
66557
|
*/
|
|
66210
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66558
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66211
66559
|
};
|
|
66212
66560
|
|
|
66213
66561
|
/**
|
|
@@ -66284,12 +66632,12 @@ export declare const OrganizationControllerApiFp: (configuration?: MetadataConfi
|
|
|
66284
66632
|
* @summary Get Organizations
|
|
66285
66633
|
* @param {string} id
|
|
66286
66634
|
* @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\').
|
|
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.
|
|
66635
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66288
66636
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
66289
66637
|
* @param {*} [options] Override http request option.
|
|
66290
66638
|
* @throws {RequiredError}
|
|
66291
66639
|
*/
|
|
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>>;
|
|
66640
|
+
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
66293
66641
|
/**
|
|
66294
66642
|
*
|
|
66295
66643
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -66306,11 +66654,11 @@ export declare const OrganizationControllerApiFp: (configuration?: MetadataConfi
|
|
|
66306
66654
|
* @param {string} id
|
|
66307
66655
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
66308
66656
|
* @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\').
|
|
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.
|
|
66657
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66310
66658
|
* @param {*} [options] Override http request option.
|
|
66311
66659
|
* @throws {RequiredError}
|
|
66312
66660
|
*/
|
|
66313
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
66661
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
66314
66662
|
/**
|
|
66315
66663
|
*
|
|
66316
66664
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -66327,11 +66675,11 @@ export declare const OrganizationControllerApiFp: (configuration?: MetadataConfi
|
|
|
66327
66675
|
* @param {string} id
|
|
66328
66676
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
66329
66677
|
* @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\').
|
|
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.
|
|
66678
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66331
66679
|
* @param {*} [options] Override http request option.
|
|
66332
66680
|
* @throws {RequiredError}
|
|
66333
66681
|
*/
|
|
66334
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
66682
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
66335
66683
|
};
|
|
66336
66684
|
|
|
66337
66685
|
/**
|
|
@@ -66374,10 +66722,10 @@ export declare interface OrganizationControllerApiGetEntityOrganizationsRequest
|
|
|
66374
66722
|
readonly filter?: string;
|
|
66375
66723
|
/**
|
|
66376
66724
|
* 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.
|
|
66377
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
66725
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
66378
66726
|
* @memberof OrganizationControllerApiGetEntityOrganizations
|
|
66379
66727
|
*/
|
|
66380
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
66728
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
66381
66729
|
/**
|
|
66382
66730
|
* Include Meta objects.
|
|
66383
66731
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -66500,10 +66848,10 @@ export declare interface OrganizationControllerApiPatchEntityOrganizationsReques
|
|
|
66500
66848
|
readonly filter?: string;
|
|
66501
66849
|
/**
|
|
66502
66850
|
* 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.
|
|
66503
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
66851
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
66504
66852
|
* @memberof OrganizationControllerApiPatchEntityOrganizations
|
|
66505
66853
|
*/
|
|
66506
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
66854
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
66507
66855
|
}
|
|
66508
66856
|
|
|
66509
66857
|
/**
|
|
@@ -66558,10 +66906,10 @@ export declare interface OrganizationControllerApiUpdateEntityOrganizationsReque
|
|
|
66558
66906
|
readonly filter?: string;
|
|
66559
66907
|
/**
|
|
66560
66908
|
* 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.
|
|
66561
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
66909
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
66562
66910
|
* @memberof OrganizationControllerApiUpdateEntityOrganizations
|
|
66563
66911
|
*/
|
|
66564
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
66912
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
66565
66913
|
}
|
|
66566
66914
|
|
|
66567
66915
|
/**
|
|
@@ -66887,12 +67235,12 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
66887
67235
|
* @summary Get Organizations
|
|
66888
67236
|
* @param {string} id
|
|
66889
67237
|
* @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\').
|
|
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.
|
|
67238
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66891
67239
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
66892
67240
|
* @param {*} [options] Override http request option.
|
|
66893
67241
|
* @throws {RequiredError}
|
|
66894
67242
|
*/
|
|
66895
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
67243
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66896
67244
|
/**
|
|
66897
67245
|
* Gets a basic information about organization.
|
|
66898
67246
|
* @summary Get current organization info
|
|
@@ -66917,11 +67265,11 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
66917
67265
|
* @param {string} id
|
|
66918
67266
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
66919
67267
|
* @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\').
|
|
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.
|
|
67268
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66921
67269
|
* @param {*} [options] Override http request option.
|
|
66922
67270
|
* @throws {RequiredError}
|
|
66923
67271
|
*/
|
|
66924
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
67272
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66925
67273
|
/**
|
|
66926
67274
|
*
|
|
66927
67275
|
* @summary Put Organization entity
|
|
@@ -66938,11 +67286,11 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
66938
67286
|
* @param {string} id
|
|
66939
67287
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
66940
67288
|
* @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\').
|
|
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.
|
|
67289
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
66942
67290
|
* @param {*} [options] Override http request option.
|
|
66943
67291
|
* @throws {RequiredError}
|
|
66944
67292
|
*/
|
|
66945
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
67293
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
66946
67294
|
};
|
|
66947
67295
|
|
|
66948
67296
|
/**
|
|
@@ -67114,12 +67462,12 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: MetadataConfi
|
|
|
67114
67462
|
* @summary Get Organizations
|
|
67115
67463
|
* @param {string} id
|
|
67116
67464
|
* @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\').
|
|
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.
|
|
67465
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
67118
67466
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
67119
67467
|
* @param {*} [options] Override http request option.
|
|
67120
67468
|
* @throws {RequiredError}
|
|
67121
67469
|
*/
|
|
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>>;
|
|
67470
|
+
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
67123
67471
|
/**
|
|
67124
67472
|
* Gets a basic information about organization.
|
|
67125
67473
|
* @summary Get current organization info
|
|
@@ -67144,11 +67492,11 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: MetadataConfi
|
|
|
67144
67492
|
* @param {string} id
|
|
67145
67493
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
67146
67494
|
* @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\').
|
|
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.
|
|
67495
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
67148
67496
|
* @param {*} [options] Override http request option.
|
|
67149
67497
|
* @throws {RequiredError}
|
|
67150
67498
|
*/
|
|
67151
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
67499
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
67152
67500
|
/**
|
|
67153
67501
|
*
|
|
67154
67502
|
* @summary Put Organization entity
|
|
@@ -67165,11 +67513,11 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: MetadataConfi
|
|
|
67165
67513
|
* @param {string} id
|
|
67166
67514
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
67167
67515
|
* @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\').
|
|
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.
|
|
67516
|
+
* @param {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | '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.
|
|
67169
67517
|
* @param {*} [options] Override http request option.
|
|
67170
67518
|
* @throws {RequiredError}
|
|
67171
67519
|
*/
|
|
67172
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
67520
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
67173
67521
|
};
|
|
67174
67522
|
|
|
67175
67523
|
/**
|
|
@@ -67250,10 +67598,10 @@ export declare interface OrganizationEntityAPIsApiGetEntityOrganizationsRequest
|
|
|
67250
67598
|
readonly filter?: string;
|
|
67251
67599
|
/**
|
|
67252
67600
|
* 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.
|
|
67253
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
67601
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
67254
67602
|
* @memberof OrganizationEntityAPIsApiGetEntityOrganizations
|
|
67255
67603
|
*/
|
|
67256
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
67604
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
67257
67605
|
/**
|
|
67258
67606
|
* Include Meta objects.
|
|
67259
67607
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -67426,10 +67774,10 @@ export declare interface OrganizationEntityAPIsApiPatchEntityOrganizationsReques
|
|
|
67426
67774
|
readonly filter?: string;
|
|
67427
67775
|
/**
|
|
67428
67776
|
* 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.
|
|
67429
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
67777
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
67430
67778
|
* @memberof OrganizationEntityAPIsApiPatchEntityOrganizations
|
|
67431
67779
|
*/
|
|
67432
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
67780
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
67433
67781
|
}
|
|
67434
67782
|
|
|
67435
67783
|
/**
|
|
@@ -67484,10 +67832,10 @@ export declare interface OrganizationEntityAPIsApiUpdateEntityOrganizationsReque
|
|
|
67484
67832
|
readonly filter?: string;
|
|
67485
67833
|
/**
|
|
67486
67834
|
* 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.
|
|
67487
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
67835
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
67488
67836
|
* @memberof OrganizationEntityAPIsApiUpdateEntityOrganizations
|
|
67489
67837
|
*/
|
|
67490
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
67838
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
67491
67839
|
}
|
|
67492
67840
|
|
|
67493
67841
|
/**
|
|
@@ -85499,7 +85847,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
85499
85847
|
* @param {string} workspaceId
|
|
85500
85848
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
85501
85849
|
* @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\').
|
|
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.
|
|
85850
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
85503
85851
|
* @param {number} [page] Zero-based page index (0..N)
|
|
85504
85852
|
* @param {number} [size] The size of the page to be returned
|
|
85505
85853
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -85508,7 +85856,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
85508
85856
|
* @param {*} [options] Override http request option.
|
|
85509
85857
|
* @throws {RequiredError}
|
|
85510
85858
|
*/
|
|
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>;
|
|
85859
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
85512
85860
|
/**
|
|
85513
85861
|
*
|
|
85514
85862
|
* @summary Get all Context Filters
|
|
@@ -85761,13 +86109,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
85761
86109
|
* @param {string} workspaceId
|
|
85762
86110
|
* @param {string} objectId
|
|
85763
86111
|
* @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\').
|
|
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.
|
|
86112
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
85765
86113
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
85766
86114
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
85767
86115
|
* @param {*} [options] Override http request option.
|
|
85768
86116
|
* @throws {RequiredError}
|
|
85769
86117
|
*/
|
|
85770
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
86118
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
85771
86119
|
/**
|
|
85772
86120
|
*
|
|
85773
86121
|
* @summary Get a Context Filter
|
|
@@ -88183,7 +88531,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
88183
88531
|
* @param {string} workspaceId
|
|
88184
88532
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
88185
88533
|
* @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\').
|
|
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.
|
|
88534
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
88187
88535
|
* @param {number} [page] Zero-based page index (0..N)
|
|
88188
88536
|
* @param {number} [size] The size of the page to be returned
|
|
88189
88537
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -88192,7 +88540,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
88192
88540
|
* @param {*} [options] Override http request option.
|
|
88193
88541
|
* @throws {RequiredError}
|
|
88194
88542
|
*/
|
|
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>>;
|
|
88543
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "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>>;
|
|
88196
88544
|
/**
|
|
88197
88545
|
*
|
|
88198
88546
|
* @summary Get all Context Filters
|
|
@@ -88445,13 +88793,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
88445
88793
|
* @param {string} workspaceId
|
|
88446
88794
|
* @param {string} objectId
|
|
88447
88795
|
* @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\').
|
|
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.
|
|
88796
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
88449
88797
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
88450
88798
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
88451
88799
|
* @param {*} [options] Override http request option.
|
|
88452
88800
|
* @throws {RequiredError}
|
|
88453
88801
|
*/
|
|
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>>;
|
|
88802
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
88455
88803
|
/**
|
|
88456
88804
|
*
|
|
88457
88805
|
* @summary Get a Context Filter
|
|
@@ -89417,10 +89765,10 @@ export declare interface WorkspaceObjectControllerApiGetAllEntitiesFactsRequest
|
|
|
89417
89765
|
readonly filter?: string;
|
|
89418
89766
|
/**
|
|
89419
89767
|
* 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.
|
|
89420
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
89768
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
89421
89769
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesFacts
|
|
89422
89770
|
*/
|
|
89423
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
89771
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
89424
89772
|
/**
|
|
89425
89773
|
* Zero-based page index (0..N)
|
|
89426
89774
|
* @type {number}
|
|
@@ -90377,10 +90725,10 @@ export declare interface WorkspaceObjectControllerApiGetEntityFactsRequest {
|
|
|
90377
90725
|
readonly filter?: string;
|
|
90378
90726
|
/**
|
|
90379
90727
|
* 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.
|
|
90380
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
90728
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
90381
90729
|
* @memberof WorkspaceObjectControllerApiGetEntityFacts
|
|
90382
90730
|
*/
|
|
90383
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
90731
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
90384
90732
|
/**
|
|
90385
90733
|
*
|
|
90386
90734
|
* @type {boolean}
|