@gooddata/api-client-tiger 10.32.0-alpha.39 → 10.32.0-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +1133 -1481
- package/esm/generated/afm-rest-api/api.d.ts +2 -2
- package/esm/generated/afm-rest-api/openapi-spec.json +2 -2
- package/esm/generated/automation-json-api/api.d.ts +0 -6
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +0 -16
- package/esm/generated/export-json-api/openapi-spec.json +0 -6
- package/esm/generated/metadata-json-api/api.d.ts +1087 -1402
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +52 -240
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +8258 -8472
- package/package.json +3 -3
|
@@ -2255,12 +2255,6 @@ 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;
|
|
2264
2258
|
}
|
|
2265
2259
|
/**
|
|
2266
2260
|
* A dataset extension properties.
|
|
@@ -2531,12 +2525,6 @@ export interface DeclarativeFact {
|
|
|
2531
2525
|
* @memberof DeclarativeFact
|
|
2532
2526
|
*/
|
|
2533
2527
|
tags?: Array<string>;
|
|
2534
|
-
/**
|
|
2535
|
-
*
|
|
2536
|
-
* @type {DeclarativeSourceFactReference}
|
|
2537
|
-
* @memberof DeclarativeFact
|
|
2538
|
-
*/
|
|
2539
|
-
sourceFactReference?: DeclarativeSourceFactReference;
|
|
2540
2528
|
}
|
|
2541
2529
|
export declare const DeclarativeFactSourceColumnDataTypeEnum: {
|
|
2542
2530
|
readonly INT: "INT";
|
|
@@ -2653,11 +2641,11 @@ export interface DeclarativeIdentityProvider {
|
|
|
2653
2641
|
*/
|
|
2654
2642
|
id: string;
|
|
2655
2643
|
/**
|
|
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.
|
|
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. In multiple provider setup, this field is mandatory.
|
|
2657
2645
|
* @type {Array<string>}
|
|
2658
2646
|
* @memberof DeclarativeIdentityProvider
|
|
2659
2647
|
*/
|
|
2660
|
-
identifiers
|
|
2648
|
+
identifiers: Array<string>;
|
|
2661
2649
|
/**
|
|
2662
2650
|
* 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.
|
|
2663
2651
|
* @type {{ [key: string]: string; }}
|
|
@@ -2702,12 +2690,6 @@ export interface DeclarativeIdentityProvider {
|
|
|
2702
2690
|
* @memberof DeclarativeIdentityProvider
|
|
2703
2691
|
*/
|
|
2704
2692
|
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;
|
|
2711
2693
|
/**
|
|
2712
2694
|
* 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.
|
|
2713
2695
|
* @type {{ [key: string]: string; }}
|
|
@@ -2723,35 +2705,6 @@ export interface DeclarativeIdentityProvider {
|
|
|
2723
2705
|
*/
|
|
2724
2706
|
oauthCustomScopes?: Array<string> | null;
|
|
2725
2707
|
}
|
|
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];
|
|
2755
2708
|
/**
|
|
2756
2709
|
* A declarative form of the JWK.
|
|
2757
2710
|
* @export
|
|
@@ -3255,12 +3208,6 @@ export interface DeclarativeOrganizationInfo {
|
|
|
3255
3208
|
* @memberof DeclarativeOrganizationInfo
|
|
3256
3209
|
*/
|
|
3257
3210
|
cspDirectives?: Array<DeclarativeCspDirective>;
|
|
3258
|
-
/**
|
|
3259
|
-
*
|
|
3260
|
-
* @type {DeclarativeIdentityProviderIdentifier}
|
|
3261
|
-
* @memberof DeclarativeOrganizationInfo
|
|
3262
|
-
*/
|
|
3263
|
-
identityProvider?: DeclarativeIdentityProviderIdentifier;
|
|
3264
3211
|
}
|
|
3265
3212
|
/**
|
|
3266
3213
|
* Definition of an organization permission assigned to a user/user-group.
|
|
@@ -3523,31 +3470,6 @@ export declare const DeclarativeSingleWorkspacePermissionNameEnum: {
|
|
|
3523
3470
|
readonly VIEW: "VIEW";
|
|
3524
3471
|
};
|
|
3525
3472
|
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];
|
|
3551
3473
|
/**
|
|
3552
3474
|
* A database table.
|
|
3553
3475
|
* @export
|
|
@@ -4583,29 +4505,6 @@ export interface ExecutionSettings {
|
|
|
4583
4505
|
* @export
|
|
4584
4506
|
*/
|
|
4585
4507
|
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];
|
|
4609
4508
|
/**
|
|
4610
4509
|
* @type FilterDefinition
|
|
4611
4510
|
* Abstract filter definition type
|
|
@@ -6568,10 +6467,10 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
6568
6467
|
details?: any;
|
|
6569
6468
|
/**
|
|
6570
6469
|
*
|
|
6571
|
-
* @type {
|
|
6470
|
+
* @type {JsonApiAutomationPatchAttributesMetadata}
|
|
6572
6471
|
* @memberof JsonApiAutomationOutAttributes
|
|
6573
6472
|
*/
|
|
6574
|
-
metadata?:
|
|
6473
|
+
metadata?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
6575
6474
|
/**
|
|
6576
6475
|
* Current state of the automation.
|
|
6577
6476
|
* @type {string}
|
|
@@ -6580,52 +6479,52 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
6580
6479
|
state?: JsonApiAutomationOutAttributesStateEnum;
|
|
6581
6480
|
/**
|
|
6582
6481
|
*
|
|
6583
|
-
* @type {
|
|
6482
|
+
* @type {JsonApiAutomationPatchAttributesSchedule}
|
|
6584
6483
|
* @memberof JsonApiAutomationOutAttributes
|
|
6585
6484
|
*/
|
|
6586
|
-
schedule?:
|
|
6485
|
+
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
6587
6486
|
/**
|
|
6588
6487
|
*
|
|
6589
|
-
* @type {
|
|
6488
|
+
* @type {JsonApiAutomationPatchAttributesAlert}
|
|
6590
6489
|
* @memberof JsonApiAutomationOutAttributes
|
|
6591
6490
|
*/
|
|
6592
|
-
alert?:
|
|
6491
|
+
alert?: JsonApiAutomationPatchAttributesAlert;
|
|
6593
6492
|
/**
|
|
6594
6493
|
*
|
|
6595
|
-
* @type {Array<
|
|
6494
|
+
* @type {Array<JsonApiAutomationPatchAttributesTabularExports>}
|
|
6596
6495
|
* @memberof JsonApiAutomationOutAttributes
|
|
6597
6496
|
*/
|
|
6598
|
-
tabularExports?: Array<
|
|
6497
|
+
tabularExports?: Array<JsonApiAutomationPatchAttributesTabularExports>;
|
|
6599
6498
|
/**
|
|
6600
6499
|
*
|
|
6601
|
-
* @type {Array<
|
|
6500
|
+
* @type {Array<JsonApiAutomationPatchAttributesVisualExports>}
|
|
6602
6501
|
* @memberof JsonApiAutomationOutAttributes
|
|
6603
6502
|
*/
|
|
6604
|
-
visualExports?: Array<
|
|
6503
|
+
visualExports?: Array<JsonApiAutomationPatchAttributesVisualExports>;
|
|
6605
6504
|
/**
|
|
6606
6505
|
*
|
|
6607
|
-
* @type {Array<
|
|
6506
|
+
* @type {Array<JsonApiAutomationPatchAttributesImageExports>}
|
|
6608
6507
|
* @memberof JsonApiAutomationOutAttributes
|
|
6609
6508
|
*/
|
|
6610
|
-
imageExports?: Array<
|
|
6509
|
+
imageExports?: Array<JsonApiAutomationPatchAttributesImageExports>;
|
|
6611
6510
|
/**
|
|
6612
6511
|
*
|
|
6613
|
-
* @type {Array<
|
|
6512
|
+
* @type {Array<JsonApiAutomationPatchAttributesRawExports>}
|
|
6614
6513
|
* @memberof JsonApiAutomationOutAttributes
|
|
6615
6514
|
*/
|
|
6616
|
-
rawExports?: Array<
|
|
6515
|
+
rawExports?: Array<JsonApiAutomationPatchAttributesRawExports>;
|
|
6617
6516
|
/**
|
|
6618
6517
|
*
|
|
6619
|
-
* @type {Array<
|
|
6518
|
+
* @type {Array<JsonApiAutomationPatchAttributesSlidesExports>}
|
|
6620
6519
|
* @memberof JsonApiAutomationOutAttributes
|
|
6621
6520
|
*/
|
|
6622
|
-
slidesExports?: Array<
|
|
6521
|
+
slidesExports?: Array<JsonApiAutomationPatchAttributesSlidesExports>;
|
|
6623
6522
|
/**
|
|
6624
6523
|
* External recipients of the automation action results.
|
|
6625
|
-
* @type {Array<
|
|
6524
|
+
* @type {Array<JsonApiAutomationPatchAttributesExternalRecipients>}
|
|
6626
6525
|
* @memberof JsonApiAutomationOutAttributes
|
|
6627
6526
|
*/
|
|
6628
|
-
externalRecipients?: Array<
|
|
6527
|
+
externalRecipients?: Array<JsonApiAutomationPatchAttributesExternalRecipients>;
|
|
6629
6528
|
/**
|
|
6630
6529
|
*
|
|
6631
6530
|
* @type {string}
|
|
@@ -6644,164 +6543,6 @@ export declare const JsonApiAutomationOutAttributesStateEnum: {
|
|
|
6644
6543
|
readonly PAUSED: "PAUSED";
|
|
6645
6544
|
};
|
|
6646
6545
|
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
|
-
}
|
|
6805
6546
|
/**
|
|
6806
6547
|
*
|
|
6807
6548
|
* @export
|
|
@@ -6871,16 +6612,16 @@ export interface JsonApiAutomationOutList {
|
|
|
6871
6612
|
export interface JsonApiAutomationOutRelationships {
|
|
6872
6613
|
/**
|
|
6873
6614
|
*
|
|
6874
|
-
* @type {
|
|
6615
|
+
* @type {JsonApiAutomationPatchRelationshipsNotificationChannel}
|
|
6875
6616
|
* @memberof JsonApiAutomationOutRelationships
|
|
6876
6617
|
*/
|
|
6877
|
-
notificationChannel?:
|
|
6618
|
+
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
6878
6619
|
/**
|
|
6879
6620
|
*
|
|
6880
|
-
* @type {
|
|
6621
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
6881
6622
|
* @memberof JsonApiAutomationOutRelationships
|
|
6882
6623
|
*/
|
|
6883
|
-
analyticalDashboard?:
|
|
6624
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
6884
6625
|
/**
|
|
6885
6626
|
*
|
|
6886
6627
|
* @type {JsonApiVisualizationObjectOutRelationshipsCreatedBy}
|
|
@@ -6895,55 +6636,16 @@ export interface JsonApiAutomationOutRelationships {
|
|
|
6895
6636
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
6896
6637
|
/**
|
|
6897
6638
|
*
|
|
6898
|
-
* @type {
|
|
6639
|
+
* @type {JsonApiAutomationPatchRelationshipsExportDefinitions}
|
|
6899
6640
|
* @memberof JsonApiAutomationOutRelationships
|
|
6900
6641
|
*/
|
|
6901
|
-
exportDefinitions?:
|
|
6642
|
+
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
6902
6643
|
/**
|
|
6903
6644
|
*
|
|
6904
|
-
* @type {
|
|
6645
|
+
* @type {JsonApiAutomationPatchRelationshipsRecipients}
|
|
6905
6646
|
* @memberof JsonApiAutomationOutRelationships
|
|
6906
6647
|
*/
|
|
6907
|
-
recipients?:
|
|
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>;
|
|
6648
|
+
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
6947
6649
|
}
|
|
6948
6650
|
/**
|
|
6949
6651
|
*
|
|
@@ -7065,10 +6767,10 @@ export interface JsonApiAutomationPatchAttributes {
|
|
|
7065
6767
|
details?: any;
|
|
7066
6768
|
/**
|
|
7067
6769
|
*
|
|
7068
|
-
* @type {
|
|
6770
|
+
* @type {JsonApiAutomationPatchAttributesMetadata}
|
|
7069
6771
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7070
6772
|
*/
|
|
7071
|
-
metadata?:
|
|
6773
|
+
metadata?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
7072
6774
|
/**
|
|
7073
6775
|
* Current state of the automation.
|
|
7074
6776
|
* @type {string}
|
|
@@ -7077,58 +6779,216 @@ export interface JsonApiAutomationPatchAttributes {
|
|
|
7077
6779
|
state?: JsonApiAutomationPatchAttributesStateEnum;
|
|
7078
6780
|
/**
|
|
7079
6781
|
*
|
|
7080
|
-
* @type {
|
|
6782
|
+
* @type {JsonApiAutomationPatchAttributesSchedule}
|
|
7081
6783
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7082
6784
|
*/
|
|
7083
|
-
schedule?:
|
|
6785
|
+
schedule?: JsonApiAutomationPatchAttributesSchedule;
|
|
7084
6786
|
/**
|
|
7085
6787
|
*
|
|
7086
|
-
* @type {
|
|
6788
|
+
* @type {JsonApiAutomationPatchAttributesAlert}
|
|
7087
6789
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7088
6790
|
*/
|
|
7089
|
-
alert?:
|
|
6791
|
+
alert?: JsonApiAutomationPatchAttributesAlert;
|
|
7090
6792
|
/**
|
|
7091
6793
|
*
|
|
7092
|
-
* @type {Array<
|
|
6794
|
+
* @type {Array<JsonApiAutomationPatchAttributesTabularExports>}
|
|
7093
6795
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7094
6796
|
*/
|
|
7095
|
-
tabularExports?: Array<
|
|
6797
|
+
tabularExports?: Array<JsonApiAutomationPatchAttributesTabularExports>;
|
|
7096
6798
|
/**
|
|
7097
6799
|
*
|
|
7098
|
-
* @type {Array<
|
|
6800
|
+
* @type {Array<JsonApiAutomationPatchAttributesVisualExports>}
|
|
7099
6801
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7100
6802
|
*/
|
|
7101
|
-
visualExports?: Array<
|
|
6803
|
+
visualExports?: Array<JsonApiAutomationPatchAttributesVisualExports>;
|
|
7102
6804
|
/**
|
|
7103
6805
|
*
|
|
7104
|
-
* @type {Array<
|
|
6806
|
+
* @type {Array<JsonApiAutomationPatchAttributesImageExports>}
|
|
7105
6807
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7106
6808
|
*/
|
|
7107
|
-
imageExports?: Array<
|
|
6809
|
+
imageExports?: Array<JsonApiAutomationPatchAttributesImageExports>;
|
|
7108
6810
|
/**
|
|
7109
6811
|
*
|
|
7110
|
-
* @type {Array<
|
|
6812
|
+
* @type {Array<JsonApiAutomationPatchAttributesRawExports>}
|
|
7111
6813
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7112
6814
|
*/
|
|
7113
|
-
rawExports?: Array<
|
|
6815
|
+
rawExports?: Array<JsonApiAutomationPatchAttributesRawExports>;
|
|
7114
6816
|
/**
|
|
7115
6817
|
*
|
|
7116
|
-
* @type {Array<
|
|
6818
|
+
* @type {Array<JsonApiAutomationPatchAttributesSlidesExports>}
|
|
7117
6819
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7118
6820
|
*/
|
|
7119
|
-
slidesExports?: Array<
|
|
6821
|
+
slidesExports?: Array<JsonApiAutomationPatchAttributesSlidesExports>;
|
|
7120
6822
|
/**
|
|
7121
6823
|
* External recipients of the automation action results.
|
|
7122
|
-
* @type {Array<
|
|
6824
|
+
* @type {Array<JsonApiAutomationPatchAttributesExternalRecipients>}
|
|
7123
6825
|
* @memberof JsonApiAutomationPatchAttributes
|
|
7124
6826
|
*/
|
|
7125
|
-
externalRecipients?: Array<
|
|
6827
|
+
externalRecipients?: Array<JsonApiAutomationPatchAttributesExternalRecipients>;
|
|
7126
6828
|
}
|
|
7127
6829
|
export declare const JsonApiAutomationPatchAttributesStateEnum: {
|
|
7128
6830
|
readonly ACTIVE: "ACTIVE";
|
|
7129
6831
|
readonly PAUSED: "PAUSED";
|
|
7130
6832
|
};
|
|
7131
6833
|
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
|
+
}
|
|
7132
6992
|
/**
|
|
7133
6993
|
*
|
|
7134
6994
|
* @export
|
|
@@ -7150,28 +7010,80 @@ export interface JsonApiAutomationPatchDocument {
|
|
|
7150
7010
|
export interface JsonApiAutomationPatchRelationships {
|
|
7151
7011
|
/**
|
|
7152
7012
|
*
|
|
7153
|
-
* @type {
|
|
7013
|
+
* @type {JsonApiAutomationPatchRelationshipsNotificationChannel}
|
|
7154
7014
|
* @memberof JsonApiAutomationPatchRelationships
|
|
7155
7015
|
*/
|
|
7156
|
-
notificationChannel?:
|
|
7016
|
+
notificationChannel?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
7157
7017
|
/**
|
|
7158
7018
|
*
|
|
7159
|
-
* @type {
|
|
7019
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
7160
7020
|
* @memberof JsonApiAutomationPatchRelationships
|
|
7161
7021
|
*/
|
|
7162
|
-
analyticalDashboard?:
|
|
7022
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
7163
7023
|
/**
|
|
7164
7024
|
*
|
|
7165
|
-
* @type {
|
|
7025
|
+
* @type {JsonApiAutomationPatchRelationshipsExportDefinitions}
|
|
7166
7026
|
* @memberof JsonApiAutomationPatchRelationships
|
|
7167
7027
|
*/
|
|
7168
|
-
exportDefinitions?:
|
|
7028
|
+
exportDefinitions?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
7169
7029
|
/**
|
|
7170
7030
|
*
|
|
7171
|
-
* @type {
|
|
7031
|
+
* @type {JsonApiAutomationPatchRelationshipsRecipients}
|
|
7172
7032
|
* @memberof JsonApiAutomationPatchRelationships
|
|
7173
7033
|
*/
|
|
7174
|
-
recipients?:
|
|
7034
|
+
recipients?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
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>;
|
|
7175
7087
|
}
|
|
7176
7088
|
/**
|
|
7177
7089
|
* @type JsonApiAutomationToOneLinkage
|
|
@@ -7199,15 +7111,34 @@ export interface JsonApiColorPaletteIn {
|
|
|
7199
7111
|
id: string;
|
|
7200
7112
|
/**
|
|
7201
7113
|
*
|
|
7202
|
-
* @type {
|
|
7114
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
7203
7115
|
* @memberof JsonApiColorPaletteIn
|
|
7204
7116
|
*/
|
|
7205
|
-
attributes:
|
|
7117
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
7206
7118
|
}
|
|
7207
7119
|
export declare const JsonApiColorPaletteInTypeEnum: {
|
|
7208
7120
|
readonly COLOR_PALETTE: "colorPalette";
|
|
7209
7121
|
};
|
|
7210
7122
|
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
|
+
}
|
|
7211
7142
|
/**
|
|
7212
7143
|
*
|
|
7213
7144
|
* @export
|
|
@@ -7241,34 +7172,15 @@ export interface JsonApiColorPaletteOut {
|
|
|
7241
7172
|
id: string;
|
|
7242
7173
|
/**
|
|
7243
7174
|
*
|
|
7244
|
-
* @type {
|
|
7175
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
7245
7176
|
* @memberof JsonApiColorPaletteOut
|
|
7246
7177
|
*/
|
|
7247
|
-
attributes:
|
|
7178
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
7248
7179
|
}
|
|
7249
7180
|
export declare const JsonApiColorPaletteOutTypeEnum: {
|
|
7250
7181
|
readonly COLOR_PALETTE: "colorPalette";
|
|
7251
7182
|
};
|
|
7252
7183
|
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
|
-
}
|
|
7272
7184
|
/**
|
|
7273
7185
|
*
|
|
7274
7186
|
* @export
|
|
@@ -7333,10 +7245,10 @@ export interface JsonApiColorPaletteOutWithLinks {
|
|
|
7333
7245
|
id: string;
|
|
7334
7246
|
/**
|
|
7335
7247
|
*
|
|
7336
|
-
* @type {
|
|
7248
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
7337
7249
|
* @memberof JsonApiColorPaletteOutWithLinks
|
|
7338
7250
|
*/
|
|
7339
|
-
attributes:
|
|
7251
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
7340
7252
|
/**
|
|
7341
7253
|
*
|
|
7342
7254
|
* @type {ObjectLinks}
|
|
@@ -7429,10 +7341,10 @@ export interface JsonApiCookieSecurityConfigurationIn {
|
|
|
7429
7341
|
id: string;
|
|
7430
7342
|
/**
|
|
7431
7343
|
*
|
|
7432
|
-
* @type {
|
|
7344
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
7433
7345
|
* @memberof JsonApiCookieSecurityConfigurationIn
|
|
7434
7346
|
*/
|
|
7435
|
-
attributes?:
|
|
7347
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
7436
7348
|
}
|
|
7437
7349
|
export declare const JsonApiCookieSecurityConfigurationInTypeEnum: {
|
|
7438
7350
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
@@ -7471,15 +7383,34 @@ export interface JsonApiCookieSecurityConfigurationOut {
|
|
|
7471
7383
|
id: string;
|
|
7472
7384
|
/**
|
|
7473
7385
|
*
|
|
7474
|
-
* @type {
|
|
7386
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
7475
7387
|
* @memberof JsonApiCookieSecurityConfigurationOut
|
|
7476
7388
|
*/
|
|
7477
|
-
attributes?:
|
|
7389
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
7478
7390
|
}
|
|
7479
7391
|
export declare const JsonApiCookieSecurityConfigurationOutTypeEnum: {
|
|
7480
7392
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
7481
7393
|
};
|
|
7482
7394
|
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
|
+
}
|
|
7483
7414
|
/**
|
|
7484
7415
|
*
|
|
7485
7416
|
* @export
|
|
@@ -7519,34 +7450,15 @@ export interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
7519
7450
|
id: string;
|
|
7520
7451
|
/**
|
|
7521
7452
|
*
|
|
7522
|
-
* @type {
|
|
7453
|
+
* @type {JsonApiCookieSecurityConfigurationOutAttributes}
|
|
7523
7454
|
* @memberof JsonApiCookieSecurityConfigurationPatch
|
|
7524
7455
|
*/
|
|
7525
|
-
attributes?:
|
|
7456
|
+
attributes?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
7526
7457
|
}
|
|
7527
7458
|
export declare const JsonApiCookieSecurityConfigurationPatchTypeEnum: {
|
|
7528
7459
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
7529
7460
|
};
|
|
7530
7461
|
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
|
-
}
|
|
7550
7462
|
/**
|
|
7551
7463
|
*
|
|
7552
7464
|
* @export
|
|
@@ -7580,15 +7492,28 @@ export interface JsonApiCspDirectiveIn {
|
|
|
7580
7492
|
id: string;
|
|
7581
7493
|
/**
|
|
7582
7494
|
*
|
|
7583
|
-
* @type {
|
|
7495
|
+
* @type {JsonApiCspDirectiveInAttributes}
|
|
7584
7496
|
* @memberof JsonApiCspDirectiveIn
|
|
7585
7497
|
*/
|
|
7586
|
-
attributes:
|
|
7498
|
+
attributes: JsonApiCspDirectiveInAttributes;
|
|
7587
7499
|
}
|
|
7588
7500
|
export declare const JsonApiCspDirectiveInTypeEnum: {
|
|
7589
7501
|
readonly CSP_DIRECTIVE: "cspDirective";
|
|
7590
7502
|
};
|
|
7591
7503
|
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
|
+
}
|
|
7592
7517
|
/**
|
|
7593
7518
|
*
|
|
7594
7519
|
* @export
|
|
@@ -7622,28 +7547,15 @@ export interface JsonApiCspDirectiveOut {
|
|
|
7622
7547
|
id: string;
|
|
7623
7548
|
/**
|
|
7624
7549
|
*
|
|
7625
|
-
* @type {
|
|
7550
|
+
* @type {JsonApiCspDirectiveInAttributes}
|
|
7626
7551
|
* @memberof JsonApiCspDirectiveOut
|
|
7627
7552
|
*/
|
|
7628
|
-
attributes:
|
|
7553
|
+
attributes: JsonApiCspDirectiveInAttributes;
|
|
7629
7554
|
}
|
|
7630
7555
|
export declare const JsonApiCspDirectiveOutTypeEnum: {
|
|
7631
7556
|
readonly CSP_DIRECTIVE: "cspDirective";
|
|
7632
7557
|
};
|
|
7633
7558
|
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
|
-
}
|
|
7647
7559
|
/**
|
|
7648
7560
|
*
|
|
7649
7561
|
* @export
|
|
@@ -7708,10 +7620,10 @@ export interface JsonApiCspDirectiveOutWithLinks {
|
|
|
7708
7620
|
id: string;
|
|
7709
7621
|
/**
|
|
7710
7622
|
*
|
|
7711
|
-
* @type {
|
|
7623
|
+
* @type {JsonApiCspDirectiveInAttributes}
|
|
7712
7624
|
* @memberof JsonApiCspDirectiveOutWithLinks
|
|
7713
7625
|
*/
|
|
7714
|
-
attributes:
|
|
7626
|
+
attributes: JsonApiCspDirectiveInAttributes;
|
|
7715
7627
|
/**
|
|
7716
7628
|
*
|
|
7717
7629
|
* @type {ObjectLinks}
|
|
@@ -8480,10 +8392,10 @@ export interface JsonApiDataSourceIdentifierOut {
|
|
|
8480
8392
|
id: string;
|
|
8481
8393
|
/**
|
|
8482
8394
|
*
|
|
8483
|
-
* @type {
|
|
8395
|
+
* @type {JsonApiDataSourceOutMeta}
|
|
8484
8396
|
* @memberof JsonApiDataSourceIdentifierOut
|
|
8485
8397
|
*/
|
|
8486
|
-
meta?:
|
|
8398
|
+
meta?: JsonApiDataSourceOutMeta;
|
|
8487
8399
|
/**
|
|
8488
8400
|
*
|
|
8489
8401
|
* @type {JsonApiDataSourceIdentifierOutAttributes}
|
|
@@ -8592,24 +8504,6 @@ export interface JsonApiDataSourceIdentifierOutList {
|
|
|
8592
8504
|
*/
|
|
8593
8505
|
meta?: JsonApiApiTokenOutListMeta;
|
|
8594
8506
|
}
|
|
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];
|
|
8613
8507
|
/**
|
|
8614
8508
|
*
|
|
8615
8509
|
* @export
|
|
@@ -8630,10 +8524,10 @@ export interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
|
8630
8524
|
id: string;
|
|
8631
8525
|
/**
|
|
8632
8526
|
*
|
|
8633
|
-
* @type {
|
|
8527
|
+
* @type {JsonApiDataSourceOutMeta}
|
|
8634
8528
|
* @memberof JsonApiDataSourceIdentifierOutWithLinks
|
|
8635
8529
|
*/
|
|
8636
|
-
meta?:
|
|
8530
|
+
meta?: JsonApiDataSourceOutMeta;
|
|
8637
8531
|
/**
|
|
8638
8532
|
*
|
|
8639
8533
|
* @type {JsonApiDataSourceIdentifierOutAttributes}
|
|
@@ -8754,10 +8648,10 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
8754
8648
|
clientSecret?: string | null;
|
|
8755
8649
|
/**
|
|
8756
8650
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
8757
|
-
* @type {Array<
|
|
8651
|
+
* @type {Array<JsonApiDataSourceInAttributesParameters>}
|
|
8758
8652
|
* @memberof JsonApiDataSourceInAttributes
|
|
8759
8653
|
*/
|
|
8760
|
-
parameters?: Array<
|
|
8654
|
+
parameters?: Array<JsonApiDataSourceInAttributesParameters> | null;
|
|
8761
8655
|
/**
|
|
8762
8656
|
* Determines how the results coming from a particular datasource should be cached.
|
|
8763
8657
|
* @type {string}
|
|
@@ -8798,6 +8692,25 @@ export declare const JsonApiDataSourceInAttributesCacheStrategyEnum: {
|
|
|
8798
8692
|
readonly NEVER: "NEVER";
|
|
8799
8693
|
};
|
|
8800
8694
|
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
|
+
}
|
|
8801
8714
|
/**
|
|
8802
8715
|
*
|
|
8803
8716
|
* @export
|
|
@@ -8831,10 +8744,10 @@ export interface JsonApiDataSourceOut {
|
|
|
8831
8744
|
id: string;
|
|
8832
8745
|
/**
|
|
8833
8746
|
*
|
|
8834
|
-
* @type {
|
|
8747
|
+
* @type {JsonApiDataSourceOutMeta}
|
|
8835
8748
|
* @memberof JsonApiDataSourceOut
|
|
8836
8749
|
*/
|
|
8837
|
-
meta?:
|
|
8750
|
+
meta?: JsonApiDataSourceOutMeta;
|
|
8838
8751
|
/**
|
|
8839
8752
|
*
|
|
8840
8753
|
* @type {JsonApiDataSourceOutAttributes}
|
|
@@ -8890,16 +8803,16 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
8890
8803
|
clientId?: string | null;
|
|
8891
8804
|
/**
|
|
8892
8805
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
8893
|
-
* @type {Array<
|
|
8806
|
+
* @type {Array<JsonApiDataSourceInAttributesParameters>}
|
|
8894
8807
|
* @memberof JsonApiDataSourceOutAttributes
|
|
8895
8808
|
*/
|
|
8896
|
-
parameters?: Array<
|
|
8809
|
+
parameters?: Array<JsonApiDataSourceInAttributesParameters> | null;
|
|
8897
8810
|
/**
|
|
8898
8811
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
8899
|
-
* @type {Array<
|
|
8812
|
+
* @type {Array<JsonApiDataSourceInAttributesParameters>}
|
|
8900
8813
|
* @memberof JsonApiDataSourceOutAttributes
|
|
8901
8814
|
*/
|
|
8902
|
-
decodedParameters?: Array<
|
|
8815
|
+
decodedParameters?: Array<JsonApiDataSourceInAttributesParameters> | null;
|
|
8903
8816
|
/**
|
|
8904
8817
|
* Determines how the results coming from a particular datasource should be cached.
|
|
8905
8818
|
* @type {string}
|
|
@@ -8954,25 +8867,6 @@ export declare const JsonApiDataSourceOutAttributesAuthenticationTypeEnum: {
|
|
|
8954
8867
|
readonly ACCESS_TOKEN: "ACCESS_TOKEN";
|
|
8955
8868
|
};
|
|
8956
8869
|
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
|
-
}
|
|
8976
8870
|
/**
|
|
8977
8871
|
*
|
|
8978
8872
|
* @export
|
|
@@ -9017,6 +8911,24 @@ export interface JsonApiDataSourceOutList {
|
|
|
9017
8911
|
*/
|
|
9018
8912
|
meta?: JsonApiApiTokenOutListMeta;
|
|
9019
8913
|
}
|
|
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];
|
|
9020
8932
|
/**
|
|
9021
8933
|
*
|
|
9022
8934
|
* @export
|
|
@@ -9037,10 +8949,10 @@ export interface JsonApiDataSourceOutWithLinks {
|
|
|
9037
8949
|
id: string;
|
|
9038
8950
|
/**
|
|
9039
8951
|
*
|
|
9040
|
-
* @type {
|
|
8952
|
+
* @type {JsonApiDataSourceOutMeta}
|
|
9041
8953
|
* @memberof JsonApiDataSourceOutWithLinks
|
|
9042
8954
|
*/
|
|
9043
|
-
meta?:
|
|
8955
|
+
meta?: JsonApiDataSourceOutMeta;
|
|
9044
8956
|
/**
|
|
9045
8957
|
*
|
|
9046
8958
|
* @type {JsonApiDataSourceOutAttributes}
|
|
@@ -9161,10 +9073,10 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
9161
9073
|
clientSecret?: string | null;
|
|
9162
9074
|
/**
|
|
9163
9075
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
9164
|
-
* @type {Array<
|
|
9076
|
+
* @type {Array<JsonApiDataSourceInAttributesParameters>}
|
|
9165
9077
|
* @memberof JsonApiDataSourcePatchAttributes
|
|
9166
9078
|
*/
|
|
9167
|
-
parameters?: Array<
|
|
9079
|
+
parameters?: Array<JsonApiDataSourceInAttributesParameters> | null;
|
|
9168
9080
|
/**
|
|
9169
9081
|
* Determines how the results coming from a particular datasource should be cached.
|
|
9170
9082
|
* @type {string}
|
|
@@ -9342,12 +9254,6 @@ export interface JsonApiDatasetOutAttributes {
|
|
|
9342
9254
|
* @memberof JsonApiDatasetOutAttributes
|
|
9343
9255
|
*/
|
|
9344
9256
|
sql?: JsonApiDatasetOutAttributesSql;
|
|
9345
|
-
/**
|
|
9346
|
-
*
|
|
9347
|
-
* @type {number}
|
|
9348
|
-
* @memberof JsonApiDatasetOutAttributes
|
|
9349
|
-
*/
|
|
9350
|
-
precedence?: number;
|
|
9351
9257
|
/**
|
|
9352
9258
|
*
|
|
9353
9259
|
* @type {boolean}
|
|
@@ -10047,10 +9953,10 @@ export interface JsonApiExportDefinitionOutRelationships {
|
|
|
10047
9953
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
10048
9954
|
/**
|
|
10049
9955
|
*
|
|
10050
|
-
* @type {
|
|
9956
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
10051
9957
|
* @memberof JsonApiExportDefinitionOutRelationships
|
|
10052
9958
|
*/
|
|
10053
|
-
analyticalDashboard?:
|
|
9959
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
10054
9960
|
/**
|
|
10055
9961
|
*
|
|
10056
9962
|
* @type {JsonApiExportDefinitionOutRelationshipsAutomation}
|
|
@@ -10070,19 +9976,6 @@ export interface JsonApiExportDefinitionOutRelationships {
|
|
|
10070
9976
|
*/
|
|
10071
9977
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
10072
9978
|
}
|
|
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
|
-
}
|
|
10086
9979
|
/**
|
|
10087
9980
|
*
|
|
10088
9981
|
* @export
|
|
@@ -10255,10 +10148,10 @@ export interface JsonApiExportDefinitionPatchRelationships {
|
|
|
10255
10148
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
10256
10149
|
/**
|
|
10257
10150
|
*
|
|
10258
|
-
* @type {
|
|
10151
|
+
* @type {JsonApiAutomationPatchRelationshipsAnalyticalDashboard}
|
|
10259
10152
|
* @memberof JsonApiExportDefinitionPatchRelationships
|
|
10260
10153
|
*/
|
|
10261
|
-
analyticalDashboard?:
|
|
10154
|
+
analyticalDashboard?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
10262
10155
|
}
|
|
10263
10156
|
/**
|
|
10264
10157
|
* JSON:API representation of exportDefinition entity.
|
|
@@ -10328,10 +10221,10 @@ export interface JsonApiExportTemplateIn {
|
|
|
10328
10221
|
id: string;
|
|
10329
10222
|
/**
|
|
10330
10223
|
*
|
|
10331
|
-
* @type {
|
|
10224
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributes}
|
|
10332
10225
|
* @memberof JsonApiExportTemplateIn
|
|
10333
10226
|
*/
|
|
10334
|
-
attributes:
|
|
10227
|
+
attributes: JsonApiExportTemplatePostOptionalIdAttributes;
|
|
10335
10228
|
}
|
|
10336
10229
|
export declare const JsonApiExportTemplateInTypeEnum: {
|
|
10337
10230
|
readonly EXPORT_TEMPLATE: "exportTemplate";
|
|
@@ -10370,106 +10263,15 @@ export interface JsonApiExportTemplateOut {
|
|
|
10370
10263
|
id: string;
|
|
10371
10264
|
/**
|
|
10372
10265
|
*
|
|
10373
|
-
* @type {
|
|
10266
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributes}
|
|
10374
10267
|
* @memberof JsonApiExportTemplateOut
|
|
10375
10268
|
*/
|
|
10376
|
-
attributes:
|
|
10269
|
+
attributes: JsonApiExportTemplatePostOptionalIdAttributes;
|
|
10377
10270
|
}
|
|
10378
10271
|
export declare const JsonApiExportTemplateOutTypeEnum: {
|
|
10379
10272
|
readonly EXPORT_TEMPLATE: "exportTemplate";
|
|
10380
10273
|
};
|
|
10381
10274
|
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];
|
|
10473
10275
|
/**
|
|
10474
10276
|
*
|
|
10475
10277
|
* @export
|
|
@@ -10534,10 +10336,10 @@ export interface JsonApiExportTemplateOutWithLinks {
|
|
|
10534
10336
|
id: string;
|
|
10535
10337
|
/**
|
|
10536
10338
|
*
|
|
10537
|
-
* @type {
|
|
10339
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributes}
|
|
10538
10340
|
* @memberof JsonApiExportTemplateOutWithLinks
|
|
10539
10341
|
*/
|
|
10540
|
-
attributes:
|
|
10342
|
+
attributes: JsonApiExportTemplatePostOptionalIdAttributes;
|
|
10541
10343
|
/**
|
|
10542
10344
|
*
|
|
10543
10345
|
* @type {ObjectLinks}
|
|
@@ -10592,16 +10394,16 @@ export interface JsonApiExportTemplatePatchAttributes {
|
|
|
10592
10394
|
name?: string;
|
|
10593
10395
|
/**
|
|
10594
10396
|
*
|
|
10595
|
-
* @type {
|
|
10397
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate}
|
|
10596
10398
|
* @memberof JsonApiExportTemplatePatchAttributes
|
|
10597
10399
|
*/
|
|
10598
|
-
dashboardSlidesTemplate?:
|
|
10400
|
+
dashboardSlidesTemplate?: JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate | null;
|
|
10599
10401
|
/**
|
|
10600
10402
|
*
|
|
10601
|
-
* @type {
|
|
10403
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate}
|
|
10602
10404
|
* @memberof JsonApiExportTemplatePatchAttributes
|
|
10603
10405
|
*/
|
|
10604
|
-
widgetSlidesTemplate?:
|
|
10406
|
+
widgetSlidesTemplate?: JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate | null;
|
|
10605
10407
|
}
|
|
10606
10408
|
/**
|
|
10607
10409
|
*
|
|
@@ -10636,15 +10438,106 @@ export interface JsonApiExportTemplatePostOptionalId {
|
|
|
10636
10438
|
id?: string;
|
|
10637
10439
|
/**
|
|
10638
10440
|
*
|
|
10639
|
-
* @type {
|
|
10441
|
+
* @type {JsonApiExportTemplatePostOptionalIdAttributes}
|
|
10640
10442
|
* @memberof JsonApiExportTemplatePostOptionalId
|
|
10641
10443
|
*/
|
|
10642
|
-
attributes:
|
|
10444
|
+
attributes: JsonApiExportTemplatePostOptionalIdAttributes;
|
|
10643
10445
|
}
|
|
10644
10446
|
export declare const JsonApiExportTemplatePostOptionalIdTypeEnum: {
|
|
10645
10447
|
readonly EXPORT_TEMPLATE: "exportTemplate";
|
|
10646
10448
|
};
|
|
10647
10449
|
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];
|
|
10648
10541
|
/**
|
|
10649
10542
|
*
|
|
10650
10543
|
* @export
|
|
@@ -10764,12 +10657,6 @@ export interface JsonApiFactOutAttributes {
|
|
|
10764
10657
|
* @memberof JsonApiFactOutAttributes
|
|
10765
10658
|
*/
|
|
10766
10659
|
areRelationsValid?: boolean;
|
|
10767
|
-
/**
|
|
10768
|
-
*
|
|
10769
|
-
* @type {string}
|
|
10770
|
-
* @memberof JsonApiFactOutAttributes
|
|
10771
|
-
*/
|
|
10772
|
-
operation?: JsonApiFactOutAttributesOperationEnum;
|
|
10773
10660
|
}
|
|
10774
10661
|
export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
10775
10662
|
readonly INT: "INT";
|
|
@@ -10781,12 +10668,6 @@ export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
|
10781
10668
|
readonly BOOLEAN: "BOOLEAN";
|
|
10782
10669
|
};
|
|
10783
10670
|
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];
|
|
10790
10671
|
/**
|
|
10791
10672
|
*
|
|
10792
10673
|
* @export
|
|
@@ -10807,16 +10688,11 @@ export interface JsonApiFactOutDocument {
|
|
|
10807
10688
|
links?: ObjectLinks;
|
|
10808
10689
|
/**
|
|
10809
10690
|
* Included resources
|
|
10810
|
-
* @type {Array<
|
|
10691
|
+
* @type {Array<JsonApiDatasetOutWithLinks>}
|
|
10811
10692
|
* @memberof JsonApiFactOutDocument
|
|
10812
10693
|
*/
|
|
10813
|
-
included?: Array<
|
|
10694
|
+
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
10814
10695
|
}
|
|
10815
|
-
/**
|
|
10816
|
-
* @type JsonApiFactOutIncludes
|
|
10817
|
-
* @export
|
|
10818
|
-
*/
|
|
10819
|
-
export type JsonApiFactOutIncludes = JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks;
|
|
10820
10696
|
/**
|
|
10821
10697
|
* A JSON:API document with a list of resources
|
|
10822
10698
|
* @export
|
|
@@ -10843,10 +10719,10 @@ export interface JsonApiFactOutList {
|
|
|
10843
10719
|
meta?: JsonApiApiTokenOutListMeta;
|
|
10844
10720
|
/**
|
|
10845
10721
|
* Included resources
|
|
10846
|
-
* @type {Array<
|
|
10722
|
+
* @type {Array<JsonApiDatasetOutWithLinks>}
|
|
10847
10723
|
* @memberof JsonApiFactOutList
|
|
10848
10724
|
*/
|
|
10849
|
-
included?: Array<
|
|
10725
|
+
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
10850
10726
|
}
|
|
10851
10727
|
/**
|
|
10852
10728
|
*
|
|
@@ -10860,25 +10736,6 @@ export interface JsonApiFactOutRelationships {
|
|
|
10860
10736
|
* @memberof JsonApiFactOutRelationships
|
|
10861
10737
|
*/
|
|
10862
10738
|
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;
|
|
10882
10739
|
}
|
|
10883
10740
|
/**
|
|
10884
10741
|
*
|
|
@@ -10927,12 +10784,6 @@ export declare const JsonApiFactOutWithLinksTypeEnum: {
|
|
|
10927
10784
|
readonly FACT: "fact";
|
|
10928
10785
|
};
|
|
10929
10786
|
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;
|
|
10936
10787
|
/**
|
|
10937
10788
|
* JSON:API representation of filterContext entity.
|
|
10938
10789
|
* @export
|
|
@@ -11319,10 +11170,10 @@ export interface JsonApiFilterViewIn {
|
|
|
11319
11170
|
attributes: JsonApiFilterViewOutAttributes;
|
|
11320
11171
|
/**
|
|
11321
11172
|
*
|
|
11322
|
-
* @type {
|
|
11173
|
+
* @type {JsonApiFilterViewPatchRelationships}
|
|
11323
11174
|
* @memberof JsonApiFilterViewIn
|
|
11324
11175
|
*/
|
|
11325
|
-
relationships?:
|
|
11176
|
+
relationships?: JsonApiFilterViewPatchRelationships;
|
|
11326
11177
|
}
|
|
11327
11178
|
export declare const JsonApiFilterViewInTypeEnum: {
|
|
11328
11179
|
readonly FILTER_VIEW: "filterView";
|
|
@@ -11367,10 +11218,10 @@ export interface JsonApiFilterViewOut {
|
|
|
11367
11218
|
attributes: JsonApiFilterViewOutAttributes;
|
|
11368
11219
|
/**
|
|
11369
11220
|
*
|
|
11370
|
-
* @type {
|
|
11221
|
+
* @type {JsonApiFilterViewPatchRelationships}
|
|
11371
11222
|
* @memberof JsonApiFilterViewOut
|
|
11372
11223
|
*/
|
|
11373
|
-
relationships?:
|
|
11224
|
+
relationships?: JsonApiFilterViewPatchRelationships;
|
|
11374
11225
|
}
|
|
11375
11226
|
export declare const JsonApiFilterViewOutTypeEnum: {
|
|
11376
11227
|
readonly FILTER_VIEW: "filterView";
|
|
@@ -11480,25 +11331,6 @@ export interface JsonApiFilterViewOutList {
|
|
|
11480
11331
|
*/
|
|
11481
11332
|
included?: Array<JsonApiFilterViewOutIncludes>;
|
|
11482
11333
|
}
|
|
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
|
-
}
|
|
11502
11334
|
/**
|
|
11503
11335
|
*
|
|
11504
11336
|
* @export
|
|
@@ -11525,10 +11357,10 @@ export interface JsonApiFilterViewOutWithLinks {
|
|
|
11525
11357
|
attributes: JsonApiFilterViewOutAttributes;
|
|
11526
11358
|
/**
|
|
11527
11359
|
*
|
|
11528
|
-
* @type {
|
|
11360
|
+
* @type {JsonApiFilterViewPatchRelationships}
|
|
11529
11361
|
* @memberof JsonApiFilterViewOutWithLinks
|
|
11530
11362
|
*/
|
|
11531
|
-
relationships?:
|
|
11363
|
+
relationships?: JsonApiFilterViewPatchRelationships;
|
|
11532
11364
|
/**
|
|
11533
11365
|
*
|
|
11534
11366
|
* @type {ObjectLinks}
|
|
@@ -11566,10 +11398,10 @@ export interface JsonApiFilterViewPatch {
|
|
|
11566
11398
|
attributes: JsonApiFilterViewPatchAttributes;
|
|
11567
11399
|
/**
|
|
11568
11400
|
*
|
|
11569
|
-
* @type {
|
|
11401
|
+
* @type {JsonApiFilterViewPatchRelationships}
|
|
11570
11402
|
* @memberof JsonApiFilterViewPatch
|
|
11571
11403
|
*/
|
|
11572
|
-
relationships?:
|
|
11404
|
+
relationships?: JsonApiFilterViewPatchRelationships;
|
|
11573
11405
|
}
|
|
11574
11406
|
export declare const JsonApiFilterViewPatchTypeEnum: {
|
|
11575
11407
|
readonly FILTER_VIEW: "filterView";
|
|
@@ -11631,6 +11463,38 @@ export interface JsonApiFilterViewPatchDocument {
|
|
|
11631
11463
|
*/
|
|
11632
11464
|
data: JsonApiFilterViewPatch;
|
|
11633
11465
|
}
|
|
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
|
+
}
|
|
11634
11498
|
/**
|
|
11635
11499
|
* JSON:API representation of identityProvider entity.
|
|
11636
11500
|
* @export
|
|
@@ -11651,10 +11515,10 @@ export interface JsonApiIdentityProviderIn {
|
|
|
11651
11515
|
id: string;
|
|
11652
11516
|
/**
|
|
11653
11517
|
*
|
|
11654
|
-
* @type {
|
|
11518
|
+
* @type {JsonApiIdentityProviderInAttributes}
|
|
11655
11519
|
* @memberof JsonApiIdentityProviderIn
|
|
11656
11520
|
*/
|
|
11657
|
-
attributes
|
|
11521
|
+
attributes: JsonApiIdentityProviderInAttributes;
|
|
11658
11522
|
}
|
|
11659
11523
|
export declare const JsonApiIdentityProviderInTypeEnum: {
|
|
11660
11524
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
@@ -11663,39 +11527,87 @@ export type JsonApiIdentityProviderInTypeEnum = typeof JsonApiIdentityProviderIn
|
|
|
11663
11527
|
/**
|
|
11664
11528
|
*
|
|
11665
11529
|
* @export
|
|
11666
|
-
* @interface
|
|
11530
|
+
* @interface JsonApiIdentityProviderInAttributes
|
|
11667
11531
|
*/
|
|
11668
|
-
export interface
|
|
11532
|
+
export interface JsonApiIdentityProviderInAttributes {
|
|
11669
11533
|
/**
|
|
11670
|
-
*
|
|
11671
|
-
* @type {
|
|
11672
|
-
* @memberof
|
|
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
|
|
11673
11537
|
*/
|
|
11674
|
-
|
|
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
|
+
};
|
|
11591
|
+
/**
|
|
11592
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
11593
|
+
* @type {Array<string>}
|
|
11594
|
+
* @memberof JsonApiIdentityProviderInAttributes
|
|
11595
|
+
*/
|
|
11596
|
+
oauthCustomScopes?: Array<string> | null;
|
|
11675
11597
|
}
|
|
11676
11598
|
/**
|
|
11677
|
-
*
|
|
11599
|
+
*
|
|
11678
11600
|
* @export
|
|
11679
|
-
* @interface
|
|
11601
|
+
* @interface JsonApiIdentityProviderInDocument
|
|
11680
11602
|
*/
|
|
11681
|
-
export interface
|
|
11682
|
-
/**
|
|
11683
|
-
*
|
|
11684
|
-
* @type {string}
|
|
11685
|
-
* @memberof JsonApiIdentityProviderLinkage
|
|
11686
|
-
*/
|
|
11687
|
-
id: string;
|
|
11603
|
+
export interface JsonApiIdentityProviderInDocument {
|
|
11688
11604
|
/**
|
|
11689
11605
|
*
|
|
11690
|
-
* @type {
|
|
11691
|
-
* @memberof
|
|
11606
|
+
* @type {JsonApiIdentityProviderIn}
|
|
11607
|
+
* @memberof JsonApiIdentityProviderInDocument
|
|
11692
11608
|
*/
|
|
11693
|
-
|
|
11609
|
+
data: JsonApiIdentityProviderIn;
|
|
11694
11610
|
}
|
|
11695
|
-
export declare const JsonApiIdentityProviderLinkageTypeEnum: {
|
|
11696
|
-
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
11697
|
-
};
|
|
11698
|
-
export type JsonApiIdentityProviderLinkageTypeEnum = typeof JsonApiIdentityProviderLinkageTypeEnum[keyof typeof JsonApiIdentityProviderLinkageTypeEnum];
|
|
11699
11611
|
/**
|
|
11700
11612
|
* JSON:API representation of identityProvider entity.
|
|
11701
11613
|
* @export
|
|
@@ -11719,7 +11631,7 @@ export interface JsonApiIdentityProviderOut {
|
|
|
11719
11631
|
* @type {JsonApiIdentityProviderOutAttributes}
|
|
11720
11632
|
* @memberof JsonApiIdentityProviderOut
|
|
11721
11633
|
*/
|
|
11722
|
-
attributes
|
|
11634
|
+
attributes: JsonApiIdentityProviderOutAttributes;
|
|
11723
11635
|
}
|
|
11724
11636
|
export declare const JsonApiIdentityProviderOutTypeEnum: {
|
|
11725
11637
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
@@ -11732,11 +11644,11 @@ export type JsonApiIdentityProviderOutTypeEnum = typeof JsonApiIdentityProviderO
|
|
|
11732
11644
|
*/
|
|
11733
11645
|
export interface JsonApiIdentityProviderOutAttributes {
|
|
11734
11646
|
/**
|
|
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.
|
|
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. In multiple provider setup, this field is mandatory.
|
|
11736
11648
|
* @type {Array<string>}
|
|
11737
11649
|
* @memberof JsonApiIdentityProviderOutAttributes
|
|
11738
11650
|
*/
|
|
11739
|
-
identifiers
|
|
11651
|
+
identifiers: Array<string>;
|
|
11740
11652
|
/**
|
|
11741
11653
|
* 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.
|
|
11742
11654
|
* @type {{ [key: string]: string; }}
|
|
@@ -11783,19 +11695,7 @@ export interface JsonApiIdentityProviderOutAttributes {
|
|
|
11783
11695
|
* @memberof JsonApiIdentityProviderOutAttributes
|
|
11784
11696
|
*/
|
|
11785
11697
|
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;
|
|
11792
11698
|
}
|
|
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];
|
|
11799
11699
|
/**
|
|
11800
11700
|
*
|
|
11801
11701
|
* @export
|
|
@@ -11863,7 +11763,7 @@ export interface JsonApiIdentityProviderOutWithLinks {
|
|
|
11863
11763
|
* @type {JsonApiIdentityProviderOutAttributes}
|
|
11864
11764
|
* @memberof JsonApiIdentityProviderOutWithLinks
|
|
11865
11765
|
*/
|
|
11866
|
-
attributes
|
|
11766
|
+
attributes: JsonApiIdentityProviderOutAttributes;
|
|
11867
11767
|
/**
|
|
11868
11768
|
*
|
|
11869
11769
|
* @type {ObjectLinks}
|
|
@@ -11898,7 +11798,7 @@ export interface JsonApiIdentityProviderPatch {
|
|
|
11898
11798
|
* @type {JsonApiIdentityProviderPatchAttributes}
|
|
11899
11799
|
* @memberof JsonApiIdentityProviderPatch
|
|
11900
11800
|
*/
|
|
11901
|
-
attributes
|
|
11801
|
+
attributes: JsonApiIdentityProviderPatchAttributes;
|
|
11902
11802
|
}
|
|
11903
11803
|
export declare const JsonApiIdentityProviderPatchTypeEnum: {
|
|
11904
11804
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
@@ -11911,7 +11811,7 @@ export type JsonApiIdentityProviderPatchTypeEnum = typeof JsonApiIdentityProvide
|
|
|
11911
11811
|
*/
|
|
11912
11812
|
export interface JsonApiIdentityProviderPatchAttributes {
|
|
11913
11813
|
/**
|
|
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.
|
|
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. In multiple provider setup, this field is mandatory.
|
|
11915
11815
|
* @type {Array<string>}
|
|
11916
11816
|
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
11917
11817
|
*/
|
|
@@ -11974,19 +11874,7 @@ export interface JsonApiIdentityProviderPatchAttributes {
|
|
|
11974
11874
|
* @memberof JsonApiIdentityProviderPatchAttributes
|
|
11975
11875
|
*/
|
|
11976
11876
|
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;
|
|
11983
11877
|
}
|
|
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];
|
|
11990
11878
|
/**
|
|
11991
11879
|
*
|
|
11992
11880
|
* @export
|
|
@@ -12000,12 +11888,6 @@ export interface JsonApiIdentityProviderPatchDocument {
|
|
|
12000
11888
|
*/
|
|
12001
11889
|
data: JsonApiIdentityProviderPatch;
|
|
12002
11890
|
}
|
|
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;
|
|
12009
11891
|
/**
|
|
12010
11892
|
* JSON:API representation of jwk entity.
|
|
12011
11893
|
* @export
|
|
@@ -12026,15 +11908,28 @@ export interface JsonApiJwkIn {
|
|
|
12026
11908
|
id: string;
|
|
12027
11909
|
/**
|
|
12028
11910
|
*
|
|
12029
|
-
* @type {
|
|
11911
|
+
* @type {JsonApiJwkInAttributes}
|
|
12030
11912
|
* @memberof JsonApiJwkIn
|
|
12031
11913
|
*/
|
|
12032
|
-
attributes?:
|
|
11914
|
+
attributes?: JsonApiJwkInAttributes;
|
|
12033
11915
|
}
|
|
12034
11916
|
export declare const JsonApiJwkInTypeEnum: {
|
|
12035
11917
|
readonly JWK: "jwk";
|
|
12036
11918
|
};
|
|
12037
11919
|
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
|
+
}
|
|
12038
11933
|
/**
|
|
12039
11934
|
*
|
|
12040
11935
|
* @export
|
|
@@ -12068,28 +11963,15 @@ export interface JsonApiJwkOut {
|
|
|
12068
11963
|
id: string;
|
|
12069
11964
|
/**
|
|
12070
11965
|
*
|
|
12071
|
-
* @type {
|
|
11966
|
+
* @type {JsonApiJwkInAttributes}
|
|
12072
11967
|
* @memberof JsonApiJwkOut
|
|
12073
11968
|
*/
|
|
12074
|
-
attributes?:
|
|
11969
|
+
attributes?: JsonApiJwkInAttributes;
|
|
12075
11970
|
}
|
|
12076
11971
|
export declare const JsonApiJwkOutTypeEnum: {
|
|
12077
11972
|
readonly JWK: "jwk";
|
|
12078
11973
|
};
|
|
12079
11974
|
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
|
-
}
|
|
12093
11975
|
/**
|
|
12094
11976
|
*
|
|
12095
11977
|
* @export
|
|
@@ -12154,10 +12036,10 @@ export interface JsonApiJwkOutWithLinks {
|
|
|
12154
12036
|
id: string;
|
|
12155
12037
|
/**
|
|
12156
12038
|
*
|
|
12157
|
-
* @type {
|
|
12039
|
+
* @type {JsonApiJwkInAttributes}
|
|
12158
12040
|
* @memberof JsonApiJwkOutWithLinks
|
|
12159
12041
|
*/
|
|
12160
|
-
attributes?:
|
|
12042
|
+
attributes?: JsonApiJwkInAttributes;
|
|
12161
12043
|
/**
|
|
12162
12044
|
*
|
|
12163
12045
|
* @type {ObjectLinks}
|
|
@@ -12189,10 +12071,10 @@ export interface JsonApiJwkPatch {
|
|
|
12189
12071
|
id: string;
|
|
12190
12072
|
/**
|
|
12191
12073
|
*
|
|
12192
|
-
* @type {
|
|
12074
|
+
* @type {JsonApiJwkInAttributes}
|
|
12193
12075
|
* @memberof JsonApiJwkPatch
|
|
12194
12076
|
*/
|
|
12195
|
-
attributes?:
|
|
12077
|
+
attributes?: JsonApiJwkInAttributes;
|
|
12196
12078
|
}
|
|
12197
12079
|
export declare const JsonApiJwkPatchTypeEnum: {
|
|
12198
12080
|
readonly JWK: "jwk";
|
|
@@ -13423,10 +13305,10 @@ export interface JsonApiNotificationChannelIn {
|
|
|
13423
13305
|
id: string;
|
|
13424
13306
|
/**
|
|
13425
13307
|
*
|
|
13426
|
-
* @type {
|
|
13308
|
+
* @type {JsonApiNotificationChannelPostOptionalIdAttributes}
|
|
13427
13309
|
* @memberof JsonApiNotificationChannelIn
|
|
13428
13310
|
*/
|
|
13429
|
-
attributes?:
|
|
13311
|
+
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
13430
13312
|
}
|
|
13431
13313
|
export declare const JsonApiNotificationChannelInTypeEnum: {
|
|
13432
13314
|
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
@@ -13681,10 +13563,10 @@ export interface JsonApiNotificationChannelPatch {
|
|
|
13681
13563
|
id: string;
|
|
13682
13564
|
/**
|
|
13683
13565
|
*
|
|
13684
|
-
* @type {
|
|
13566
|
+
* @type {JsonApiNotificationChannelPostOptionalIdAttributes}
|
|
13685
13567
|
* @memberof JsonApiNotificationChannelPatch
|
|
13686
13568
|
*/
|
|
13687
|
-
attributes?:
|
|
13569
|
+
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
13688
13570
|
}
|
|
13689
13571
|
export declare const JsonApiNotificationChannelPatchTypeEnum: {
|
|
13690
13572
|
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
@@ -13693,117 +13575,117 @@ export type JsonApiNotificationChannelPatchTypeEnum = typeof JsonApiNotification
|
|
|
13693
13575
|
/**
|
|
13694
13576
|
*
|
|
13695
13577
|
* @export
|
|
13696
|
-
* @interface
|
|
13578
|
+
* @interface JsonApiNotificationChannelPatchDocument
|
|
13697
13579
|
*/
|
|
13698
|
-
export interface
|
|
13580
|
+
export interface JsonApiNotificationChannelPatchDocument {
|
|
13699
13581
|
/**
|
|
13700
13582
|
*
|
|
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
|
|
13701
13602
|
* @type {string}
|
|
13702
|
-
* @memberof
|
|
13603
|
+
* @memberof JsonApiNotificationChannelPostOptionalId
|
|
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
|
|
13703
13627
|
*/
|
|
13704
13628
|
name?: string | null;
|
|
13705
13629
|
/**
|
|
13706
13630
|
*
|
|
13707
13631
|
* @type {string}
|
|
13708
|
-
* @memberof
|
|
13632
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13709
13633
|
*/
|
|
13710
13634
|
description?: string | null;
|
|
13711
13635
|
/**
|
|
13712
13636
|
* The destination where the notifications are to be sent.
|
|
13713
13637
|
* @type {DefaultSmtp | InPlatform | Smtp | Webhook}
|
|
13714
|
-
* @memberof
|
|
13638
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13715
13639
|
*/
|
|
13716
13640
|
destination?: DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
13717
13641
|
/**
|
|
13718
13642
|
* 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}
|
|
13719
13643
|
* @type {string}
|
|
13720
|
-
* @memberof
|
|
13644
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13721
13645
|
*/
|
|
13722
13646
|
customDashboardUrl?: string;
|
|
13723
13647
|
/**
|
|
13724
13648
|
* 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
|
|
13725
13649
|
* @type {string}
|
|
13726
|
-
* @memberof
|
|
13650
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13727
13651
|
*/
|
|
13728
|
-
dashboardLinkVisibility?:
|
|
13652
|
+
dashboardLinkVisibility?: JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum;
|
|
13729
13653
|
/**
|
|
13730
13654
|
* 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}}
|
|
13731
13655
|
* @type {string}
|
|
13732
|
-
* @memberof
|
|
13656
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13733
13657
|
*/
|
|
13734
13658
|
notificationSource?: string;
|
|
13735
13659
|
/**
|
|
13736
13660
|
* 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
|
|
13737
13661
|
* @type {string}
|
|
13738
|
-
* @memberof
|
|
13662
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13739
13663
|
*/
|
|
13740
|
-
allowedRecipients?:
|
|
13664
|
+
allowedRecipients?: JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum;
|
|
13741
13665
|
/**
|
|
13742
13666
|
* 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
|
|
13743
13667
|
* @type {string}
|
|
13744
|
-
* @memberof
|
|
13668
|
+
* @memberof JsonApiNotificationChannelPostOptionalIdAttributes
|
|
13745
13669
|
*/
|
|
13746
|
-
inPlatformNotification?:
|
|
13670
|
+
inPlatformNotification?: JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum;
|
|
13747
13671
|
}
|
|
13748
|
-
export declare const
|
|
13672
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum: {
|
|
13749
13673
|
readonly HIDDEN: "HIDDEN";
|
|
13750
13674
|
readonly INTERNAL_ONLY: "INTERNAL_ONLY";
|
|
13751
13675
|
readonly ALL: "ALL";
|
|
13752
13676
|
};
|
|
13753
|
-
export type
|
|
13754
|
-
export declare const
|
|
13677
|
+
export type JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum = typeof JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum];
|
|
13678
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum: {
|
|
13755
13679
|
readonly CREATOR: "CREATOR";
|
|
13756
13680
|
readonly INTERNAL: "INTERNAL";
|
|
13757
13681
|
readonly EXTERNAL: "EXTERNAL";
|
|
13758
13682
|
};
|
|
13759
|
-
export type
|
|
13760
|
-
export declare const
|
|
13683
|
+
export type JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum = typeof JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum];
|
|
13684
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum: {
|
|
13761
13685
|
readonly DISABLED: "DISABLED";
|
|
13762
13686
|
readonly ENABLED: "ENABLED";
|
|
13763
13687
|
};
|
|
13764
|
-
export type
|
|
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];
|
|
13688
|
+
export type JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum = typeof JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum];
|
|
13807
13689
|
/**
|
|
13808
13690
|
*
|
|
13809
13691
|
* @export
|
|
@@ -13843,21 +13725,97 @@ export interface JsonApiOrganizationIn {
|
|
|
13843
13725
|
id: string;
|
|
13844
13726
|
/**
|
|
13845
13727
|
*
|
|
13846
|
-
* @type {
|
|
13728
|
+
* @type {JsonApiOrganizationInAttributes}
|
|
13847
13729
|
* @memberof JsonApiOrganizationIn
|
|
13848
13730
|
*/
|
|
13849
|
-
attributes?:
|
|
13850
|
-
/**
|
|
13851
|
-
*
|
|
13852
|
-
* @type {JsonApiOrganizationPatchRelationships}
|
|
13853
|
-
* @memberof JsonApiOrganizationIn
|
|
13854
|
-
*/
|
|
13855
|
-
relationships?: JsonApiOrganizationPatchRelationships;
|
|
13731
|
+
attributes?: JsonApiOrganizationInAttributes;
|
|
13856
13732
|
}
|
|
13857
13733
|
export declare const JsonApiOrganizationInTypeEnum: {
|
|
13858
13734
|
readonly ORGANIZATION: "organization";
|
|
13859
13735
|
};
|
|
13860
13736
|
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
|
+
}
|
|
13861
13819
|
/**
|
|
13862
13820
|
*
|
|
13863
13821
|
* @export
|
|
@@ -14047,7 +14005,7 @@ export interface JsonApiOrganizationOutDocument {
|
|
|
14047
14005
|
* @type JsonApiOrganizationOutIncludes
|
|
14048
14006
|
* @export
|
|
14049
14007
|
*/
|
|
14050
|
-
export type JsonApiOrganizationOutIncludes =
|
|
14008
|
+
export type JsonApiOrganizationOutIncludes = JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
14051
14009
|
/**
|
|
14052
14010
|
*
|
|
14053
14011
|
* @export
|
|
@@ -14074,48 +14032,16 @@ export type JsonApiOrganizationOutMetaPermissionsEnum = typeof JsonApiOrganizati
|
|
|
14074
14032
|
export interface JsonApiOrganizationOutRelationships {
|
|
14075
14033
|
/**
|
|
14076
14034
|
*
|
|
14077
|
-
* @type {
|
|
14035
|
+
* @type {JsonApiFilterViewPatchRelationshipsUser}
|
|
14078
14036
|
* @memberof JsonApiOrganizationOutRelationships
|
|
14079
14037
|
*/
|
|
14080
|
-
bootstrapUser?:
|
|
14038
|
+
bootstrapUser?: JsonApiFilterViewPatchRelationshipsUser;
|
|
14081
14039
|
/**
|
|
14082
14040
|
*
|
|
14083
|
-
* @type {
|
|
14041
|
+
* @type {JsonApiUserDataFilterPatchRelationshipsUserGroup}
|
|
14084
14042
|
* @memberof JsonApiOrganizationOutRelationships
|
|
14085
14043
|
*/
|
|
14086
|
-
bootstrapUserGroup?:
|
|
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;
|
|
14044
|
+
bootstrapUserGroup?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
14119
14045
|
}
|
|
14120
14046
|
/**
|
|
14121
14047
|
* JSON:API representation of patching organization entity.
|
|
@@ -14137,103 +14063,15 @@ export interface JsonApiOrganizationPatch {
|
|
|
14137
14063
|
id: string;
|
|
14138
14064
|
/**
|
|
14139
14065
|
*
|
|
14140
|
-
* @type {
|
|
14141
|
-
* @memberof JsonApiOrganizationPatch
|
|
14142
|
-
*/
|
|
14143
|
-
attributes?: JsonApiOrganizationPatchAttributes;
|
|
14144
|
-
/**
|
|
14145
|
-
*
|
|
14146
|
-
* @type {JsonApiOrganizationPatchRelationships}
|
|
14066
|
+
* @type {JsonApiOrganizationInAttributes}
|
|
14147
14067
|
* @memberof JsonApiOrganizationPatch
|
|
14148
14068
|
*/
|
|
14149
|
-
|
|
14069
|
+
attributes?: JsonApiOrganizationInAttributes;
|
|
14150
14070
|
}
|
|
14151
14071
|
export declare const JsonApiOrganizationPatchTypeEnum: {
|
|
14152
14072
|
readonly ORGANIZATION: "organization";
|
|
14153
14073
|
};
|
|
14154
14074
|
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
|
-
}
|
|
14237
14075
|
/**
|
|
14238
14076
|
*
|
|
14239
14077
|
* @export
|
|
@@ -14247,32 +14085,6 @@ export interface JsonApiOrganizationPatchDocument {
|
|
|
14247
14085
|
*/
|
|
14248
14086
|
data: JsonApiOrganizationPatch;
|
|
14249
14087
|
}
|
|
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
|
-
}
|
|
14276
14088
|
/**
|
|
14277
14089
|
* JSON:API representation of organizationSetting entity.
|
|
14278
14090
|
* @export
|
|
@@ -14485,10 +14297,10 @@ export interface JsonApiThemeIn {
|
|
|
14485
14297
|
id: string;
|
|
14486
14298
|
/**
|
|
14487
14299
|
*
|
|
14488
|
-
* @type {
|
|
14300
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
14489
14301
|
* @memberof JsonApiThemeIn
|
|
14490
14302
|
*/
|
|
14491
|
-
attributes:
|
|
14303
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
14492
14304
|
}
|
|
14493
14305
|
export declare const JsonApiThemeInTypeEnum: {
|
|
14494
14306
|
readonly THEME: "theme";
|
|
@@ -14527,10 +14339,10 @@ export interface JsonApiThemeOut {
|
|
|
14527
14339
|
id: string;
|
|
14528
14340
|
/**
|
|
14529
14341
|
*
|
|
14530
|
-
* @type {
|
|
14342
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
14531
14343
|
* @memberof JsonApiThemeOut
|
|
14532
14344
|
*/
|
|
14533
|
-
attributes:
|
|
14345
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
14534
14346
|
}
|
|
14535
14347
|
export declare const JsonApiThemeOutTypeEnum: {
|
|
14536
14348
|
readonly THEME: "theme";
|
|
@@ -14600,10 +14412,10 @@ export interface JsonApiThemeOutWithLinks {
|
|
|
14600
14412
|
id: string;
|
|
14601
14413
|
/**
|
|
14602
14414
|
*
|
|
14603
|
-
* @type {
|
|
14415
|
+
* @type {JsonApiColorPaletteInAttributes}
|
|
14604
14416
|
* @memberof JsonApiThemeOutWithLinks
|
|
14605
14417
|
*/
|
|
14606
|
-
attributes:
|
|
14418
|
+
attributes: JsonApiColorPaletteInAttributes;
|
|
14607
14419
|
/**
|
|
14608
14420
|
*
|
|
14609
14421
|
* @type {ObjectLinks}
|
|
@@ -14852,16 +14664,16 @@ export interface JsonApiUserDataFilterOutList {
|
|
|
14852
14664
|
export interface JsonApiUserDataFilterOutRelationships {
|
|
14853
14665
|
/**
|
|
14854
14666
|
*
|
|
14855
|
-
* @type {
|
|
14667
|
+
* @type {JsonApiFilterViewPatchRelationshipsUser}
|
|
14856
14668
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
14857
14669
|
*/
|
|
14858
|
-
user?:
|
|
14670
|
+
user?: JsonApiFilterViewPatchRelationshipsUser;
|
|
14859
14671
|
/**
|
|
14860
14672
|
*
|
|
14861
|
-
* @type {
|
|
14673
|
+
* @type {JsonApiUserDataFilterPatchRelationshipsUserGroup}
|
|
14862
14674
|
* @memberof JsonApiUserDataFilterOutRelationships
|
|
14863
14675
|
*/
|
|
14864
|
-
userGroup?:
|
|
14676
|
+
userGroup?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
14865
14677
|
/**
|
|
14866
14678
|
*
|
|
14867
14679
|
* @type {JsonApiVisualizationObjectOutRelationshipsFacts}
|
|
@@ -15033,16 +14845,29 @@ export interface JsonApiUserDataFilterPatchDocument {
|
|
|
15033
14845
|
export interface JsonApiUserDataFilterPatchRelationships {
|
|
15034
14846
|
/**
|
|
15035
14847
|
*
|
|
15036
|
-
* @type {
|
|
14848
|
+
* @type {JsonApiFilterViewPatchRelationshipsUser}
|
|
15037
14849
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
15038
14850
|
*/
|
|
15039
|
-
user?:
|
|
14851
|
+
user?: JsonApiFilterViewPatchRelationshipsUser;
|
|
15040
14852
|
/**
|
|
15041
14853
|
*
|
|
15042
|
-
* @type {
|
|
14854
|
+
* @type {JsonApiUserDataFilterPatchRelationshipsUserGroup}
|
|
15043
14855
|
* @memberof JsonApiUserDataFilterPatchRelationships
|
|
15044
14856
|
*/
|
|
15045
|
-
userGroup?:
|
|
14857
|
+
userGroup?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
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;
|
|
15046
14871
|
}
|
|
15047
14872
|
/**
|
|
15048
14873
|
* JSON:API representation of userDataFilter entity.
|
|
@@ -16894,16 +16719,16 @@ export interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
16894
16719
|
id: string;
|
|
16895
16720
|
/**
|
|
16896
16721
|
*
|
|
16897
|
-
* @type {
|
|
16722
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
16898
16723
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
16899
16724
|
*/
|
|
16900
|
-
attributes?:
|
|
16725
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
16901
16726
|
/**
|
|
16902
16727
|
*
|
|
16903
|
-
* @type {
|
|
16728
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
16904
16729
|
* @memberof JsonApiWorkspaceDataFilterSettingIn
|
|
16905
16730
|
*/
|
|
16906
|
-
relationships?:
|
|
16731
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
16907
16732
|
}
|
|
16908
16733
|
export declare const JsonApiWorkspaceDataFilterSettingInTypeEnum: {
|
|
16909
16734
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
@@ -16971,46 +16796,21 @@ export interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
16971
16796
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
16972
16797
|
/**
|
|
16973
16798
|
*
|
|
16974
|
-
* @type {
|
|
16799
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
16975
16800
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
16976
16801
|
*/
|
|
16977
|
-
attributes?:
|
|
16802
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
16978
16803
|
/**
|
|
16979
16804
|
*
|
|
16980
|
-
* @type {
|
|
16805
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
16981
16806
|
* @memberof JsonApiWorkspaceDataFilterSettingOut
|
|
16982
16807
|
*/
|
|
16983
|
-
relationships?:
|
|
16808
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
16984
16809
|
}
|
|
16985
16810
|
export declare const JsonApiWorkspaceDataFilterSettingOutTypeEnum: {
|
|
16986
16811
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
16987
16812
|
};
|
|
16988
16813
|
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
|
-
}
|
|
17014
16814
|
/**
|
|
17015
16815
|
*
|
|
17016
16816
|
* @export
|
|
@@ -17067,32 +16867,6 @@ export interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
|
17067
16867
|
*/
|
|
17068
16868
|
included?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
17069
16869
|
}
|
|
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
|
-
}
|
|
17096
16870
|
/**
|
|
17097
16871
|
*
|
|
17098
16872
|
* @export
|
|
@@ -17119,16 +16893,16 @@ export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
17119
16893
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
17120
16894
|
/**
|
|
17121
16895
|
*
|
|
17122
|
-
* @type {
|
|
16896
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
17123
16897
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
17124
16898
|
*/
|
|
17125
|
-
attributes?:
|
|
16899
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
17126
16900
|
/**
|
|
17127
16901
|
*
|
|
17128
|
-
* @type {
|
|
16902
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
17129
16903
|
* @memberof JsonApiWorkspaceDataFilterSettingOutWithLinks
|
|
17130
16904
|
*/
|
|
17131
|
-
relationships?:
|
|
16905
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
17132
16906
|
/**
|
|
17133
16907
|
*
|
|
17134
16908
|
* @type {ObjectLinks}
|
|
@@ -17160,21 +16934,46 @@ export interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
17160
16934
|
id: string;
|
|
17161
16935
|
/**
|
|
17162
16936
|
*
|
|
17163
|
-
* @type {
|
|
16937
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchAttributes}
|
|
17164
16938
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
17165
16939
|
*/
|
|
17166
|
-
attributes?:
|
|
16940
|
+
attributes?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
17167
16941
|
/**
|
|
17168
16942
|
*
|
|
17169
|
-
* @type {
|
|
16943
|
+
* @type {JsonApiWorkspaceDataFilterSettingPatchRelationships}
|
|
17170
16944
|
* @memberof JsonApiWorkspaceDataFilterSettingPatch
|
|
17171
16945
|
*/
|
|
17172
|
-
relationships?:
|
|
16946
|
+
relationships?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
17173
16947
|
}
|
|
17174
16948
|
export declare const JsonApiWorkspaceDataFilterSettingPatchTypeEnum: {
|
|
17175
16949
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
17176
16950
|
};
|
|
17177
16951
|
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
|
+
}
|
|
17178
16977
|
/**
|
|
17179
16978
|
*
|
|
17180
16979
|
* @export
|
|
@@ -17188,6 +16987,32 @@ export interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
|
17188
16987
|
*/
|
|
17189
16988
|
data: JsonApiWorkspaceDataFilterSettingPatch;
|
|
17190
16989
|
}
|
|
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
|
+
}
|
|
17191
17016
|
/**
|
|
17192
17017
|
* @type JsonApiWorkspaceDataFilterToOneLinkage
|
|
17193
17018
|
* References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -17214,21 +17039,90 @@ export interface JsonApiWorkspaceIn {
|
|
|
17214
17039
|
id: string;
|
|
17215
17040
|
/**
|
|
17216
17041
|
*
|
|
17217
|
-
* @type {
|
|
17042
|
+
* @type {JsonApiWorkspaceInAttributes}
|
|
17218
17043
|
* @memberof JsonApiWorkspaceIn
|
|
17219
17044
|
*/
|
|
17220
|
-
attributes?:
|
|
17045
|
+
attributes?: JsonApiWorkspaceInAttributes;
|
|
17221
17046
|
/**
|
|
17222
17047
|
*
|
|
17223
|
-
* @type {
|
|
17048
|
+
* @type {JsonApiWorkspaceInRelationships}
|
|
17224
17049
|
* @memberof JsonApiWorkspaceIn
|
|
17225
17050
|
*/
|
|
17226
|
-
relationships?:
|
|
17051
|
+
relationships?: JsonApiWorkspaceInRelationships;
|
|
17227
17052
|
}
|
|
17228
17053
|
export declare const JsonApiWorkspaceInTypeEnum: {
|
|
17229
17054
|
readonly WORKSPACE: "workspace";
|
|
17230
17055
|
};
|
|
17231
17056
|
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
|
+
}
|
|
17232
17126
|
/**
|
|
17233
17127
|
*
|
|
17234
17128
|
* @export
|
|
@@ -17242,6 +17136,32 @@ export interface JsonApiWorkspaceInDocument {
|
|
|
17242
17136
|
*/
|
|
17243
17137
|
data: JsonApiWorkspaceIn;
|
|
17244
17138
|
}
|
|
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
|
+
}
|
|
17245
17165
|
/**
|
|
17246
17166
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
17247
17167
|
* @export
|
|
@@ -17291,90 +17211,21 @@ export interface JsonApiWorkspaceOut {
|
|
|
17291
17211
|
meta?: JsonApiWorkspaceOutMeta;
|
|
17292
17212
|
/**
|
|
17293
17213
|
*
|
|
17294
|
-
* @type {
|
|
17214
|
+
* @type {JsonApiWorkspaceInAttributes}
|
|
17295
17215
|
* @memberof JsonApiWorkspaceOut
|
|
17296
17216
|
*/
|
|
17297
|
-
attributes?:
|
|
17217
|
+
attributes?: JsonApiWorkspaceInAttributes;
|
|
17298
17218
|
/**
|
|
17299
17219
|
*
|
|
17300
|
-
* @type {
|
|
17220
|
+
* @type {JsonApiWorkspaceInRelationships}
|
|
17301
17221
|
* @memberof JsonApiWorkspaceOut
|
|
17302
17222
|
*/
|
|
17303
|
-
relationships?:
|
|
17223
|
+
relationships?: JsonApiWorkspaceInRelationships;
|
|
17304
17224
|
}
|
|
17305
17225
|
export declare const JsonApiWorkspaceOutTypeEnum: {
|
|
17306
17226
|
readonly WORKSPACE: "workspace";
|
|
17307
17227
|
};
|
|
17308
17228
|
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
|
-
}
|
|
17378
17229
|
/**
|
|
17379
17230
|
*
|
|
17380
17231
|
* @export
|
|
@@ -17525,32 +17376,6 @@ export interface JsonApiWorkspaceOutMetaHierarchy {
|
|
|
17525
17376
|
*/
|
|
17526
17377
|
childrenCount: number;
|
|
17527
17378
|
}
|
|
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
|
-
}
|
|
17554
17379
|
/**
|
|
17555
17380
|
*
|
|
17556
17381
|
* @export
|
|
@@ -17577,16 +17402,16 @@ export interface JsonApiWorkspaceOutWithLinks {
|
|
|
17577
17402
|
meta?: JsonApiWorkspaceOutMeta;
|
|
17578
17403
|
/**
|
|
17579
17404
|
*
|
|
17580
|
-
* @type {
|
|
17405
|
+
* @type {JsonApiWorkspaceInAttributes}
|
|
17581
17406
|
* @memberof JsonApiWorkspaceOutWithLinks
|
|
17582
17407
|
*/
|
|
17583
|
-
attributes?:
|
|
17408
|
+
attributes?: JsonApiWorkspaceInAttributes;
|
|
17584
17409
|
/**
|
|
17585
17410
|
*
|
|
17586
|
-
* @type {
|
|
17411
|
+
* @type {JsonApiWorkspaceInRelationships}
|
|
17587
17412
|
* @memberof JsonApiWorkspaceOutWithLinks
|
|
17588
17413
|
*/
|
|
17589
|
-
relationships?:
|
|
17414
|
+
relationships?: JsonApiWorkspaceInRelationships;
|
|
17590
17415
|
/**
|
|
17591
17416
|
*
|
|
17592
17417
|
* @type {ObjectLinks}
|
|
@@ -17618,16 +17443,16 @@ export interface JsonApiWorkspacePatch {
|
|
|
17618
17443
|
id: string;
|
|
17619
17444
|
/**
|
|
17620
17445
|
*
|
|
17621
|
-
* @type {
|
|
17446
|
+
* @type {JsonApiWorkspaceInAttributes}
|
|
17622
17447
|
* @memberof JsonApiWorkspacePatch
|
|
17623
17448
|
*/
|
|
17624
|
-
attributes?:
|
|
17449
|
+
attributes?: JsonApiWorkspaceInAttributes;
|
|
17625
17450
|
/**
|
|
17626
17451
|
*
|
|
17627
|
-
* @type {
|
|
17452
|
+
* @type {JsonApiWorkspaceInRelationships}
|
|
17628
17453
|
* @memberof JsonApiWorkspacePatch
|
|
17629
17454
|
*/
|
|
17630
|
-
relationships?:
|
|
17455
|
+
relationships?: JsonApiWorkspaceInRelationships;
|
|
17631
17456
|
}
|
|
17632
17457
|
export declare const JsonApiWorkspacePatchTypeEnum: {
|
|
17633
17458
|
readonly WORKSPACE: "workspace";
|
|
@@ -30979,7 +30804,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
30979
30804
|
* @param {string} workspaceId
|
|
30980
30805
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
30981
30806
|
* @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\').
|
|
30982
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
30983
30808
|
* @param {number} [page] Zero-based page index (0..N)
|
|
30984
30809
|
* @param {number} [size] The size of the page to be returned
|
|
30985
30810
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -30988,7 +30813,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
30988
30813
|
* @param {*} [options] Override http request option.
|
|
30989
30814
|
* @throws {RequiredError}
|
|
30990
30815
|
*/
|
|
30991
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
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>;
|
|
30992
30817
|
/**
|
|
30993
30818
|
*
|
|
30994
30819
|
* @summary Get all Context Filters
|
|
@@ -31477,13 +31302,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31477
31302
|
* @param {string} workspaceId
|
|
31478
31303
|
* @param {string} objectId
|
|
31479
31304
|
* @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\').
|
|
31480
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
31481
31306
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
31482
31307
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
31483
31308
|
* @param {*} [options] Override http request option.
|
|
31484
31309
|
* @throws {RequiredError}
|
|
31485
31310
|
*/
|
|
31486
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
31311
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31487
31312
|
/**
|
|
31488
31313
|
*
|
|
31489
31314
|
* @summary Get a Context Filter
|
|
@@ -31593,12 +31418,12 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31593
31418
|
* @summary Get Organizations
|
|
31594
31419
|
* @param {string} id
|
|
31595
31420
|
* @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\').
|
|
31596
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
31597
31422
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
31598
31423
|
* @param {*} [options] Override http request option.
|
|
31599
31424
|
* @throws {RequiredError}
|
|
31600
31425
|
*/
|
|
31601
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
31426
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31602
31427
|
/**
|
|
31603
31428
|
*
|
|
31604
31429
|
* @summary Get Theming
|
|
@@ -31943,11 +31768,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31943
31768
|
* @param {string} id
|
|
31944
31769
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
31945
31770
|
* @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\').
|
|
31946
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
31947
31772
|
* @param {*} [options] Override http request option.
|
|
31948
31773
|
* @throws {RequiredError}
|
|
31949
31774
|
*/
|
|
31950
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
31775
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31951
31776
|
/**
|
|
31952
31777
|
*
|
|
31953
31778
|
* @summary Patch Theming
|
|
@@ -32263,11 +32088,11 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32263
32088
|
* @param {string} id
|
|
32264
32089
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
32265
32090
|
* @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\').
|
|
32266
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
32267
32092
|
* @param {*} [options] Override http request option.
|
|
32268
32093
|
* @throws {RequiredError}
|
|
32269
32094
|
*/
|
|
32270
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
32095
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32271
32096
|
/**
|
|
32272
32097
|
*
|
|
32273
32098
|
* @summary Put Theming
|
|
@@ -33159,7 +32984,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33159
32984
|
* @param {string} workspaceId
|
|
33160
32985
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
33161
32986
|
* @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\').
|
|
33162
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
33163
32988
|
* @param {number} [page] Zero-based page index (0..N)
|
|
33164
32989
|
* @param {number} [size] The size of the page to be returned
|
|
33165
32990
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -33168,7 +32993,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33168
32993
|
* @param {*} [options] Override http request option.
|
|
33169
32994
|
* @throws {RequiredError}
|
|
33170
32995
|
*/
|
|
33171
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
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>>;
|
|
33172
32997
|
/**
|
|
33173
32998
|
*
|
|
33174
32999
|
* @summary Get all Context Filters
|
|
@@ -33659,13 +33484,13 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33659
33484
|
* @param {string} workspaceId
|
|
33660
33485
|
* @param {string} objectId
|
|
33661
33486
|
* @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\').
|
|
33662
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
33663
33488
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
33664
33489
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33665
33490
|
* @param {*} [options] Override http request option.
|
|
33666
33491
|
* @throws {RequiredError}
|
|
33667
33492
|
*/
|
|
33668
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
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>>;
|
|
33669
33494
|
/**
|
|
33670
33495
|
*
|
|
33671
33496
|
* @summary Get a Context Filter
|
|
@@ -33775,12 +33600,12 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33775
33600
|
* @summary Get Organizations
|
|
33776
33601
|
* @param {string} id
|
|
33777
33602
|
* @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\').
|
|
33778
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
33779
33604
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33780
33605
|
* @param {*} [options] Override http request option.
|
|
33781
33606
|
* @throws {RequiredError}
|
|
33782
33607
|
*/
|
|
33783
|
-
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
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>>;
|
|
33784
33609
|
/**
|
|
33785
33610
|
*
|
|
33786
33611
|
* @summary Get Theming
|
|
@@ -34125,11 +33950,11 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
34125
33950
|
* @param {string} id
|
|
34126
33951
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
34127
33952
|
* @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\').
|
|
34128
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
34129
33954
|
* @param {*} [options] Override http request option.
|
|
34130
33955
|
* @throws {RequiredError}
|
|
34131
33956
|
*/
|
|
34132
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
33957
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
34133
33958
|
/**
|
|
34134
33959
|
*
|
|
34135
33960
|
* @summary Patch Theming
|
|
@@ -34445,11 +34270,11 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
34445
34270
|
* @param {string} id
|
|
34446
34271
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
34447
34272
|
* @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\').
|
|
34448
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
34449
34274
|
* @param {*} [options] Override http request option.
|
|
34450
34275
|
* @throws {RequiredError}
|
|
34451
34276
|
*/
|
|
34452
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
34277
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
34453
34278
|
/**
|
|
34454
34279
|
*
|
|
34455
34280
|
* @summary Put Theming
|
|
@@ -39976,10 +39801,10 @@ export interface EntitiesApiGetAllEntitiesFactsRequest {
|
|
|
39976
39801
|
readonly filter?: string;
|
|
39977
39802
|
/**
|
|
39978
39803
|
* 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.
|
|
39979
|
-
* @type {Array<'datasets' | '
|
|
39804
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
39980
39805
|
* @memberof EntitiesApiGetAllEntitiesFacts
|
|
39981
39806
|
*/
|
|
39982
|
-
readonly include?: Array<"datasets" | "
|
|
39807
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
39983
39808
|
/**
|
|
39984
39809
|
* Zero-based page index (0..N)
|
|
39985
39810
|
* @type {number}
|
|
@@ -41556,10 +41381,10 @@ export interface EntitiesApiGetEntityFactsRequest {
|
|
|
41556
41381
|
readonly filter?: string;
|
|
41557
41382
|
/**
|
|
41558
41383
|
* 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.
|
|
41559
|
-
* @type {Array<'datasets' | '
|
|
41384
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
41560
41385
|
* @memberof EntitiesApiGetEntityFacts
|
|
41561
41386
|
*/
|
|
41562
|
-
readonly include?: Array<"datasets" | "
|
|
41387
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
41563
41388
|
/**
|
|
41564
41389
|
*
|
|
41565
41390
|
* @type {boolean}
|
|
@@ -41873,10 +41698,10 @@ export interface EntitiesApiGetEntityOrganizationsRequest {
|
|
|
41873
41698
|
readonly filter?: string;
|
|
41874
41699
|
/**
|
|
41875
41700
|
* 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.
|
|
41876
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
41701
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
41877
41702
|
* @memberof EntitiesApiGetEntityOrganizations
|
|
41878
41703
|
*/
|
|
41879
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
41704
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
41880
41705
|
/**
|
|
41881
41706
|
* Include Meta objects.
|
|
41882
41707
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -42853,10 +42678,10 @@ export interface EntitiesApiPatchEntityOrganizationsRequest {
|
|
|
42853
42678
|
readonly filter?: string;
|
|
42854
42679
|
/**
|
|
42855
42680
|
* 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.
|
|
42856
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
42681
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
42857
42682
|
* @memberof EntitiesApiPatchEntityOrganizations
|
|
42858
42683
|
*/
|
|
42859
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
42684
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
42860
42685
|
}
|
|
42861
42686
|
/**
|
|
42862
42687
|
* Request parameters for patchEntityThemes operation in EntitiesApi.
|
|
@@ -43758,10 +43583,10 @@ export interface EntitiesApiUpdateEntityOrganizationsRequest {
|
|
|
43758
43583
|
readonly filter?: string;
|
|
43759
43584
|
/**
|
|
43760
43585
|
* 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.
|
|
43761
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
43586
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
43762
43587
|
* @memberof EntitiesApiUpdateEntityOrganizations
|
|
43763
43588
|
*/
|
|
43764
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
43589
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
43765
43590
|
}
|
|
43766
43591
|
/**
|
|
43767
43592
|
* Request parameters for updateEntityThemes operation in EntitiesApi.
|
|
@@ -46717,7 +46542,7 @@ export declare const FactsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
46717
46542
|
* @param {string} workspaceId
|
|
46718
46543
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
46719
46544
|
* @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\').
|
|
46720
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
46721
46546
|
* @param {number} [page] Zero-based page index (0..N)
|
|
46722
46547
|
* @param {number} [size] The size of the page to be returned
|
|
46723
46548
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -46726,20 +46551,20 @@ export declare const FactsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
46726
46551
|
* @param {*} [options] Override http request option.
|
|
46727
46552
|
* @throws {RequiredError}
|
|
46728
46553
|
*/
|
|
46729
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
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>;
|
|
46730
46555
|
/**
|
|
46731
46556
|
*
|
|
46732
46557
|
* @summary Get a Fact
|
|
46733
46558
|
* @param {string} workspaceId
|
|
46734
46559
|
* @param {string} objectId
|
|
46735
46560
|
* @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\').
|
|
46736
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
46737
46562
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
46738
46563
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46739
46564
|
* @param {*} [options] Override http request option.
|
|
46740
46565
|
* @throws {RequiredError}
|
|
46741
46566
|
*/
|
|
46742
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
46567
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46743
46568
|
};
|
|
46744
46569
|
/**
|
|
46745
46570
|
* FactsApi - functional programming interface
|
|
@@ -46752,7 +46577,7 @@ export declare const FactsApiFp: (configuration?: Configuration) => {
|
|
|
46752
46577
|
* @param {string} workspaceId
|
|
46753
46578
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
46754
46579
|
* @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\').
|
|
46755
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
46756
46581
|
* @param {number} [page] Zero-based page index (0..N)
|
|
46757
46582
|
* @param {number} [size] The size of the page to be returned
|
|
46758
46583
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -46761,20 +46586,20 @@ export declare const FactsApiFp: (configuration?: Configuration) => {
|
|
|
46761
46586
|
* @param {*} [options] Override http request option.
|
|
46762
46587
|
* @throws {RequiredError}
|
|
46763
46588
|
*/
|
|
46764
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
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>>;
|
|
46765
46590
|
/**
|
|
46766
46591
|
*
|
|
46767
46592
|
* @summary Get a Fact
|
|
46768
46593
|
* @param {string} workspaceId
|
|
46769
46594
|
* @param {string} objectId
|
|
46770
46595
|
* @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\').
|
|
46771
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
46772
46597
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
46773
46598
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46774
46599
|
* @param {*} [options] Override http request option.
|
|
46775
46600
|
* @throws {RequiredError}
|
|
46776
46601
|
*/
|
|
46777
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
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>>;
|
|
46778
46603
|
};
|
|
46779
46604
|
/**
|
|
46780
46605
|
* FactsApi - factory interface
|
|
@@ -46849,10 +46674,10 @@ export interface FactsApiGetAllEntitiesFactsRequest {
|
|
|
46849
46674
|
readonly filter?: string;
|
|
46850
46675
|
/**
|
|
46851
46676
|
* 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.
|
|
46852
|
-
* @type {Array<'datasets' | '
|
|
46677
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
46853
46678
|
* @memberof FactsApiGetAllEntitiesFacts
|
|
46854
46679
|
*/
|
|
46855
|
-
readonly include?: Array<"datasets" | "
|
|
46680
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
46856
46681
|
/**
|
|
46857
46682
|
* Zero-based page index (0..N)
|
|
46858
46683
|
* @type {number}
|
|
@@ -46910,10 +46735,10 @@ export interface FactsApiGetEntityFactsRequest {
|
|
|
46910
46735
|
readonly filter?: string;
|
|
46911
46736
|
/**
|
|
46912
46737
|
* 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.
|
|
46913
|
-
* @type {Array<'datasets' | '
|
|
46738
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
46914
46739
|
* @memberof FactsApiGetEntityFacts
|
|
46915
46740
|
*/
|
|
46916
|
-
readonly include?: Array<"datasets" | "
|
|
46741
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
46917
46742
|
/**
|
|
46918
46743
|
*
|
|
46919
46744
|
* @type {boolean}
|
|
@@ -53134,17 +52959,6 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
53134
52959
|
* @throws {RequiredError}
|
|
53135
52960
|
*/
|
|
53136
52961
|
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>;
|
|
53148
52962
|
/**
|
|
53149
52963
|
*
|
|
53150
52964
|
* @summary Get all Notification Channel entities
|
|
@@ -53157,14 +52971,6 @@ export declare const NotificationChannelsApiAxiosParamCreator: (configuration?:
|
|
|
53157
52971
|
* @throws {RequiredError}
|
|
53158
52972
|
*/
|
|
53159
52973
|
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>;
|
|
53168
52974
|
/**
|
|
53169
52975
|
*
|
|
53170
52976
|
* @summary Get Notification Channel entity
|
|
@@ -53247,17 +53053,6 @@ export declare const NotificationChannelsApiFp: (configuration?: Configuration)
|
|
|
53247
53053
|
* @throws {RequiredError}
|
|
53248
53054
|
*/
|
|
53249
53055
|
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>>;
|
|
53261
53056
|
/**
|
|
53262
53057
|
*
|
|
53263
53058
|
* @summary Get all Notification Channel entities
|
|
@@ -53270,14 +53065,6 @@ export declare const NotificationChannelsApiFp: (configuration?: Configuration)
|
|
|
53270
53065
|
* @throws {RequiredError}
|
|
53271
53066
|
*/
|
|
53272
53067
|
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>>;
|
|
53281
53068
|
/**
|
|
53282
53069
|
*
|
|
53283
53070
|
* @summary Get Notification Channel entity
|
|
@@ -53359,13 +53146,6 @@ export declare const NotificationChannelsApiFactory: (configuration?: Configurat
|
|
|
53359
53146
|
* @throws {RequiredError}
|
|
53360
53147
|
*/
|
|
53361
53148
|
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>;
|
|
53369
53149
|
/**
|
|
53370
53150
|
*
|
|
53371
53151
|
* @summary Get all Notification Channel entities
|
|
@@ -53374,13 +53154,6 @@ export declare const NotificationChannelsApiFactory: (configuration?: Configurat
|
|
|
53374
53154
|
* @throws {RequiredError}
|
|
53375
53155
|
*/
|
|
53376
53156
|
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>;
|
|
53384
53157
|
/**
|
|
53385
53158
|
*
|
|
53386
53159
|
* @summary Get Notification Channel entity
|
|
@@ -53460,14 +53233,6 @@ export interface NotificationChannelsApiInterface {
|
|
|
53460
53233
|
* @memberof NotificationChannelsApiInterface
|
|
53461
53234
|
*/
|
|
53462
53235
|
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>;
|
|
53471
53236
|
/**
|
|
53472
53237
|
*
|
|
53473
53238
|
* @summary Get all Notification Channel entities
|
|
@@ -53477,14 +53242,6 @@ export interface NotificationChannelsApiInterface {
|
|
|
53477
53242
|
* @memberof NotificationChannelsApiInterface
|
|
53478
53243
|
*/
|
|
53479
53244
|
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>;
|
|
53488
53245
|
/**
|
|
53489
53246
|
*
|
|
53490
53247
|
* @summary Get Notification Channel entity
|
|
@@ -53579,43 +53336,6 @@ export interface NotificationChannelsApiDeleteEntityNotificationChannelsRequest
|
|
|
53579
53336
|
*/
|
|
53580
53337
|
readonly filter?: string;
|
|
53581
53338
|
}
|
|
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
|
-
}
|
|
53619
53339
|
/**
|
|
53620
53340
|
* Request parameters for getAllEntitiesNotificationChannels operation in NotificationChannelsApi.
|
|
53621
53341
|
* @export
|
|
@@ -53653,25 +53373,6 @@ export interface NotificationChannelsApiGetAllEntitiesNotificationChannelsReques
|
|
|
53653
53373
|
*/
|
|
53654
53374
|
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
53655
53375
|
}
|
|
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
|
-
}
|
|
53675
53376
|
/**
|
|
53676
53377
|
* Request parameters for getEntityNotificationChannels operation in NotificationChannelsApi.
|
|
53677
53378
|
* @export
|
|
@@ -53792,14 +53493,6 @@ export declare class NotificationChannelsApi extends BaseAPI implements Notifica
|
|
|
53792
53493
|
* @memberof NotificationChannelsApi
|
|
53793
53494
|
*/
|
|
53794
53495
|
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>>;
|
|
53803
53496
|
/**
|
|
53804
53497
|
*
|
|
53805
53498
|
* @summary Get all Notification Channel entities
|
|
@@ -53809,14 +53502,6 @@ export declare class NotificationChannelsApi extends BaseAPI implements Notifica
|
|
|
53809
53502
|
* @memberof NotificationChannelsApi
|
|
53810
53503
|
*/
|
|
53811
53504
|
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>>;
|
|
53820
53505
|
/**
|
|
53821
53506
|
*
|
|
53822
53507
|
* @summary Get Notification Channel entity
|
|
@@ -53968,12 +53653,12 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
53968
53653
|
* @summary Get Organizations
|
|
53969
53654
|
* @param {string} id
|
|
53970
53655
|
* @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\').
|
|
53971
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
53972
53657
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
53973
53658
|
* @param {*} [options] Override http request option.
|
|
53974
53659
|
* @throws {RequiredError}
|
|
53975
53660
|
*/
|
|
53976
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
53661
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53977
53662
|
/**
|
|
53978
53663
|
*
|
|
53979
53664
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -53990,11 +53675,11 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
53990
53675
|
* @param {string} id
|
|
53991
53676
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
53992
53677
|
* @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\').
|
|
53993
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
53994
53679
|
* @param {*} [options] Override http request option.
|
|
53995
53680
|
* @throws {RequiredError}
|
|
53996
53681
|
*/
|
|
53997
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
53682
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53998
53683
|
/**
|
|
53999
53684
|
*
|
|
54000
53685
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -54011,11 +53696,11 @@ export declare const OrganizationControllerApiAxiosParamCreator: (configuration?
|
|
|
54011
53696
|
* @param {string} id
|
|
54012
53697
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
54013
53698
|
* @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\').
|
|
54014
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54015
53700
|
* @param {*} [options] Override http request option.
|
|
54016
53701
|
* @throws {RequiredError}
|
|
54017
53702
|
*/
|
|
54018
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
53703
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54019
53704
|
};
|
|
54020
53705
|
/**
|
|
54021
53706
|
* OrganizationControllerApi - functional programming interface
|
|
@@ -54036,12 +53721,12 @@ export declare const OrganizationControllerApiFp: (configuration?: Configuration
|
|
|
54036
53721
|
* @summary Get Organizations
|
|
54037
53722
|
* @param {string} id
|
|
54038
53723
|
* @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\').
|
|
54039
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54040
53725
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
54041
53726
|
* @param {*} [options] Override http request option.
|
|
54042
53727
|
* @throws {RequiredError}
|
|
54043
53728
|
*/
|
|
54044
|
-
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
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>>;
|
|
54045
53730
|
/**
|
|
54046
53731
|
*
|
|
54047
53732
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -54058,11 +53743,11 @@ export declare const OrganizationControllerApiFp: (configuration?: Configuration
|
|
|
54058
53743
|
* @param {string} id
|
|
54059
53744
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
54060
53745
|
* @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\').
|
|
54061
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54062
53747
|
* @param {*} [options] Override http request option.
|
|
54063
53748
|
* @throws {RequiredError}
|
|
54064
53749
|
*/
|
|
54065
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
53750
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
54066
53751
|
/**
|
|
54067
53752
|
*
|
|
54068
53753
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -54079,11 +53764,11 @@ export declare const OrganizationControllerApiFp: (configuration?: Configuration
|
|
|
54079
53764
|
* @param {string} id
|
|
54080
53765
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
54081
53766
|
* @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\').
|
|
54082
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54083
53768
|
* @param {*} [options] Override http request option.
|
|
54084
53769
|
* @throws {RequiredError}
|
|
54085
53770
|
*/
|
|
54086
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
53771
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
54087
53772
|
};
|
|
54088
53773
|
/**
|
|
54089
53774
|
* OrganizationControllerApi - factory interface
|
|
@@ -54239,10 +53924,10 @@ export interface OrganizationControllerApiGetEntityOrganizationsRequest {
|
|
|
54239
53924
|
readonly filter?: string;
|
|
54240
53925
|
/**
|
|
54241
53926
|
* 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.
|
|
54242
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
53927
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
54243
53928
|
* @memberof OrganizationControllerApiGetEntityOrganizations
|
|
54244
53929
|
*/
|
|
54245
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
53930
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
54246
53931
|
/**
|
|
54247
53932
|
* Include Meta objects.
|
|
54248
53933
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -54301,10 +53986,10 @@ export interface OrganizationControllerApiPatchEntityOrganizationsRequest {
|
|
|
54301
53986
|
readonly filter?: string;
|
|
54302
53987
|
/**
|
|
54303
53988
|
* 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
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
53989
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
54305
53990
|
* @memberof OrganizationControllerApiPatchEntityOrganizations
|
|
54306
53991
|
*/
|
|
54307
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
53992
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
54308
53993
|
}
|
|
54309
53994
|
/**
|
|
54310
53995
|
* Request parameters for updateEntityCookieSecurityConfigurations operation in OrganizationControllerApi.
|
|
@@ -54357,10 +54042,10 @@ export interface OrganizationControllerApiUpdateEntityOrganizationsRequest {
|
|
|
54357
54042
|
readonly filter?: string;
|
|
54358
54043
|
/**
|
|
54359
54044
|
* 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.
|
|
54360
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
54045
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
54361
54046
|
* @memberof OrganizationControllerApiUpdateEntityOrganizations
|
|
54362
54047
|
*/
|
|
54363
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
54048
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
54364
54049
|
}
|
|
54365
54050
|
/**
|
|
54366
54051
|
* OrganizationControllerApi - object-oriented interface
|
|
@@ -54615,12 +54300,12 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
54615
54300
|
* @summary Get Organizations
|
|
54616
54301
|
* @param {string} id
|
|
54617
54302
|
* @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\').
|
|
54618
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54619
54304
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
54620
54305
|
* @param {*} [options] Override http request option.
|
|
54621
54306
|
* @throws {RequiredError}
|
|
54622
54307
|
*/
|
|
54623
|
-
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
54308
|
+
getEntityOrganizations: (id: string, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, metaInclude?: Array<"permissions" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54624
54309
|
/**
|
|
54625
54310
|
* Gets a basic information about organization.
|
|
54626
54311
|
* @summary Get current organization info
|
|
@@ -54645,11 +54330,11 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
54645
54330
|
* @param {string} id
|
|
54646
54331
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
54647
54332
|
* @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\').
|
|
54648
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54649
54334
|
* @param {*} [options] Override http request option.
|
|
54650
54335
|
* @throws {RequiredError}
|
|
54651
54336
|
*/
|
|
54652
|
-
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
54337
|
+
patchEntityOrganizations: (id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54653
54338
|
/**
|
|
54654
54339
|
*
|
|
54655
54340
|
* @summary Put Organization entity
|
|
@@ -54666,11 +54351,11 @@ export declare const OrganizationEntityAPIsApiAxiosParamCreator: (configuration?
|
|
|
54666
54351
|
* @param {string} id
|
|
54667
54352
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
54668
54353
|
* @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\').
|
|
54669
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54670
54355
|
* @param {*} [options] Override http request option.
|
|
54671
54356
|
* @throws {RequiredError}
|
|
54672
54357
|
*/
|
|
54673
|
-
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
54358
|
+
updateEntityOrganizations: (id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54674
54359
|
};
|
|
54675
54360
|
/**
|
|
54676
54361
|
* OrganizationEntityAPIsApi - functional programming interface
|
|
@@ -54720,12 +54405,12 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: Configuration
|
|
|
54720
54405
|
* @summary Get Organizations
|
|
54721
54406
|
* @param {string} id
|
|
54722
54407
|
* @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\').
|
|
54723
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54724
54409
|
* @param {Array<'permissions' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
54725
54410
|
* @param {*} [options] Override http request option.
|
|
54726
54411
|
* @throws {RequiredError}
|
|
54727
54412
|
*/
|
|
54728
|
-
getEntityOrganizations(id: string, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
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>>;
|
|
54729
54414
|
/**
|
|
54730
54415
|
* Gets a basic information about organization.
|
|
54731
54416
|
* @summary Get current organization info
|
|
@@ -54750,11 +54435,11 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: Configuration
|
|
|
54750
54435
|
* @param {string} id
|
|
54751
54436
|
* @param {JsonApiOrganizationPatchDocument} jsonApiOrganizationPatchDocument
|
|
54752
54437
|
* @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\').
|
|
54753
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54754
54439
|
* @param {*} [options] Override http request option.
|
|
54755
54440
|
* @throws {RequiredError}
|
|
54756
54441
|
*/
|
|
54757
|
-
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
54442
|
+
patchEntityOrganizations(id: string, jsonApiOrganizationPatchDocument: JsonApiOrganizationPatchDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
54758
54443
|
/**
|
|
54759
54444
|
*
|
|
54760
54445
|
* @summary Put Organization entity
|
|
@@ -54771,11 +54456,11 @@ export declare const OrganizationEntityAPIsApiFp: (configuration?: Configuration
|
|
|
54771
54456
|
* @param {string} id
|
|
54772
54457
|
* @param {JsonApiOrganizationInDocument} jsonApiOrganizationInDocument
|
|
54773
54458
|
* @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\').
|
|
54774
|
-
* @param {Array<'users' | 'userGroups' | '
|
|
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.
|
|
54775
54460
|
* @param {*} [options] Override http request option.
|
|
54776
54461
|
* @throws {RequiredError}
|
|
54777
54462
|
*/
|
|
54778
|
-
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "
|
|
54463
|
+
updateEntityOrganizations(id: string, jsonApiOrganizationInDocument: JsonApiOrganizationInDocument, filter?: string, include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiOrganizationOutDocument>>;
|
|
54779
54464
|
};
|
|
54780
54465
|
/**
|
|
54781
54466
|
* OrganizationEntityAPIsApi - factory interface
|
|
@@ -55068,10 +54753,10 @@ export interface OrganizationEntityAPIsApiGetEntityOrganizationsRequest {
|
|
|
55068
54753
|
readonly filter?: string;
|
|
55069
54754
|
/**
|
|
55070
54755
|
* 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.
|
|
55071
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
54756
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
55072
54757
|
* @memberof OrganizationEntityAPIsApiGetEntityOrganizations
|
|
55073
54758
|
*/
|
|
55074
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
54759
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
55075
54760
|
/**
|
|
55076
54761
|
* Include Meta objects.
|
|
55077
54762
|
* @type {Array<'permissions' | 'all' | 'ALL'>}
|
|
@@ -55143,10 +54828,10 @@ export interface OrganizationEntityAPIsApiPatchEntityOrganizationsRequest {
|
|
|
55143
54828
|
readonly filter?: string;
|
|
55144
54829
|
/**
|
|
55145
54830
|
* 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.
|
|
55146
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
54831
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
55147
54832
|
* @memberof OrganizationEntityAPIsApiPatchEntityOrganizations
|
|
55148
54833
|
*/
|
|
55149
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
54834
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
55150
54835
|
}
|
|
55151
54836
|
/**
|
|
55152
54837
|
* Request parameters for updateEntityOrganizationSettings operation in OrganizationEntityAPIsApi.
|
|
@@ -55199,10 +54884,10 @@ export interface OrganizationEntityAPIsApiUpdateEntityOrganizationsRequest {
|
|
|
55199
54884
|
readonly filter?: string;
|
|
55200
54885
|
/**
|
|
55201
54886
|
* 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.
|
|
55202
|
-
* @type {Array<'users' | 'userGroups' | '
|
|
54887
|
+
* @type {Array<'users' | 'userGroups' | 'bootstrapUser' | 'bootstrapUserGroup' | 'ALL'>}
|
|
55203
54888
|
* @memberof OrganizationEntityAPIsApiUpdateEntityOrganizations
|
|
55204
54889
|
*/
|
|
55205
|
-
readonly include?: Array<"users" | "userGroups" | "
|
|
54890
|
+
readonly include?: Array<"users" | "userGroups" | "bootstrapUser" | "bootstrapUserGroup" | "ALL">;
|
|
55206
54891
|
}
|
|
55207
54892
|
/**
|
|
55208
54893
|
* OrganizationEntityAPIsApi - object-oriented interface
|
|
@@ -68056,7 +67741,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68056
67741
|
* @param {string} workspaceId
|
|
68057
67742
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
68058
67743
|
* @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\').
|
|
68059
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
68060
67745
|
* @param {number} [page] Zero-based page index (0..N)
|
|
68061
67746
|
* @param {number} [size] The size of the page to be returned
|
|
68062
67747
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -68065,7 +67750,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68065
67750
|
* @param {*} [options] Override http request option.
|
|
68066
67751
|
* @throws {RequiredError}
|
|
68067
67752
|
*/
|
|
68068
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
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>;
|
|
68069
67754
|
/**
|
|
68070
67755
|
*
|
|
68071
67756
|
* @summary Get all Context Filters
|
|
@@ -68318,13 +68003,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68318
68003
|
* @param {string} workspaceId
|
|
68319
68004
|
* @param {string} objectId
|
|
68320
68005
|
* @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\').
|
|
68321
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
68322
68007
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
68323
68008
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
68324
68009
|
* @param {*} [options] Override http request option.
|
|
68325
68010
|
* @throws {RequiredError}
|
|
68326
68011
|
*/
|
|
68327
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
68012
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68328
68013
|
/**
|
|
68329
68014
|
*
|
|
68330
68015
|
* @summary Get a Context Filter
|
|
@@ -69202,7 +68887,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69202
68887
|
* @param {string} workspaceId
|
|
69203
68888
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
69204
68889
|
* @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\').
|
|
69205
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
69206
68891
|
* @param {number} [page] Zero-based page index (0..N)
|
|
69207
68892
|
* @param {number} [size] The size of the page to be returned
|
|
69208
68893
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -69211,7 +68896,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69211
68896
|
* @param {*} [options] Override http request option.
|
|
69212
68897
|
* @throws {RequiredError}
|
|
69213
68898
|
*/
|
|
69214
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
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>>;
|
|
69215
68900
|
/**
|
|
69216
68901
|
*
|
|
69217
68902
|
* @summary Get all Context Filters
|
|
@@ -69464,13 +69149,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69464
69149
|
* @param {string} workspaceId
|
|
69465
69150
|
* @param {string} objectId
|
|
69466
69151
|
* @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\').
|
|
69467
|
-
* @param {Array<'datasets' | '
|
|
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.
|
|
69468
69153
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
69469
69154
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
69470
69155
|
* @param {*} [options] Override http request option.
|
|
69471
69156
|
* @throws {RequiredError}
|
|
69472
69157
|
*/
|
|
69473
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
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>>;
|
|
69474
69159
|
/**
|
|
69475
69160
|
*
|
|
69476
69161
|
* @summary Get a Context Filter
|
|
@@ -72770,10 +72455,10 @@ export interface WorkspaceObjectControllerApiGetAllEntitiesFactsRequest {
|
|
|
72770
72455
|
readonly filter?: string;
|
|
72771
72456
|
/**
|
|
72772
72457
|
* 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.
|
|
72773
|
-
* @type {Array<'datasets' | '
|
|
72458
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
72774
72459
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesFacts
|
|
72775
72460
|
*/
|
|
72776
|
-
readonly include?: Array<"datasets" | "
|
|
72461
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
72777
72462
|
/**
|
|
72778
72463
|
* Zero-based page index (0..N)
|
|
72779
72464
|
* @type {number}
|
|
@@ -73712,10 +73397,10 @@ export interface WorkspaceObjectControllerApiGetEntityFactsRequest {
|
|
|
73712
73397
|
readonly filter?: string;
|
|
73713
73398
|
/**
|
|
73714
73399
|
* 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.
|
|
73715
|
-
* @type {Array<'datasets' | '
|
|
73400
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
73716
73401
|
* @memberof WorkspaceObjectControllerApiGetEntityFacts
|
|
73717
73402
|
*/
|
|
73718
|
-
readonly include?: Array<"datasets" | "
|
|
73403
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
73719
73404
|
/**
|
|
73720
73405
|
*
|
|
73721
73406
|
* @type {boolean}
|