@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
|
@@ -2255,6 +2255,12 @@ export interface DeclarativeDataset {
|
|
|
2255
2255
|
* @memberof DeclarativeDataset
|
|
2256
2256
|
*/
|
|
2257
2257
|
workspaceDataFilterReferences?: Array<DeclarativeWorkspaceDataFilterReferences>;
|
|
2258
|
+
/**
|
|
2259
|
+
* Precedence used in aggregate awareness.
|
|
2260
|
+
* @type {number}
|
|
2261
|
+
* @memberof DeclarativeDataset
|
|
2262
|
+
*/
|
|
2263
|
+
precedence?: number;
|
|
2258
2264
|
}
|
|
2259
2265
|
/**
|
|
2260
2266
|
* A dataset extension properties.
|
|
@@ -2525,6 +2531,12 @@ export interface DeclarativeFact {
|
|
|
2525
2531
|
* @memberof DeclarativeFact
|
|
2526
2532
|
*/
|
|
2527
2533
|
tags?: Array<string>;
|
|
2534
|
+
/**
|
|
2535
|
+
*
|
|
2536
|
+
* @type {DeclarativeSourceFactReference}
|
|
2537
|
+
* @memberof DeclarativeFact
|
|
2538
|
+
*/
|
|
2539
|
+
sourceFactReference?: DeclarativeSourceFactReference;
|
|
2528
2540
|
}
|
|
2529
2541
|
export declare const DeclarativeFactSourceColumnDataTypeEnum: {
|
|
2530
2542
|
readonly INT: "INT";
|
|
@@ -2641,11 +2653,11 @@ export interface DeclarativeIdentityProvider {
|
|
|
2641
2653
|
*/
|
|
2642
2654
|
id: string;
|
|
2643
2655
|
/**
|
|
2644
|
-
* 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.
|
|
2656
|
+
* 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.
|
|
2645
2657
|
* @type {Array<string>}
|
|
2646
2658
|
* @memberof DeclarativeIdentityProvider
|
|
2647
2659
|
*/
|
|
2648
|
-
identifiers
|
|
2660
|
+
identifiers?: Array<string>;
|
|
2649
2661
|
/**
|
|
2650
2662
|
* 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.
|
|
2651
2663
|
* @type {{ [key: string]: string; }}
|
|
@@ -2690,6 +2702,12 @@ export interface DeclarativeIdentityProvider {
|
|
|
2690
2702
|
* @memberof DeclarativeIdentityProvider
|
|
2691
2703
|
*/
|
|
2692
2704
|
oauthSubjectIdClaim?: string;
|
|
2705
|
+
/**
|
|
2706
|
+
* 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.
|
|
2707
|
+
* @type {string}
|
|
2708
|
+
* @memberof DeclarativeIdentityProvider
|
|
2709
|
+
*/
|
|
2710
|
+
idpType?: DeclarativeIdentityProviderIdpTypeEnum;
|
|
2693
2711
|
/**
|
|
2694
2712
|
* 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.
|
|
2695
2713
|
* @type {{ [key: string]: string; }}
|
|
@@ -2705,6 +2723,35 @@ export interface DeclarativeIdentityProvider {
|
|
|
2705
2723
|
*/
|
|
2706
2724
|
oauthCustomScopes?: Array<string> | null;
|
|
2707
2725
|
}
|
|
2726
|
+
export declare const DeclarativeIdentityProviderIdpTypeEnum: {
|
|
2727
|
+
readonly MANAGED_IDP: "MANAGED_IDP";
|
|
2728
|
+
readonly FIM_IDP: "FIM_IDP";
|
|
2729
|
+
readonly CUSTOM_IDP: "CUSTOM_IDP";
|
|
2730
|
+
};
|
|
2731
|
+
export type DeclarativeIdentityProviderIdpTypeEnum = typeof DeclarativeIdentityProviderIdpTypeEnum[keyof typeof DeclarativeIdentityProviderIdpTypeEnum];
|
|
2732
|
+
/**
|
|
2733
|
+
* An Identity Provider identifier.
|
|
2734
|
+
* @export
|
|
2735
|
+
* @interface DeclarativeIdentityProviderIdentifier
|
|
2736
|
+
*/
|
|
2737
|
+
export interface DeclarativeIdentityProviderIdentifier {
|
|
2738
|
+
/**
|
|
2739
|
+
* Identifier of the identity provider.
|
|
2740
|
+
* @type {string}
|
|
2741
|
+
* @memberof DeclarativeIdentityProviderIdentifier
|
|
2742
|
+
*/
|
|
2743
|
+
id: string;
|
|
2744
|
+
/**
|
|
2745
|
+
* A type.
|
|
2746
|
+
* @type {string}
|
|
2747
|
+
* @memberof DeclarativeIdentityProviderIdentifier
|
|
2748
|
+
*/
|
|
2749
|
+
type: DeclarativeIdentityProviderIdentifierTypeEnum;
|
|
2750
|
+
}
|
|
2751
|
+
export declare const DeclarativeIdentityProviderIdentifierTypeEnum: {
|
|
2752
|
+
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
2753
|
+
};
|
|
2754
|
+
export type DeclarativeIdentityProviderIdentifierTypeEnum = typeof DeclarativeIdentityProviderIdentifierTypeEnum[keyof typeof DeclarativeIdentityProviderIdentifierTypeEnum];
|
|
2708
2755
|
/**
|
|
2709
2756
|
* A declarative form of the JWK.
|
|
2710
2757
|
* @export
|
|
@@ -3208,6 +3255,12 @@ export interface DeclarativeOrganizationInfo {
|
|
|
3208
3255
|
* @memberof DeclarativeOrganizationInfo
|
|
3209
3256
|
*/
|
|
3210
3257
|
cspDirectives?: Array<DeclarativeCspDirective>;
|
|
3258
|
+
/**
|
|
3259
|
+
*
|
|
3260
|
+
* @type {DeclarativeIdentityProviderIdentifier}
|
|
3261
|
+
* @memberof DeclarativeOrganizationInfo
|
|
3262
|
+
*/
|
|
3263
|
+
identityProvider?: DeclarativeIdentityProviderIdentifier;
|
|
3211
3264
|
}
|
|
3212
3265
|
/**
|
|
3213
3266
|
* Definition of an organization permission assigned to a user/user-group.
|
|
@@ -3470,6 +3523,31 @@ export declare const DeclarativeSingleWorkspacePermissionNameEnum: {
|
|
|
3470
3523
|
readonly VIEW: "VIEW";
|
|
3471
3524
|
};
|
|
3472
3525
|
export type DeclarativeSingleWorkspacePermissionNameEnum = typeof DeclarativeSingleWorkspacePermissionNameEnum[keyof typeof DeclarativeSingleWorkspacePermissionNameEnum];
|
|
3526
|
+
/**
|
|
3527
|
+
* Aggregated awareness source fact reference.
|
|
3528
|
+
* @export
|
|
3529
|
+
* @interface DeclarativeSourceFactReference
|
|
3530
|
+
*/
|
|
3531
|
+
export interface DeclarativeSourceFactReference {
|
|
3532
|
+
/**
|
|
3533
|
+
*
|
|
3534
|
+
* @type {FactIdentifier}
|
|
3535
|
+
* @memberof DeclarativeSourceFactReference
|
|
3536
|
+
*/
|
|
3537
|
+
reference: FactIdentifier;
|
|
3538
|
+
/**
|
|
3539
|
+
* Aggregation operation.
|
|
3540
|
+
* @type {string}
|
|
3541
|
+
* @memberof DeclarativeSourceFactReference
|
|
3542
|
+
*/
|
|
3543
|
+
operation: DeclarativeSourceFactReferenceOperationEnum;
|
|
3544
|
+
}
|
|
3545
|
+
export declare const DeclarativeSourceFactReferenceOperationEnum: {
|
|
3546
|
+
readonly SUM: "SUM";
|
|
3547
|
+
readonly MIN: "MIN";
|
|
3548
|
+
readonly MAX: "MAX";
|
|
3549
|
+
};
|
|
3550
|
+
export type DeclarativeSourceFactReferenceOperationEnum = typeof DeclarativeSourceFactReferenceOperationEnum[keyof typeof DeclarativeSourceFactReferenceOperationEnum];
|
|
3473
3551
|
/**
|
|
3474
3552
|
* A database table.
|
|
3475
3553
|
* @export
|
|
@@ -4505,6 +4583,29 @@ export interface ExecutionSettings {
|
|
|
4505
4583
|
* @export
|
|
4506
4584
|
*/
|
|
4507
4585
|
export type ExportRequest = TabularExportRequest | VisualExportRequest;
|
|
4586
|
+
/**
|
|
4587
|
+
* A fact identifier.
|
|
4588
|
+
* @export
|
|
4589
|
+
* @interface FactIdentifier
|
|
4590
|
+
*/
|
|
4591
|
+
export interface FactIdentifier {
|
|
4592
|
+
/**
|
|
4593
|
+
* Fact ID.
|
|
4594
|
+
* @type {string}
|
|
4595
|
+
* @memberof FactIdentifier
|
|
4596
|
+
*/
|
|
4597
|
+
id: string;
|
|
4598
|
+
/**
|
|
4599
|
+
* A type of the fact.
|
|
4600
|
+
* @type {string}
|
|
4601
|
+
* @memberof FactIdentifier
|
|
4602
|
+
*/
|
|
4603
|
+
type: FactIdentifierTypeEnum;
|
|
4604
|
+
}
|
|
4605
|
+
export declare const FactIdentifierTypeEnum: {
|
|
4606
|
+
readonly FACT: "fact";
|
|
4607
|
+
};
|
|
4608
|
+
export type FactIdentifierTypeEnum = typeof FactIdentifierTypeEnum[keyof typeof FactIdentifierTypeEnum];
|
|
4508
4609
|
/**
|
|
4509
4610
|
* @type FilterDefinition
|
|
4510
4611
|
* Abstract filter definition type
|
|
@@ -6467,10 +6568,10 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
6467
6568
|
details?: any;
|
|
6468
6569
|
/**
|
|
6469
6570
|
*
|
|
6470
|
-
* @type {
|
|
6571
|
+
* @type {JsonApiAutomationOutAttributesMetadata}
|
|
6471
6572
|
* @memberof JsonApiAutomationOutAttributes
|
|
6472
6573
|
*/
|
|
6473
|
-
metadata?:
|
|
6574
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
6474
6575
|
/**
|
|
6475
6576
|
* Current state of the automation.
|
|
6476
6577
|
* @type {string}
|
|
@@ -6479,52 +6580,52 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
6479
6580
|
state?: JsonApiAutomationOutAttributesStateEnum;
|
|
6480
6581
|
/**
|
|
6481
6582
|
*
|
|
6482
|
-
* @type {
|
|
6583
|
+
* @type {JsonApiAutomationOutAttributesSchedule}
|
|
6483
6584
|
* @memberof JsonApiAutomationOutAttributes
|
|
6484
6585
|
*/
|
|
6485
|
-
schedule?:
|
|
6586
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
6486
6587
|
/**
|
|
6487
6588
|
*
|
|
6488
|
-
* @type {
|
|
6589
|
+
* @type {JsonApiAutomationOutAttributesAlert}
|
|
6489
6590
|
* @memberof JsonApiAutomationOutAttributes
|
|
6490
6591
|
*/
|
|
6491
|
-
alert?:
|
|
6592
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
6492
6593
|
/**
|
|
6493
6594
|
*
|
|
6494
|
-
* @type {Array<
|
|
6595
|
+
* @type {Array<JsonApiAutomationOutAttributesTabularExports>}
|
|
6495
6596
|
* @memberof JsonApiAutomationOutAttributes
|
|
6496
6597
|
*/
|
|
6497
|
-
tabularExports?: Array<
|
|
6598
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExports>;
|
|
6498
6599
|
/**
|
|
6499
6600
|
*
|
|
6500
|
-
* @type {Array<
|
|
6601
|
+
* @type {Array<JsonApiAutomationOutAttributesVisualExports>}
|
|
6501
6602
|
* @memberof JsonApiAutomationOutAttributes
|
|
6502
6603
|
*/
|
|
6503
|
-
visualExports?: Array<
|
|
6604
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExports>;
|
|
6504
6605
|
/**
|
|
6505
6606
|
*
|
|
6506
|
-
* @type {Array<
|
|
6607
|
+
* @type {Array<JsonApiAutomationOutAttributesImageExports>}
|
|
6507
6608
|
* @memberof JsonApiAutomationOutAttributes
|
|
6508
6609
|
*/
|
|
6509
|
-
imageExports?: Array<
|
|
6610
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExports>;
|
|
6510
6611
|
/**
|
|
6511
6612
|
*
|
|
6512
|
-
* @type {Array<
|
|
6613
|
+
* @type {Array<JsonApiAutomationOutAttributesRawExports>}
|
|
6513
6614
|
* @memberof JsonApiAutomationOutAttributes
|
|
6514
6615
|
*/
|
|
6515
|
-
rawExports?: Array<
|
|
6616
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExports>;
|
|
6516
6617
|
/**
|
|
6517
6618
|
*
|
|
6518
|
-
* @type {Array<
|
|
6619
|
+
* @type {Array<JsonApiAutomationOutAttributesSlidesExports>}
|
|
6519
6620
|
* @memberof JsonApiAutomationOutAttributes
|
|
6520
6621
|
*/
|
|
6521
|
-
slidesExports?: Array<
|
|
6622
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExports>;
|
|
6522
6623
|
/**
|
|
6523
6624
|
* External recipients of the automation action results.
|
|
6524
|
-
* @type {Array<
|
|
6625
|
+
* @type {Array<JsonApiAutomationOutAttributesExternalRecipients>}
|
|
6525
6626
|
* @memberof JsonApiAutomationOutAttributes
|
|
6526
6627
|
*/
|
|
6527
|
-
externalRecipients?: Array<
|
|
6628
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipients>;
|
|
6528
6629
|
/**
|
|
6529
6630
|
*
|
|
6530
6631
|
* @type {string}
|
|
@@ -6543,6 +6644,164 @@ export declare const JsonApiAutomationOutAttributesStateEnum: {
|
|
|
6543
6644
|
readonly PAUSED: "PAUSED";
|
|
6544
6645
|
};
|
|
6545
6646
|
export type JsonApiAutomationOutAttributesStateEnum = typeof JsonApiAutomationOutAttributesStateEnum[keyof typeof JsonApiAutomationOutAttributesStateEnum];
|
|
6647
|
+
/**
|
|
6648
|
+
*
|
|
6649
|
+
* @export
|
|
6650
|
+
* @interface JsonApiAutomationOutAttributesAlert
|
|
6651
|
+
*/
|
|
6652
|
+
export interface JsonApiAutomationOutAttributesAlert {
|
|
6653
|
+
/**
|
|
6654
|
+
*
|
|
6655
|
+
* @type {AlertAfm}
|
|
6656
|
+
* @memberof JsonApiAutomationOutAttributesAlert
|
|
6657
|
+
*/
|
|
6658
|
+
execution: AlertAfm;
|
|
6659
|
+
/**
|
|
6660
|
+
*
|
|
6661
|
+
* @type {AlertCondition}
|
|
6662
|
+
* @memberof JsonApiAutomationOutAttributesAlert
|
|
6663
|
+
*/
|
|
6664
|
+
condition: AlertCondition;
|
|
6665
|
+
/**
|
|
6666
|
+
* 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.
|
|
6667
|
+
* @type {string}
|
|
6668
|
+
* @memberof JsonApiAutomationOutAttributesAlert
|
|
6669
|
+
*/
|
|
6670
|
+
trigger?: JsonApiAutomationOutAttributesAlertTriggerEnum;
|
|
6671
|
+
}
|
|
6672
|
+
export declare const JsonApiAutomationOutAttributesAlertTriggerEnum: {
|
|
6673
|
+
readonly ALWAYS: "ALWAYS";
|
|
6674
|
+
readonly ONCE: "ONCE";
|
|
6675
|
+
};
|
|
6676
|
+
export type JsonApiAutomationOutAttributesAlertTriggerEnum = typeof JsonApiAutomationOutAttributesAlertTriggerEnum[keyof typeof JsonApiAutomationOutAttributesAlertTriggerEnum];
|
|
6677
|
+
/**
|
|
6678
|
+
*
|
|
6679
|
+
* @export
|
|
6680
|
+
* @interface JsonApiAutomationOutAttributesExternalRecipients
|
|
6681
|
+
*/
|
|
6682
|
+
export interface JsonApiAutomationOutAttributesExternalRecipients {
|
|
6683
|
+
/**
|
|
6684
|
+
* E-mail address to send notifications from.
|
|
6685
|
+
* @type {string}
|
|
6686
|
+
* @memberof JsonApiAutomationOutAttributesExternalRecipients
|
|
6687
|
+
*/
|
|
6688
|
+
email: string;
|
|
6689
|
+
}
|
|
6690
|
+
/**
|
|
6691
|
+
*
|
|
6692
|
+
* @export
|
|
6693
|
+
* @interface JsonApiAutomationOutAttributesImageExports
|
|
6694
|
+
*/
|
|
6695
|
+
export interface JsonApiAutomationOutAttributesImageExports {
|
|
6696
|
+
/**
|
|
6697
|
+
*
|
|
6698
|
+
* @type {ImageExportRequest}
|
|
6699
|
+
* @memberof JsonApiAutomationOutAttributesImageExports
|
|
6700
|
+
*/
|
|
6701
|
+
requestPayload: ImageExportRequest;
|
|
6702
|
+
}
|
|
6703
|
+
/**
|
|
6704
|
+
* Additional information for the automation.
|
|
6705
|
+
* @export
|
|
6706
|
+
* @interface JsonApiAutomationOutAttributesMetadata
|
|
6707
|
+
*/
|
|
6708
|
+
export interface JsonApiAutomationOutAttributesMetadata {
|
|
6709
|
+
/**
|
|
6710
|
+
*
|
|
6711
|
+
* @type {string}
|
|
6712
|
+
* @memberof JsonApiAutomationOutAttributesMetadata
|
|
6713
|
+
*/
|
|
6714
|
+
widget?: string;
|
|
6715
|
+
/**
|
|
6716
|
+
*
|
|
6717
|
+
* @type {Array<VisibleFilter>}
|
|
6718
|
+
* @memberof JsonApiAutomationOutAttributesMetadata
|
|
6719
|
+
*/
|
|
6720
|
+
visibleFilters?: Array<VisibleFilter>;
|
|
6721
|
+
}
|
|
6722
|
+
/**
|
|
6723
|
+
*
|
|
6724
|
+
* @export
|
|
6725
|
+
* @interface JsonApiAutomationOutAttributesRawExports
|
|
6726
|
+
*/
|
|
6727
|
+
export interface JsonApiAutomationOutAttributesRawExports {
|
|
6728
|
+
/**
|
|
6729
|
+
*
|
|
6730
|
+
* @type {RawExportRequest}
|
|
6731
|
+
* @memberof JsonApiAutomationOutAttributesRawExports
|
|
6732
|
+
*/
|
|
6733
|
+
requestPayload: RawExportRequest;
|
|
6734
|
+
}
|
|
6735
|
+
/**
|
|
6736
|
+
*
|
|
6737
|
+
* @export
|
|
6738
|
+
* @interface JsonApiAutomationOutAttributesSchedule
|
|
6739
|
+
*/
|
|
6740
|
+
export interface JsonApiAutomationOutAttributesSchedule {
|
|
6741
|
+
/**
|
|
6742
|
+
* 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.
|
|
6743
|
+
* @type {string}
|
|
6744
|
+
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
6745
|
+
*/
|
|
6746
|
+
cron: string;
|
|
6747
|
+
/**
|
|
6748
|
+
* Human-readable description of the cron expression.
|
|
6749
|
+
* @type {string}
|
|
6750
|
+
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
6751
|
+
*/
|
|
6752
|
+
cronDescription?: string;
|
|
6753
|
+
/**
|
|
6754
|
+
* Timezone in which the schedule is defined.
|
|
6755
|
+
* @type {string}
|
|
6756
|
+
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
6757
|
+
*/
|
|
6758
|
+
timezone: string;
|
|
6759
|
+
/**
|
|
6760
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
6761
|
+
* @type {string}
|
|
6762
|
+
* @memberof JsonApiAutomationOutAttributesSchedule
|
|
6763
|
+
*/
|
|
6764
|
+
firstRun?: string;
|
|
6765
|
+
}
|
|
6766
|
+
/**
|
|
6767
|
+
*
|
|
6768
|
+
* @export
|
|
6769
|
+
* @interface JsonApiAutomationOutAttributesSlidesExports
|
|
6770
|
+
*/
|
|
6771
|
+
export interface JsonApiAutomationOutAttributesSlidesExports {
|
|
6772
|
+
/**
|
|
6773
|
+
*
|
|
6774
|
+
* @type {SlidesExportRequest}
|
|
6775
|
+
* @memberof JsonApiAutomationOutAttributesSlidesExports
|
|
6776
|
+
*/
|
|
6777
|
+
requestPayload: SlidesExportRequest;
|
|
6778
|
+
}
|
|
6779
|
+
/**
|
|
6780
|
+
*
|
|
6781
|
+
* @export
|
|
6782
|
+
* @interface JsonApiAutomationOutAttributesTabularExports
|
|
6783
|
+
*/
|
|
6784
|
+
export interface JsonApiAutomationOutAttributesTabularExports {
|
|
6785
|
+
/**
|
|
6786
|
+
*
|
|
6787
|
+
* @type {TabularExportRequest}
|
|
6788
|
+
* @memberof JsonApiAutomationOutAttributesTabularExports
|
|
6789
|
+
*/
|
|
6790
|
+
requestPayload: TabularExportRequest;
|
|
6791
|
+
}
|
|
6792
|
+
/**
|
|
6793
|
+
*
|
|
6794
|
+
* @export
|
|
6795
|
+
* @interface JsonApiAutomationOutAttributesVisualExports
|
|
6796
|
+
*/
|
|
6797
|
+
export interface JsonApiAutomationOutAttributesVisualExports {
|
|
6798
|
+
/**
|
|
6799
|
+
*
|
|
6800
|
+
* @type {VisualExportRequest}
|
|
6801
|
+
* @memberof JsonApiAutomationOutAttributesVisualExports
|
|
6802
|
+
*/
|
|
6803
|
+
requestPayload: VisualExportRequest;
|
|
6804
|
+
}
|
|
6546
6805
|
/**
|
|
6547
6806
|
*
|
|
6548
6807
|
* @export
|
|
@@ -6612,16 +6871,16 @@ export interface JsonApiAutomationOutList {
|
|
|
6612
6871
|
export interface JsonApiAutomationOutRelationships {
|
|
6613
6872
|
/**
|
|
6614
6873
|
*
|
|
6615
|
-
* @type {
|
|
6874
|
+
* @type {JsonApiAutomationOutRelationshipsNotificationChannel}
|
|
6616
6875
|
* @memberof JsonApiAutomationOutRelationships
|
|
6617
6876
|
*/
|
|
6618
|
-
notificationChannel?:
|
|
6877
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
6619
6878
|
/**
|
|
6620
6879
|
*
|
|
6621
|
-
* @type {
|
|
6880
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
6622
6881
|
* @memberof JsonApiAutomationOutRelationships
|
|
6623
6882
|
*/
|
|
6624
|
-
analyticalDashboard?:
|
|
6883
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
6625
6884
|
/**
|
|
6626
6885
|
*
|
|
6627
6886
|
* @type {JsonApiVisualizationObjectOutRelationshipsCreatedBy}
|
|
@@ -6636,16 +6895,55 @@ export interface JsonApiAutomationOutRelationships {
|
|
|
6636
6895
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
6637
6896
|
/**
|
|
6638
6897
|
*
|
|
6639
|
-
* @type {
|
|
6898
|
+
* @type {JsonApiAutomationOutRelationshipsExportDefinitions}
|
|
6640
6899
|
* @memberof JsonApiAutomationOutRelationships
|
|
6641
6900
|
*/
|
|
6642
|
-
exportDefinitions?:
|
|
6901
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
6643
6902
|
/**
|
|
6644
6903
|
*
|
|
6645
|
-
* @type {
|
|
6904
|
+
* @type {JsonApiAutomationOutRelationshipsRecipients}
|
|
6646
6905
|
* @memberof JsonApiAutomationOutRelationships
|
|
6647
6906
|
*/
|
|
6648
|
-
recipients?:
|
|
6907
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
6908
|
+
}
|
|
6909
|
+
/**
|
|
6910
|
+
*
|
|
6911
|
+
* @export
|
|
6912
|
+
* @interface JsonApiAutomationOutRelationshipsExportDefinitions
|
|
6913
|
+
*/
|
|
6914
|
+
export interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
6915
|
+
/**
|
|
6916
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
6917
|
+
* @type {Array<JsonApiExportDefinitionLinkage>}
|
|
6918
|
+
* @memberof JsonApiAutomationOutRelationshipsExportDefinitions
|
|
6919
|
+
*/
|
|
6920
|
+
data: Array<JsonApiExportDefinitionLinkage>;
|
|
6921
|
+
}
|
|
6922
|
+
/**
|
|
6923
|
+
*
|
|
6924
|
+
* @export
|
|
6925
|
+
* @interface JsonApiAutomationOutRelationshipsNotificationChannel
|
|
6926
|
+
*/
|
|
6927
|
+
export interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
6928
|
+
/**
|
|
6929
|
+
*
|
|
6930
|
+
* @type {JsonApiNotificationChannelToOneLinkage}
|
|
6931
|
+
* @memberof JsonApiAutomationOutRelationshipsNotificationChannel
|
|
6932
|
+
*/
|
|
6933
|
+
data: JsonApiNotificationChannelToOneLinkage | null;
|
|
6934
|
+
}
|
|
6935
|
+
/**
|
|
6936
|
+
*
|
|
6937
|
+
* @export
|
|
6938
|
+
* @interface JsonApiAutomationOutRelationshipsRecipients
|
|
6939
|
+
*/
|
|
6940
|
+
export interface JsonApiAutomationOutRelationshipsRecipients {
|
|
6941
|
+
/**
|
|
6942
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
6943
|
+
* @type {Array<JsonApiUserLinkage>}
|
|
6944
|
+
* @memberof JsonApiAutomationOutRelationshipsRecipients
|
|
6945
|
+
*/
|
|
6946
|
+
data: Array<JsonApiUserLinkage>;
|
|
6649
6947
|
}
|
|
6650
6948
|
/**
|
|
6651
6949
|
*
|
|
@@ -6767,10 +7065,10 @@ export interface JsonApiAutomationPatchAttributes {
|
|
|
6767
7065
|
details?: any;
|
|
6768
7066
|
/**
|
|
6769
7067
|
*
|
|
6770
|
-
* @type {
|
|
7068
|
+
* @type {JsonApiAutomationOutAttributesMetadata}
|
|
6771
7069
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6772
7070
|
*/
|
|
6773
|
-
metadata?:
|
|
7071
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
6774
7072
|
/**
|
|
6775
7073
|
* Current state of the automation.
|
|
6776
7074
|
* @type {string}
|
|
@@ -6779,216 +7077,58 @@ export interface JsonApiAutomationPatchAttributes {
|
|
|
6779
7077
|
state?: JsonApiAutomationPatchAttributesStateEnum;
|
|
6780
7078
|
/**
|
|
6781
7079
|
*
|
|
6782
|
-
* @type {
|
|
7080
|
+
* @type {JsonApiAutomationOutAttributesSchedule}
|
|
6783
7081
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6784
7082
|
*/
|
|
6785
|
-
schedule?:
|
|
7083
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
6786
7084
|
/**
|
|
6787
7085
|
*
|
|
6788
|
-
* @type {
|
|
7086
|
+
* @type {JsonApiAutomationOutAttributesAlert}
|
|
6789
7087
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6790
7088
|
*/
|
|
6791
|
-
alert?:
|
|
7089
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
6792
7090
|
/**
|
|
6793
7091
|
*
|
|
6794
|
-
* @type {Array<
|
|
7092
|
+
* @type {Array<JsonApiAutomationOutAttributesTabularExports>}
|
|
6795
7093
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6796
7094
|
*/
|
|
6797
|
-
tabularExports?: Array<
|
|
7095
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExports>;
|
|
6798
7096
|
/**
|
|
6799
7097
|
*
|
|
6800
|
-
* @type {Array<
|
|
7098
|
+
* @type {Array<JsonApiAutomationOutAttributesVisualExports>}
|
|
6801
7099
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6802
7100
|
*/
|
|
6803
|
-
visualExports?: Array<
|
|
7101
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExports>;
|
|
6804
7102
|
/**
|
|
6805
7103
|
*
|
|
6806
|
-
* @type {Array<
|
|
7104
|
+
* @type {Array<JsonApiAutomationOutAttributesImageExports>}
|
|
6807
7105
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6808
7106
|
*/
|
|
6809
|
-
imageExports?: Array<
|
|
7107
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExports>;
|
|
6810
7108
|
/**
|
|
6811
7109
|
*
|
|
6812
|
-
* @type {Array<
|
|
7110
|
+
* @type {Array<JsonApiAutomationOutAttributesRawExports>}
|
|
6813
7111
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6814
7112
|
*/
|
|
6815
|
-
rawExports?: Array<
|
|
7113
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExports>;
|
|
6816
7114
|
/**
|
|
6817
7115
|
*
|
|
6818
|
-
* @type {Array<
|
|
7116
|
+
* @type {Array<JsonApiAutomationOutAttributesSlidesExports>}
|
|
6819
7117
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6820
7118
|
*/
|
|
6821
|
-
slidesExports?: Array<
|
|
7119
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExports>;
|
|
6822
7120
|
/**
|
|
6823
7121
|
* External recipients of the automation action results.
|
|
6824
|
-
* @type {Array<
|
|
7122
|
+
* @type {Array<JsonApiAutomationOutAttributesExternalRecipients>}
|
|
6825
7123
|
* @memberof JsonApiAutomationPatchAttributes
|
|
6826
7124
|
*/
|
|
6827
|
-
externalRecipients?: Array<
|
|
7125
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipients>;
|
|
6828
7126
|
}
|
|
6829
7127
|
export declare const JsonApiAutomationPatchAttributesStateEnum: {
|
|
6830
7128
|
readonly ACTIVE: "ACTIVE";
|
|
6831
7129
|
readonly PAUSED: "PAUSED";
|
|
6832
7130
|
};
|
|
6833
7131
|
export type JsonApiAutomationPatchAttributesStateEnum = typeof JsonApiAutomationPatchAttributesStateEnum[keyof typeof JsonApiAutomationPatchAttributesStateEnum];
|
|
6834
|
-
/**
|
|
6835
|
-
*
|
|
6836
|
-
* @export
|
|
6837
|
-
* @interface JsonApiAutomationPatchAttributesAlert
|
|
6838
|
-
*/
|
|
6839
|
-
export interface JsonApiAutomationPatchAttributesAlert {
|
|
6840
|
-
/**
|
|
6841
|
-
*
|
|
6842
|
-
* @type {AlertAfm}
|
|
6843
|
-
* @memberof JsonApiAutomationPatchAttributesAlert
|
|
6844
|
-
*/
|
|
6845
|
-
execution: AlertAfm;
|
|
6846
|
-
/**
|
|
6847
|
-
*
|
|
6848
|
-
* @type {AlertCondition}
|
|
6849
|
-
* @memberof JsonApiAutomationPatchAttributesAlert
|
|
6850
|
-
*/
|
|
6851
|
-
condition: AlertCondition;
|
|
6852
|
-
/**
|
|
6853
|
-
* 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.
|
|
6854
|
-
* @type {string}
|
|
6855
|
-
* @memberof JsonApiAutomationPatchAttributesAlert
|
|
6856
|
-
*/
|
|
6857
|
-
trigger?: JsonApiAutomationPatchAttributesAlertTriggerEnum;
|
|
6858
|
-
}
|
|
6859
|
-
export declare const JsonApiAutomationPatchAttributesAlertTriggerEnum: {
|
|
6860
|
-
readonly ALWAYS: "ALWAYS";
|
|
6861
|
-
readonly ONCE: "ONCE";
|
|
6862
|
-
};
|
|
6863
|
-
export type JsonApiAutomationPatchAttributesAlertTriggerEnum = typeof JsonApiAutomationPatchAttributesAlertTriggerEnum[keyof typeof JsonApiAutomationPatchAttributesAlertTriggerEnum];
|
|
6864
|
-
/**
|
|
6865
|
-
*
|
|
6866
|
-
* @export
|
|
6867
|
-
* @interface JsonApiAutomationPatchAttributesExternalRecipients
|
|
6868
|
-
*/
|
|
6869
|
-
export interface JsonApiAutomationPatchAttributesExternalRecipients {
|
|
6870
|
-
/**
|
|
6871
|
-
* E-mail address to send notifications from.
|
|
6872
|
-
* @type {string}
|
|
6873
|
-
* @memberof JsonApiAutomationPatchAttributesExternalRecipients
|
|
6874
|
-
*/
|
|
6875
|
-
email: string;
|
|
6876
|
-
}
|
|
6877
|
-
/**
|
|
6878
|
-
*
|
|
6879
|
-
* @export
|
|
6880
|
-
* @interface JsonApiAutomationPatchAttributesImageExports
|
|
6881
|
-
*/
|
|
6882
|
-
export interface JsonApiAutomationPatchAttributesImageExports {
|
|
6883
|
-
/**
|
|
6884
|
-
*
|
|
6885
|
-
* @type {ImageExportRequest}
|
|
6886
|
-
* @memberof JsonApiAutomationPatchAttributesImageExports
|
|
6887
|
-
*/
|
|
6888
|
-
requestPayload: ImageExportRequest;
|
|
6889
|
-
}
|
|
6890
|
-
/**
|
|
6891
|
-
* Additional information for the automation.
|
|
6892
|
-
* @export
|
|
6893
|
-
* @interface JsonApiAutomationPatchAttributesMetadata
|
|
6894
|
-
*/
|
|
6895
|
-
export interface JsonApiAutomationPatchAttributesMetadata {
|
|
6896
|
-
/**
|
|
6897
|
-
*
|
|
6898
|
-
* @type {string}
|
|
6899
|
-
* @memberof JsonApiAutomationPatchAttributesMetadata
|
|
6900
|
-
*/
|
|
6901
|
-
widget?: string;
|
|
6902
|
-
/**
|
|
6903
|
-
*
|
|
6904
|
-
* @type {Array<VisibleFilter>}
|
|
6905
|
-
* @memberof JsonApiAutomationPatchAttributesMetadata
|
|
6906
|
-
*/
|
|
6907
|
-
visibleFilters?: Array<VisibleFilter>;
|
|
6908
|
-
}
|
|
6909
|
-
/**
|
|
6910
|
-
*
|
|
6911
|
-
* @export
|
|
6912
|
-
* @interface JsonApiAutomationPatchAttributesRawExports
|
|
6913
|
-
*/
|
|
6914
|
-
export interface JsonApiAutomationPatchAttributesRawExports {
|
|
6915
|
-
/**
|
|
6916
|
-
*
|
|
6917
|
-
* @type {RawExportRequest}
|
|
6918
|
-
* @memberof JsonApiAutomationPatchAttributesRawExports
|
|
6919
|
-
*/
|
|
6920
|
-
requestPayload: RawExportRequest;
|
|
6921
|
-
}
|
|
6922
|
-
/**
|
|
6923
|
-
*
|
|
6924
|
-
* @export
|
|
6925
|
-
* @interface JsonApiAutomationPatchAttributesSchedule
|
|
6926
|
-
*/
|
|
6927
|
-
export interface JsonApiAutomationPatchAttributesSchedule {
|
|
6928
|
-
/**
|
|
6929
|
-
* 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.
|
|
6930
|
-
* @type {string}
|
|
6931
|
-
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
6932
|
-
*/
|
|
6933
|
-
cron: string;
|
|
6934
|
-
/**
|
|
6935
|
-
* Human-readable description of the cron expression.
|
|
6936
|
-
* @type {string}
|
|
6937
|
-
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
6938
|
-
*/
|
|
6939
|
-
cronDescription?: string;
|
|
6940
|
-
/**
|
|
6941
|
-
* Timezone in which the schedule is defined.
|
|
6942
|
-
* @type {string}
|
|
6943
|
-
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
6944
|
-
*/
|
|
6945
|
-
timezone: string;
|
|
6946
|
-
/**
|
|
6947
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
6948
|
-
* @type {string}
|
|
6949
|
-
* @memberof JsonApiAutomationPatchAttributesSchedule
|
|
6950
|
-
*/
|
|
6951
|
-
firstRun?: string;
|
|
6952
|
-
}
|
|
6953
|
-
/**
|
|
6954
|
-
*
|
|
6955
|
-
* @export
|
|
6956
|
-
* @interface JsonApiAutomationPatchAttributesSlidesExports
|
|
6957
|
-
*/
|
|
6958
|
-
export interface JsonApiAutomationPatchAttributesSlidesExports {
|
|
6959
|
-
/**
|
|
6960
|
-
*
|
|
6961
|
-
* @type {SlidesExportRequest}
|
|
6962
|
-
* @memberof JsonApiAutomationPatchAttributesSlidesExports
|
|
6963
|
-
*/
|
|
6964
|
-
requestPayload: SlidesExportRequest;
|
|
6965
|
-
}
|
|
6966
|
-
/**
|
|
6967
|
-
*
|
|
6968
|
-
* @export
|
|
6969
|
-
* @interface JsonApiAutomationPatchAttributesTabularExports
|
|
6970
|
-
*/
|
|
6971
|
-
export interface JsonApiAutomationPatchAttributesTabularExports {
|
|
6972
|
-
/**
|
|
6973
|
-
*
|
|
6974
|
-
* @type {TabularExportRequest}
|
|
6975
|
-
* @memberof JsonApiAutomationPatchAttributesTabularExports
|
|
6976
|
-
*/
|
|
6977
|
-
requestPayload: TabularExportRequest;
|
|
6978
|
-
}
|
|
6979
|
-
/**
|
|
6980
|
-
*
|
|
6981
|
-
* @export
|
|
6982
|
-
* @interface JsonApiAutomationPatchAttributesVisualExports
|
|
6983
|
-
*/
|
|
6984
|
-
export interface JsonApiAutomationPatchAttributesVisualExports {
|
|
6985
|
-
/**
|
|
6986
|
-
*
|
|
6987
|
-
* @type {VisualExportRequest}
|
|
6988
|
-
* @memberof JsonApiAutomationPatchAttributesVisualExports
|
|
6989
|
-
*/
|
|
6990
|
-
requestPayload: VisualExportRequest;
|
|
6991
|
-
}
|
|
6992
7132
|
/**
|
|
6993
7133
|
*
|
|
6994
7134
|
* @export
|
|
@@ -7010,80 +7150,28 @@ export interface JsonApiAutomationPatchDocument {
|
|
|
7010
7150
|
export interface JsonApiAutomationPatchRelationships {
|
|
7011
7151
|
/**
|
|
7012
7152
|
*
|
|
7013
|
-
* @type {
|
|
7153
|
+
* @type {JsonApiAutomationOutRelationshipsNotificationChannel}
|
|
7014
7154
|
* @memberof JsonApiAutomationPatchRelationships
|
|
7015
7155
|
*/
|
|
7016
|
-
notificationChannel?:
|
|
7156
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
7017
7157
|
/**
|
|
7018
7158
|
*
|
|
7019
|
-
* @type {
|
|
7159
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
7020
7160
|
* @memberof JsonApiAutomationPatchRelationships
|
|
7021
7161
|
*/
|
|
7022
|
-
analyticalDashboard?:
|
|
7162
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
7023
7163
|
/**
|
|
7024
7164
|
*
|
|
7025
|
-
* @type {
|
|
7165
|
+
* @type {JsonApiAutomationOutRelationshipsExportDefinitions}
|
|
7026
7166
|
* @memberof JsonApiAutomationPatchRelationships
|
|
7027
7167
|
*/
|
|
7028
|
-
exportDefinitions?:
|
|
7168
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
7029
7169
|
/**
|
|
7030
7170
|
*
|
|
7031
|
-
* @type {
|
|
7171
|
+
* @type {JsonApiAutomationOutRelationshipsRecipients}
|
|
7032
7172
|
* @memberof JsonApiAutomationPatchRelationships
|
|
7033
7173
|
*/
|
|
7034
|
-
recipients?:
|
|
7035
|
-
}
|
|
7036
|
-
/**
|
|
7037
|
-
*
|
|
7038
|
-
* @export
|
|
7039
|
-
* @interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard
|
|
7040
|
-
*/
|
|
7041
|
-
export interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard {
|
|
7042
|
-
/**
|
|
7043
|
-
*
|
|
7044
|
-
* @type {JsonApiAnalyticalDashboardToOneLinkage}
|
|
7045
|
-
* @memberof JsonApiAutomationPatchRelationshipsAnalyticalDashboard
|
|
7046
|
-
*/
|
|
7047
|
-
data: JsonApiAnalyticalDashboardToOneLinkage | null;
|
|
7048
|
-
}
|
|
7049
|
-
/**
|
|
7050
|
-
*
|
|
7051
|
-
* @export
|
|
7052
|
-
* @interface JsonApiAutomationPatchRelationshipsExportDefinitions
|
|
7053
|
-
*/
|
|
7054
|
-
export interface JsonApiAutomationPatchRelationshipsExportDefinitions {
|
|
7055
|
-
/**
|
|
7056
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7057
|
-
* @type {Array<JsonApiExportDefinitionLinkage>}
|
|
7058
|
-
* @memberof JsonApiAutomationPatchRelationshipsExportDefinitions
|
|
7059
|
-
*/
|
|
7060
|
-
data: Array<JsonApiExportDefinitionLinkage>;
|
|
7061
|
-
}
|
|
7062
|
-
/**
|
|
7063
|
-
*
|
|
7064
|
-
* @export
|
|
7065
|
-
* @interface JsonApiAutomationPatchRelationshipsNotificationChannel
|
|
7066
|
-
*/
|
|
7067
|
-
export interface JsonApiAutomationPatchRelationshipsNotificationChannel {
|
|
7068
|
-
/**
|
|
7069
|
-
*
|
|
7070
|
-
* @type {JsonApiNotificationChannelToOneLinkage}
|
|
7071
|
-
* @memberof JsonApiAutomationPatchRelationshipsNotificationChannel
|
|
7072
|
-
*/
|
|
7073
|
-
data: JsonApiNotificationChannelToOneLinkage | null;
|
|
7074
|
-
}
|
|
7075
|
-
/**
|
|
7076
|
-
*
|
|
7077
|
-
* @export
|
|
7078
|
-
* @interface JsonApiAutomationPatchRelationshipsRecipients
|
|
7079
|
-
*/
|
|
7080
|
-
export interface JsonApiAutomationPatchRelationshipsRecipients {
|
|
7081
|
-
/**
|
|
7082
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7083
|
-
* @type {Array<JsonApiUserLinkage>}
|
|
7084
|
-
* @memberof JsonApiAutomationPatchRelationshipsRecipients
|
|
7085
|
-
*/
|
|
7086
|
-
data: Array<JsonApiUserLinkage>;
|
|
7174
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
7087
7175
|
}
|
|
7088
7176
|
/**
|
|
7089
7177
|
* @type JsonApiAutomationToOneLinkage
|
|
@@ -7111,34 +7199,15 @@ export interface JsonApiColorPaletteIn {
|
|
|
7111
7199
|
id: string;
|
|
7112
7200
|
/**
|
|
7113
7201
|
*
|
|
7114
|
-
* @type {
|
|
7202
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
7115
7203
|
* @memberof JsonApiColorPaletteIn
|
|
7116
7204
|
*/
|
|
7117
|
-
attributes:
|
|
7205
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
7118
7206
|
}
|
|
7119
7207
|
export declare const JsonApiColorPaletteInTypeEnum: {
|
|
7120
7208
|
readonly COLOR_PALETTE: "colorPalette";
|
|
7121
7209
|
};
|
|
7122
7210
|
export type JsonApiColorPaletteInTypeEnum = typeof JsonApiColorPaletteInTypeEnum[keyof typeof JsonApiColorPaletteInTypeEnum];
|
|
7123
|
-
/**
|
|
7124
|
-
*
|
|
7125
|
-
* @export
|
|
7126
|
-
* @interface JsonApiColorPaletteInAttributes
|
|
7127
|
-
*/
|
|
7128
|
-
export interface JsonApiColorPaletteInAttributes {
|
|
7129
|
-
/**
|
|
7130
|
-
*
|
|
7131
|
-
* @type {string}
|
|
7132
|
-
* @memberof JsonApiColorPaletteInAttributes
|
|
7133
|
-
*/
|
|
7134
|
-
name: string;
|
|
7135
|
-
/**
|
|
7136
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
7137
|
-
* @type {object}
|
|
7138
|
-
* @memberof JsonApiColorPaletteInAttributes
|
|
7139
|
-
*/
|
|
7140
|
-
content: object;
|
|
7141
|
-
}
|
|
7142
7211
|
/**
|
|
7143
7212
|
*
|
|
7144
7213
|
* @export
|
|
@@ -7172,15 +7241,34 @@ export interface JsonApiColorPaletteOut {
|
|
|
7172
7241
|
id: string;
|
|
7173
7242
|
/**
|
|
7174
7243
|
*
|
|
7175
|
-
* @type {
|
|
7244
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
7176
7245
|
* @memberof JsonApiColorPaletteOut
|
|
7177
7246
|
*/
|
|
7178
|
-
attributes:
|
|
7247
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
7179
7248
|
}
|
|
7180
7249
|
export declare const JsonApiColorPaletteOutTypeEnum: {
|
|
7181
7250
|
readonly COLOR_PALETTE: "colorPalette";
|
|
7182
7251
|
};
|
|
7183
7252
|
export type JsonApiColorPaletteOutTypeEnum = typeof JsonApiColorPaletteOutTypeEnum[keyof typeof JsonApiColorPaletteOutTypeEnum];
|
|
7253
|
+
/**
|
|
7254
|
+
*
|
|
7255
|
+
* @export
|
|
7256
|
+
* @interface JsonApiColorPaletteOutAttributes
|
|
7257
|
+
*/
|
|
7258
|
+
export interface JsonApiColorPaletteOutAttributes {
|
|
7259
|
+
/**
|
|
7260
|
+
*
|
|
7261
|
+
* @type {string}
|
|
7262
|
+
* @memberof JsonApiColorPaletteOutAttributes
|
|
7263
|
+
*/
|
|
7264
|
+
name: string;
|
|
7265
|
+
/**
|
|
7266
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
7267
|
+
* @type {object}
|
|
7268
|
+
* @memberof JsonApiColorPaletteOutAttributes
|
|
7269
|
+
*/
|
|
7270
|
+
content: object;
|
|
7271
|
+
}
|
|
7184
7272
|
/**
|
|
7185
7273
|
*
|
|
7186
7274
|
* @export
|
|
@@ -7245,10 +7333,10 @@ export interface JsonApiColorPaletteOutWithLinks {
|
|
|
7245
7333
|
id: string;
|
|
7246
7334
|
/**
|
|
7247
7335
|
*
|
|
7248
|
-
* @type {
|
|
7336
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
7249
7337
|
* @memberof JsonApiColorPaletteOutWithLinks
|
|
7250
7338
|
*/
|
|
7251
|
-
attributes:
|
|
7339
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
7252
7340
|
/**
|
|
7253
7341
|
*
|
|
7254
7342
|
* @type {ObjectLinks}
|
|
@@ -7341,10 +7429,10 @@ export interface JsonApiCookieSecurityConfigurationIn {
|
|
|
7341
7429
|
id: string;
|
|
7342
7430
|
/**
|
|
7343
7431
|
*
|
|
7344
|
-
* @type {
|
|
7432
|
+
* @type {JsonApiCookieSecurityConfigurationPatchAttributes}
|
|
7345
7433
|
* @memberof JsonApiCookieSecurityConfigurationIn
|
|
7346
7434
|
*/
|
|
7347
|
-
attributes?:
|
|
7435
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
7348
7436
|
}
|
|
7349
7437
|
export declare const JsonApiCookieSecurityConfigurationInTypeEnum: {
|
|
7350
7438
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
@@ -7383,34 +7471,15 @@ export interface JsonApiCookieSecurityConfigurationOut {
|
|
|
7383
7471
|
id: string;
|
|
7384
7472
|
/**
|
|
7385
7473
|
*
|
|
7386
|
-
* @type {
|
|
7474
|
+
* @type {JsonApiCookieSecurityConfigurationPatchAttributes}
|
|
7387
7475
|
* @memberof JsonApiCookieSecurityConfigurationOut
|
|
7388
7476
|
*/
|
|
7389
|
-
attributes?:
|
|
7477
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
7390
7478
|
}
|
|
7391
7479
|
export declare const JsonApiCookieSecurityConfigurationOutTypeEnum: {
|
|
7392
7480
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
7393
7481
|
};
|
|
7394
7482
|
export type JsonApiCookieSecurityConfigurationOutTypeEnum = typeof JsonApiCookieSecurityConfigurationOutTypeEnum[keyof typeof JsonApiCookieSecurityConfigurationOutTypeEnum];
|
|
7395
|
-
/**
|
|
7396
|
-
*
|
|
7397
|
-
* @export
|
|
7398
|
-
* @interface JsonApiCookieSecurityConfigurationOutAttributes
|
|
7399
|
-
*/
|
|
7400
|
-
export interface JsonApiCookieSecurityConfigurationOutAttributes {
|
|
7401
|
-
/**
|
|
7402
|
-
*
|
|
7403
|
-
* @type {string}
|
|
7404
|
-
* @memberof JsonApiCookieSecurityConfigurationOutAttributes
|
|
7405
|
-
*/
|
|
7406
|
-
lastRotation?: string;
|
|
7407
|
-
/**
|
|
7408
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
7409
|
-
* @type {string}
|
|
7410
|
-
* @memberof JsonApiCookieSecurityConfigurationOutAttributes
|
|
7411
|
-
*/
|
|
7412
|
-
rotationInterval?: string;
|
|
7413
|
-
}
|
|
7414
7483
|
/**
|
|
7415
7484
|
*
|
|
7416
7485
|
* @export
|
|
@@ -7450,15 +7519,34 @@ export interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
7450
7519
|
id: string;
|
|
7451
7520
|
/**
|
|
7452
7521
|
*
|
|
7453
|
-
* @type {
|
|
7522
|
+
* @type {JsonApiCookieSecurityConfigurationPatchAttributes}
|
|
7454
7523
|
* @memberof JsonApiCookieSecurityConfigurationPatch
|
|
7455
7524
|
*/
|
|
7456
|
-
attributes?:
|
|
7525
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
7457
7526
|
}
|
|
7458
7527
|
export declare const JsonApiCookieSecurityConfigurationPatchTypeEnum: {
|
|
7459
7528
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
7460
7529
|
};
|
|
7461
7530
|
export type JsonApiCookieSecurityConfigurationPatchTypeEnum = typeof JsonApiCookieSecurityConfigurationPatchTypeEnum[keyof typeof JsonApiCookieSecurityConfigurationPatchTypeEnum];
|
|
7531
|
+
/**
|
|
7532
|
+
*
|
|
7533
|
+
* @export
|
|
7534
|
+
* @interface JsonApiCookieSecurityConfigurationPatchAttributes
|
|
7535
|
+
*/
|
|
7536
|
+
export interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
7537
|
+
/**
|
|
7538
|
+
*
|
|
7539
|
+
* @type {string}
|
|
7540
|
+
* @memberof JsonApiCookieSecurityConfigurationPatchAttributes
|
|
7541
|
+
*/
|
|
7542
|
+
lastRotation?: string;
|
|
7543
|
+
/**
|
|
7544
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
7545
|
+
* @type {string}
|
|
7546
|
+
* @memberof JsonApiCookieSecurityConfigurationPatchAttributes
|
|
7547
|
+
*/
|
|
7548
|
+
rotationInterval?: string;
|
|
7549
|
+
}
|
|
7462
7550
|
/**
|
|
7463
7551
|
*
|
|
7464
7552
|
* @export
|
|
@@ -7492,28 +7580,15 @@ export interface JsonApiCspDirectiveIn {
|
|
|
7492
7580
|
id: string;
|
|
7493
7581
|
/**
|
|
7494
7582
|
*
|
|
7495
|
-
* @type {
|
|
7583
|
+
* @type {JsonApiCspDirectiveOutAttributes}
|
|
7496
7584
|
* @memberof JsonApiCspDirectiveIn
|
|
7497
7585
|
*/
|
|
7498
|
-
attributes:
|
|
7586
|
+
attributes: JsonApiCspDirectiveOutAttributes;
|
|
7499
7587
|
}
|
|
7500
7588
|
export declare const JsonApiCspDirectiveInTypeEnum: {
|
|
7501
7589
|
readonly CSP_DIRECTIVE: "cspDirective";
|
|
7502
7590
|
};
|
|
7503
7591
|
export type JsonApiCspDirectiveInTypeEnum = typeof JsonApiCspDirectiveInTypeEnum[keyof typeof JsonApiCspDirectiveInTypeEnum];
|
|
7504
|
-
/**
|
|
7505
|
-
*
|
|
7506
|
-
* @export
|
|
7507
|
-
* @interface JsonApiCspDirectiveInAttributes
|
|
7508
|
-
*/
|
|
7509
|
-
export interface JsonApiCspDirectiveInAttributes {
|
|
7510
|
-
/**
|
|
7511
|
-
*
|
|
7512
|
-
* @type {Array<string>}
|
|
7513
|
-
* @memberof JsonApiCspDirectiveInAttributes
|
|
7514
|
-
*/
|
|
7515
|
-
sources: Array<string>;
|
|
7516
|
-
}
|
|
7517
7592
|
/**
|
|
7518
7593
|
*
|
|
7519
7594
|
* @export
|
|
@@ -7547,15 +7622,28 @@ export interface JsonApiCspDirectiveOut {
|
|
|
7547
7622
|
id: string;
|
|
7548
7623
|
/**
|
|
7549
7624
|
*
|
|
7550
|
-
* @type {
|
|
7625
|
+
* @type {JsonApiCspDirectiveOutAttributes}
|
|
7551
7626
|
* @memberof JsonApiCspDirectiveOut
|
|
7552
7627
|
*/
|
|
7553
|
-
attributes:
|
|
7628
|
+
attributes: JsonApiCspDirectiveOutAttributes;
|
|
7554
7629
|
}
|
|
7555
7630
|
export declare const JsonApiCspDirectiveOutTypeEnum: {
|
|
7556
7631
|
readonly CSP_DIRECTIVE: "cspDirective";
|
|
7557
7632
|
};
|
|
7558
7633
|
export type JsonApiCspDirectiveOutTypeEnum = typeof JsonApiCspDirectiveOutTypeEnum[keyof typeof JsonApiCspDirectiveOutTypeEnum];
|
|
7634
|
+
/**
|
|
7635
|
+
*
|
|
7636
|
+
* @export
|
|
7637
|
+
* @interface JsonApiCspDirectiveOutAttributes
|
|
7638
|
+
*/
|
|
7639
|
+
export interface JsonApiCspDirectiveOutAttributes {
|
|
7640
|
+
/**
|
|
7641
|
+
*
|
|
7642
|
+
* @type {Array<string>}
|
|
7643
|
+
* @memberof JsonApiCspDirectiveOutAttributes
|
|
7644
|
+
*/
|
|
7645
|
+
sources: Array<string>;
|
|
7646
|
+
}
|
|
7559
7647
|
/**
|
|
7560
7648
|
*
|
|
7561
7649
|
* @export
|
|
@@ -7620,10 +7708,10 @@ export interface JsonApiCspDirectiveOutWithLinks {
|
|
|
7620
7708
|
id: string;
|
|
7621
7709
|
/**
|
|
7622
7710
|
*
|
|
7623
|
-
* @type {
|
|
7711
|
+
* @type {JsonApiCspDirectiveOutAttributes}
|
|
7624
7712
|
* @memberof JsonApiCspDirectiveOutWithLinks
|
|
7625
7713
|
*/
|
|
7626
|
-
attributes:
|
|
7714
|
+
attributes: JsonApiCspDirectiveOutAttributes;
|
|
7627
7715
|
/**
|
|
7628
7716
|
*
|
|
7629
7717
|
* @type {ObjectLinks}
|
|
@@ -8392,10 +8480,10 @@ export interface JsonApiDataSourceIdentifierOut {
|
|
|
8392
8480
|
id: string;
|
|
8393
8481
|
/**
|
|
8394
8482
|
*
|
|
8395
|
-
* @type {
|
|
8483
|
+
* @type {JsonApiDataSourceIdentifierOutMeta}
|
|
8396
8484
|
* @memberof JsonApiDataSourceIdentifierOut
|
|
8397
8485
|
*/
|
|
8398
|
-
meta?:
|
|
8486
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
8399
8487
|
/**
|
|
8400
8488
|
*
|
|
8401
8489
|
* @type {JsonApiDataSourceIdentifierOutAttributes}
|
|
@@ -8504,6 +8592,24 @@ export interface JsonApiDataSourceIdentifierOutList {
|
|
|
8504
8592
|
*/
|
|
8505
8593
|
meta?: JsonApiApiTokenOutListMeta;
|
|
8506
8594
|
}
|
|
8595
|
+
/**
|
|
8596
|
+
*
|
|
8597
|
+
* @export
|
|
8598
|
+
* @interface JsonApiDataSourceIdentifierOutMeta
|
|
8599
|
+
*/
|
|
8600
|
+
export interface JsonApiDataSourceIdentifierOutMeta {
|
|
8601
|
+
/**
|
|
8602
|
+
* List of valid permissions for a logged-in user.
|
|
8603
|
+
* @type {Array<string>}
|
|
8604
|
+
* @memberof JsonApiDataSourceIdentifierOutMeta
|
|
8605
|
+
*/
|
|
8606
|
+
permissions?: Array<JsonApiDataSourceIdentifierOutMetaPermissionsEnum>;
|
|
8607
|
+
}
|
|
8608
|
+
export declare const JsonApiDataSourceIdentifierOutMetaPermissionsEnum: {
|
|
8609
|
+
readonly MANAGE: "MANAGE";
|
|
8610
|
+
readonly USE: "USE";
|
|
8611
|
+
};
|
|
8612
|
+
export type JsonApiDataSourceIdentifierOutMetaPermissionsEnum = typeof JsonApiDataSourceIdentifierOutMetaPermissionsEnum[keyof typeof JsonApiDataSourceIdentifierOutMetaPermissionsEnum];
|
|
8507
8613
|
/**
|
|
8508
8614
|
*
|
|
8509
8615
|
* @export
|
|
@@ -8524,10 +8630,10 @@ export interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
|
8524
8630
|
id: string;
|
|
8525
8631
|
/**
|
|
8526
8632
|
*
|
|
8527
|
-
* @type {
|
|
8633
|
+
* @type {JsonApiDataSourceIdentifierOutMeta}
|
|
8528
8634
|
* @memberof JsonApiDataSourceIdentifierOutWithLinks
|
|
8529
8635
|
*/
|
|
8530
|
-
meta?:
|
|
8636
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
8531
8637
|
/**
|
|
8532
8638
|
*
|
|
8533
8639
|
* @type {JsonApiDataSourceIdentifierOutAttributes}
|
|
@@ -8648,10 +8754,10 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
8648
8754
|
clientSecret?: string | null;
|
|
8649
8755
|
/**
|
|
8650
8756
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
8651
|
-
* @type {Array<
|
|
8757
|
+
* @type {Array<JsonApiDataSourceOutAttributesParameters>}
|
|
8652
8758
|
* @memberof JsonApiDataSourceInAttributes
|
|
8653
8759
|
*/
|
|
8654
|
-
parameters?: Array<
|
|
8760
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParameters> | null;
|
|
8655
8761
|
/**
|
|
8656
8762
|
* Determines how the results coming from a particular datasource should be cached.
|
|
8657
8763
|
* @type {string}
|
|
@@ -8692,25 +8798,6 @@ export declare const JsonApiDataSourceInAttributesCacheStrategyEnum: {
|
|
|
8692
8798
|
readonly NEVER: "NEVER";
|
|
8693
8799
|
};
|
|
8694
8800
|
export type JsonApiDataSourceInAttributesCacheStrategyEnum = typeof JsonApiDataSourceInAttributesCacheStrategyEnum[keyof typeof JsonApiDataSourceInAttributesCacheStrategyEnum];
|
|
8695
|
-
/**
|
|
8696
|
-
*
|
|
8697
|
-
* @export
|
|
8698
|
-
* @interface JsonApiDataSourceInAttributesParameters
|
|
8699
|
-
*/
|
|
8700
|
-
export interface JsonApiDataSourceInAttributesParameters {
|
|
8701
|
-
/**
|
|
8702
|
-
*
|
|
8703
|
-
* @type {string}
|
|
8704
|
-
* @memberof JsonApiDataSourceInAttributesParameters
|
|
8705
|
-
*/
|
|
8706
|
-
name: string;
|
|
8707
|
-
/**
|
|
8708
|
-
*
|
|
8709
|
-
* @type {string}
|
|
8710
|
-
* @memberof JsonApiDataSourceInAttributesParameters
|
|
8711
|
-
*/
|
|
8712
|
-
value: string;
|
|
8713
|
-
}
|
|
8714
8801
|
/**
|
|
8715
8802
|
*
|
|
8716
8803
|
* @export
|
|
@@ -8744,10 +8831,10 @@ export interface JsonApiDataSourceOut {
|
|
|
8744
8831
|
id: string;
|
|
8745
8832
|
/**
|
|
8746
8833
|
*
|
|
8747
|
-
* @type {
|
|
8834
|
+
* @type {JsonApiDataSourceIdentifierOutMeta}
|
|
8748
8835
|
* @memberof JsonApiDataSourceOut
|
|
8749
8836
|
*/
|
|
8750
|
-
meta?:
|
|
8837
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
8751
8838
|
/**
|
|
8752
8839
|
*
|
|
8753
8840
|
* @type {JsonApiDataSourceOutAttributes}
|
|
@@ -8803,16 +8890,16 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
8803
8890
|
clientId?: string | null;
|
|
8804
8891
|
/**
|
|
8805
8892
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
8806
|
-
* @type {Array<
|
|
8893
|
+
* @type {Array<JsonApiDataSourceOutAttributesParameters>}
|
|
8807
8894
|
* @memberof JsonApiDataSourceOutAttributes
|
|
8808
8895
|
*/
|
|
8809
|
-
parameters?: Array<
|
|
8896
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParameters> | null;
|
|
8810
8897
|
/**
|
|
8811
8898
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
8812
|
-
* @type {Array<
|
|
8899
|
+
* @type {Array<JsonApiDataSourceOutAttributesParameters>}
|
|
8813
8900
|
* @memberof JsonApiDataSourceOutAttributes
|
|
8814
8901
|
*/
|
|
8815
|
-
decodedParameters?: Array<
|
|
8902
|
+
decodedParameters?: Array<JsonApiDataSourceOutAttributesParameters> | null;
|
|
8816
8903
|
/**
|
|
8817
8904
|
* Determines how the results coming from a particular datasource should be cached.
|
|
8818
8905
|
* @type {string}
|
|
@@ -8867,6 +8954,25 @@ export declare const JsonApiDataSourceOutAttributesAuthenticationTypeEnum: {
|
|
|
8867
8954
|
readonly ACCESS_TOKEN: "ACCESS_TOKEN";
|
|
8868
8955
|
};
|
|
8869
8956
|
export type JsonApiDataSourceOutAttributesAuthenticationTypeEnum = typeof JsonApiDataSourceOutAttributesAuthenticationTypeEnum[keyof typeof JsonApiDataSourceOutAttributesAuthenticationTypeEnum];
|
|
8957
|
+
/**
|
|
8958
|
+
*
|
|
8959
|
+
* @export
|
|
8960
|
+
* @interface JsonApiDataSourceOutAttributesParameters
|
|
8961
|
+
*/
|
|
8962
|
+
export interface JsonApiDataSourceOutAttributesParameters {
|
|
8963
|
+
/**
|
|
8964
|
+
*
|
|
8965
|
+
* @type {string}
|
|
8966
|
+
* @memberof JsonApiDataSourceOutAttributesParameters
|
|
8967
|
+
*/
|
|
8968
|
+
name: string;
|
|
8969
|
+
/**
|
|
8970
|
+
*
|
|
8971
|
+
* @type {string}
|
|
8972
|
+
* @memberof JsonApiDataSourceOutAttributesParameters
|
|
8973
|
+
*/
|
|
8974
|
+
value: string;
|
|
8975
|
+
}
|
|
8870
8976
|
/**
|
|
8871
8977
|
*
|
|
8872
8978
|
* @export
|
|
@@ -8911,24 +9017,6 @@ export interface JsonApiDataSourceOutList {
|
|
|
8911
9017
|
*/
|
|
8912
9018
|
meta?: JsonApiApiTokenOutListMeta;
|
|
8913
9019
|
}
|
|
8914
|
-
/**
|
|
8915
|
-
*
|
|
8916
|
-
* @export
|
|
8917
|
-
* @interface JsonApiDataSourceOutMeta
|
|
8918
|
-
*/
|
|
8919
|
-
export interface JsonApiDataSourceOutMeta {
|
|
8920
|
-
/**
|
|
8921
|
-
* List of valid permissions for a logged-in user.
|
|
8922
|
-
* @type {Array<string>}
|
|
8923
|
-
* @memberof JsonApiDataSourceOutMeta
|
|
8924
|
-
*/
|
|
8925
|
-
permissions?: Array<JsonApiDataSourceOutMetaPermissionsEnum>;
|
|
8926
|
-
}
|
|
8927
|
-
export declare const JsonApiDataSourceOutMetaPermissionsEnum: {
|
|
8928
|
-
readonly MANAGE: "MANAGE";
|
|
8929
|
-
readonly USE: "USE";
|
|
8930
|
-
};
|
|
8931
|
-
export type JsonApiDataSourceOutMetaPermissionsEnum = typeof JsonApiDataSourceOutMetaPermissionsEnum[keyof typeof JsonApiDataSourceOutMetaPermissionsEnum];
|
|
8932
9020
|
/**
|
|
8933
9021
|
*
|
|
8934
9022
|
* @export
|
|
@@ -8949,10 +9037,10 @@ export interface JsonApiDataSourceOutWithLinks {
|
|
|
8949
9037
|
id: string;
|
|
8950
9038
|
/**
|
|
8951
9039
|
*
|
|
8952
|
-
* @type {
|
|
9040
|
+
* @type {JsonApiDataSourceIdentifierOutMeta}
|
|
8953
9041
|
* @memberof JsonApiDataSourceOutWithLinks
|
|
8954
9042
|
*/
|
|
8955
|
-
meta?:
|
|
9043
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
8956
9044
|
/**
|
|
8957
9045
|
*
|
|
8958
9046
|
* @type {JsonApiDataSourceOutAttributes}
|
|
@@ -9073,10 +9161,10 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
9073
9161
|
clientSecret?: string | null;
|
|
9074
9162
|
/**
|
|
9075
9163
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
9076
|
-
* @type {Array<
|
|
9164
|
+
* @type {Array<JsonApiDataSourceOutAttributesParameters>}
|
|
9077
9165
|
* @memberof JsonApiDataSourcePatchAttributes
|
|
9078
9166
|
*/
|
|
9079
|
-
parameters?: Array<
|
|
9167
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParameters> | null;
|
|
9080
9168
|
/**
|
|
9081
9169
|
* Determines how the results coming from a particular datasource should be cached.
|
|
9082
9170
|
* @type {string}
|
|
@@ -9254,6 +9342,12 @@ export interface JsonApiDatasetOutAttributes {
|
|
|
9254
9342
|
* @memberof JsonApiDatasetOutAttributes
|
|
9255
9343
|
*/
|
|
9256
9344
|
sql?: JsonApiDatasetOutAttributesSql;
|
|
9345
|
+
/**
|
|
9346
|
+
*
|
|
9347
|
+
* @type {number}
|
|
9348
|
+
* @memberof JsonApiDatasetOutAttributes
|
|
9349
|
+
*/
|
|
9350
|
+
precedence?: number;
|
|
9257
9351
|
/**
|
|
9258
9352
|
*
|
|
9259
9353
|
* @type {boolean}
|
|
@@ -9953,10 +10047,10 @@ export interface JsonApiExportDefinitionOutRelationships {
|
|
|
9953
10047
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
9954
10048
|
/**
|
|
9955
10049
|
*
|
|
9956
|
-
* @type {
|
|
10050
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
9957
10051
|
* @memberof JsonApiExportDefinitionOutRelationships
|
|
9958
10052
|
*/
|
|
9959
|
-
analyticalDashboard?:
|
|
10053
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
9960
10054
|
/**
|
|
9961
10055
|
*
|
|
9962
10056
|
* @type {JsonApiExportDefinitionOutRelationshipsAutomation}
|
|
@@ -9976,6 +10070,19 @@ export interface JsonApiExportDefinitionOutRelationships {
|
|
|
9976
10070
|
*/
|
|
9977
10071
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
9978
10072
|
}
|
|
10073
|
+
/**
|
|
10074
|
+
*
|
|
10075
|
+
* @export
|
|
10076
|
+
* @interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard
|
|
10077
|
+
*/
|
|
10078
|
+
export interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
10079
|
+
/**
|
|
10080
|
+
*
|
|
10081
|
+
* @type {JsonApiAnalyticalDashboardToOneLinkage}
|
|
10082
|
+
* @memberof JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard
|
|
10083
|
+
*/
|
|
10084
|
+
data: JsonApiAnalyticalDashboardToOneLinkage | null;
|
|
10085
|
+
}
|
|
9979
10086
|
/**
|
|
9980
10087
|
*
|
|
9981
10088
|
* @export
|
|
@@ -10148,10 +10255,10 @@ export interface JsonApiExportDefinitionPatchRelationships {
|
|
|
10148
10255
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
10149
10256
|
/**
|
|
10150
10257
|
*
|
|
10151
|
-
* @type {
|
|
10258
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
10152
10259
|
* @memberof JsonApiExportDefinitionPatchRelationships
|
|
10153
10260
|
*/
|
|
10154
|
-
analyticalDashboard?:
|
|
10261
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
10155
10262
|
}
|
|
10156
10263
|
/**
|
|
10157
10264
|
* JSON:API representation of exportDefinition entity.
|
|
@@ -10221,10 +10328,10 @@ export interface JsonApiExportTemplateIn {
|
|
|
10221
10328
|
id: string;
|
|
10222
10329
|
/**
|
|
10223
10330
|
*
|
|
10224
|
-
* @type {
|
|
10331
|
+
* @type {JsonApiExportTemplateOutAttributes}
|
|
10225
10332
|
* @memberof JsonApiExportTemplateIn
|
|
10226
10333
|
*/
|
|
10227
|
-
attributes:
|
|
10334
|
+
attributes: JsonApiExportTemplateOutAttributes;
|
|
10228
10335
|
}
|
|
10229
10336
|
export declare const JsonApiExportTemplateInTypeEnum: {
|
|
10230
10337
|
readonly EXPORT_TEMPLATE: "exportTemplate";
|
|
@@ -10263,15 +10370,106 @@ export interface JsonApiExportTemplateOut {
|
|
|
10263
10370
|
id: string;
|
|
10264
10371
|
/**
|
|
10265
10372
|
*
|
|
10266
|
-
* @type {
|
|
10373
|
+
* @type {JsonApiExportTemplateOutAttributes}
|
|
10267
10374
|
* @memberof JsonApiExportTemplateOut
|
|
10268
10375
|
*/
|
|
10269
|
-
attributes:
|
|
10376
|
+
attributes: JsonApiExportTemplateOutAttributes;
|
|
10270
10377
|
}
|
|
10271
10378
|
export declare const JsonApiExportTemplateOutTypeEnum: {
|
|
10272
10379
|
readonly EXPORT_TEMPLATE: "exportTemplate";
|
|
10273
10380
|
};
|
|
10274
10381
|
export type JsonApiExportTemplateOutTypeEnum = typeof JsonApiExportTemplateOutTypeEnum[keyof typeof JsonApiExportTemplateOutTypeEnum];
|
|
10382
|
+
/**
|
|
10383
|
+
*
|
|
10384
|
+
* @export
|
|
10385
|
+
* @interface JsonApiExportTemplateOutAttributes
|
|
10386
|
+
*/
|
|
10387
|
+
export interface JsonApiExportTemplateOutAttributes {
|
|
10388
|
+
/**
|
|
10389
|
+
* User-facing name of the Slides template.
|
|
10390
|
+
* @type {string}
|
|
10391
|
+
* @memberof JsonApiExportTemplateOutAttributes
|
|
10392
|
+
*/
|
|
10393
|
+
name: string;
|
|
10394
|
+
/**
|
|
10395
|
+
*
|
|
10396
|
+
* @type {JsonApiExportTemplateOutAttributesDashboardSlidesTemplate}
|
|
10397
|
+
* @memberof JsonApiExportTemplateOutAttributes
|
|
10398
|
+
*/
|
|
10399
|
+
dashboardSlidesTemplate?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
10400
|
+
/**
|
|
10401
|
+
*
|
|
10402
|
+
* @type {JsonApiExportTemplateOutAttributesWidgetSlidesTemplate}
|
|
10403
|
+
* @memberof JsonApiExportTemplateOutAttributes
|
|
10404
|
+
*/
|
|
10405
|
+
widgetSlidesTemplate?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
10406
|
+
}
|
|
10407
|
+
/**
|
|
10408
|
+
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
10409
|
+
* @export
|
|
10410
|
+
* @interface JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
10411
|
+
*/
|
|
10412
|
+
export interface JsonApiExportTemplateOutAttributesDashboardSlidesTemplate {
|
|
10413
|
+
/**
|
|
10414
|
+
* Export types this template applies to.
|
|
10415
|
+
* @type {Array<string>}
|
|
10416
|
+
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
10417
|
+
*/
|
|
10418
|
+
appliedOn: Array<JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
10419
|
+
/**
|
|
10420
|
+
*
|
|
10421
|
+
* @type {CoverSlideTemplate}
|
|
10422
|
+
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
10423
|
+
*/
|
|
10424
|
+
coverSlide?: CoverSlideTemplate | null;
|
|
10425
|
+
/**
|
|
10426
|
+
*
|
|
10427
|
+
* @type {IntroSlideTemplate}
|
|
10428
|
+
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
10429
|
+
*/
|
|
10430
|
+
introSlide?: IntroSlideTemplate | null;
|
|
10431
|
+
/**
|
|
10432
|
+
*
|
|
10433
|
+
* @type {SectionSlideTemplate}
|
|
10434
|
+
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
10435
|
+
*/
|
|
10436
|
+
sectionSlide?: SectionSlideTemplate | null;
|
|
10437
|
+
/**
|
|
10438
|
+
*
|
|
10439
|
+
* @type {ContentSlideTemplate}
|
|
10440
|
+
* @memberof JsonApiExportTemplateOutAttributesDashboardSlidesTemplate
|
|
10441
|
+
*/
|
|
10442
|
+
contentSlide?: ContentSlideTemplate | null;
|
|
10443
|
+
}
|
|
10444
|
+
export declare const JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum: {
|
|
10445
|
+
readonly PDF: "PDF";
|
|
10446
|
+
readonly PPTX: "PPTX";
|
|
10447
|
+
};
|
|
10448
|
+
export type JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum = typeof JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum[keyof typeof JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum];
|
|
10449
|
+
/**
|
|
10450
|
+
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
10451
|
+
* @export
|
|
10452
|
+
* @interface JsonApiExportTemplateOutAttributesWidgetSlidesTemplate
|
|
10453
|
+
*/
|
|
10454
|
+
export interface JsonApiExportTemplateOutAttributesWidgetSlidesTemplate {
|
|
10455
|
+
/**
|
|
10456
|
+
* Export types this template applies to.
|
|
10457
|
+
* @type {Array<string>}
|
|
10458
|
+
* @memberof JsonApiExportTemplateOutAttributesWidgetSlidesTemplate
|
|
10459
|
+
*/
|
|
10460
|
+
appliedOn: Array<JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
10461
|
+
/**
|
|
10462
|
+
*
|
|
10463
|
+
* @type {ContentSlideTemplate}
|
|
10464
|
+
* @memberof JsonApiExportTemplateOutAttributesWidgetSlidesTemplate
|
|
10465
|
+
*/
|
|
10466
|
+
contentSlide?: ContentSlideTemplate | null;
|
|
10467
|
+
}
|
|
10468
|
+
export declare const JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum: {
|
|
10469
|
+
readonly PDF: "PDF";
|
|
10470
|
+
readonly PPTX: "PPTX";
|
|
10471
|
+
};
|
|
10472
|
+
export type JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum = typeof JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum[keyof typeof JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum];
|
|
10275
10473
|
/**
|
|
10276
10474
|
*
|
|
10277
10475
|
* @export
|
|
@@ -10336,10 +10534,10 @@ export interface JsonApiExportTemplateOutWithLinks {
|
|
|
10336
10534
|
id: string;
|
|
10337
10535
|
/**
|
|
10338
10536
|
*
|
|
10339
|
-
* @type {
|
|
10537
|
+
* @type {JsonApiExportTemplateOutAttributes}
|
|
10340
10538
|
* @memberof JsonApiExportTemplateOutWithLinks
|
|
10341
10539
|
*/
|
|
10342
|
-
attributes:
|
|
10540
|
+
attributes: JsonApiExportTemplateOutAttributes;
|
|
10343
10541
|
/**
|
|
10344
10542
|
*
|
|
10345
10543
|
* @type {ObjectLinks}
|
|
@@ -10394,16 +10592,16 @@ export interface JsonApiExportTemplatePatchAttributes {
|
|
|
10394
10592
|
name?: string;
|
|
10395
10593
|
/**
|
|
10396
10594
|
*
|
|
10397
|
-
* @type {
|
|
10595
|
+
* @type {JsonApiExportTemplateOutAttributesDashboardSlidesTemplate}
|
|
10398
10596
|
* @memberof JsonApiExportTemplatePatchAttributes
|
|
10399
10597
|
*/
|
|
10400
|
-
dashboardSlidesTemplate?:
|
|
10598
|
+
dashboardSlidesTemplate?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
10401
10599
|
/**
|
|
10402
10600
|
*
|
|
10403
|
-
* @type {
|
|
10601
|
+
* @type {JsonApiExportTemplateOutAttributesWidgetSlidesTemplate}
|
|
10404
10602
|
* @memberof JsonApiExportTemplatePatchAttributes
|
|
10405
10603
|
*/
|
|
10406
|
-
widgetSlidesTemplate?:
|
|
10604
|
+
widgetSlidesTemplate?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
10407
10605
|
}
|
|
10408
10606
|
/**
|
|
10409
10607
|
*
|
|
@@ -10438,106 +10636,15 @@ export interface JsonApiExportTemplatePostOptionalId {
|
|
|
10438
10636
|
id?: string;
|
|
10439
10637
|
/**
|
|
10440
10638
|
*
|
|
10441
|
-
* @type {
|
|
10639
|
+
* @type {JsonApiExportTemplateOutAttributes}
|
|
10442
10640
|
* @memberof JsonApiExportTemplatePostOptionalId
|
|
10443
10641
|
*/
|
|
10444
|
-
attributes:
|
|
10642
|
+
attributes: JsonApiExportTemplateOutAttributes;
|
|
10445
10643
|
}
|
|
10446
10644
|
export declare const JsonApiExportTemplatePostOptionalIdTypeEnum: {
|
|
10447
10645
|
readonly EXPORT_TEMPLATE: "exportTemplate";
|
|
10448
10646
|
};
|
|
10449
10647
|
export type JsonApiExportTemplatePostOptionalIdTypeEnum = typeof JsonApiExportTemplatePostOptionalIdTypeEnum[keyof typeof JsonApiExportTemplatePostOptionalIdTypeEnum];
|
|
10450
|
-
/**
|
|
10451
|
-
*
|
|
10452
|
-
* @export
|
|
10453
|
-
* @interface JsonApiExportTemplatePostOptionalIdAttributes
|
|
10454
|
-
*/
|
|
10455
|
-
export interface JsonApiExportTemplatePostOptionalIdAttributes {
|
|
10456
|
-
/**
|
|
10457
|
-
* User-facing name of the Slides template.
|
|
10458
|
-
* @type {string}
|
|
10459
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributes
|
|
10460
|
-
*/
|
|
10461
|
-
name: string;
|
|
10462
|
-
/**
|
|
10463
|
-
*
|
|
10464
|
-
* @type {JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate}
|
|
10465
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributes
|
|
10466
|
-
*/
|
|
10467
|
-
dashboardSlidesTemplate?: JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate | null;
|
|
10468
|
-
/**
|
|
10469
|
-
*
|
|
10470
|
-
* @type {JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate}
|
|
10471
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributes
|
|
10472
|
-
*/
|
|
10473
|
-
widgetSlidesTemplate?: JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate | null;
|
|
10474
|
-
}
|
|
10475
|
-
/**
|
|
10476
|
-
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
10477
|
-
* @export
|
|
10478
|
-
* @interface JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
10479
|
-
*/
|
|
10480
|
-
export interface JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate {
|
|
10481
|
-
/**
|
|
10482
|
-
* Export types this template applies to.
|
|
10483
|
-
* @type {Array<string>}
|
|
10484
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
10485
|
-
*/
|
|
10486
|
-
appliedOn: Array<JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
10487
|
-
/**
|
|
10488
|
-
*
|
|
10489
|
-
* @type {CoverSlideTemplate}
|
|
10490
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
10491
|
-
*/
|
|
10492
|
-
coverSlide?: CoverSlideTemplate | null;
|
|
10493
|
-
/**
|
|
10494
|
-
*
|
|
10495
|
-
* @type {IntroSlideTemplate}
|
|
10496
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
10497
|
-
*/
|
|
10498
|
-
introSlide?: IntroSlideTemplate | null;
|
|
10499
|
-
/**
|
|
10500
|
-
*
|
|
10501
|
-
* @type {SectionSlideTemplate}
|
|
10502
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
10503
|
-
*/
|
|
10504
|
-
sectionSlide?: SectionSlideTemplate | null;
|
|
10505
|
-
/**
|
|
10506
|
-
*
|
|
10507
|
-
* @type {ContentSlideTemplate}
|
|
10508
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate
|
|
10509
|
-
*/
|
|
10510
|
-
contentSlide?: ContentSlideTemplate | null;
|
|
10511
|
-
}
|
|
10512
|
-
export declare const JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum: {
|
|
10513
|
-
readonly PDF: "PDF";
|
|
10514
|
-
readonly PPTX: "PPTX";
|
|
10515
|
-
};
|
|
10516
|
-
export type JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum = typeof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum[keyof typeof JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplateAppliedOnEnum];
|
|
10517
|
-
/**
|
|
10518
|
-
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
10519
|
-
* @export
|
|
10520
|
-
* @interface JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate
|
|
10521
|
-
*/
|
|
10522
|
-
export interface JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate {
|
|
10523
|
-
/**
|
|
10524
|
-
* Export types this template applies to.
|
|
10525
|
-
* @type {Array<string>}
|
|
10526
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate
|
|
10527
|
-
*/
|
|
10528
|
-
appliedOn: Array<JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
10529
|
-
/**
|
|
10530
|
-
*
|
|
10531
|
-
* @type {ContentSlideTemplate}
|
|
10532
|
-
* @memberof JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate
|
|
10533
|
-
*/
|
|
10534
|
-
contentSlide?: ContentSlideTemplate | null;
|
|
10535
|
-
}
|
|
10536
|
-
export declare const JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum: {
|
|
10537
|
-
readonly PDF: "PDF";
|
|
10538
|
-
readonly PPTX: "PPTX";
|
|
10539
|
-
};
|
|
10540
|
-
export type JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum = typeof JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum[keyof typeof JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplateAppliedOnEnum];
|
|
10541
10648
|
/**
|
|
10542
10649
|
*
|
|
10543
10650
|
* @export
|
|
@@ -10657,6 +10764,12 @@ export interface JsonApiFactOutAttributes {
|
|
|
10657
10764
|
* @memberof JsonApiFactOutAttributes
|
|
10658
10765
|
*/
|
|
10659
10766
|
areRelationsValid?: boolean;
|
|
10767
|
+
/**
|
|
10768
|
+
*
|
|
10769
|
+
* @type {string}
|
|
10770
|
+
* @memberof JsonApiFactOutAttributes
|
|
10771
|
+
*/
|
|
10772
|
+
operation?: JsonApiFactOutAttributesOperationEnum;
|
|
10660
10773
|
}
|
|
10661
10774
|
export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
10662
10775
|
readonly INT: "INT";
|
|
@@ -10668,6 +10781,12 @@ export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
|
10668
10781
|
readonly BOOLEAN: "BOOLEAN";
|
|
10669
10782
|
};
|
|
10670
10783
|
export type JsonApiFactOutAttributesSourceColumnDataTypeEnum = typeof JsonApiFactOutAttributesSourceColumnDataTypeEnum[keyof typeof JsonApiFactOutAttributesSourceColumnDataTypeEnum];
|
|
10784
|
+
export declare const JsonApiFactOutAttributesOperationEnum: {
|
|
10785
|
+
readonly SUM: "SUM";
|
|
10786
|
+
readonly MIN: "MIN";
|
|
10787
|
+
readonly MAX: "MAX";
|
|
10788
|
+
};
|
|
10789
|
+
export type JsonApiFactOutAttributesOperationEnum = typeof JsonApiFactOutAttributesOperationEnum[keyof typeof JsonApiFactOutAttributesOperationEnum];
|
|
10671
10790
|
/**
|
|
10672
10791
|
*
|
|
10673
10792
|
* @export
|
|
@@ -10688,11 +10807,16 @@ export interface JsonApiFactOutDocument {
|
|
|
10688
10807
|
links?: ObjectLinks;
|
|
10689
10808
|
/**
|
|
10690
10809
|
* Included resources
|
|
10691
|
-
* @type {Array<
|
|
10810
|
+
* @type {Array<JsonApiFactOutIncludes>}
|
|
10692
10811
|
* @memberof JsonApiFactOutDocument
|
|
10693
10812
|
*/
|
|
10694
|
-
included?: Array<
|
|
10813
|
+
included?: Array<JsonApiFactOutIncludes>;
|
|
10695
10814
|
}
|
|
10815
|
+
/**
|
|
10816
|
+
* @type JsonApiFactOutIncludes
|
|
10817
|
+
* @export
|
|
10818
|
+
*/
|
|
10819
|
+
export type JsonApiFactOutIncludes = JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks;
|
|
10696
10820
|
/**
|
|
10697
10821
|
* A JSON:API document with a list of resources
|
|
10698
10822
|
* @export
|
|
@@ -10719,10 +10843,10 @@ export interface JsonApiFactOutList {
|
|
|
10719
10843
|
meta?: JsonApiApiTokenOutListMeta;
|
|
10720
10844
|
/**
|
|
10721
10845
|
* Included resources
|
|
10722
|
-
* @type {Array<
|
|
10846
|
+
* @type {Array<JsonApiFactOutIncludes>}
|
|
10723
10847
|
* @memberof JsonApiFactOutList
|
|
10724
10848
|
*/
|
|
10725
|
-
included?: Array<
|
|
10849
|
+
included?: Array<JsonApiFactOutIncludes>;
|
|
10726
10850
|
}
|
|
10727
10851
|
/**
|
|
10728
10852
|
*
|
|
@@ -10736,6 +10860,25 @@ export interface JsonApiFactOutRelationships {
|
|
|
10736
10860
|
* @memberof JsonApiFactOutRelationships
|
|
10737
10861
|
*/
|
|
10738
10862
|
dataset?: JsonApiAttributeOutRelationshipsDataset;
|
|
10863
|
+
/**
|
|
10864
|
+
*
|
|
10865
|
+
* @type {JsonApiFactOutRelationshipsSourceFact}
|
|
10866
|
+
* @memberof JsonApiFactOutRelationships
|
|
10867
|
+
*/
|
|
10868
|
+
sourceFact?: JsonApiFactOutRelationshipsSourceFact;
|
|
10869
|
+
}
|
|
10870
|
+
/**
|
|
10871
|
+
*
|
|
10872
|
+
* @export
|
|
10873
|
+
* @interface JsonApiFactOutRelationshipsSourceFact
|
|
10874
|
+
*/
|
|
10875
|
+
export interface JsonApiFactOutRelationshipsSourceFact {
|
|
10876
|
+
/**
|
|
10877
|
+
*
|
|
10878
|
+
* @type {JsonApiFactToOneLinkage}
|
|
10879
|
+
* @memberof JsonApiFactOutRelationshipsSourceFact
|
|
10880
|
+
*/
|
|
10881
|
+
data: JsonApiFactToOneLinkage | null;
|
|
10739
10882
|
}
|
|
10740
10883
|
/**
|
|
10741
10884
|
*
|
|
@@ -10784,6 +10927,12 @@ export declare const JsonApiFactOutWithLinksTypeEnum: {
|
|
|
10784
10927
|
readonly FACT: "fact";
|
|
10785
10928
|
};
|
|
10786
10929
|
export type JsonApiFactOutWithLinksTypeEnum = typeof JsonApiFactOutWithLinksTypeEnum[keyof typeof JsonApiFactOutWithLinksTypeEnum];
|
|
10930
|
+
/**
|
|
10931
|
+
* @type JsonApiFactToOneLinkage
|
|
10932
|
+
* References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
10933
|
+
* @export
|
|
10934
|
+
*/
|
|
10935
|
+
export type JsonApiFactToOneLinkage = JsonApiFactLinkage;
|
|
10787
10936
|
/**
|
|
10788
10937
|
* JSON:API representation of filterContext entity.
|
|
10789
10938
|
* @export
|
|
@@ -11170,10 +11319,10 @@ export interface JsonApiFilterViewIn {
|
|
|
11170
11319
|
attributes: JsonApiFilterViewOutAttributes;
|
|
11171
11320
|
/**
|
|
11172
11321
|
*
|
|
11173
|
-
* @type {
|
|
11322
|
+
* @type {JsonApiFilterViewOutRelationships}
|
|
11174
11323
|
* @memberof JsonApiFilterViewIn
|
|
11175
11324
|
*/
|
|
11176
|
-
relationships?:
|
|
11325
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
11177
11326
|
}
|
|
11178
11327
|
export declare const JsonApiFilterViewInTypeEnum: {
|
|
11179
11328
|
readonly FILTER_VIEW: "filterView";
|
|
@@ -11218,10 +11367,10 @@ export interface JsonApiFilterViewOut {
|
|
|
11218
11367
|
attributes: JsonApiFilterViewOutAttributes;
|
|
11219
11368
|
/**
|
|
11220
11369
|
*
|
|
11221
|
-
* @type {
|
|
11370
|
+
* @type {JsonApiFilterViewOutRelationships}
|
|
11222
11371
|
* @memberof JsonApiFilterViewOut
|
|
11223
11372
|
*/
|
|
11224
|
-
relationships?:
|
|
11373
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
11225
11374
|
}
|
|
11226
11375
|
export declare const JsonApiFilterViewOutTypeEnum: {
|
|
11227
11376
|
readonly FILTER_VIEW: "filterView";
|
|
@@ -11331,6 +11480,25 @@ export interface JsonApiFilterViewOutList {
|
|
|
11331
11480
|
*/
|
|
11332
11481
|
included?: Array<JsonApiFilterViewOutIncludes>;
|
|
11333
11482
|
}
|
|
11483
|
+
/**
|
|
11484
|
+
*
|
|
11485
|
+
* @export
|
|
11486
|
+
* @interface JsonApiFilterViewOutRelationships
|
|
11487
|
+
*/
|
|
11488
|
+
export interface JsonApiFilterViewOutRelationships {
|
|
11489
|
+
/**
|
|
11490
|
+
*
|
|
11491
|
+
* @type {JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard}
|
|
11492
|
+
* @memberof JsonApiFilterViewOutRelationships
|
|
11493
|
+
*/
|
|
11494
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
11495
|
+
/**
|
|
11496
|
+
*
|
|
11497
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
11498
|
+
* @memberof JsonApiFilterViewOutRelationships
|
|
11499
|
+
*/
|
|
11500
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
11501
|
+
}
|
|
11334
11502
|
/**
|
|
11335
11503
|
*
|
|
11336
11504
|
* @export
|
|
@@ -11357,10 +11525,10 @@ export interface JsonApiFilterViewOutWithLinks {
|
|
|
11357
11525
|
attributes: JsonApiFilterViewOutAttributes;
|
|
11358
11526
|
/**
|
|
11359
11527
|
*
|
|
11360
|
-
* @type {
|
|
11528
|
+
* @type {JsonApiFilterViewOutRelationships}
|
|
11361
11529
|
* @memberof JsonApiFilterViewOutWithLinks
|
|
11362
11530
|
*/
|
|
11363
|
-
relationships?:
|
|
11531
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
11364
11532
|
/**
|
|
11365
11533
|
*
|
|
11366
11534
|
* @type {ObjectLinks}
|
|
@@ -11398,10 +11566,10 @@ export interface JsonApiFilterViewPatch {
|
|
|
11398
11566
|
attributes: JsonApiFilterViewPatchAttributes;
|
|
11399
11567
|
/**
|
|
11400
11568
|
*
|
|
11401
|
-
* @type {
|
|
11569
|
+
* @type {JsonApiFilterViewOutRelationships}
|
|
11402
11570
|
* @memberof JsonApiFilterViewPatch
|
|
11403
11571
|
*/
|
|
11404
|
-
relationships?:
|
|
11572
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
11405
11573
|
}
|
|
11406
11574
|
export declare const JsonApiFilterViewPatchTypeEnum: {
|
|
11407
11575
|
readonly FILTER_VIEW: "filterView";
|
|
@@ -11463,38 +11631,6 @@ export interface JsonApiFilterViewPatchDocument {
|
|
|
11463
11631
|
*/
|
|
11464
11632
|
data: JsonApiFilterViewPatch;
|
|
11465
11633
|
}
|
|
11466
|
-
/**
|
|
11467
|
-
*
|
|
11468
|
-
* @export
|
|
11469
|
-
* @interface JsonApiFilterViewPatchRelationships
|
|
11470
|
-
*/
|
|
11471
|
-
export interface JsonApiFilterViewPatchRelationships {
|
|
11472
|
-
/**
|
|
11473
|
-
*
|
|
11474
|
-
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
11475
|
-
* @memberof JsonApiFilterViewPatchRelationships
|
|
11476
|
-
*/
|
|
11477
|
-
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
11478
|
-
/**
|
|
11479
|
-
*
|
|
11480
|
-
* @type {JsonApiFilterViewPatchRelationshipsUser}
|
|
11481
|
-
* @memberof JsonApiFilterViewPatchRelationships
|
|
11482
|
-
*/
|
|
11483
|
-
user?: JsonApiFilterViewPatchRelationshipsUser;
|
|
11484
|
-
}
|
|
11485
|
-
/**
|
|
11486
|
-
*
|
|
11487
|
-
* @export
|
|
11488
|
-
* @interface JsonApiFilterViewPatchRelationshipsUser
|
|
11489
|
-
*/
|
|
11490
|
-
export interface JsonApiFilterViewPatchRelationshipsUser {
|
|
11491
|
-
/**
|
|
11492
|
-
*
|
|
11493
|
-
* @type {JsonApiUserToOneLinkage}
|
|
11494
|
-
* @memberof JsonApiFilterViewPatchRelationshipsUser
|
|
11495
|
-
*/
|
|
11496
|
-
data: JsonApiUserToOneLinkage | null;
|
|
11497
|
-
}
|
|
11498
11634
|
/**
|
|
11499
11635
|
* JSON:API representation of identityProvider entity.
|
|
11500
11636
|
* @export
|
|
@@ -11515,10 +11651,10 @@ export interface JsonApiIdentityProviderIn {
|
|
|
11515
11651
|
id: string;
|
|
11516
11652
|
/**
|
|
11517
11653
|
*
|
|
11518
|
-
* @type {
|
|
11654
|
+
* @type {JsonApiIdentityProviderPatchAttributes}
|
|
11519
11655
|
* @memberof JsonApiIdentityProviderIn
|
|
11520
11656
|
*/
|
|
11521
|
-
attributes
|
|
11657
|
+
attributes?: JsonApiIdentityProviderPatchAttributes;
|
|
11522
11658
|
}
|
|
11523
11659
|
export declare const JsonApiIdentityProviderInTypeEnum: {
|
|
11524
11660
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
@@ -11527,87 +11663,39 @@ export type JsonApiIdentityProviderInTypeEnum = typeof JsonApiIdentityProviderIn
|
|
|
11527
11663
|
/**
|
|
11528
11664
|
*
|
|
11529
11665
|
* @export
|
|
11530
|
-
* @interface
|
|
11666
|
+
* @interface JsonApiIdentityProviderInDocument
|
|
11531
11667
|
*/
|
|
11532
|
-
export interface
|
|
11533
|
-
/**
|
|
11534
|
-
* 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.
|
|
11535
|
-
* @type {Array<string>}
|
|
11536
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11537
|
-
*/
|
|
11538
|
-
identifiers: Array<string>;
|
|
11539
|
-
/**
|
|
11540
|
-
* 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.
|
|
11541
|
-
* @type {{ [key: string]: string; }}
|
|
11542
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11543
|
-
*/
|
|
11544
|
-
customClaimMapping?: {
|
|
11545
|
-
[key: string]: string;
|
|
11546
|
-
};
|
|
11547
|
-
/**
|
|
11548
|
-
* 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.
|
|
11549
|
-
* @type {string}
|
|
11550
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11551
|
-
*/
|
|
11552
|
-
samlMetadata?: string;
|
|
11553
|
-
/**
|
|
11554
|
-
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
11555
|
-
* @type {string}
|
|
11556
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11557
|
-
*/
|
|
11558
|
-
oauthClientId?: string;
|
|
11559
|
-
/**
|
|
11560
|
-
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
11561
|
-
* @type {string}
|
|
11562
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11563
|
-
*/
|
|
11564
|
-
oauthClientSecret?: string;
|
|
11565
|
-
/**
|
|
11566
|
-
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
11567
|
-
* @type {string}
|
|
11568
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11569
|
-
*/
|
|
11570
|
-
oauthIssuerLocation?: string;
|
|
11571
|
-
/**
|
|
11572
|
-
* 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.
|
|
11573
|
-
* @type {string}
|
|
11574
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11575
|
-
*/
|
|
11576
|
-
oauthIssuerId?: string;
|
|
11577
|
-
/**
|
|
11578
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
11579
|
-
* @type {string}
|
|
11580
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11581
|
-
*/
|
|
11582
|
-
oauthSubjectIdClaim?: string;
|
|
11583
|
-
/**
|
|
11584
|
-
* 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.
|
|
11585
|
-
* @type {{ [key: string]: string; }}
|
|
11586
|
-
* @memberof JsonApiIdentityProviderInAttributes
|
|
11587
|
-
*/
|
|
11588
|
-
oauthCustomAuthAttributes?: {
|
|
11589
|
-
[key: string]: string;
|
|
11590
|
-
};
|
|
11668
|
+
export interface JsonApiIdentityProviderInDocument {
|
|
11591
11669
|
/**
|
|
11592
|
-
*
|
|
11593
|
-
* @type {
|
|
11594
|
-
* @memberof
|
|
11670
|
+
*
|
|
11671
|
+
* @type {JsonApiIdentityProviderIn}
|
|
11672
|
+
* @memberof JsonApiIdentityProviderInDocument
|
|
11595
11673
|
*/
|
|
11596
|
-
|
|
11674
|
+
data: JsonApiIdentityProviderIn;
|
|
11597
11675
|
}
|
|
11598
11676
|
/**
|
|
11599
|
-
*
|
|
11677
|
+
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
11600
11678
|
* @export
|
|
11601
|
-
* @interface
|
|
11679
|
+
* @interface JsonApiIdentityProviderLinkage
|
|
11602
11680
|
*/
|
|
11603
|
-
export interface
|
|
11681
|
+
export interface JsonApiIdentityProviderLinkage {
|
|
11604
11682
|
/**
|
|
11605
11683
|
*
|
|
11606
|
-
* @type {
|
|
11607
|
-
* @memberof
|
|
11684
|
+
* @type {string}
|
|
11685
|
+
* @memberof JsonApiIdentityProviderLinkage
|
|
11608
11686
|
*/
|
|
11609
|
-
|
|
11687
|
+
id: string;
|
|
11688
|
+
/**
|
|
11689
|
+
*
|
|
11690
|
+
* @type {string}
|
|
11691
|
+
* @memberof JsonApiIdentityProviderLinkage
|
|
11692
|
+
*/
|
|
11693
|
+
type: JsonApiIdentityProviderLinkageTypeEnum;
|
|
11610
11694
|
}
|
|
11695
|
+
export declare const JsonApiIdentityProviderLinkageTypeEnum: {
|
|
11696
|
+
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
11697
|
+
};
|
|
11698
|
+
export type JsonApiIdentityProviderLinkageTypeEnum = typeof JsonApiIdentityProviderLinkageTypeEnum[keyof typeof JsonApiIdentityProviderLinkageTypeEnum];
|
|
11611
11699
|
/**
|
|
11612
11700
|
* JSON:API representation of identityProvider entity.
|
|
11613
11701
|
* @export
|
|
@@ -11631,7 +11719,7 @@ export interface JsonApiIdentityProviderOut {
|
|
|
11631
11719
|
* @type {JsonApiIdentityProviderOutAttributes}
|
|
11632
11720
|
* @memberof JsonApiIdentityProviderOut
|
|
11633
11721
|
*/
|
|
11634
|
-
attributes
|
|
11722
|
+
attributes?: JsonApiIdentityProviderOutAttributes;
|
|
11635
11723
|
}
|
|
11636
11724
|
export declare const JsonApiIdentityProviderOutTypeEnum: {
|
|
11637
11725
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
@@ -11644,11 +11732,11 @@ export type JsonApiIdentityProviderOutTypeEnum = typeof JsonApiIdentityProviderO
|
|
|
11644
11732
|
*/
|
|
11645
11733
|
export interface JsonApiIdentityProviderOutAttributes {
|
|
11646
11734
|
/**
|
|
11647
|
-
* 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.
|
|
11735
|
+
* 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.
|
|
11648
11736
|
* @type {Array<string>}
|
|
11649
11737
|
* @memberof JsonApiIdentityProviderOutAttributes
|
|
11650
11738
|
*/
|
|
11651
|
-
identifiers
|
|
11739
|
+
identifiers?: Array<string>;
|
|
11652
11740
|
/**
|
|
11653
11741
|
* 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.
|
|
11654
11742
|
* @type {{ [key: string]: string; }}
|
|
@@ -11695,7 +11783,19 @@ export interface JsonApiIdentityProviderOutAttributes {
|
|
|
11695
11783
|
* @memberof JsonApiIdentityProviderOutAttributes
|
|
11696
11784
|
*/
|
|
11697
11785
|
oauthCustomScopes?: Array<string> | null;
|
|
11786
|
+
/**
|
|
11787
|
+
* 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.
|
|
11788
|
+
* @type {string}
|
|
11789
|
+
* @memberof JsonApiIdentityProviderOutAttributes
|
|
11790
|
+
*/
|
|
11791
|
+
idpType?: JsonApiIdentityProviderOutAttributesIdpTypeEnum;
|
|
11698
11792
|
}
|
|
11793
|
+
export declare const JsonApiIdentityProviderOutAttributesIdpTypeEnum: {
|
|
11794
|
+
readonly MANAGED_IDP: "MANAGED_IDP";
|
|
11795
|
+
readonly FIM_IDP: "FIM_IDP";
|
|
11796
|
+
readonly CUSTOM_IDP: "CUSTOM_IDP";
|
|
11797
|
+
};
|
|
11798
|
+
export type JsonApiIdentityProviderOutAttributesIdpTypeEnum = typeof JsonApiIdentityProviderOutAttributesIdpTypeEnum[keyof typeof JsonApiIdentityProviderOutAttributesIdpTypeEnum];
|
|
11699
11799
|
/**
|
|
11700
11800
|
*
|
|
11701
11801
|
* @export
|
|
@@ -11763,7 +11863,7 @@ export interface JsonApiIdentityProviderOutWithLinks {
|
|
|
11763
11863
|
* @type {JsonApiIdentityProviderOutAttributes}
|
|
11764
11864
|
* @memberof JsonApiIdentityProviderOutWithLinks
|
|
11765
11865
|
*/
|
|
11766
|
-
attributes
|
|
11866
|
+
attributes?: JsonApiIdentityProviderOutAttributes;
|
|
11767
11867
|
/**
|
|
11768
11868
|
*
|
|
11769
11869
|
* @type {ObjectLinks}
|
|
@@ -11798,7 +11898,7 @@ export interface JsonApiIdentityProviderPatch {
|
|
|
11798
11898
|
* @type {JsonApiIdentityProviderPatchAttributes}
|
|
11799
11899
|
* @memberof JsonApiIdentityProviderPatch
|
|
11800
11900
|
*/
|
|
11801
|
-
attributes
|
|
11901
|
+
attributes?: JsonApiIdentityProviderPatchAttributes;
|
|
11802
11902
|
}
|
|
11803
11903
|
export declare const JsonApiIdentityProviderPatchTypeEnum: {
|
|
11804
11904
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
@@ -11811,7 +11911,7 @@ export type JsonApiIdentityProviderPatchTypeEnum = typeof JsonApiIdentityProvide
|
|
|
11811
11911
|
*/
|
|
11812
11912
|
export interface JsonApiIdentityProviderPatchAttributes {
|
|
11813
11913
|
/**
|
|
11814
|
-
* 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.
|
|
11914
|
+
* 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.
|
|
11815
11915
|
* @type {Array<string>}
|
|
11816
11916
|
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
11817
11917
|
*/
|
|
@@ -11874,7 +11974,19 @@ export interface JsonApiIdentityProviderPatchAttributes {
|
|
|
11874
11974
|
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
11875
11975
|
*/
|
|
11876
11976
|
oauthCustomScopes?: Array<string> | null;
|
|
11977
|
+
/**
|
|
11978
|
+
* 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.
|
|
11979
|
+
* @type {string}
|
|
11980
|
+
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
11981
|
+
*/
|
|
11982
|
+
idpType?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
|
|
11877
11983
|
}
|
|
11984
|
+
export declare const JsonApiIdentityProviderPatchAttributesIdpTypeEnum: {
|
|
11985
|
+
readonly MANAGED_IDP: "MANAGED_IDP";
|
|
11986
|
+
readonly FIM_IDP: "FIM_IDP";
|
|
11987
|
+
readonly CUSTOM_IDP: "CUSTOM_IDP";
|
|
11988
|
+
};
|
|
11989
|
+
export type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = typeof JsonApiIdentityProviderPatchAttributesIdpTypeEnum[keyof typeof JsonApiIdentityProviderPatchAttributesIdpTypeEnum];
|
|
11878
11990
|
/**
|
|
11879
11991
|
*
|
|
11880
11992
|
* @export
|
|
@@ -11888,6 +12000,12 @@ export interface JsonApiIdentityProviderPatchDocument {
|
|
|
11888
12000
|
*/
|
|
11889
12001
|
data: JsonApiIdentityProviderPatch;
|
|
11890
12002
|
}
|
|
12003
|
+
/**
|
|
12004
|
+
* @type JsonApiIdentityProviderToOneLinkage
|
|
12005
|
+
* References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
12006
|
+
* @export
|
|
12007
|
+
*/
|
|
12008
|
+
export type JsonApiIdentityProviderToOneLinkage = JsonApiIdentityProviderLinkage;
|
|
11891
12009
|
/**
|
|
11892
12010
|
* JSON:API representation of jwk entity.
|
|
11893
12011
|
* @export
|
|
@@ -11908,28 +12026,15 @@ export interface JsonApiJwkIn {
|
|
|
11908
12026
|
id: string;
|
|
11909
12027
|
/**
|
|
11910
12028
|
*
|
|
11911
|
-
* @type {
|
|
12029
|
+
* @type {JsonApiJwkOutAttributes}
|
|
11912
12030
|
* @memberof JsonApiJwkIn
|
|
11913
12031
|
*/
|
|
11914
|
-
attributes?:
|
|
12032
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
11915
12033
|
}
|
|
11916
12034
|
export declare const JsonApiJwkInTypeEnum: {
|
|
11917
12035
|
readonly JWK: "jwk";
|
|
11918
12036
|
};
|
|
11919
12037
|
export type JsonApiJwkInTypeEnum = typeof JsonApiJwkInTypeEnum[keyof typeof JsonApiJwkInTypeEnum];
|
|
11920
|
-
/**
|
|
11921
|
-
*
|
|
11922
|
-
* @export
|
|
11923
|
-
* @interface JsonApiJwkInAttributes
|
|
11924
|
-
*/
|
|
11925
|
-
export interface JsonApiJwkInAttributes {
|
|
11926
|
-
/**
|
|
11927
|
-
* Specification of the cryptographic key
|
|
11928
|
-
* @type {RsaSpecification}
|
|
11929
|
-
* @memberof JsonApiJwkInAttributes
|
|
11930
|
-
*/
|
|
11931
|
-
content?: RsaSpecification;
|
|
11932
|
-
}
|
|
11933
12038
|
/**
|
|
11934
12039
|
*
|
|
11935
12040
|
* @export
|
|
@@ -11963,15 +12068,28 @@ export interface JsonApiJwkOut {
|
|
|
11963
12068
|
id: string;
|
|
11964
12069
|
/**
|
|
11965
12070
|
*
|
|
11966
|
-
* @type {
|
|
12071
|
+
* @type {JsonApiJwkOutAttributes}
|
|
11967
12072
|
* @memberof JsonApiJwkOut
|
|
11968
12073
|
*/
|
|
11969
|
-
attributes?:
|
|
12074
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
11970
12075
|
}
|
|
11971
12076
|
export declare const JsonApiJwkOutTypeEnum: {
|
|
11972
12077
|
readonly JWK: "jwk";
|
|
11973
12078
|
};
|
|
11974
12079
|
export type JsonApiJwkOutTypeEnum = typeof JsonApiJwkOutTypeEnum[keyof typeof JsonApiJwkOutTypeEnum];
|
|
12080
|
+
/**
|
|
12081
|
+
*
|
|
12082
|
+
* @export
|
|
12083
|
+
* @interface JsonApiJwkOutAttributes
|
|
12084
|
+
*/
|
|
12085
|
+
export interface JsonApiJwkOutAttributes {
|
|
12086
|
+
/**
|
|
12087
|
+
* Specification of the cryptographic key
|
|
12088
|
+
* @type {RsaSpecification}
|
|
12089
|
+
* @memberof JsonApiJwkOutAttributes
|
|
12090
|
+
*/
|
|
12091
|
+
content?: RsaSpecification;
|
|
12092
|
+
}
|
|
11975
12093
|
/**
|
|
11976
12094
|
*
|
|
11977
12095
|
* @export
|
|
@@ -12036,10 +12154,10 @@ export interface JsonApiJwkOutWithLinks {
|
|
|
12036
12154
|
id: string;
|
|
12037
12155
|
/**
|
|
12038
12156
|
*
|
|
12039
|
-
* @type {
|
|
12157
|
+
* @type {JsonApiJwkOutAttributes}
|
|
12040
12158
|
* @memberof JsonApiJwkOutWithLinks
|
|
12041
12159
|
*/
|
|
12042
|
-
attributes?:
|
|
12160
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
12043
12161
|
/**
|
|
12044
12162
|
*
|
|
12045
12163
|
* @type {ObjectLinks}
|
|
@@ -12071,10 +12189,10 @@ export interface JsonApiJwkPatch {
|
|
|
12071
12189
|
id: string;
|
|
12072
12190
|
/**
|
|
12073
12191
|
*
|
|
12074
|
-
* @type {
|
|
12192
|
+
* @type {JsonApiJwkOutAttributes}
|
|
12075
12193
|
* @memberof JsonApiJwkPatch
|
|
12076
12194
|
*/
|
|
12077
|
-
attributes?:
|
|
12195
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
12078
12196
|
}
|
|
12079
12197
|
export declare const JsonApiJwkPatchTypeEnum: {
|
|
12080
12198
|
readonly JWK: "jwk";
|
|
@@ -13305,10 +13423,10 @@ export interface JsonApiNotificationChannelIn {
|
|
|
13305
13423
|
id: string;
|
|
13306
13424
|
/**
|
|
13307
13425
|
*
|
|
13308
|
-
* @type {
|
|
13426
|
+
* @type {JsonApiNotificationChannelPatchAttributes}
|
|
13309
13427
|
* @memberof JsonApiNotificationChannelIn
|
|
13310
13428
|
*/
|
|
13311
|
-
attributes?:
|
|
13429
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
13312
13430
|
}
|
|
13313
13431
|
export declare const JsonApiNotificationChannelInTypeEnum: {
|
|
13314
13432
|
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
@@ -13563,10 +13681,10 @@ export interface JsonApiNotificationChannelPatch {
|
|
|
13563
13681
|
id: string;
|
|
13564
13682
|
/**
|
|
13565
13683
|
*
|
|
13566
|
-
* @type {
|
|
13684
|
+
* @type {JsonApiNotificationChannelPatchAttributes}
|
|
13567
13685
|
* @memberof JsonApiNotificationChannelPatch
|
|
13568
13686
|
*/
|
|
13569
|
-
attributes?:
|
|
13687
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
13570
13688
|
}
|
|
13571
13689
|
export declare const JsonApiNotificationChannelPatchTypeEnum: {
|
|
13572
13690
|
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
@@ -13575,117 +13693,117 @@ export type JsonApiNotificationChannelPatchTypeEnum = typeof JsonApiNotification
|
|
|
13575
13693
|
/**
|
|
13576
13694
|
*
|
|
13577
13695
|
* @export
|
|
13578
|
-
* @interface
|
|
13696
|
+
* @interface JsonApiNotificationChannelPatchAttributes
|
|
13579
13697
|
*/
|
|
13580
|
-
export interface
|
|
13698
|
+
export interface JsonApiNotificationChannelPatchAttributes {
|
|
13581
13699
|
/**
|
|
13582
13700
|
*
|
|
13583
|
-
* @type {JsonApiNotificationChannelPatch}
|
|
13584
|
-
* @memberof JsonApiNotificationChannelPatchDocument
|
|
13585
|
-
*/
|
|
13586
|
-
data: JsonApiNotificationChannelPatch;
|
|
13587
|
-
}
|
|
13588
|
-
/**
|
|
13589
|
-
* JSON:API representation of notificationChannel entity.
|
|
13590
|
-
* @export
|
|
13591
|
-
* @interface JsonApiNotificationChannelPostOptionalId
|
|
13592
|
-
*/
|
|
13593
|
-
export interface JsonApiNotificationChannelPostOptionalId {
|
|
13594
|
-
/**
|
|
13595
|
-
* Object type
|
|
13596
|
-
* @type {string}
|
|
13597
|
-
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
13598
|
-
*/
|
|
13599
|
-
type: JsonApiNotificationChannelPostOptionalIdTypeEnum;
|
|
13600
|
-
/**
|
|
13601
|
-
* API identifier of an object
|
|
13602
13701
|
* @type {string}
|
|
13603
|
-
* @memberof
|
|
13604
|
-
*/
|
|
13605
|
-
id?: string;
|
|
13606
|
-
/**
|
|
13607
|
-
*
|
|
13608
|
-
* @type {JsonApiNotificationChannelPostOptionalIdAttributes}
|
|
13609
|
-
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
13610
|
-
*/
|
|
13611
|
-
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
13612
|
-
}
|
|
13613
|
-
export declare const JsonApiNotificationChannelPostOptionalIdTypeEnum: {
|
|
13614
|
-
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
13615
|
-
};
|
|
13616
|
-
export type JsonApiNotificationChannelPostOptionalIdTypeEnum = typeof JsonApiNotificationChannelPostOptionalIdTypeEnum[keyof typeof JsonApiNotificationChannelPostOptionalIdTypeEnum];
|
|
13617
|
-
/**
|
|
13618
|
-
*
|
|
13619
|
-
* @export
|
|
13620
|
-
* @interface JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13621
|
-
*/
|
|
13622
|
-
export interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
13623
|
-
/**
|
|
13624
|
-
*
|
|
13625
|
-
* @type {string}
|
|
13626
|
-
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13702
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
13627
13703
|
*/
|
|
13628
13704
|
name?: string | null;
|
|
13629
13705
|
/**
|
|
13630
13706
|
*
|
|
13631
13707
|
* @type {string}
|
|
13632
|
-
* @memberof
|
|
13708
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
13633
13709
|
*/
|
|
13634
13710
|
description?: string | null;
|
|
13635
13711
|
/**
|
|
13636
13712
|
* The destination where the notifications are to be sent.
|
|
13637
13713
|
* @type {DefaultSmtp | InPlatform | Smtp | Webhook}
|
|
13638
|
-
* @memberof
|
|
13714
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
13639
13715
|
*/
|
|
13640
13716
|
destination?: DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
13641
13717
|
/**
|
|
13642
13718
|
* 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}
|
|
13643
13719
|
* @type {string}
|
|
13644
|
-
* @memberof
|
|
13720
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
13645
13721
|
*/
|
|
13646
13722
|
customDashboardUrl?: string;
|
|
13647
13723
|
/**
|
|
13648
13724
|
* 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
|
|
13649
13725
|
* @type {string}
|
|
13650
|
-
* @memberof
|
|
13726
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
13651
13727
|
*/
|
|
13652
|
-
dashboardLinkVisibility?:
|
|
13728
|
+
dashboardLinkVisibility?: JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum;
|
|
13653
13729
|
/**
|
|
13654
13730
|
* 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}}
|
|
13655
13731
|
* @type {string}
|
|
13656
|
-
* @memberof
|
|
13732
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
13657
13733
|
*/
|
|
13658
13734
|
notificationSource?: string;
|
|
13659
13735
|
/**
|
|
13660
13736
|
* 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
|
|
13661
13737
|
* @type {string}
|
|
13662
|
-
* @memberof
|
|
13738
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
13663
13739
|
*/
|
|
13664
|
-
allowedRecipients?:
|
|
13740
|
+
allowedRecipients?: JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum;
|
|
13665
13741
|
/**
|
|
13666
13742
|
* 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
|
|
13667
13743
|
* @type {string}
|
|
13668
|
-
* @memberof
|
|
13744
|
+
* @memberof JsonApiNotificationChannelPatchAttributes
|
|
13669
13745
|
*/
|
|
13670
|
-
inPlatformNotification?:
|
|
13746
|
+
inPlatformNotification?: JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum;
|
|
13671
13747
|
}
|
|
13672
|
-
export declare const
|
|
13748
|
+
export declare const JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum: {
|
|
13673
13749
|
readonly HIDDEN: "HIDDEN";
|
|
13674
13750
|
readonly INTERNAL_ONLY: "INTERNAL_ONLY";
|
|
13675
13751
|
readonly ALL: "ALL";
|
|
13676
13752
|
};
|
|
13677
|
-
export type
|
|
13678
|
-
export declare const
|
|
13753
|
+
export type JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum = typeof JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum[keyof typeof JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum];
|
|
13754
|
+
export declare const JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum: {
|
|
13679
13755
|
readonly CREATOR: "CREATOR";
|
|
13680
13756
|
readonly INTERNAL: "INTERNAL";
|
|
13681
13757
|
readonly EXTERNAL: "EXTERNAL";
|
|
13682
13758
|
};
|
|
13683
|
-
export type
|
|
13684
|
-
export declare const
|
|
13759
|
+
export type JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum = typeof JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum[keyof typeof JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum];
|
|
13760
|
+
export declare const JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum: {
|
|
13685
13761
|
readonly DISABLED: "DISABLED";
|
|
13686
13762
|
readonly ENABLED: "ENABLED";
|
|
13687
13763
|
};
|
|
13688
|
-
export type
|
|
13764
|
+
export type JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum = typeof JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum[keyof typeof JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum];
|
|
13765
|
+
/**
|
|
13766
|
+
*
|
|
13767
|
+
* @export
|
|
13768
|
+
* @interface JsonApiNotificationChannelPatchDocument
|
|
13769
|
+
*/
|
|
13770
|
+
export interface JsonApiNotificationChannelPatchDocument {
|
|
13771
|
+
/**
|
|
13772
|
+
*
|
|
13773
|
+
* @type {JsonApiNotificationChannelPatch}
|
|
13774
|
+
* @memberof JsonApiNotificationChannelPatchDocument
|
|
13775
|
+
*/
|
|
13776
|
+
data: JsonApiNotificationChannelPatch;
|
|
13777
|
+
}
|
|
13778
|
+
/**
|
|
13779
|
+
* JSON:API representation of notificationChannel entity.
|
|
13780
|
+
* @export
|
|
13781
|
+
* @interface JsonApiNotificationChannelPostOptionalId
|
|
13782
|
+
*/
|
|
13783
|
+
export interface JsonApiNotificationChannelPostOptionalId {
|
|
13784
|
+
/**
|
|
13785
|
+
* Object type
|
|
13786
|
+
* @type {string}
|
|
13787
|
+
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
13788
|
+
*/
|
|
13789
|
+
type: JsonApiNotificationChannelPostOptionalIdTypeEnum;
|
|
13790
|
+
/**
|
|
13791
|
+
* API identifier of an object
|
|
13792
|
+
* @type {string}
|
|
13793
|
+
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
13794
|
+
*/
|
|
13795
|
+
id?: string;
|
|
13796
|
+
/**
|
|
13797
|
+
*
|
|
13798
|
+
* @type {JsonApiNotificationChannelPatchAttributes}
|
|
13799
|
+
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
13800
|
+
*/
|
|
13801
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
13802
|
+
}
|
|
13803
|
+
export declare const JsonApiNotificationChannelPostOptionalIdTypeEnum: {
|
|
13804
|
+
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
13805
|
+
};
|
|
13806
|
+
export type JsonApiNotificationChannelPostOptionalIdTypeEnum = typeof JsonApiNotificationChannelPostOptionalIdTypeEnum[keyof typeof JsonApiNotificationChannelPostOptionalIdTypeEnum];
|
|
13689
13807
|
/**
|
|
13690
13808
|
*
|
|
13691
13809
|
* @export
|
|
@@ -13725,97 +13843,21 @@ export interface JsonApiOrganizationIn {
|
|
|
13725
13843
|
id: string;
|
|
13726
13844
|
/**
|
|
13727
13845
|
*
|
|
13728
|
-
* @type {
|
|
13846
|
+
* @type {JsonApiOrganizationPatchAttributes}
|
|
13729
13847
|
* @memberof JsonApiOrganizationIn
|
|
13730
13848
|
*/
|
|
13731
|
-
attributes?:
|
|
13849
|
+
attributes?: JsonApiOrganizationPatchAttributes;
|
|
13850
|
+
/**
|
|
13851
|
+
*
|
|
13852
|
+
* @type {JsonApiOrganizationPatchRelationships}
|
|
13853
|
+
* @memberof JsonApiOrganizationIn
|
|
13854
|
+
*/
|
|
13855
|
+
relationships?: JsonApiOrganizationPatchRelationships;
|
|
13732
13856
|
}
|
|
13733
13857
|
export declare const JsonApiOrganizationInTypeEnum: {
|
|
13734
13858
|
readonly ORGANIZATION: "organization";
|
|
13735
13859
|
};
|
|
13736
13860
|
export type JsonApiOrganizationInTypeEnum = typeof JsonApiOrganizationInTypeEnum[keyof typeof JsonApiOrganizationInTypeEnum];
|
|
13737
|
-
/**
|
|
13738
|
-
*
|
|
13739
|
-
* @export
|
|
13740
|
-
* @interface JsonApiOrganizationInAttributes
|
|
13741
|
-
*/
|
|
13742
|
-
export interface JsonApiOrganizationInAttributes {
|
|
13743
|
-
/**
|
|
13744
|
-
*
|
|
13745
|
-
* @type {string}
|
|
13746
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13747
|
-
*/
|
|
13748
|
-
name?: string | null;
|
|
13749
|
-
/**
|
|
13750
|
-
*
|
|
13751
|
-
* @type {string}
|
|
13752
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13753
|
-
*/
|
|
13754
|
-
hostname?: string;
|
|
13755
|
-
/**
|
|
13756
|
-
*
|
|
13757
|
-
* @type {Array<string>}
|
|
13758
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13759
|
-
*/
|
|
13760
|
-
allowedOrigins?: Array<string>;
|
|
13761
|
-
/**
|
|
13762
|
-
*
|
|
13763
|
-
* @type {string}
|
|
13764
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13765
|
-
*/
|
|
13766
|
-
oauthIssuerLocation?: string;
|
|
13767
|
-
/**
|
|
13768
|
-
*
|
|
13769
|
-
* @type {string}
|
|
13770
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13771
|
-
*/
|
|
13772
|
-
oauthClientId?: string;
|
|
13773
|
-
/**
|
|
13774
|
-
*
|
|
13775
|
-
* @type {string}
|
|
13776
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13777
|
-
*/
|
|
13778
|
-
oauthClientSecret?: string;
|
|
13779
|
-
/**
|
|
13780
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
13781
|
-
* @type {string}
|
|
13782
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13783
|
-
* @deprecated
|
|
13784
|
-
*/
|
|
13785
|
-
earlyAccess?: string | null;
|
|
13786
|
-
/**
|
|
13787
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
13788
|
-
* @type {Array<string>}
|
|
13789
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13790
|
-
*/
|
|
13791
|
-
earlyAccessValues?: Array<string> | null;
|
|
13792
|
-
/**
|
|
13793
|
-
* 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.
|
|
13794
|
-
* @type {string}
|
|
13795
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13796
|
-
*/
|
|
13797
|
-
oauthIssuerId?: string;
|
|
13798
|
-
/**
|
|
13799
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
13800
|
-
* @type {string}
|
|
13801
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13802
|
-
*/
|
|
13803
|
-
oauthSubjectIdClaim?: string;
|
|
13804
|
-
/**
|
|
13805
|
-
* 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.
|
|
13806
|
-
* @type {{ [key: string]: string; }}
|
|
13807
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13808
|
-
*/
|
|
13809
|
-
oauthCustomAuthAttributes?: {
|
|
13810
|
-
[key: string]: string;
|
|
13811
|
-
};
|
|
13812
|
-
/**
|
|
13813
|
-
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
13814
|
-
* @type {Array<string>}
|
|
13815
|
-
* @memberof JsonApiOrganizationInAttributes
|
|
13816
|
-
*/
|
|
13817
|
-
oauthCustomScopes?: Array<string> | null;
|
|
13818
|
-
}
|
|
13819
13861
|
/**
|
|
13820
13862
|
*
|
|
13821
13863
|
* @export
|
|
@@ -14005,7 +14047,7 @@ export interface JsonApiOrganizationOutDocument {
|
|
|
14005
14047
|
* @type JsonApiOrganizationOutIncludes
|
|
14006
14048
|
* @export
|
|
14007
14049
|
*/
|
|
14008
|
-
export type JsonApiOrganizationOutIncludes = JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
14050
|
+
export type JsonApiOrganizationOutIncludes = JsonApiIdentityProviderOutWithLinks | JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
14009
14051
|
/**
|
|
14010
14052
|
*
|
|
14011
14053
|
* @export
|
|
@@ -14032,16 +14074,48 @@ export type JsonApiOrganizationOutMetaPermissionsEnum = typeof JsonApiOrganizati
|
|
|
14032
14074
|
export interface JsonApiOrganizationOutRelationships {
|
|
14033
14075
|
/**
|
|
14034
14076
|
*
|
|
14035
|
-
* @type {
|
|
14077
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
14036
14078
|
* @memberof JsonApiOrganizationOutRelationships
|
|
14037
14079
|
*/
|
|
14038
|
-
bootstrapUser?:
|
|
14080
|
+
bootstrapUser?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
14039
14081
|
/**
|
|
14040
14082
|
*
|
|
14041
|
-
* @type {
|
|
14083
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
14042
14084
|
* @memberof JsonApiOrganizationOutRelationships
|
|
14043
14085
|
*/
|
|
14044
|
-
bootstrapUserGroup?:
|
|
14086
|
+
bootstrapUserGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
14087
|
+
/**
|
|
14088
|
+
*
|
|
14089
|
+
* @type {JsonApiOrganizationPatchRelationshipsIdentityProvider}
|
|
14090
|
+
* @memberof JsonApiOrganizationOutRelationships
|
|
14091
|
+
*/
|
|
14092
|
+
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
14093
|
+
}
|
|
14094
|
+
/**
|
|
14095
|
+
*
|
|
14096
|
+
* @export
|
|
14097
|
+
* @interface JsonApiOrganizationOutRelationshipsBootstrapUser
|
|
14098
|
+
*/
|
|
14099
|
+
export interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
14100
|
+
/**
|
|
14101
|
+
*
|
|
14102
|
+
* @type {JsonApiUserToOneLinkage}
|
|
14103
|
+
* @memberof JsonApiOrganizationOutRelationshipsBootstrapUser
|
|
14104
|
+
*/
|
|
14105
|
+
data: JsonApiUserToOneLinkage | null;
|
|
14106
|
+
}
|
|
14107
|
+
/**
|
|
14108
|
+
*
|
|
14109
|
+
* @export
|
|
14110
|
+
* @interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup
|
|
14111
|
+
*/
|
|
14112
|
+
export interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
14113
|
+
/**
|
|
14114
|
+
*
|
|
14115
|
+
* @type {JsonApiUserGroupToOneLinkage}
|
|
14116
|
+
* @memberof JsonApiOrganizationOutRelationshipsBootstrapUserGroup
|
|
14117
|
+
*/
|
|
14118
|
+
data: JsonApiUserGroupToOneLinkage | null;
|
|
14045
14119
|
}
|
|
14046
14120
|
/**
|
|
14047
14121
|
* JSON:API representation of patching organization entity.
|
|
@@ -14063,15 +14137,103 @@ export interface JsonApiOrganizationPatch {
|
|
|
14063
14137
|
id: string;
|
|
14064
14138
|
/**
|
|
14065
14139
|
*
|
|
14066
|
-
* @type {
|
|
14140
|
+
* @type {JsonApiOrganizationPatchAttributes}
|
|
14141
|
+
* @memberof JsonApiOrganizationPatch
|
|
14142
|
+
*/
|
|
14143
|
+
attributes?: JsonApiOrganizationPatchAttributes;
|
|
14144
|
+
/**
|
|
14145
|
+
*
|
|
14146
|
+
* @type {JsonApiOrganizationPatchRelationships}
|
|
14067
14147
|
* @memberof JsonApiOrganizationPatch
|
|
14068
14148
|
*/
|
|
14069
|
-
|
|
14149
|
+
relationships?: JsonApiOrganizationPatchRelationships;
|
|
14070
14150
|
}
|
|
14071
14151
|
export declare const JsonApiOrganizationPatchTypeEnum: {
|
|
14072
14152
|
readonly ORGANIZATION: "organization";
|
|
14073
14153
|
};
|
|
14074
14154
|
export type JsonApiOrganizationPatchTypeEnum = typeof JsonApiOrganizationPatchTypeEnum[keyof typeof JsonApiOrganizationPatchTypeEnum];
|
|
14155
|
+
/**
|
|
14156
|
+
*
|
|
14157
|
+
* @export
|
|
14158
|
+
* @interface JsonApiOrganizationPatchAttributes
|
|
14159
|
+
*/
|
|
14160
|
+
export interface JsonApiOrganizationPatchAttributes {
|
|
14161
|
+
/**
|
|
14162
|
+
*
|
|
14163
|
+
* @type {string}
|
|
14164
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14165
|
+
*/
|
|
14166
|
+
name?: string | null;
|
|
14167
|
+
/**
|
|
14168
|
+
*
|
|
14169
|
+
* @type {string}
|
|
14170
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14171
|
+
*/
|
|
14172
|
+
hostname?: string;
|
|
14173
|
+
/**
|
|
14174
|
+
*
|
|
14175
|
+
* @type {Array<string>}
|
|
14176
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14177
|
+
*/
|
|
14178
|
+
allowedOrigins?: Array<string>;
|
|
14179
|
+
/**
|
|
14180
|
+
*
|
|
14181
|
+
* @type {string}
|
|
14182
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14183
|
+
*/
|
|
14184
|
+
oauthIssuerLocation?: string;
|
|
14185
|
+
/**
|
|
14186
|
+
*
|
|
14187
|
+
* @type {string}
|
|
14188
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14189
|
+
*/
|
|
14190
|
+
oauthClientId?: string;
|
|
14191
|
+
/**
|
|
14192
|
+
*
|
|
14193
|
+
* @type {string}
|
|
14194
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14195
|
+
*/
|
|
14196
|
+
oauthClientSecret?: string;
|
|
14197
|
+
/**
|
|
14198
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
14199
|
+
* @type {string}
|
|
14200
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14201
|
+
* @deprecated
|
|
14202
|
+
*/
|
|
14203
|
+
earlyAccess?: string | null;
|
|
14204
|
+
/**
|
|
14205
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
14206
|
+
* @type {Array<string>}
|
|
14207
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14208
|
+
*/
|
|
14209
|
+
earlyAccessValues?: Array<string> | null;
|
|
14210
|
+
/**
|
|
14211
|
+
* 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.
|
|
14212
|
+
* @type {string}
|
|
14213
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14214
|
+
*/
|
|
14215
|
+
oauthIssuerId?: string;
|
|
14216
|
+
/**
|
|
14217
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
14218
|
+
* @type {string}
|
|
14219
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14220
|
+
*/
|
|
14221
|
+
oauthSubjectIdClaim?: string;
|
|
14222
|
+
/**
|
|
14223
|
+
* 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.
|
|
14224
|
+
* @type {{ [key: string]: string; }}
|
|
14225
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14226
|
+
*/
|
|
14227
|
+
oauthCustomAuthAttributes?: {
|
|
14228
|
+
[key: string]: string;
|
|
14229
|
+
};
|
|
14230
|
+
/**
|
|
14231
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
14232
|
+
* @type {Array<string>}
|
|
14233
|
+
* @memberof JsonApiOrganizationPatchAttributes
|
|
14234
|
+
*/
|
|
14235
|
+
oauthCustomScopes?: Array<string> | null;
|
|
14236
|
+
}
|
|
14075
14237
|
/**
|
|
14076
14238
|
*
|
|
14077
14239
|
* @export
|
|
@@ -14085,6 +14247,32 @@ export interface JsonApiOrganizationPatchDocument {
|
|
|
14085
14247
|
*/
|
|
14086
14248
|
data: JsonApiOrganizationPatch;
|
|
14087
14249
|
}
|
|
14250
|
+
/**
|
|
14251
|
+
*
|
|
14252
|
+
* @export
|
|
14253
|
+
* @interface JsonApiOrganizationPatchRelationships
|
|
14254
|
+
*/
|
|
14255
|
+
export interface JsonApiOrganizationPatchRelationships {
|
|
14256
|
+
/**
|
|
14257
|
+
*
|
|
14258
|
+
* @type {JsonApiOrganizationPatchRelationshipsIdentityProvider}
|
|
14259
|
+
* @memberof JsonApiOrganizationPatchRelationships
|
|
14260
|
+
*/
|
|
14261
|
+
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
14262
|
+
}
|
|
14263
|
+
/**
|
|
14264
|
+
*
|
|
14265
|
+
* @export
|
|
14266
|
+
* @interface JsonApiOrganizationPatchRelationshipsIdentityProvider
|
|
14267
|
+
*/
|
|
14268
|
+
export interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
14269
|
+
/**
|
|
14270
|
+
*
|
|
14271
|
+
* @type {JsonApiIdentityProviderToOneLinkage}
|
|
14272
|
+
* @memberof JsonApiOrganizationPatchRelationshipsIdentityProvider
|
|
14273
|
+
*/
|
|
14274
|
+
data: JsonApiIdentityProviderToOneLinkage | null;
|
|
14275
|
+
}
|
|
14088
14276
|
/**
|
|
14089
14277
|
* JSON:API representation of organizationSetting entity.
|
|
14090
14278
|
* @export
|
|
@@ -14297,10 +14485,10 @@ export interface JsonApiThemeIn {
|
|
|
14297
14485
|
id: string;
|
|
14298
14486
|
/**
|
|
14299
14487
|
*
|
|
14300
|
-
* @type {
|
|
14488
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
14301
14489
|
* @memberof JsonApiThemeIn
|
|
14302
14490
|
*/
|
|
14303
|
-
attributes:
|
|
14491
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
14304
14492
|
}
|
|
14305
14493
|
export declare const JsonApiThemeInTypeEnum: {
|
|
14306
14494
|
readonly THEME: "theme";
|
|
@@ -14339,10 +14527,10 @@ export interface JsonApiThemeOut {
|
|
|
14339
14527
|
id: string;
|
|
14340
14528
|
/**
|
|
14341
14529
|
*
|
|
14342
|
-
* @type {
|
|
14530
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
14343
14531
|
* @memberof JsonApiThemeOut
|
|
14344
14532
|
*/
|
|
14345
|
-
attributes:
|
|
14533
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
14346
14534
|
}
|
|
14347
14535
|
export declare const JsonApiThemeOutTypeEnum: {
|
|
14348
14536
|
readonly THEME: "theme";
|
|
@@ -14412,10 +14600,10 @@ export interface JsonApiThemeOutWithLinks {
|
|
|
14412
14600
|
id: string;
|
|
14413
14601
|
/**
|
|
14414
14602
|
*
|
|
14415
|
-
* @type {
|
|
14603
|
+
* @type {JsonApiColorPaletteOutAttributes}
|
|
14416
14604
|
* @memberof JsonApiThemeOutWithLinks
|
|
14417
14605
|
*/
|
|
14418
|
-
attributes:
|
|
14606
|
+
attributes: JsonApiColorPaletteOutAttributes;
|
|
14419
14607
|
/**
|
|
14420
14608
|
*
|
|
14421
14609
|
* @type {ObjectLinks}
|
|
@@ -14664,16 +14852,16 @@ export interface JsonApiUserDataFilterOutList {
|
|
|
14664
14852
|
export interface JsonApiUserDataFilterOutRelationships {
|
|
14665
14853
|
/**
|
|
14666
14854
|
*
|
|
14667
|
-
* @type {
|
|
14855
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
14668
14856
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
14669
14857
|
*/
|
|
14670
|
-
user?:
|
|
14858
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
14671
14859
|
/**
|
|
14672
14860
|
*
|
|
14673
|
-
* @type {
|
|
14861
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
14674
14862
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
14675
14863
|
*/
|
|
14676
|
-
userGroup?:
|
|
14864
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
14677
14865
|
/**
|
|
14678
14866
|
*
|
|
14679
14867
|
* @type {JsonApiVisualizationObjectOutRelationshipsFacts}
|
|
@@ -14845,29 +15033,16 @@ export interface JsonApiUserDataFilterPatchDocument {
|
|
|
14845
15033
|
export interface JsonApiUserDataFilterPatchRelationships {
|
|
14846
15034
|
/**
|
|
14847
15035
|
*
|
|
14848
|
-
* @type {
|
|
15036
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUser}
|
|
14849
15037
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
14850
15038
|
*/
|
|
14851
|
-
user?:
|
|
15039
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
14852
15040
|
/**
|
|
14853
15041
|
*
|
|
14854
|
-
* @type {
|
|
15042
|
+
* @type {JsonApiOrganizationOutRelationshipsBootstrapUserGroup}
|
|
14855
15043
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
14856
15044
|
*/
|
|
14857
|
-
userGroup?:
|
|
14858
|
-
}
|
|
14859
|
-
/**
|
|
14860
|
-
*
|
|
14861
|
-
* @export
|
|
14862
|
-
* @interface JsonApiUserDataFilterPatchRelationshipsUserGroup
|
|
14863
|
-
*/
|
|
14864
|
-
export interface JsonApiUserDataFilterPatchRelationshipsUserGroup {
|
|
14865
|
-
/**
|
|
14866
|
-
*
|
|
14867
|
-
* @type {JsonApiUserGroupToOneLinkage}
|
|
14868
|
-
* @memberof JsonApiUserDataFilterPatchRelationshipsUserGroup
|
|
14869
|
-
*/
|
|
14870
|
-
data: JsonApiUserGroupToOneLinkage | null;
|
|
15045
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
14871
15046
|
}
|
|
14872
15047
|
/**
|
|
14873
15048
|
* JSON:API representation of userDataFilter entity.
|
|
@@ -16719,16 +16894,16 @@ export interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
16719
16894
|
id: string;
|
|
16720
16895
|
/**
|
|
16721
16896
|
*
|
|
16722
|
-
* @type {
|
|
16897
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutAttributes}
|
|
16723
16898
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
16724
16899
|
*/
|
|
16725
|
-
attributes?:
|
|
16900
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
16726
16901
|
/**
|
|
16727
16902
|
*
|
|
16728
|
-
* @type {
|
|
16903
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationships}
|
|
16729
16904
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
16730
16905
|
*/
|
|
16731
|
-
relationships?:
|
|
16906
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
16732
16907
|
}
|
|
16733
16908
|
export declare const JsonApiWorkspaceDataFilterSettingInTypeEnum: {
|
|
16734
16909
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
@@ -16796,21 +16971,46 @@ export interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
16796
16971
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
16797
16972
|
/**
|
|
16798
16973
|
*
|
|
16799
|
-
* @type {
|
|
16974
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutAttributes}
|
|
16800
16975
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
16801
16976
|
*/
|
|
16802
|
-
attributes?:
|
|
16977
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
16803
16978
|
/**
|
|
16804
16979
|
*
|
|
16805
|
-
* @type {
|
|
16980
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationships}
|
|
16806
16981
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
16807
16982
|
*/
|
|
16808
|
-
relationships?:
|
|
16983
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
16809
16984
|
}
|
|
16810
16985
|
export declare const JsonApiWorkspaceDataFilterSettingOutTypeEnum: {
|
|
16811
16986
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
16812
16987
|
};
|
|
16813
16988
|
export type JsonApiWorkspaceDataFilterSettingOutTypeEnum = typeof JsonApiWorkspaceDataFilterSettingOutTypeEnum[keyof typeof JsonApiWorkspaceDataFilterSettingOutTypeEnum];
|
|
16989
|
+
/**
|
|
16990
|
+
*
|
|
16991
|
+
* @export
|
|
16992
|
+
* @interface JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
16993
|
+
*/
|
|
16994
|
+
export interface JsonApiWorkspaceDataFilterSettingOutAttributes {
|
|
16995
|
+
/**
|
|
16996
|
+
*
|
|
16997
|
+
* @type {string}
|
|
16998
|
+
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
16999
|
+
*/
|
|
17000
|
+
title?: string;
|
|
17001
|
+
/**
|
|
17002
|
+
*
|
|
17003
|
+
* @type {string}
|
|
17004
|
+
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
17005
|
+
*/
|
|
17006
|
+
description?: string;
|
|
17007
|
+
/**
|
|
17008
|
+
*
|
|
17009
|
+
* @type {Array<string>}
|
|
17010
|
+
* @memberof JsonApiWorkspaceDataFilterSettingOutAttributes
|
|
17011
|
+
*/
|
|
17012
|
+
filterValues?: Array<string>;
|
|
17013
|
+
}
|
|
16814
17014
|
/**
|
|
16815
17015
|
*
|
|
16816
17016
|
* @export
|
|
@@ -16867,6 +17067,32 @@ export interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
|
16867
17067
|
*/
|
|
16868
17068
|
included?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
16869
17069
|
}
|
|
17070
|
+
/**
|
|
17071
|
+
*
|
|
17072
|
+
* @export
|
|
17073
|
+
* @interface JsonApiWorkspaceDataFilterSettingOutRelationships
|
|
17074
|
+
*/
|
|
17075
|
+
export interface JsonApiWorkspaceDataFilterSettingOutRelationships {
|
|
17076
|
+
/**
|
|
17077
|
+
*
|
|
17078
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter}
|
|
17079
|
+
* @memberof JsonApiWorkspaceDataFilterSettingOutRelationships
|
|
17080
|
+
*/
|
|
17081
|
+
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter;
|
|
17082
|
+
}
|
|
17083
|
+
/**
|
|
17084
|
+
*
|
|
17085
|
+
* @export
|
|
17086
|
+
* @interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter
|
|
17087
|
+
*/
|
|
17088
|
+
export interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter {
|
|
17089
|
+
/**
|
|
17090
|
+
*
|
|
17091
|
+
* @type {JsonApiWorkspaceDataFilterToOneLinkage}
|
|
17092
|
+
* @memberof JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter
|
|
17093
|
+
*/
|
|
17094
|
+
data: JsonApiWorkspaceDataFilterToOneLinkage | null;
|
|
17095
|
+
}
|
|
16870
17096
|
/**
|
|
16871
17097
|
*
|
|
16872
17098
|
* @export
|
|
@@ -16893,16 +17119,16 @@ export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
16893
17119
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
16894
17120
|
/**
|
|
16895
17121
|
*
|
|
16896
|
-
* @type {
|
|
17122
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutAttributes}
|
|
16897
17123
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
16898
17124
|
*/
|
|
16899
|
-
attributes?:
|
|
17125
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
16900
17126
|
/**
|
|
16901
17127
|
*
|
|
16902
|
-
* @type {
|
|
17128
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationships}
|
|
16903
17129
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
16904
17130
|
*/
|
|
16905
|
-
relationships?:
|
|
17131
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
16906
17132
|
/**
|
|
16907
17133
|
*
|
|
16908
17134
|
* @type {ObjectLinks}
|
|
@@ -16934,46 +17160,21 @@ export interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
16934
17160
|
id: string;
|
|
16935
17161
|
/**
|
|
16936
17162
|
*
|
|
16937
|
-
* @type {
|
|
17163
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutAttributes}
|
|
16938
17164
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
16939
17165
|
*/
|
|
16940
|
-
attributes?:
|
|
17166
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
16941
17167
|
/**
|
|
16942
17168
|
*
|
|
16943
|
-
* @type {
|
|
17169
|
+
* @type {JsonApiWorkspaceDataFilterSettingOutRelationships}
|
|
16944
17170
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
16945
17171
|
*/
|
|
16946
|
-
relationships?:
|
|
17172
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
16947
17173
|
}
|
|
16948
17174
|
export declare const JsonApiWorkspaceDataFilterSettingPatchTypeEnum: {
|
|
16949
17175
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
16950
17176
|
};
|
|
16951
17177
|
export type JsonApiWorkspaceDataFilterSettingPatchTypeEnum = typeof JsonApiWorkspaceDataFilterSettingPatchTypeEnum[keyof typeof JsonApiWorkspaceDataFilterSettingPatchTypeEnum];
|
|
16952
|
-
/**
|
|
16953
|
-
*
|
|
16954
|
-
* @export
|
|
16955
|
-
* @interface JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
16956
|
-
*/
|
|
16957
|
-
export interface JsonApiWorkspaceDataFilterSettingPatchAttributes {
|
|
16958
|
-
/**
|
|
16959
|
-
*
|
|
16960
|
-
* @type {string}
|
|
16961
|
-
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
16962
|
-
*/
|
|
16963
|
-
title?: string;
|
|
16964
|
-
/**
|
|
16965
|
-
*
|
|
16966
|
-
* @type {string}
|
|
16967
|
-
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
16968
|
-
*/
|
|
16969
|
-
description?: string;
|
|
16970
|
-
/**
|
|
16971
|
-
*
|
|
16972
|
-
* @type {Array<string>}
|
|
16973
|
-
* @memberof JsonApiWorkspaceDataFilterSettingPatchAttributes
|
|
16974
|
-
*/
|
|
16975
|
-
filterValues?: Array<string>;
|
|
16976
|
-
}
|
|
16977
17178
|
/**
|
|
16978
17179
|
*
|
|
16979
17180
|
* @export
|
|
@@ -16987,32 +17188,6 @@ export interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
|
16987
17188
|
*/
|
|
16988
17189
|
data: JsonApiWorkspaceDataFilterSettingPatch;
|
|
16989
17190
|
}
|
|
16990
|
-
/**
|
|
16991
|
-
*
|
|
16992
|
-
* @export
|
|
16993
|
-
* @interface JsonApiWorkspaceDataFilterSettingPatchRelationships
|
|
16994
|
-
*/
|
|
16995
|
-
export interface JsonApiWorkspaceDataFilterSettingPatchRelationships {
|
|
16996
|
-
/**
|
|
16997
|
-
*
|
|
16998
|
-
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter}
|
|
16999
|
-
* @memberof JsonApiWorkspaceDataFilterSettingPatchRelationships
|
|
17000
|
-
*/
|
|
17001
|
-
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter;
|
|
17002
|
-
}
|
|
17003
|
-
/**
|
|
17004
|
-
*
|
|
17005
|
-
* @export
|
|
17006
|
-
* @interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter
|
|
17007
|
-
*/
|
|
17008
|
-
export interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter {
|
|
17009
|
-
/**
|
|
17010
|
-
*
|
|
17011
|
-
* @type {JsonApiWorkspaceDataFilterToOneLinkage}
|
|
17012
|
-
* @memberof JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter
|
|
17013
|
-
*/
|
|
17014
|
-
data: JsonApiWorkspaceDataFilterToOneLinkage | null;
|
|
17015
|
-
}
|
|
17016
17191
|
/**
|
|
17017
17192
|
* @type JsonApiWorkspaceDataFilterToOneLinkage
|
|
17018
17193
|
* References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -17039,90 +17214,21 @@ export interface JsonApiWorkspaceIn {
|
|
|
17039
17214
|
id: string;
|
|
17040
17215
|
/**
|
|
17041
17216
|
*
|
|
17042
|
-
* @type {
|
|
17217
|
+
* @type {JsonApiWorkspaceOutAttributes}
|
|
17043
17218
|
* @memberof JsonApiWorkspaceIn
|
|
17044
17219
|
*/
|
|
17045
|
-
attributes?:
|
|
17220
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
17046
17221
|
/**
|
|
17047
17222
|
*
|
|
17048
|
-
* @type {
|
|
17223
|
+
* @type {JsonApiWorkspaceOutRelationships}
|
|
17049
17224
|
* @memberof JsonApiWorkspaceIn
|
|
17050
17225
|
*/
|
|
17051
|
-
relationships?:
|
|
17226
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
17052
17227
|
}
|
|
17053
17228
|
export declare const JsonApiWorkspaceInTypeEnum: {
|
|
17054
17229
|
readonly WORKSPACE: "workspace";
|
|
17055
17230
|
};
|
|
17056
17231
|
export type JsonApiWorkspaceInTypeEnum = typeof JsonApiWorkspaceInTypeEnum[keyof typeof JsonApiWorkspaceInTypeEnum];
|
|
17057
|
-
/**
|
|
17058
|
-
*
|
|
17059
|
-
* @export
|
|
17060
|
-
* @interface JsonApiWorkspaceInAttributes
|
|
17061
|
-
*/
|
|
17062
|
-
export interface JsonApiWorkspaceInAttributes {
|
|
17063
|
-
/**
|
|
17064
|
-
*
|
|
17065
|
-
* @type {string}
|
|
17066
|
-
* @memberof JsonApiWorkspaceInAttributes
|
|
17067
|
-
*/
|
|
17068
|
-
name?: string | null;
|
|
17069
|
-
/**
|
|
17070
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
17071
|
-
* @type {string}
|
|
17072
|
-
* @memberof JsonApiWorkspaceInAttributes
|
|
17073
|
-
* @deprecated
|
|
17074
|
-
*/
|
|
17075
|
-
earlyAccess?: string | null;
|
|
17076
|
-
/**
|
|
17077
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
17078
|
-
* @type {Array<string>}
|
|
17079
|
-
* @memberof JsonApiWorkspaceInAttributes
|
|
17080
|
-
*/
|
|
17081
|
-
earlyAccessValues?: Array<string> | null;
|
|
17082
|
-
/**
|
|
17083
|
-
*
|
|
17084
|
-
* @type {string}
|
|
17085
|
-
* @memberof JsonApiWorkspaceInAttributes
|
|
17086
|
-
*/
|
|
17087
|
-
description?: string | null;
|
|
17088
|
-
/**
|
|
17089
|
-
* Custom prefix of entity identifiers in workspace
|
|
17090
|
-
* @type {string}
|
|
17091
|
-
* @memberof JsonApiWorkspaceInAttributes
|
|
17092
|
-
*/
|
|
17093
|
-
prefix?: string | null;
|
|
17094
|
-
/**
|
|
17095
|
-
*
|
|
17096
|
-
* @type {number}
|
|
17097
|
-
* @memberof JsonApiWorkspaceInAttributes
|
|
17098
|
-
*/
|
|
17099
|
-
cacheExtraLimit?: number;
|
|
17100
|
-
/**
|
|
17101
|
-
*
|
|
17102
|
-
* @type {JsonApiWorkspaceInAttributesDataSource}
|
|
17103
|
-
* @memberof JsonApiWorkspaceInAttributes
|
|
17104
|
-
*/
|
|
17105
|
-
dataSource?: JsonApiWorkspaceInAttributesDataSource;
|
|
17106
|
-
}
|
|
17107
|
-
/**
|
|
17108
|
-
* 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.
|
|
17109
|
-
* @export
|
|
17110
|
-
* @interface JsonApiWorkspaceInAttributesDataSource
|
|
17111
|
-
*/
|
|
17112
|
-
export interface JsonApiWorkspaceInAttributesDataSource {
|
|
17113
|
-
/**
|
|
17114
|
-
* The ID of the used data source.
|
|
17115
|
-
* @type {string}
|
|
17116
|
-
* @memberof JsonApiWorkspaceInAttributesDataSource
|
|
17117
|
-
*/
|
|
17118
|
-
id: string;
|
|
17119
|
-
/**
|
|
17120
|
-
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
17121
|
-
* @type {Array<string>}
|
|
17122
|
-
* @memberof JsonApiWorkspaceInAttributesDataSource
|
|
17123
|
-
*/
|
|
17124
|
-
schemaPath?: Array<string>;
|
|
17125
|
-
}
|
|
17126
17232
|
/**
|
|
17127
17233
|
*
|
|
17128
17234
|
* @export
|
|
@@ -17136,32 +17242,6 @@ export interface JsonApiWorkspaceInDocument {
|
|
|
17136
17242
|
*/
|
|
17137
17243
|
data: JsonApiWorkspaceIn;
|
|
17138
17244
|
}
|
|
17139
|
-
/**
|
|
17140
|
-
*
|
|
17141
|
-
* @export
|
|
17142
|
-
* @interface JsonApiWorkspaceInRelationships
|
|
17143
|
-
*/
|
|
17144
|
-
export interface JsonApiWorkspaceInRelationships {
|
|
17145
|
-
/**
|
|
17146
|
-
*
|
|
17147
|
-
* @type {JsonApiWorkspaceInRelationshipsParent}
|
|
17148
|
-
* @memberof JsonApiWorkspaceInRelationships
|
|
17149
|
-
*/
|
|
17150
|
-
parent?: JsonApiWorkspaceInRelationshipsParent;
|
|
17151
|
-
}
|
|
17152
|
-
/**
|
|
17153
|
-
*
|
|
17154
|
-
* @export
|
|
17155
|
-
* @interface JsonApiWorkspaceInRelationshipsParent
|
|
17156
|
-
*/
|
|
17157
|
-
export interface JsonApiWorkspaceInRelationshipsParent {
|
|
17158
|
-
/**
|
|
17159
|
-
*
|
|
17160
|
-
* @type {JsonApiWorkspaceToOneLinkage}
|
|
17161
|
-
* @memberof JsonApiWorkspaceInRelationshipsParent
|
|
17162
|
-
*/
|
|
17163
|
-
data: JsonApiWorkspaceToOneLinkage | null;
|
|
17164
|
-
}
|
|
17165
17245
|
/**
|
|
17166
17246
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
17167
17247
|
* @export
|
|
@@ -17211,21 +17291,90 @@ export interface JsonApiWorkspaceOut {
|
|
|
17211
17291
|
meta?: JsonApiWorkspaceOutMeta;
|
|
17212
17292
|
/**
|
|
17213
17293
|
*
|
|
17214
|
-
* @type {
|
|
17294
|
+
* @type {JsonApiWorkspaceOutAttributes}
|
|
17215
17295
|
* @memberof JsonApiWorkspaceOut
|
|
17216
17296
|
*/
|
|
17217
|
-
attributes?:
|
|
17297
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
17218
17298
|
/**
|
|
17219
17299
|
*
|
|
17220
|
-
* @type {
|
|
17300
|
+
* @type {JsonApiWorkspaceOutRelationships}
|
|
17221
17301
|
* @memberof JsonApiWorkspaceOut
|
|
17222
17302
|
*/
|
|
17223
|
-
relationships?:
|
|
17303
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
17224
17304
|
}
|
|
17225
17305
|
export declare const JsonApiWorkspaceOutTypeEnum: {
|
|
17226
17306
|
readonly WORKSPACE: "workspace";
|
|
17227
17307
|
};
|
|
17228
17308
|
export type JsonApiWorkspaceOutTypeEnum = typeof JsonApiWorkspaceOutTypeEnum[keyof typeof JsonApiWorkspaceOutTypeEnum];
|
|
17309
|
+
/**
|
|
17310
|
+
*
|
|
17311
|
+
* @export
|
|
17312
|
+
* @interface JsonApiWorkspaceOutAttributes
|
|
17313
|
+
*/
|
|
17314
|
+
export interface JsonApiWorkspaceOutAttributes {
|
|
17315
|
+
/**
|
|
17316
|
+
*
|
|
17317
|
+
* @type {string}
|
|
17318
|
+
* @memberof JsonApiWorkspaceOutAttributes
|
|
17319
|
+
*/
|
|
17320
|
+
name?: string | null;
|
|
17321
|
+
/**
|
|
17322
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
17323
|
+
* @type {string}
|
|
17324
|
+
* @memberof JsonApiWorkspaceOutAttributes
|
|
17325
|
+
* @deprecated
|
|
17326
|
+
*/
|
|
17327
|
+
earlyAccess?: string | null;
|
|
17328
|
+
/**
|
|
17329
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
17330
|
+
* @type {Array<string>}
|
|
17331
|
+
* @memberof JsonApiWorkspaceOutAttributes
|
|
17332
|
+
*/
|
|
17333
|
+
earlyAccessValues?: Array<string> | null;
|
|
17334
|
+
/**
|
|
17335
|
+
*
|
|
17336
|
+
* @type {string}
|
|
17337
|
+
* @memberof JsonApiWorkspaceOutAttributes
|
|
17338
|
+
*/
|
|
17339
|
+
description?: string | null;
|
|
17340
|
+
/**
|
|
17341
|
+
* Custom prefix of entity identifiers in workspace
|
|
17342
|
+
* @type {string}
|
|
17343
|
+
* @memberof JsonApiWorkspaceOutAttributes
|
|
17344
|
+
*/
|
|
17345
|
+
prefix?: string | null;
|
|
17346
|
+
/**
|
|
17347
|
+
*
|
|
17348
|
+
* @type {number}
|
|
17349
|
+
* @memberof JsonApiWorkspaceOutAttributes
|
|
17350
|
+
*/
|
|
17351
|
+
cacheExtraLimit?: number;
|
|
17352
|
+
/**
|
|
17353
|
+
*
|
|
17354
|
+
* @type {JsonApiWorkspaceOutAttributesDataSource}
|
|
17355
|
+
* @memberof JsonApiWorkspaceOutAttributes
|
|
17356
|
+
*/
|
|
17357
|
+
dataSource?: JsonApiWorkspaceOutAttributesDataSource;
|
|
17358
|
+
}
|
|
17359
|
+
/**
|
|
17360
|
+
* 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.
|
|
17361
|
+
* @export
|
|
17362
|
+
* @interface JsonApiWorkspaceOutAttributesDataSource
|
|
17363
|
+
*/
|
|
17364
|
+
export interface JsonApiWorkspaceOutAttributesDataSource {
|
|
17365
|
+
/**
|
|
17366
|
+
* The ID of the used data source.
|
|
17367
|
+
* @type {string}
|
|
17368
|
+
* @memberof JsonApiWorkspaceOutAttributesDataSource
|
|
17369
|
+
*/
|
|
17370
|
+
id: string;
|
|
17371
|
+
/**
|
|
17372
|
+
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
17373
|
+
* @type {Array<string>}
|
|
17374
|
+
* @memberof JsonApiWorkspaceOutAttributesDataSource
|
|
17375
|
+
*/
|
|
17376
|
+
schemaPath?: Array<string>;
|
|
17377
|
+
}
|
|
17229
17378
|
/**
|
|
17230
17379
|
*
|
|
17231
17380
|
* @export
|
|
@@ -17376,6 +17525,32 @@ export interface JsonApiWorkspaceOutMetaHierarchy {
|
|
|
17376
17525
|
*/
|
|
17377
17526
|
childrenCount: number;
|
|
17378
17527
|
}
|
|
17528
|
+
/**
|
|
17529
|
+
*
|
|
17530
|
+
* @export
|
|
17531
|
+
* @interface JsonApiWorkspaceOutRelationships
|
|
17532
|
+
*/
|
|
17533
|
+
export interface JsonApiWorkspaceOutRelationships {
|
|
17534
|
+
/**
|
|
17535
|
+
*
|
|
17536
|
+
* @type {JsonApiWorkspaceOutRelationshipsParent}
|
|
17537
|
+
* @memberof JsonApiWorkspaceOutRelationships
|
|
17538
|
+
*/
|
|
17539
|
+
parent?: JsonApiWorkspaceOutRelationshipsParent;
|
|
17540
|
+
}
|
|
17541
|
+
/**
|
|
17542
|
+
*
|
|
17543
|
+
* @export
|
|
17544
|
+
* @interface JsonApiWorkspaceOutRelationshipsParent
|
|
17545
|
+
*/
|
|
17546
|
+
export interface JsonApiWorkspaceOutRelationshipsParent {
|
|
17547
|
+
/**
|
|
17548
|
+
*
|
|
17549
|
+
* @type {JsonApiWorkspaceToOneLinkage}
|
|
17550
|
+
* @memberof JsonApiWorkspaceOutRelationshipsParent
|
|
17551
|
+
*/
|
|
17552
|
+
data: JsonApiWorkspaceToOneLinkage | null;
|
|
17553
|
+
}
|
|
17379
17554
|
/**
|
|
17380
17555
|
*
|
|
17381
17556
|
* @export
|
|
@@ -17402,16 +17577,16 @@ export interface JsonApiWorkspaceOutWithLinks {
|
|
|
17402
17577
|
meta?: JsonApiWorkspaceOutMeta;
|
|
17403
17578
|
/**
|
|
17404
17579
|
*
|
|
17405
|
-
* @type {
|
|
17580
|
+
* @type {JsonApiWorkspaceOutAttributes}
|
|
17406
17581
|
* @memberof JsonApiWorkspaceOutWithLinks
|
|
17407
17582
|
*/
|
|
17408
|
-
attributes?:
|
|
17583
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
17409
17584
|
/**
|
|
17410
17585
|
*
|
|
17411
|
-
* @type {
|
|
17586
|
+
* @type {JsonApiWorkspaceOutRelationships}
|
|
17412
17587
|
* @memberof JsonApiWorkspaceOutWithLinks
|
|
17413
17588
|
*/
|
|
17414
|
-
relationships?:
|
|
17589
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
17415
17590
|
/**
|
|
17416
17591
|
*
|
|
17417
17592
|
* @type {ObjectLinks}
|
|
@@ -17443,16 +17618,16 @@ export interface JsonApiWorkspacePatch {
|
|
|
17443
17618
|
id: string;
|
|
17444
17619
|
/**
|
|
17445
17620
|
*
|
|
17446
|
-
* @type {
|
|
17621
|
+
* @type {JsonApiWorkspaceOutAttributes}
|
|
17447
17622
|
* @memberof JsonApiWorkspacePatch
|
|
17448
17623
|
*/
|
|
17449
|
-
attributes?:
|
|
17624
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
17450
17625
|
/**
|
|
17451
17626
|
*
|
|
17452
|
-
* @type {
|
|
17627
|
+
* @type {JsonApiWorkspaceOutRelationships}
|
|
17453
17628
|
* @memberof JsonApiWorkspacePatch
|
|
17454
17629
|
*/
|
|
17455
|
-
relationships?:
|
|
17630
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
17456
17631
|
}
|
|
17457
17632
|
export declare const JsonApiWorkspacePatchTypeEnum: {
|
|
17458
17633
|
readonly WORKSPACE: "workspace";
|
|
@@ -30804,7 +30979,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
30804
30979
|
* @param {string} workspaceId
|
|
30805
30980
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
30806
30981
|
* @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\').
|
|
30807
|
-
* @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.
|
|
30982
|
+
* @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.
|
|
30808
30983
|
* @param {number} [page] Zero-based page index (0..N)
|
|
30809
30984
|
* @param {number} [size] The size of the page to be returned
|
|
30810
30985
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -30813,7 +30988,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
30813
30988
|
* @param {*} [options] Override http request option.
|
|
30814
30989
|
* @throws {RequiredError}
|
|
30815
30990
|
*/
|
|
30816
|
-
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<RequestArgs>;
|
|
30991
|
+
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<RequestArgs>;
|
|
30817
30992
|
/**
|
|
30818
30993
|
*
|
|
30819
30994
|
* @summary Get all Context Filters
|
|
@@ -31302,13 +31477,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31302
31477
|
* @param {string} workspaceId
|
|
31303
31478
|
* @param {string} objectId
|
|
31304
31479
|
* @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\').
|
|
31305
|
-
* @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.
|
|
31480
|
+
* @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.
|
|
31306
31481
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
31307
31482
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
31308
31483
|
* @param {*} [options] Override http request option.
|
|
31309
31484
|
* @throws {RequiredError}
|
|
31310
31485
|
*/
|
|
31311
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31486
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31312
31487
|
/**
|
|
31313
31488
|
*
|
|
31314
31489
|
* @summary Get a Context Filter
|
|
@@ -31418,12 +31593,12 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31418
31593
|
* @summary Get Organizations
|
|
31419
31594
|
* @param {string} id
|
|
31420
31595
|
* @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\').
|
|
31421
|
-
* @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.
|
|
31596
|
+
* @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.
|
|
31422
31597
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
31423
31598
|
* @param {*} [options] Override http request option.
|
|
31424
31599
|
* @throws {RequiredError}
|
|
31425
31600
|
*/
|
|
31426
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31601
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31427
31602
|
/**
|
|
31428
31603
|
*
|
|
31429
31604
|
* @summary Get Theming
|
|
@@ -31768,11 +31943,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31768
31943
|
* @param {string} id
|
|
31769
31944
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
31770
31945
|
* @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\').
|
|
31771
|
-
* @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.
|
|
31946
|
+
* @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.
|
|
31772
31947
|
* @param {*} [options] Override http request option.
|
|
31773
31948
|
* @throws {RequiredError}
|
|
31774
31949
|
*/
|
|
31775
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31950
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31776
31951
|
/**
|
|
31777
31952
|
*
|
|
31778
31953
|
* @summary Patch Theming
|
|
@@ -32088,11 +32263,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32088
32263
|
* @param {string} id
|
|
32089
32264
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
32090
32265
|
* @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\').
|
|
32091
|
-
* @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.
|
|
32266
|
+
* @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.
|
|
32092
32267
|
* @param {*} [options] Override http request option.
|
|
32093
32268
|
* @throws {RequiredError}
|
|
32094
32269
|
*/
|
|
32095
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32270
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32096
32271
|
/**
|
|
32097
32272
|
*
|
|
32098
32273
|
* @summary Put Theming
|
|
@@ -32984,7 +33159,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
32984
33159
|
* @param {string} workspaceId
|
|
32985
33160
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
32986
33161
|
* @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\').
|
|
32987
|
-
* @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.
|
|
33162
|
+
* @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.
|
|
32988
33163
|
* @param {number} [page] Zero-based page index (0..N)
|
|
32989
33164
|
* @param {number} [size] The size of the page to be returned
|
|
32990
33165
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -32993,7 +33168,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
32993
33168
|
* @param {*} [options] Override http request option.
|
|
32994
33169
|
* @throws {RequiredError}
|
|
32995
33170
|
*/
|
|
32996
|
-
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>>;
|
|
33171
|
+
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>>;
|
|
32997
33172
|
/**
|
|
32998
33173
|
*
|
|
32999
33174
|
* @summary Get all Context Filters
|
|
@@ -33484,13 +33659,13 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33484
33659
|
* @param {string} workspaceId
|
|
33485
33660
|
* @param {string} objectId
|
|
33486
33661
|
* @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\').
|
|
33487
|
-
* @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.
|
|
33662
|
+
* @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.
|
|
33488
33663
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
33489
33664
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33490
33665
|
* @param {*} [options] Override http request option.
|
|
33491
33666
|
* @throws {RequiredError}
|
|
33492
33667
|
*/
|
|
33493
|
-
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>>;
|
|
33668
|
+
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>>;
|
|
33494
33669
|
/**
|
|
33495
33670
|
*
|
|
33496
33671
|
* @summary Get a Context Filter
|
|
@@ -33600,12 +33775,12 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33600
33775
|
* @summary Get Organizations
|
|
33601
33776
|
* @param {string} id
|
|
33602
33777
|
* @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\').
|
|
33603
|
-
* @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.
|
|
33778
|
+
* @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.
|
|
33604
33779
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33605
33780
|
* @param {*} [options] Override http request option.
|
|
33606
33781
|
* @throws {RequiredError}
|
|
33607
33782
|
*/
|
|
33608
|
-
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>>;
|
|
33783
|
+
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>>;
|
|
33609
33784
|
/**
|
|
33610
33785
|
*
|
|
33611
33786
|
* @summary Get Theming
|
|
@@ -33950,11 +34125,11 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33950
34125
|
* @param {string} id
|
|
33951
34126
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
33952
34127
|
* @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\').
|
|
33953
|
-
* @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.
|
|
34128
|
+
* @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.
|
|
33954
34129
|
* @param {*} [options] Override http request option.
|
|
33955
34130
|
* @throws {RequiredError}
|
|
33956
34131
|
*/
|
|
33957
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
34132
|
+
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>>;
|
|
33958
34133
|
/**
|
|
33959
34134
|
*
|
|
33960
34135
|
* @summary Patch Theming
|
|
@@ -34270,11 +34445,11 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
34270
34445
|
* @param {string} id
|
|
34271
34446
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
34272
34447
|
* @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\').
|
|
34273
|
-
* @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.
|
|
34448
|
+
* @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.
|
|
34274
34449
|
* @param {*} [options] Override http request option.
|
|
34275
34450
|
* @throws {RequiredError}
|
|
34276
34451
|
*/
|
|
34277
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
34452
|
+
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>>;
|
|
34278
34453
|
/**
|
|
34279
34454
|
*
|
|
34280
34455
|
* @summary Put Theming
|
|
@@ -39801,10 +39976,10 @@ export interface EntitiesApiGetAllEntitiesFactsRequest {
|
|
|
39801
39976
|
readonly filter?: string;
|
|
39802
39977
|
/**
|
|
39803
39978
|
* 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.
|
|
39804
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
39979
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
39805
39980
|
* @memberof EntitiesApiGetAllEntitiesFacts
|
|
39806
39981
|
*/
|
|
39807
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
39982
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
39808
39983
|
/**
|
|
39809
39984
|
* Zero-based page index (0..N)
|
|
39810
39985
|
* @type {number}
|
|
@@ -41381,10 +41556,10 @@ export interface EntitiesApiGetEntityFactsRequest {
|
|
|
41381
41556
|
readonly filter?: string;
|
|
41382
41557
|
/**
|
|
41383
41558
|
* 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.
|
|
41384
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
41559
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
41385
41560
|
* @memberof EntitiesApiGetEntityFacts
|
|
41386
41561
|
*/
|
|
41387
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
41562
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
41388
41563
|
/**
|
|
41389
41564
|
*
|
|
41390
41565
|
* @type {boolean}
|
|
@@ -41698,10 +41873,10 @@ export interface EntitiesApiGetEntityOrganizationsRequest {
|
|
|
41698
41873
|
readonly filter?: string;
|
|
41699
41874
|
/**
|
|
41700
41875
|
* 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.
|
|
41701
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
41876
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
41702
41877
|
* @memberof EntitiesApiGetEntityOrganizations
|
|
41703
41878
|
*/
|
|
41704
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
41879
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
41705
41880
|
/**
|
|
41706
41881
|
* Include Meta objects.
|
|
41707
41882
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -42678,10 +42853,10 @@ export interface EntitiesApiPatchEntityOrganizationsRequest {
|
|
|
42678
42853
|
readonly filter?: string;
|
|
42679
42854
|
/**
|
|
42680
42855
|
* 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.
|
|
42681
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
42856
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
42682
42857
|
* @memberof EntitiesApiPatchEntityOrganizations
|
|
42683
42858
|
*/
|
|
42684
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
42859
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
42685
42860
|
}
|
|
42686
42861
|
/**
|
|
42687
42862
|
* Request parameters for patchEntityThemes operation in EntitiesApi.
|
|
@@ -43583,10 +43758,10 @@ export interface EntitiesApiUpdateEntityOrganizationsRequest {
|
|
|
43583
43758
|
readonly filter?: string;
|
|
43584
43759
|
/**
|
|
43585
43760
|
* 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.
|
|
43586
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
43761
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
43587
43762
|
* @memberof EntitiesApiUpdateEntityOrganizations
|
|
43588
43763
|
*/
|
|
43589
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
43764
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
43590
43765
|
}
|
|
43591
43766
|
/**
|
|
43592
43767
|
* Request parameters for updateEntityThemes operation in EntitiesApi.
|
|
@@ -46542,7 +46717,7 @@ export declare const FactsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
46542
46717
|
* @param {string} workspaceId
|
|
46543
46718
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
46544
46719
|
* @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\').
|
|
46545
|
-
* @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.
|
|
46720
|
+
* @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.
|
|
46546
46721
|
* @param {number} [page] Zero-based page index (0..N)
|
|
46547
46722
|
* @param {number} [size] The size of the page to be returned
|
|
46548
46723
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -46551,20 +46726,20 @@ export declare const FactsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
46551
46726
|
* @param {*} [options] Override http request option.
|
|
46552
46727
|
* @throws {RequiredError}
|
|
46553
46728
|
*/
|
|
46554
|
-
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<RequestArgs>;
|
|
46729
|
+
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<RequestArgs>;
|
|
46555
46730
|
/**
|
|
46556
46731
|
*
|
|
46557
46732
|
* @summary Get a Fact
|
|
46558
46733
|
* @param {string} workspaceId
|
|
46559
46734
|
* @param {string} objectId
|
|
46560
46735
|
* @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\').
|
|
46561
|
-
* @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.
|
|
46736
|
+
* @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.
|
|
46562
46737
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
46563
46738
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46564
46739
|
* @param {*} [options] Override http request option.
|
|
46565
46740
|
* @throws {RequiredError}
|
|
46566
46741
|
*/
|
|
46567
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46742
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46568
46743
|
};
|
|
46569
46744
|
/**
|
|
46570
46745
|
* FactsApi - functional programming interface
|
|
@@ -46577,7 +46752,7 @@ export declare const FactsApiFp: (configuration?: Configuration) => {
|
|
|
46577
46752
|
* @param {string} workspaceId
|
|
46578
46753
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
46579
46754
|
* @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\').
|
|
46580
|
-
* @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.
|
|
46755
|
+
* @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.
|
|
46581
46756
|
* @param {number} [page] Zero-based page index (0..N)
|
|
46582
46757
|
* @param {number} [size] The size of the page to be returned
|
|
46583
46758
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -46586,20 +46761,20 @@ export declare const FactsApiFp: (configuration?: Configuration) => {
|
|
|
46586
46761
|
* @param {*} [options] Override http request option.
|
|
46587
46762
|
* @throws {RequiredError}
|
|
46588
46763
|
*/
|
|
46589
|
-
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>>;
|
|
46764
|
+
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>>;
|
|
46590
46765
|
/**
|
|
46591
46766
|
*
|
|
46592
46767
|
* @summary Get a Fact
|
|
46593
46768
|
* @param {string} workspaceId
|
|
46594
46769
|
* @param {string} objectId
|
|
46595
46770
|
* @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\').
|
|
46596
|
-
* @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.
|
|
46771
|
+
* @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.
|
|
46597
46772
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
46598
46773
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46599
46774
|
* @param {*} [options] Override http request option.
|
|
46600
46775
|
* @throws {RequiredError}
|
|
46601
46776
|
*/
|
|
46602
|
-
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>>;
|
|
46777
|
+
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>>;
|
|
46603
46778
|
};
|
|
46604
46779
|
/**
|
|
46605
46780
|
* FactsApi - factory interface
|
|
@@ -46674,10 +46849,10 @@ export interface FactsApiGetAllEntitiesFactsRequest {
|
|
|
46674
46849
|
readonly filter?: string;
|
|
46675
46850
|
/**
|
|
46676
46851
|
* 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.
|
|
46677
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
46852
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
46678
46853
|
* @memberof FactsApiGetAllEntitiesFacts
|
|
46679
46854
|
*/
|
|
46680
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
46855
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
46681
46856
|
/**
|
|
46682
46857
|
* Zero-based page index (0..N)
|
|
46683
46858
|
* @type {number}
|
|
@@ -46735,10 +46910,10 @@ export interface FactsApiGetEntityFactsRequest {
|
|
|
46735
46910
|
readonly filter?: string;
|
|
46736
46911
|
/**
|
|
46737
46912
|
* 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.
|
|
46738
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
46913
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
46739
46914
|
* @memberof FactsApiGetEntityFacts
|
|
46740
46915
|
*/
|
|
46741
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
46916
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
46742
46917
|
/**
|
|
46743
46918
|
*
|
|
46744
46919
|
* @type {boolean}
|
|
@@ -52959,6 +53134,17 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
52959
53134
|
* @throws {RequiredError}
|
|
52960
53135
|
*/
|
|
52961
53136
|
deleteEntityNotificationChannels: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53137
|
+
/**
|
|
53138
|
+
*
|
|
53139
|
+
* @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\').
|
|
53140
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
53141
|
+
* @param {number} [size] The size of the page to be returned
|
|
53142
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
53143
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
53144
|
+
* @param {*} [options] Override http request option.
|
|
53145
|
+
* @throws {RequiredError}
|
|
53146
|
+
*/
|
|
53147
|
+
getAllEntitiesNotificationChannelIdentifiers: (filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52962
53148
|
/**
|
|
52963
53149
|
*
|
|
52964
53150
|
* @summary Get all Notification Channel entities
|
|
@@ -52971,6 +53157,14 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
52971
53157
|
* @throws {RequiredError}
|
|
52972
53158
|
*/
|
|
52973
53159
|
getAllEntitiesNotificationChannels: (filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53160
|
+
/**
|
|
53161
|
+
*
|
|
53162
|
+
* @param {string} id
|
|
53163
|
+
* @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\').
|
|
53164
|
+
* @param {*} [options] Override http request option.
|
|
53165
|
+
* @throws {RequiredError}
|
|
53166
|
+
*/
|
|
53167
|
+
getEntityNotificationChannelIdentifiers: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52974
53168
|
/**
|
|
52975
53169
|
*
|
|
52976
53170
|
* @summary Get Notification Channel entity
|
|
@@ -53053,6 +53247,17 @@ export declare const NotificationChannelsApiFp: (configuration?: Configuration)
|
|
|
53053
53247
|
* @throws {RequiredError}
|
|
53054
53248
|
*/
|
|
53055
53249
|
deleteEntityNotificationChannels(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
53250
|
+
/**
|
|
53251
|
+
*
|
|
53252
|
+
* @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\').
|
|
53253
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
53254
|
+
* @param {number} [size] The size of the page to be returned
|
|
53255
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
53256
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
53257
|
+
* @param {*} [options] Override http request option.
|
|
53258
|
+
* @throws {RequiredError}
|
|
53259
|
+
*/
|
|
53260
|
+
getAllEntitiesNotificationChannelIdentifiers(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiNotificationChannelIdentifierOutList>>;
|
|
53056
53261
|
/**
|
|
53057
53262
|
*
|
|
53058
53263
|
* @summary Get all Notification Channel entities
|
|
@@ -53065,6 +53270,14 @@ export declare const NotificationChannelsApiFp: (configuration?: Configuration)
|
|
|
53065
53270
|
* @throws {RequiredError}
|
|
53066
53271
|
*/
|
|
53067
53272
|
getAllEntitiesNotificationChannels(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiNotificationChannelOutList>>;
|
|
53273
|
+
/**
|
|
53274
|
+
*
|
|
53275
|
+
* @param {string} id
|
|
53276
|
+
* @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\').
|
|
53277
|
+
* @param {*} [options] Override http request option.
|
|
53278
|
+
* @throws {RequiredError}
|
|
53279
|
+
*/
|
|
53280
|
+
getEntityNotificationChannelIdentifiers(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiNotificationChannelIdentifierOutDocument>>;
|
|
53068
53281
|
/**
|
|
53069
53282
|
*
|
|
53070
53283
|
* @summary Get Notification Channel entity
|
|
@@ -53146,6 +53359,13 @@ export declare const NotificationChannelsApiFactory: (configuration?: Configurat
|
|
|
53146
53359
|
* @throws {RequiredError}
|
|
53147
53360
|
*/
|
|
53148
53361
|
deleteEntityNotificationChannels(requestParameters: NotificationChannelsApiDeleteEntityNotificationChannelsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
53362
|
+
/**
|
|
53363
|
+
*
|
|
53364
|
+
* @param {NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
53365
|
+
* @param {*} [options] Override http request option.
|
|
53366
|
+
* @throws {RequiredError}
|
|
53367
|
+
*/
|
|
53368
|
+
getAllEntitiesNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelIdentifierOutList>;
|
|
53149
53369
|
/**
|
|
53150
53370
|
*
|
|
53151
53371
|
* @summary Get all Notification Channel entities
|
|
@@ -53154,6 +53374,13 @@ export declare const NotificationChannelsApiFactory: (configuration?: Configurat
|
|
|
53154
53374
|
* @throws {RequiredError}
|
|
53155
53375
|
*/
|
|
53156
53376
|
getAllEntitiesNotificationChannels(requestParameters: NotificationChannelsApiGetAllEntitiesNotificationChannelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelOutList>;
|
|
53377
|
+
/**
|
|
53378
|
+
*
|
|
53379
|
+
* @param {NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
53380
|
+
* @param {*} [options] Override http request option.
|
|
53381
|
+
* @throws {RequiredError}
|
|
53382
|
+
*/
|
|
53383
|
+
getEntityNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelIdentifierOutDocument>;
|
|
53157
53384
|
/**
|
|
53158
53385
|
*
|
|
53159
53386
|
* @summary Get Notification Channel entity
|
|
@@ -53233,6 +53460,14 @@ export interface NotificationChannelsApiInterface {
|
|
|
53233
53460
|
* @memberof NotificationChannelsApiInterface
|
|
53234
53461
|
*/
|
|
53235
53462
|
deleteEntityNotificationChannels(requestParameters: NotificationChannelsApiDeleteEntityNotificationChannelsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
53463
|
+
/**
|
|
53464
|
+
*
|
|
53465
|
+
* @param {NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
53466
|
+
* @param {*} [options] Override http request option.
|
|
53467
|
+
* @throws {RequiredError}
|
|
53468
|
+
* @memberof NotificationChannelsApiInterface
|
|
53469
|
+
*/
|
|
53470
|
+
getAllEntitiesNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelIdentifierOutList>;
|
|
53236
53471
|
/**
|
|
53237
53472
|
*
|
|
53238
53473
|
* @summary Get all Notification Channel entities
|
|
@@ -53242,6 +53477,14 @@ export interface NotificationChannelsApiInterface {
|
|
|
53242
53477
|
* @memberof NotificationChannelsApiInterface
|
|
53243
53478
|
*/
|
|
53244
53479
|
getAllEntitiesNotificationChannels(requestParameters: NotificationChannelsApiGetAllEntitiesNotificationChannelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelOutList>;
|
|
53480
|
+
/**
|
|
53481
|
+
*
|
|
53482
|
+
* @param {NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
53483
|
+
* @param {*} [options] Override http request option.
|
|
53484
|
+
* @throws {RequiredError}
|
|
53485
|
+
* @memberof NotificationChannelsApiInterface
|
|
53486
|
+
*/
|
|
53487
|
+
getEntityNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiNotificationChannelIdentifierOutDocument>;
|
|
53245
53488
|
/**
|
|
53246
53489
|
*
|
|
53247
53490
|
* @summary Get Notification Channel entity
|
|
@@ -53336,6 +53579,43 @@ export interface NotificationChannelsApiDeleteEntityNotificationChannelsRequest
|
|
|
53336
53579
|
*/
|
|
53337
53580
|
readonly filter?: string;
|
|
53338
53581
|
}
|
|
53582
|
+
/**
|
|
53583
|
+
* Request parameters for getAllEntitiesNotificationChannelIdentifiers operation in NotificationChannelsApi.
|
|
53584
|
+
* @export
|
|
53585
|
+
* @interface NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest
|
|
53586
|
+
*/
|
|
53587
|
+
export interface NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest {
|
|
53588
|
+
/**
|
|
53589
|
+
* 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\').
|
|
53590
|
+
* @type {string}
|
|
53591
|
+
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
53592
|
+
*/
|
|
53593
|
+
readonly filter?: string;
|
|
53594
|
+
/**
|
|
53595
|
+
* Zero-based page index (0..N)
|
|
53596
|
+
* @type {number}
|
|
53597
|
+
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
53598
|
+
*/
|
|
53599
|
+
readonly page?: number;
|
|
53600
|
+
/**
|
|
53601
|
+
* The size of the page to be returned
|
|
53602
|
+
* @type {number}
|
|
53603
|
+
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
53604
|
+
*/
|
|
53605
|
+
readonly size?: number;
|
|
53606
|
+
/**
|
|
53607
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
53608
|
+
* @type {Array<string>}
|
|
53609
|
+
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
53610
|
+
*/
|
|
53611
|
+
readonly sort?: Array<string>;
|
|
53612
|
+
/**
|
|
53613
|
+
* Include Meta objects.
|
|
53614
|
+
* @type {Array<'page' | 'all' | 'ALL'>}
|
|
53615
|
+
* @memberof NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiers
|
|
53616
|
+
*/
|
|
53617
|
+
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
53618
|
+
}
|
|
53339
53619
|
/**
|
|
53340
53620
|
* Request parameters for getAllEntitiesNotificationChannels operation in NotificationChannelsApi.
|
|
53341
53621
|
* @export
|
|
@@ -53373,6 +53653,25 @@ export interface NotificationChannelsApiGetAllEntitiesNotificationChannelsReques
|
|
|
53373
53653
|
*/
|
|
53374
53654
|
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
53375
53655
|
}
|
|
53656
|
+
/**
|
|
53657
|
+
* Request parameters for getEntityNotificationChannelIdentifiers operation in NotificationChannelsApi.
|
|
53658
|
+
* @export
|
|
53659
|
+
* @interface NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest
|
|
53660
|
+
*/
|
|
53661
|
+
export interface NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest {
|
|
53662
|
+
/**
|
|
53663
|
+
*
|
|
53664
|
+
* @type {string}
|
|
53665
|
+
* @memberof NotificationChannelsApiGetEntityNotificationChannelIdentifiers
|
|
53666
|
+
*/
|
|
53667
|
+
readonly id: string;
|
|
53668
|
+
/**
|
|
53669
|
+
* 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\').
|
|
53670
|
+
* @type {string}
|
|
53671
|
+
* @memberof NotificationChannelsApiGetEntityNotificationChannelIdentifiers
|
|
53672
|
+
*/
|
|
53673
|
+
readonly filter?: string;
|
|
53674
|
+
}
|
|
53376
53675
|
/**
|
|
53377
53676
|
* Request parameters for getEntityNotificationChannels operation in NotificationChannelsApi.
|
|
53378
53677
|
* @export
|
|
@@ -53493,6 +53792,14 @@ export declare class NotificationChannelsApi extends BaseAPI implements Notifica
|
|
|
53493
53792
|
* @memberof NotificationChannelsApi
|
|
53494
53793
|
*/
|
|
53495
53794
|
deleteEntityNotificationChannels(requestParameters: NotificationChannelsApiDeleteEntityNotificationChannelsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
53795
|
+
/**
|
|
53796
|
+
*
|
|
53797
|
+
* @param {NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
53798
|
+
* @param {*} [options] Override http request option.
|
|
53799
|
+
* @throws {RequiredError}
|
|
53800
|
+
* @memberof NotificationChannelsApi
|
|
53801
|
+
*/
|
|
53802
|
+
getAllEntitiesNotificationChannelIdentifiers(requestParameters?: NotificationChannelsApiGetAllEntitiesNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiNotificationChannelIdentifierOutList, any>>;
|
|
53496
53803
|
/**
|
|
53497
53804
|
*
|
|
53498
53805
|
* @summary Get all Notification Channel entities
|
|
@@ -53502,6 +53809,14 @@ export declare class NotificationChannelsApi extends BaseAPI implements Notifica
|
|
|
53502
53809
|
* @memberof NotificationChannelsApi
|
|
53503
53810
|
*/
|
|
53504
53811
|
getAllEntitiesNotificationChannels(requestParameters?: NotificationChannelsApiGetAllEntitiesNotificationChannelsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiNotificationChannelOutList, any>>;
|
|
53812
|
+
/**
|
|
53813
|
+
*
|
|
53814
|
+
* @param {NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest} requestParameters Request parameters.
|
|
53815
|
+
* @param {*} [options] Override http request option.
|
|
53816
|
+
* @throws {RequiredError}
|
|
53817
|
+
* @memberof NotificationChannelsApi
|
|
53818
|
+
*/
|
|
53819
|
+
getEntityNotificationChannelIdentifiers(requestParameters: NotificationChannelsApiGetEntityNotificationChannelIdentifiersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiNotificationChannelIdentifierOutDocument, any>>;
|
|
53505
53820
|
/**
|
|
53506
53821
|
*
|
|
53507
53822
|
* @summary Get Notification Channel entity
|
|
@@ -53653,12 +53968,12 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
53653
53968
|
* @summary Get Organizations
|
|
53654
53969
|
* @param {string} id
|
|
53655
53970
|
* @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\').
|
|
53656
|
-
* @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.
|
|
53971
|
+
* @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.
|
|
53657
53972
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
53658
53973
|
* @param {*} [options] Override http request option.
|
|
53659
53974
|
* @throws {RequiredError}
|
|
53660
53975
|
*/
|
|
53661
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53976
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53662
53977
|
/**
|
|
53663
53978
|
*
|
|
53664
53979
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -53675,11 +53990,11 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
53675
53990
|
* @param {string} id
|
|
53676
53991
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
53677
53992
|
* @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\').
|
|
53678
|
-
* @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.
|
|
53993
|
+
* @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.
|
|
53679
53994
|
* @param {*} [options] Override http request option.
|
|
53680
53995
|
* @throws {RequiredError}
|
|
53681
53996
|
*/
|
|
53682
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53997
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53683
53998
|
/**
|
|
53684
53999
|
*
|
|
53685
54000
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -53696,11 +54011,11 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
53696
54011
|
* @param {string} id
|
|
53697
54012
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
53698
54013
|
* @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\').
|
|
53699
|
-
* @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.
|
|
54014
|
+
* @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.
|
|
53700
54015
|
* @param {*} [options] Override http request option.
|
|
53701
54016
|
* @throws {RequiredError}
|
|
53702
54017
|
*/
|
|
53703
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54018
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53704
54019
|
};
|
|
53705
54020
|
/**
|
|
53706
54021
|
* OrganizationControllerApi - functional programming interface
|
|
@@ -53721,12 +54036,12 @@ export declare const OrganizationControllerApiFp: (configuration?: Configuration
|
|
|
53721
54036
|
* @summary Get Organizations
|
|
53722
54037
|
* @param {string} id
|
|
53723
54038
|
* @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\').
|
|
53724
|
-
* @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.
|
|
54039
|
+
* @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.
|
|
53725
54040
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
53726
54041
|
* @param {*} [options] Override http request option.
|
|
53727
54042
|
* @throws {RequiredError}
|
|
53728
54043
|
*/
|
|
53729
|
-
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>>;
|
|
54044
|
+
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>>;
|
|
53730
54045
|
/**
|
|
53731
54046
|
*
|
|
53732
54047
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -53743,11 +54058,11 @@ export declare const OrganizationControllerApiFp: (configuration?: Configuration
|
|
|
53743
54058
|
* @param {string} id
|
|
53744
54059
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
53745
54060
|
* @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\').
|
|
53746
|
-
* @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.
|
|
54061
|
+
* @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.
|
|
53747
54062
|
* @param {*} [options] Override http request option.
|
|
53748
54063
|
* @throws {RequiredError}
|
|
53749
54064
|
*/
|
|
53750
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
54065
|
+
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>>;
|
|
53751
54066
|
/**
|
|
53752
54067
|
*
|
|
53753
54068
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -53764,11 +54079,11 @@ export declare const OrganizationControllerApiFp: (configuration?: Configuration
|
|
|
53764
54079
|
* @param {string} id
|
|
53765
54080
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
53766
54081
|
* @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\').
|
|
53767
|
-
* @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.
|
|
54082
|
+
* @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.
|
|
53768
54083
|
* @param {*} [options] Override http request option.
|
|
53769
54084
|
* @throws {RequiredError}
|
|
53770
54085
|
*/
|
|
53771
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
54086
|
+
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>>;
|
|
53772
54087
|
};
|
|
53773
54088
|
/**
|
|
53774
54089
|
* OrganizationControllerApi - factory interface
|
|
@@ -53924,10 +54239,10 @@ export interface OrganizationControllerApiGetEntityOrganizationsRequest {
|
|
|
53924
54239
|
readonly filter?: string;
|
|
53925
54240
|
/**
|
|
53926
54241
|
* 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.
|
|
53927
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
54242
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
53928
54243
|
* @memberof OrganizationControllerApiGetEntityOrganizations
|
|
53929
54244
|
*/
|
|
53930
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
54245
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
53931
54246
|
/**
|
|
53932
54247
|
* Include Meta objects.
|
|
53933
54248
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -53986,10 +54301,10 @@ export interface OrganizationControllerApiPatchEntityOrganizationsRequest {
|
|
|
53986
54301
|
readonly filter?: string;
|
|
53987
54302
|
/**
|
|
53988
54303
|
* 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.
|
|
53989
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
54304
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
53990
54305
|
* @memberof OrganizationControllerApiPatchEntityOrganizations
|
|
53991
54306
|
*/
|
|
53992
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
54307
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
53993
54308
|
}
|
|
53994
54309
|
/**
|
|
53995
54310
|
* Request parameters for updateEntityCookieSecurityConfigurations operation in OrganizationControllerApi.
|
|
@@ -54042,10 +54357,10 @@ export interface OrganizationControllerApiUpdateEntityOrganizationsRequest {
|
|
|
54042
54357
|
readonly filter?: string;
|
|
54043
54358
|
/**
|
|
54044
54359
|
* 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.
|
|
54045
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
54360
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
54046
54361
|
* @memberof OrganizationControllerApiUpdateEntityOrganizations
|
|
54047
54362
|
*/
|
|
54048
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
54363
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
54049
54364
|
}
|
|
54050
54365
|
/**
|
|
54051
54366
|
* OrganizationControllerApi - object-oriented interface
|
|
@@ -54300,12 +54615,12 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
54300
54615
|
* @summary Get Organizations
|
|
54301
54616
|
* @param {string} id
|
|
54302
54617
|
* @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\').
|
|
54303
|
-
* @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.
|
|
54618
|
+
* @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.
|
|
54304
54619
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
54305
54620
|
* @param {*} [options] Override http request option.
|
|
54306
54621
|
* @throws {RequiredError}
|
|
54307
54622
|
*/
|
|
54308
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54623
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54309
54624
|
/**
|
|
54310
54625
|
* Gets a basic information about organization.
|
|
54311
54626
|
* @summary Get current organization info
|
|
@@ -54330,11 +54645,11 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
54330
54645
|
* @param {string} id
|
|
54331
54646
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
54332
54647
|
* @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\').
|
|
54333
|
-
* @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.
|
|
54648
|
+
* @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.
|
|
54334
54649
|
* @param {*} [options] Override http request option.
|
|
54335
54650
|
* @throws {RequiredError}
|
|
54336
54651
|
*/
|
|
54337
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54652
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54338
54653
|
/**
|
|
54339
54654
|
*
|
|
54340
54655
|
* @summary Put Organization entity
|
|
@@ -54351,11 +54666,11 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
54351
54666
|
* @param {string} id
|
|
54352
54667
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
54353
54668
|
* @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\').
|
|
54354
|
-
* @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.
|
|
54669
|
+
* @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.
|
|
54355
54670
|
* @param {*} [options] Override http request option.
|
|
54356
54671
|
* @throws {RequiredError}
|
|
54357
54672
|
*/
|
|
54358
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54673
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54359
54674
|
};
|
|
54360
54675
|
/**
|
|
54361
54676
|
* OrganizationEntityAPIsApi - functional programming interface
|
|
@@ -54405,12 +54720,12 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: Configuration
|
|
|
54405
54720
|
* @summary Get Organizations
|
|
54406
54721
|
* @param {string} id
|
|
54407
54722
|
* @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\').
|
|
54408
|
-
* @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.
|
|
54723
|
+
* @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.
|
|
54409
54724
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
54410
54725
|
* @param {*} [options] Override http request option.
|
|
54411
54726
|
* @throws {RequiredError}
|
|
54412
54727
|
*/
|
|
54413
|
-
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>>;
|
|
54728
|
+
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>>;
|
|
54414
54729
|
/**
|
|
54415
54730
|
* Gets a basic information about organization.
|
|
54416
54731
|
* @summary Get current organization info
|
|
@@ -54435,11 +54750,11 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: Configuration
|
|
|
54435
54750
|
* @param {string} id
|
|
54436
54751
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
54437
54752
|
* @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\').
|
|
54438
|
-
* @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.
|
|
54753
|
+
* @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.
|
|
54439
54754
|
* @param {*} [options] Override http request option.
|
|
54440
54755
|
* @throws {RequiredError}
|
|
54441
54756
|
*/
|
|
54442
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
54757
|
+
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>>;
|
|
54443
54758
|
/**
|
|
54444
54759
|
*
|
|
54445
54760
|
* @summary Put Organization entity
|
|
@@ -54456,11 +54771,11 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: Configuration
|
|
|
54456
54771
|
* @param {string} id
|
|
54457
54772
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
54458
54773
|
* @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\').
|
|
54459
|
-
* @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.
|
|
54774
|
+
* @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.
|
|
54460
54775
|
* @param {*} [options] Override http request option.
|
|
54461
54776
|
* @throws {RequiredError}
|
|
54462
54777
|
*/
|
|
54463
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
54778
|
+
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>>;
|
|
54464
54779
|
};
|
|
54465
54780
|
/**
|
|
54466
54781
|
* OrganizationEntityAPIsApi - factory interface
|
|
@@ -54753,10 +55068,10 @@ export interface OrganizationEntityAPIsApiGetEntityOrganizationsRequest {
|
|
|
54753
55068
|
readonly filter?: string;
|
|
54754
55069
|
/**
|
|
54755
55070
|
* 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.
|
|
54756
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
55071
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
54757
55072
|
* @memberof OrganizationEntityAPIsApiGetEntityOrganizations
|
|
54758
55073
|
*/
|
|
54759
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
55074
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
54760
55075
|
/**
|
|
54761
55076
|
* Include Meta objects.
|
|
54762
55077
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -54828,10 +55143,10 @@ export interface OrganizationEntityAPIsApiPatchEntityOrganizationsRequest {
|
|
|
54828
55143
|
readonly filter?: string;
|
|
54829
55144
|
/**
|
|
54830
55145
|
* 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.
|
|
54831
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
55146
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
54832
55147
|
* @memberof OrganizationEntityAPIsApiPatchEntityOrganizations
|
|
54833
55148
|
*/
|
|
54834
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
55149
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
54835
55150
|
}
|
|
54836
55151
|
/**
|
|
54837
55152
|
* Request parameters for updateEntityOrganizationSettings operation in OrganizationEntityAPIsApi.
|
|
@@ -54884,10 +55199,10 @@ export interface OrganizationEntityAPIsApiUpdateEntityOrganizationsRequest {
|
|
|
54884
55199
|
readonly filter?: string;
|
|
54885
55200
|
/**
|
|
54886
55201
|
* 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.
|
|
54887
|
-
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
55202
|
+
* @type {Array<'users' | 'userGroups' | 'identityProviders' | 'bootstrapUser' | 'bootstrapUserGroup' | 'identityProvider' | 'ALL'>}
|
|
54888
55203
|
* @memberof OrganizationEntityAPIsApiUpdateEntityOrganizations
|
|
54889
55204
|
*/
|
|
54890
|
-
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
55205
|
+
readonly include?: Array<"users" | "userGroups" | "identityProviders" | "bootstrapUser" | "bootstrapUserGroup" | "identityProvider" | "ALL">;
|
|
54891
55206
|
}
|
|
54892
55207
|
/**
|
|
54893
55208
|
* OrganizationEntityAPIsApi - object-oriented interface
|
|
@@ -67741,7 +68056,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
67741
68056
|
* @param {string} workspaceId
|
|
67742
68057
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
67743
68058
|
* @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\').
|
|
67744
|
-
* @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.
|
|
68059
|
+
* @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.
|
|
67745
68060
|
* @param {number} [page] Zero-based page index (0..N)
|
|
67746
68061
|
* @param {number} [size] The size of the page to be returned
|
|
67747
68062
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -67750,7 +68065,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
67750
68065
|
* @param {*} [options] Override http request option.
|
|
67751
68066
|
* @throws {RequiredError}
|
|
67752
68067
|
*/
|
|
67753
|
-
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<RequestArgs>;
|
|
68068
|
+
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<RequestArgs>;
|
|
67754
68069
|
/**
|
|
67755
68070
|
*
|
|
67756
68071
|
* @summary Get all Context Filters
|
|
@@ -68003,13 +68318,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68003
68318
|
* @param {string} workspaceId
|
|
68004
68319
|
* @param {string} objectId
|
|
68005
68320
|
* @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\').
|
|
68006
|
-
* @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.
|
|
68321
|
+
* @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.
|
|
68007
68322
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
68008
68323
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
68009
68324
|
* @param {*} [options] Override http request option.
|
|
68010
68325
|
* @throws {RequiredError}
|
|
68011
68326
|
*/
|
|
68012
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68327
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68013
68328
|
/**
|
|
68014
68329
|
*
|
|
68015
68330
|
* @summary Get a Context Filter
|
|
@@ -68887,7 +69202,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
68887
69202
|
* @param {string} workspaceId
|
|
68888
69203
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
68889
69204
|
* @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\').
|
|
68890
|
-
* @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.
|
|
69205
|
+
* @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.
|
|
68891
69206
|
* @param {number} [page] Zero-based page index (0..N)
|
|
68892
69207
|
* @param {number} [size] The size of the page to be returned
|
|
68893
69208
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -68896,7 +69211,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
68896
69211
|
* @param {*} [options] Override http request option.
|
|
68897
69212
|
* @throws {RequiredError}
|
|
68898
69213
|
*/
|
|
68899
|
-
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>>;
|
|
69214
|
+
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>>;
|
|
68900
69215
|
/**
|
|
68901
69216
|
*
|
|
68902
69217
|
* @summary Get all Context Filters
|
|
@@ -69149,13 +69464,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69149
69464
|
* @param {string} workspaceId
|
|
69150
69465
|
* @param {string} objectId
|
|
69151
69466
|
* @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\').
|
|
69152
|
-
* @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.
|
|
69467
|
+
* @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.
|
|
69153
69468
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
69154
69469
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
69155
69470
|
* @param {*} [options] Override http request option.
|
|
69156
69471
|
* @throws {RequiredError}
|
|
69157
69472
|
*/
|
|
69158
|
-
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>>;
|
|
69473
|
+
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>>;
|
|
69159
69474
|
/**
|
|
69160
69475
|
*
|
|
69161
69476
|
* @summary Get a Context Filter
|
|
@@ -72455,10 +72770,10 @@ export interface WorkspaceObjectControllerApiGetAllEntitiesFactsRequest {
|
|
|
72455
72770
|
readonly filter?: string;
|
|
72456
72771
|
/**
|
|
72457
72772
|
* 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.
|
|
72458
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
72773
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
72459
72774
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesFacts
|
|
72460
72775
|
*/
|
|
72461
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
72776
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
72462
72777
|
/**
|
|
72463
72778
|
* Zero-based page index (0..N)
|
|
72464
72779
|
* @type {number}
|
|
@@ -73397,10 +73712,10 @@ export interface WorkspaceObjectControllerApiGetEntityFactsRequest {
|
|
|
73397
73712
|
readonly filter?: string;
|
|
73398
73713
|
/**
|
|
73399
73714
|
* 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.
|
|
73400
|
-
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
73715
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
73401
73716
|
* @memberof WorkspaceObjectControllerApiGetEntityFacts
|
|
73402
73717
|
*/
|
|
73403
|
-
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
73718
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
73404
73719
|
/**
|
|
73405
73720
|
*
|
|
73406
73721
|
* @type {boolean}
|