@coveo/platform-client 37.3.0 → 37.5.0-alpha.0
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/dist/APICore.js +276 -264
- package/dist/APICore.js.map +1 -1
- package/dist/ConfigurationInterfaces.js +2 -2
- package/dist/Endpoints.js +40 -40
- package/dist/Entry.js +14 -14
- package/dist/PlatformClient.js +44 -44
- package/dist/definitions/APICore.d.ts +32 -31
- package/dist/definitions/ConfigurationInterfaces.d.ts +14 -14
- package/dist/definitions/Endpoints.d.ts +13 -13
- package/dist/definitions/Entry.d.ts +9 -9
- package/dist/definitions/PlatformClient.d.ts +18 -18
- package/dist/definitions/handlers/ResponseHandlerInterfaces.d.ts +4 -4
- package/dist/definitions/handlers/ResponseHandlers.d.ts +10 -10
- package/dist/definitions/handlers/index.d.ts +2 -2
- package/dist/definitions/resources/AWS/AWS.d.ts +9 -9
- package/dist/definitions/resources/AWS/AWSInterfaces.d.ts +18 -18
- package/dist/definitions/resources/AWS/index.d.ts +2 -2
- package/dist/definitions/resources/Activities/Activities.d.ts +13 -13
- package/dist/definitions/resources/Activities/ActivitiesInterfaces.d.ts +64 -64
- package/dist/definitions/resources/Activities/index.d.ts +2 -2
- package/dist/definitions/resources/ApiKeys/ApiKeys.d.ts +12 -12
- package/dist/definitions/resources/ApiKeys/ApiKeysInterfaces.d.ts +133 -133
- package/dist/definitions/resources/ApiKeys/index.d.ts +2 -2
- package/dist/definitions/resources/BaseInterfaces.d.ts +51 -51
- package/dist/definitions/resources/CaseAssistConfigs/CaseAssistConfig.d.ts +16 -16
- package/dist/definitions/resources/CaseAssistConfigs/CaseAssistConfigInterfaces.d.ts +59 -59
- package/dist/definitions/resources/CaseAssistConfigs/CaseAssistPreviewInterfaces.d.ts +27 -27
- package/dist/definitions/resources/CaseAssistConfigs/index.d.ts +3 -3
- package/dist/definitions/resources/Catalogs/Catalog.d.ts +21 -21
- package/dist/definitions/resources/Catalogs/CatalogConfiguration.d.ts +11 -11
- package/dist/definitions/resources/Catalogs/CatalogInterfaces.d.ts +338 -338
- package/dist/definitions/resources/Catalogs/ProductListing.d.ts +14 -14
- package/dist/definitions/resources/Catalogs/ProductListingConfiguration.d.ts +11 -11
- package/dist/definitions/resources/Catalogs/ProductListingConfigurationInterfaces.d.ts +41 -41
- package/dist/definitions/resources/Catalogs/ProductListingInterfaces.d.ts +81 -81
- package/dist/definitions/resources/Catalogs/index.d.ts +7 -7
- package/dist/definitions/resources/Clusters/Agents/ClusterAgent.d.ts +9 -9
- package/dist/definitions/resources/Clusters/Agents/ClusterAgentInterfaces.d.ts +9 -9
- package/dist/definitions/resources/Clusters/Agents/index.d.ts +2 -2
- package/dist/definitions/resources/Clusters/Cluster.d.ts +18 -18
- package/dist/definitions/resources/Clusters/ClusterInterfaces.d.ts +92 -92
- package/dist/definitions/resources/Clusters/Nodes/ClusterNode.d.ts +12 -12
- package/dist/definitions/resources/Clusters/Nodes/ClusterNodeInterfaces.d.ts +20 -20
- package/dist/definitions/resources/Clusters/Nodes/index.d.ts +2 -2
- package/dist/definitions/resources/Clusters/index.d.ts +4 -4
- package/dist/definitions/resources/Connectivity/Connectivity.d.ts +7 -7
- package/dist/definitions/resources/Connectivity/ConnectivityInterface.d.ts +16 -16
- package/dist/definitions/resources/Connectivity/index.d.ts +2 -2
- package/dist/definitions/resources/CrawlingModule/CrawlingModule.d.ts +16 -16
- package/dist/definitions/resources/CrawlingModule/CrawlingModuleInterfaces.d.ts +180 -57
- package/dist/definitions/resources/CrawlingModule/index.d.ts +2 -2
- package/dist/definitions/resources/Enums.d.ts +981 -981
- package/dist/definitions/resources/Extensions/Extensions.d.ts +12 -12
- package/dist/definitions/resources/Extensions/ExtensionsInterfaces.d.ts +55 -55
- package/dist/definitions/resources/Extensions/index.d.ts +2 -2
- package/dist/definitions/resources/Fields/Fields.d.ts +19 -19
- package/dist/definitions/resources/Fields/FieldsInterfaces.d.ts +70 -70
- package/dist/definitions/resources/Fields/index.d.ts +2 -2
- package/dist/definitions/resources/Global/Global.d.ts +11 -11
- package/dist/definitions/resources/Global/OrganizationConfigurations/OrganizationConfiguration.d.ts +8 -8
- package/dist/definitions/resources/Global/OrganizationConfigurations/OrganizationConfigurationInterfaces.d.ts +6 -6
- package/dist/definitions/resources/Global/OrganizationConfigurations/index.d.ts +2 -2
- package/dist/definitions/resources/Global/RegionConfigurations/RegionConfiguration.d.ts +7 -7
- package/dist/definitions/resources/Global/RegionConfigurations/RegionConfigurationInterfaces.d.ts +10 -10
- package/dist/definitions/resources/Global/RegionConfigurations/index.d.ts +2 -2
- package/dist/definitions/resources/Global/index.d.ts +3 -3
- package/dist/definitions/resources/GlobalGroups/GlobalGroup.d.ts +13 -13
- package/dist/definitions/resources/GlobalGroups/GlobalGroupInterfaces.d.ts +18 -18
- package/dist/definitions/resources/GlobalGroups/index.d.ts +2 -2
- package/dist/definitions/resources/Groups/Groups.d.ts +24 -24
- package/dist/definitions/resources/Groups/GroupsInterfaces.d.ts +21 -21
- package/dist/definitions/resources/Groups/Invites/GroupInvite.d.ts +11 -11
- package/dist/definitions/resources/Groups/Invites/GroupInviteInterfaces.d.ts +35 -35
- package/dist/definitions/resources/Groups/Invites/index.d.ts +2 -2
- package/dist/definitions/resources/Groups/Members/GroupMember.d.ts +9 -9
- package/dist/definitions/resources/Groups/Members/GroupMemberInterfaces.d.ts +13 -13
- package/dist/definitions/resources/Groups/Members/index.d.ts +2 -2
- package/dist/definitions/resources/Groups/Realms/GroupRealm.d.ts +9 -9
- package/dist/definitions/resources/Groups/Realms/GroupRealmInterfaces.d.ts +7 -7
- package/dist/definitions/resources/Groups/Realms/index.d.ts +2 -2
- package/dist/definitions/resources/Groups/index.d.ts +5 -5
- package/dist/definitions/resources/InProductExperiences/InProductExperiences.d.ts +31 -31
- package/dist/definitions/resources/InProductExperiences/InProductExperiencesInterfaces.d.ts +327 -327
- package/dist/definitions/resources/InProductExperiences/index.d.ts +2 -2
- package/dist/definitions/resources/Indexes/Indexes.d.ts +26 -26
- package/dist/definitions/resources/Indexes/IndexesInterface.d.ts +198 -198
- package/dist/definitions/resources/Indexes/index.d.ts +2 -2
- package/dist/definitions/resources/InsightPanelConfigs/InsightPanelConfig.d.ts +11 -11
- package/dist/definitions/resources/InsightPanelConfigs/InsightPanelConfigInterfaces.d.ts +158 -158
- package/dist/definitions/resources/InsightPanelConfigs/index.d.ts +2 -2
- package/dist/definitions/resources/InsightPanelInterfaces/InsightPanelInterface.d.ts +11 -11
- package/dist/definitions/resources/InsightPanelInterfaces/InsightPanelInterface.model.d.ts +240 -240
- package/dist/definitions/resources/InsightPanelInterfaces/index.d.ts +2 -2
- package/dist/definitions/resources/InternalBaseInterface.d.ts +12 -12
- package/dist/definitions/resources/License/License.d.ts +12 -12
- package/dist/definitions/resources/License/LicenseInterfaces.d.ts +194 -194
- package/dist/definitions/resources/License/index.d.ts +2 -2
- package/dist/definitions/resources/Limits/Limits.d.ts +12 -12
- package/dist/definitions/resources/Limits/LimitsInterfaces.d.ts +38 -38
- package/dist/definitions/resources/Limits/index.d.ts +2 -2
- package/dist/definitions/resources/Links/Links.d.ts +5 -5
- package/dist/definitions/resources/Links/index.d.ts +1 -1
- package/dist/definitions/resources/Logs/Logs.d.ts +8 -8
- package/dist/definitions/resources/Logs/LogsInterfaces.d.ts +47 -47
- package/dist/definitions/resources/Logs/index.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.d.ts +15 -15
- package/dist/definitions/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfigurationInterfaces.d.ts +147 -147
- package/dist/definitions/resources/MachineLearning/CaseClassificationConfiguration/index.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/DNEConfiguration/DNEConfiguration.d.ts +15 -15
- package/dist/definitions/resources/MachineLearning/DNEConfiguration/DNEConfigurationInterfaces.d.ts +41 -41
- package/dist/definitions/resources/MachineLearning/DNEConfiguration/index.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/FilterConditions.d.ts +18 -18
- package/dist/definitions/resources/MachineLearning/MachineLearning.d.ts +26 -26
- package/dist/definitions/resources/MachineLearning/MachineLearningInterfaces.d.ts +65 -65
- package/dist/definitions/resources/MachineLearning/ModelConfiguration/ModelConfiguration.d.ts +7 -7
- package/dist/definitions/resources/MachineLearning/ModelConfiguration/ModelConfigurationInterfaces.d.ts +10 -10
- package/dist/definitions/resources/MachineLearning/ModelConfiguration/index.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/ModelInformation/ModelInformation.d.ts +10 -10
- package/dist/definitions/resources/MachineLearning/ModelInformation/ModelInformationInterfaces.d.ts +252 -252
- package/dist/definitions/resources/MachineLearning/ModelInformation/index.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/Models/Models.d.ts +13 -13
- package/dist/definitions/resources/MachineLearning/Models/ModelsInterfaces.d.ts +49 -49
- package/dist/definitions/resources/MachineLearning/Models/index.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/PQSConfiguration/PQSConfiguration.d.ts +6 -6
- package/dist/definitions/resources/MachineLearning/PQSConfiguration/PQSConfigurationInterfaces.d.ts +40 -40
- package/dist/definitions/resources/MachineLearning/PQSConfiguration/index.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfiguration.d.ts +17 -17
- package/dist/definitions/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts +131 -131
- package/dist/definitions/resources/MachineLearning/SmartSnippetsConfiguration/index.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/UserActionHistoryConfiguration/UserActionHistoryConfiguration.d.ts +7 -7
- package/dist/definitions/resources/MachineLearning/UserActionHistoryConfiguration/index.d.ts +1 -1
- package/dist/definitions/resources/MachineLearning/index.d.ts +11 -11
- package/dist/definitions/resources/ModifierTemplates/ModifierTemplateInterfaces.d.ts +71 -71
- package/dist/definitions/resources/ModifierTemplates/ModifierTemplates.d.ts +7 -7
- package/dist/definitions/resources/ModifierTemplates/index.d.ts +2 -2
- package/dist/definitions/resources/Notification/Subscription/Subscription.d.ts +21 -21
- package/dist/definitions/resources/Notification/Subscription/SubscriptionInterfaces.d.ts +41 -41
- package/dist/definitions/resources/Notification/Subscription/index.d.ts +2 -2
- package/dist/definitions/resources/Notification/index.d.ts +2 -2
- package/dist/definitions/resources/Notification/notification.d.ts +9 -9
- package/dist/definitions/resources/OrganizationAccess/Access.d.ts +7 -7
- package/dist/definitions/resources/OrganizationAccess/AccessInterfaces.d.ts +13 -13
- package/dist/definitions/resources/OrganizationAccess/index.d.ts +2 -2
- package/dist/definitions/resources/Organizations/Members/Members.d.ts +8 -8
- package/dist/definitions/resources/Organizations/Members/MembersInterface.d.ts +37 -37
- package/dist/definitions/resources/Organizations/Members/index.d.ts +2 -2
- package/dist/definitions/resources/Organizations/Organization.d.ts +42 -42
- package/dist/definitions/resources/Organizations/OrganizationInterfaces.d.ts +176 -176
- package/dist/definitions/resources/Organizations/index.d.ts +3 -3
- package/dist/definitions/resources/Pipelines/Conditions/Condition.d.ts +11 -11
- package/dist/definitions/resources/Pipelines/Conditions/ConditionInterfaces.d.ts +25 -25
- package/dist/definitions/resources/Pipelines/Conditions/index.d.ts +2 -2
- package/dist/definitions/resources/Pipelines/FacetStateRules/FacetStateRules.d.ts +11 -11
- package/dist/definitions/resources/Pipelines/FacetStateRules/FacetStateRulesInterface.d.ts +45 -45
- package/dist/definitions/resources/Pipelines/FacetStateRules/index.d.ts +2 -2
- package/dist/definitions/resources/Pipelines/MLAssociations/MLAssociations.d.ts +13 -13
- package/dist/definitions/resources/Pipelines/MLAssociations/MLAssociationsInterfaces.d.ts +57 -57
- package/dist/definitions/resources/Pipelines/MLAssociations/index.d.ts +2 -2
- package/dist/definitions/resources/Pipelines/Pipelines.d.ts +30 -30
- package/dist/definitions/resources/Pipelines/PipelinesInterfaces.d.ts +213 -213
- package/dist/definitions/resources/Pipelines/ResultRankings/ResultRankings.d.ts +15 -15
- package/dist/definitions/resources/Pipelines/ResultRankings/ResultRankingsInterfaces.d.ts +266 -266
- package/dist/definitions/resources/Pipelines/ResultRankings/index.d.ts +2 -2
- package/dist/definitions/resources/Pipelines/StatementGroups/StatementGroups.d.ts +13 -13
- package/dist/definitions/resources/Pipelines/StatementGroups/StatementGroupsInterfaces.d.ts +230 -230
- package/dist/definitions/resources/Pipelines/StatementGroups/index.d.ts +2 -2
- package/dist/definitions/resources/Pipelines/Statements/Statements.d.ts +17 -17
- package/dist/definitions/resources/Pipelines/Statements/StatementsInterfaces.d.ts +142 -142
- package/dist/definitions/resources/Pipelines/Statements/index.d.ts +2 -2
- package/dist/definitions/resources/Pipelines/index.d.ts +8 -8
- package/dist/definitions/resources/PlatformResources.d.ts +99 -99
- package/dist/definitions/resources/PrivilegeEvaluator/PrivilegeEvaluator.d.ts +11 -11
- package/dist/definitions/resources/PrivilegeEvaluator/PrivilegeEvaluatorInterfaces.d.ts +29 -29
- package/dist/definitions/resources/PrivilegeEvaluator/index.d.ts +2 -2
- package/dist/definitions/resources/Products/Product.d.ts +7 -7
- package/dist/definitions/resources/Products/ProductInterfaces.d.ts +209 -209
- package/dist/definitions/resources/Products/index.d.ts +2 -2
- package/dist/definitions/resources/PushApi/PushApi.d.ts +10 -10
- package/dist/definitions/resources/PushApi/PushApiInterfaces.d.ts +37 -37
- package/dist/definitions/resources/PushApi/index.d.ts +2 -2
- package/dist/definitions/resources/Resource.d.ts +10 -10
- package/dist/definitions/resources/ResourceSnapshots/ResourceSnapshots.d.ts +52 -52
- package/dist/definitions/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts +344 -344
- package/dist/definitions/resources/ResourceSnapshots/index.d.ts +2 -2
- package/dist/definitions/resources/Saml/Saml.d.ts +14 -14
- package/dist/definitions/resources/Saml/SamlInterfaces.d.ts +13 -13
- package/dist/definitions/resources/Saml/index.d.ts +2 -2
- package/dist/definitions/resources/SchemaService/SchemaService.d.ts +60 -60
- package/dist/definitions/resources/SchemaService/SchemaServiceInterfaces.d.ts +155 -155
- package/dist/definitions/resources/SchemaService/index.d.ts +2 -2
- package/dist/definitions/resources/Search/Search.d.ts +10 -10
- package/dist/definitions/resources/Search/SearchInterfaces.d.ts +2140 -2140
- package/dist/definitions/resources/Search/index.d.ts +2 -2
- package/dist/definitions/resources/SearchInterfaces/SearchInterfaces.d.ts +17 -17
- package/dist/definitions/resources/SearchInterfaces/SearchInterfaces.model.d.ts +179 -179
- package/dist/definitions/resources/SearchInterfaces/index.d.ts +2 -2
- package/dist/definitions/resources/SearchPages/SearchPages.d.ts +20 -20
- package/dist/definitions/resources/SearchPages/SearchPagesInterfaces.d.ts +42 -42
- package/dist/definitions/resources/SearchPages/index.d.ts +2 -2
- package/dist/definitions/resources/SearchUsageMetrics/LicenseMetrics/LicenseMetrics.d.ts +8 -7
- package/dist/definitions/resources/SearchUsageMetrics/LicenseMetrics/LicenseMetricsInterface.d.ts +49 -49
- package/dist/definitions/resources/SearchUsageMetrics/LicenseMetrics/index.d.ts +2 -2
- package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/RawMetrics.d.ts +10 -10
- package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/RawMetricsInterface.d.ts +127 -127
- package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/index.d.ts +2 -2
- package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/SearchHubs.d.ts +11 -11
- package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/SearchHubsInterface.d.ts +64 -64
- package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/index.d.ts +2 -2
- package/dist/definitions/resources/SearchUsageMetrics/SearchUsageMetrics.d.ts +13 -13
- package/dist/definitions/resources/SearchUsageMetrics/index.d.ts +4 -4
- package/dist/definitions/resources/SecurityCache/SecurityCache.d.ts +26 -26
- package/dist/definitions/resources/SecurityCache/SecurityCacheInterfaces.d.ts +137 -137
- package/dist/definitions/resources/SecurityCache/index.d.ts +2 -2
- package/dist/definitions/resources/Sources/Sources.d.ts +67 -67
- package/dist/definitions/resources/Sources/SourcesDatasets/SourcesDatasets.d.ts +8 -8
- package/dist/definitions/resources/Sources/SourcesDatasets/SourcesDatasetsInterfaces.d.ts +24 -24
- package/dist/definitions/resources/Sources/SourcesDatasets/index.d.ts +2 -2
- package/dist/definitions/resources/Sources/SourcesFields/SourcesFields.d.ts +10 -10
- package/dist/definitions/resources/Sources/SourcesFields/SourcesFieldsInterfaces.d.ts +15 -15
- package/dist/definitions/resources/Sources/SourcesFields/index.d.ts +2 -2
- package/dist/definitions/resources/Sources/SourcesInterfaces.d.ts +114 -114
- package/dist/definitions/resources/Sources/SourcesMappings/SourcesMappings.d.ts +7 -7
- package/dist/definitions/resources/Sources/SourcesMappings/SourcesMappingsInterfaces.d.ts +72 -72
- package/dist/definitions/resources/Sources/SourcesMappings/index.d.ts +2 -2
- package/dist/definitions/resources/Sources/SourcesMetadata/SourcesMetadata.d.ts +9 -9
- package/dist/definitions/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.d.ts +55 -55
- package/dist/definitions/resources/Sources/SourcesMetadata/index.d.ts +2 -2
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Address.d.ts +6 -6
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Authentification.d.ts +37 -37
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Document.d.ts +104 -104
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Error.d.ts +4 -4
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/ExtendedDataFile.d.ts +5 -5
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Extension.d.ts +9 -9
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Information.d.ts +59 -59
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Parameter.d.ts +4 -4
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Permission.d.ts +42 -42
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/Url.d.ts +6 -6
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/User.d.ts +5 -5
- package/dist/definitions/resources/Sources/SourcesSubInterfaces/index.d.ts +11 -11
- package/dist/definitions/resources/Sources/index.d.ts +6 -6
- package/dist/definitions/resources/TableauService/ContentQuery/ContentQuery.d.ts +8 -8
- package/dist/definitions/resources/TableauService/ContentQuery/ContentQueryInterfaces.d.ts +58 -58
- package/dist/definitions/resources/TableauService/ContentQuery/index.d.ts +2 -2
- package/dist/definitions/resources/TableauService/TableauService.d.ts +9 -9
- package/dist/definitions/resources/TableauService/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Administration/Administration.d.ts +10 -10
- package/dist/definitions/resources/UsageAnalytics/Read/Administration/AdministrationInterfaces.d.ts +21 -21
- package/dist/definitions/resources/UsageAnalytics/Read/Administration/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/DataShare/DataShare.d.ts +9 -9
- package/dist/definitions/resources/UsageAnalytics/Read/DataShare/DataShareInterfaces.d.ts +43 -43
- package/dist/definitions/resources/UsageAnalytics/Read/DataShare/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/Dimensions.d.ts +21 -21
- package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/DimensionsInterfaces.d.ts +101 -101
- package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Exports/Exports.d.ts +20 -20
- package/dist/definitions/resources/UsageAnalytics/Read/Exports/ExportsInterfaces.d.ts +101 -101
- package/dist/definitions/resources/UsageAnalytics/Read/Exports/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Filters/Filters.d.ts +71 -71
- package/dist/definitions/resources/UsageAnalytics/Read/Filters/FiltersInterfaces.d.ts +67 -67
- package/dist/definitions/resources/UsageAnalytics/Read/Filters/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Reports/Reports.d.ts +58 -58
- package/dist/definitions/resources/UsageAnalytics/Read/Reports/ReportsInterfaces.d.ts +99 -99
- package/dist/definitions/resources/UsageAnalytics/Read/Reports/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Snowflake/Snowflake.d.ts +16 -16
- package/dist/definitions/resources/UsageAnalytics/Read/Snowflake/SnowflakeInterfaces.d.ts +49 -49
- package/dist/definitions/resources/UsageAnalytics/Read/Snowflake/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Statistics/Statistics.d.ts +18 -18
- package/dist/definitions/resources/UsageAnalytics/Read/Statistics/StatisticsInterfaces.d.ts +186 -186
- package/dist/definitions/resources/UsageAnalytics/Read/Statistics/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Users/Users.d.ts +12 -12
- package/dist/definitions/resources/UsageAnalytics/Read/Users/UsersInterfaces.d.ts +113 -113
- package/dist/definitions/resources/UsageAnalytics/Read/Users/index.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/index.d.ts +9 -9
- package/dist/definitions/resources/UsageAnalytics/UsageAnalytics.d.ts +23 -23
- package/dist/definitions/resources/UsageAnalytics/index.d.ts +2 -2
- package/dist/definitions/resources/Users/User.d.ts +9 -9
- package/dist/definitions/resources/Users/UserInterfaces.d.ts +29 -29
- package/dist/definitions/resources/Users/index.d.ts +2 -2
- package/dist/definitions/resources/Vaults/Vaults.d.ts +33 -33
- package/dist/definitions/resources/Vaults/VaultsInterfaces.d.ts +29 -29
- package/dist/definitions/resources/Vaults/index.d.ts +2 -2
- package/dist/definitions/resources/index.d.ts +46 -46
- package/dist/definitions/utils/FormData.d.ts +1 -0
- package/dist/definitions/utils/Retriever.d.ts +3 -3
- package/dist/definitions/utils/WithRequired.d.ts +3 -3
- package/dist/definitions/utils/index.d.ts +2 -2
- package/dist/definitions/utils/normalizePaginatedOptions.d.ts +3 -3
- package/dist/handlers/ResponseHandlerInterfaces.js +2 -2
- package/dist/handlers/ResponseHandlers.js +45 -45
- package/dist/handlers/index.js +5 -5
- package/dist/resources/AWS/AWS.js +17 -17
- package/dist/resources/AWS/AWSInterfaces.js +2 -2
- package/dist/resources/AWS/index.js +5 -5
- package/dist/resources/Activities/Activities.js +37 -37
- package/dist/resources/Activities/ActivitiesInterfaces.js +2 -2
- package/dist/resources/Activities/index.js +5 -5
- package/dist/resources/ApiKeys/ApiKeys.js +33 -33
- package/dist/resources/ApiKeys/ApiKeysInterfaces.js +2 -2
- package/dist/resources/ApiKeys/index.js +5 -5
- package/dist/resources/BaseInterfaces.js +2 -2
- package/dist/resources/CaseAssistConfigs/CaseAssistConfig.js +41 -41
- package/dist/resources/CaseAssistConfigs/CaseAssistConfigInterfaces.js +17 -17
- package/dist/resources/CaseAssistConfigs/CaseAssistPreviewInterfaces.js +2 -2
- package/dist/resources/CaseAssistConfigs/index.js +6 -6
- package/dist/resources/Catalogs/Catalog.js +42 -42
- package/dist/resources/Catalogs/CatalogConfiguration.js +29 -29
- package/dist/resources/Catalogs/CatalogInterfaces.js +2 -2
- package/dist/resources/Catalogs/ProductListing.js +38 -38
- package/dist/resources/Catalogs/ProductListingConfiguration.js +31 -31
- package/dist/resources/Catalogs/ProductListingConfigurationInterfaces.js +9 -9
- package/dist/resources/Catalogs/ProductListingInterfaces.js +3 -3
- package/dist/resources/Catalogs/index.js +10 -10
- package/dist/resources/Clusters/Agents/ClusterAgent.js +20 -20
- package/dist/resources/Clusters/Agents/ClusterAgentInterfaces.js +2 -2
- package/dist/resources/Clusters/Agents/index.js +5 -5
- package/dist/resources/Clusters/Cluster.js +37 -37
- package/dist/resources/Clusters/ClusterInterfaces.js +2 -2
- package/dist/resources/Clusters/Nodes/ClusterNode.js +32 -32
- package/dist/resources/Clusters/Nodes/ClusterNodeInterfaces.js +2 -2
- package/dist/resources/Clusters/Nodes/index.js +5 -5
- package/dist/resources/Clusters/index.js +7 -7
- package/dist/resources/Connectivity/Connectivity.js +22 -22
- package/dist/resources/Connectivity/ConnectivityInterface.js +8 -8
- package/dist/resources/Connectivity/index.js +5 -5
- package/dist/resources/CrawlingModule/CrawlingModule.js +44 -44
- package/dist/resources/CrawlingModule/CrawlingModuleInterfaces.js +16 -16
- package/dist/resources/CrawlingModule/CrawlingModuleInterfaces.js.map +1 -1
- package/dist/resources/CrawlingModule/index.js +5 -5
- package/dist/resources/Enums.js +1094 -1094
- package/dist/resources/Extensions/Extensions.js +35 -35
- package/dist/resources/Extensions/ExtensionsInterfaces.js +2 -2
- package/dist/resources/Extensions/index.js +5 -5
- package/dist/resources/Fields/Fields.js +48 -48
- package/dist/resources/Fields/FieldsInterfaces.js +2 -2
- package/dist/resources/Fields/index.js +5 -5
- package/dist/resources/Global/Global.js +19 -19
- package/dist/resources/Global/OrganizationConfigurations/OrganizationConfiguration.js +19 -19
- package/dist/resources/Global/OrganizationConfigurations/OrganizationConfigurationInterfaces.js +2 -2
- package/dist/resources/Global/OrganizationConfigurations/index.js +5 -5
- package/dist/resources/Global/RegionConfigurations/RegionConfiguration.js +19 -19
- package/dist/resources/Global/RegionConfigurations/RegionConfigurationInterfaces.js +2 -2
- package/dist/resources/Global/RegionConfigurations/index.js +5 -5
- package/dist/resources/Global/index.js +6 -6
- package/dist/resources/GlobalGroups/GlobalGroup.js +28 -28
- package/dist/resources/GlobalGroups/GlobalGroupInterfaces.js +2 -2
- package/dist/resources/GlobalGroups/index.js +5 -5
- package/dist/resources/Groups/Groups.js +41 -41
- package/dist/resources/Groups/GroupsInterfaces.js +2 -2
- package/dist/resources/Groups/Invites/GroupInvite.js +30 -30
- package/dist/resources/Groups/Invites/GroupInviteInterfaces.js +2 -2
- package/dist/resources/Groups/Invites/index.js +5 -5
- package/dist/resources/Groups/Members/GroupMember.js +27 -27
- package/dist/resources/Groups/Members/GroupMemberInterfaces.js +2 -2
- package/dist/resources/Groups/Members/index.js +5 -5
- package/dist/resources/Groups/Realms/GroupRealm.js +26 -26
- package/dist/resources/Groups/Realms/GroupRealmInterfaces.js +2 -2
- package/dist/resources/Groups/Realms/index.js +5 -5
- package/dist/resources/Groups/index.js +8 -8
- package/dist/resources/InProductExperiences/InProductExperiences.js +44 -44
- package/dist/resources/InProductExperiences/InProductExperiencesInterfaces.js +30 -30
- package/dist/resources/InProductExperiences/index.js +5 -5
- package/dist/resources/Indexes/Indexes.js +61 -61
- package/dist/resources/Indexes/IndexesInterface.js +2 -2
- package/dist/resources/Indexes/index.js +5 -5
- package/dist/resources/InsightPanelConfigs/InsightPanelConfig.js +30 -30
- package/dist/resources/InsightPanelConfigs/InsightPanelConfigInterfaces.js +2 -2
- package/dist/resources/InsightPanelConfigs/index.js +5 -5
- package/dist/resources/InsightPanelInterfaces/InsightPanelInterface.js +30 -30
- package/dist/resources/InsightPanelInterfaces/InsightPanelInterface.model.js +15 -15
- package/dist/resources/InsightPanelInterfaces/index.js +5 -5
- package/dist/resources/InternalBaseInterface.js +2 -2
- package/dist/resources/License/License.js +32 -32
- package/dist/resources/License/LicenseInterfaces.js +78 -78
- package/dist/resources/License/index.js +5 -5
- package/dist/resources/Limits/Limits.js +30 -30
- package/dist/resources/Limits/LimitsInterfaces.js +8 -8
- package/dist/resources/Limits/index.js +5 -5
- package/dist/resources/Links/Links.js +17 -17
- package/dist/resources/Links/index.js +4 -4
- package/dist/resources/Logs/Logs.js +23 -23
- package/dist/resources/Logs/LogsInterfaces.js +2 -2
- package/dist/resources/Logs/index.js +5 -5
- package/dist/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js +35 -35
- package/dist/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfigurationInterfaces.js +8 -8
- package/dist/resources/MachineLearning/CaseClassificationConfiguration/index.js +5 -5
- package/dist/resources/MachineLearning/DNEConfiguration/DNEConfiguration.js +51 -51
- package/dist/resources/MachineLearning/DNEConfiguration/DNEConfigurationInterfaces.js +2 -2
- package/dist/resources/MachineLearning/DNEConfiguration/index.js +5 -5
- package/dist/resources/MachineLearning/FilterConditions.js +2 -2
- package/dist/resources/MachineLearning/MachineLearning.js +36 -36
- package/dist/resources/MachineLearning/MachineLearningInterfaces.js +2 -2
- package/dist/resources/MachineLearning/ModelConfiguration/ModelConfiguration.js +22 -22
- package/dist/resources/MachineLearning/ModelConfiguration/ModelConfigurationInterfaces.js +2 -2
- package/dist/resources/MachineLearning/ModelConfiguration/index.js +5 -5
- package/dist/resources/MachineLearning/ModelInformation/ModelInformation.js +25 -25
- package/dist/resources/MachineLearning/ModelInformation/ModelInformationInterfaces.js +2 -2
- package/dist/resources/MachineLearning/ModelInformation/index.js +5 -5
- package/dist/resources/MachineLearning/Models/Models.js +35 -35
- package/dist/resources/MachineLearning/Models/ModelsInterfaces.js +2 -2
- package/dist/resources/MachineLearning/Models/index.js +5 -5
- package/dist/resources/MachineLearning/PQSConfiguration/PQSConfiguration.js +17 -17
- package/dist/resources/MachineLearning/PQSConfiguration/PQSConfigurationInterfaces.js +2 -2
- package/dist/resources/MachineLearning/PQSConfiguration/index.js +5 -5
- package/dist/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfiguration.js +39 -39
- package/dist/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.js +2 -2
- package/dist/resources/MachineLearning/SmartSnippetsConfiguration/index.js +5 -5
- package/dist/resources/MachineLearning/UserActionHistoryConfiguration/UserActionHistoryConfiguration.js +23 -23
- package/dist/resources/MachineLearning/UserActionHistoryConfiguration/index.js +4 -4
- package/dist/resources/MachineLearning/index.js +14 -14
- package/dist/resources/ModifierTemplates/ModifierTemplateInterfaces.js +26 -26
- package/dist/resources/ModifierTemplates/ModifierTemplates.js +19 -19
- package/dist/resources/ModifierTemplates/index.js +5 -5
- package/dist/resources/Notification/Subscription/Subscription.js +61 -61
- package/dist/resources/Notification/Subscription/SubscriptionInterfaces.js +2 -2
- package/dist/resources/Notification/Subscription/index.js +5 -5
- package/dist/resources/Notification/index.js +5 -5
- package/dist/resources/Notification/notification.js +17 -17
- package/dist/resources/OrganizationAccess/Access.js +20 -20
- package/dist/resources/OrganizationAccess/AccessInterfaces.js +2 -2
- package/dist/resources/OrganizationAccess/index.js +5 -5
- package/dist/resources/Organizations/Members/Members.js +23 -23
- package/dist/resources/Organizations/Members/MembersInterface.js +2 -2
- package/dist/resources/Organizations/Members/index.js +5 -5
- package/dist/resources/Organizations/Organization.js +91 -91
- package/dist/resources/Organizations/OrganizationInterfaces.js +57 -57
- package/dist/resources/Organizations/index.js +6 -6
- package/dist/resources/Pipelines/Conditions/Condition.js +29 -29
- package/dist/resources/Pipelines/Conditions/ConditionInterfaces.js +2 -2
- package/dist/resources/Pipelines/Conditions/index.js +5 -5
- package/dist/resources/Pipelines/FacetStateRules/FacetStateRules.js +39 -39
- package/dist/resources/Pipelines/FacetStateRules/FacetStateRulesInterface.js +2 -2
- package/dist/resources/Pipelines/FacetStateRules/index.js +5 -5
- package/dist/resources/Pipelines/MLAssociations/MLAssociations.js +45 -45
- package/dist/resources/Pipelines/MLAssociations/MLAssociationsInterfaces.js +2 -2
- package/dist/resources/Pipelines/MLAssociations/index.js +5 -5
- package/dist/resources/Pipelines/Pipelines.js +60 -60
- package/dist/resources/Pipelines/PipelinesInterfaces.js +2 -2
- package/dist/resources/Pipelines/ResultRankings/ResultRankings.js +59 -59
- package/dist/resources/Pipelines/ResultRankings/ResultRankingsInterfaces.js +2 -2
- package/dist/resources/Pipelines/ResultRankings/index.js +5 -5
- package/dist/resources/Pipelines/StatementGroups/StatementGroups.js +47 -47
- package/dist/resources/Pipelines/StatementGroups/StatementGroupsInterfaces.js +7 -7
- package/dist/resources/Pipelines/StatementGroups/index.js +5 -5
- package/dist/resources/Pipelines/Statements/Statements.js +58 -58
- package/dist/resources/Pipelines/Statements/StatementsInterfaces.js +2 -2
- package/dist/resources/Pipelines/Statements/index.js +5 -5
- package/dist/resources/Pipelines/index.js +11 -11
- package/dist/resources/PlatformResources.js +112 -112
- package/dist/resources/PrivilegeEvaluator/PrivilegeEvaluator.js +22 -22
- package/dist/resources/PrivilegeEvaluator/PrivilegeEvaluatorInterfaces.js +14 -14
- package/dist/resources/PrivilegeEvaluator/index.js +5 -5
- package/dist/resources/Products/Product.js +18 -18
- package/dist/resources/Products/ProductInterfaces.js +2 -2
- package/dist/resources/Products/index.js +5 -5
- package/dist/resources/PushApi/PushApi.js +33 -33
- package/dist/resources/PushApi/PushApiInterfaces.js +2 -2
- package/dist/resources/PushApi/index.js +5 -5
- package/dist/resources/Resource.js +24 -24
- package/dist/resources/ResourceSnapshots/ResourceSnapshots.js +130 -130
- package/dist/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js +96 -96
- package/dist/resources/ResourceSnapshots/index.js +5 -5
- package/dist/resources/Saml/Saml.js +35 -35
- package/dist/resources/Saml/SamlInterfaces.js +2 -2
- package/dist/resources/Saml/index.js +5 -5
- package/dist/resources/SchemaService/SchemaService.js +84 -84
- package/dist/resources/SchemaService/SchemaServiceInterfaces.js +2 -2
- package/dist/resources/SchemaService/index.js +5 -5
- package/dist/resources/Search/Search.js +36 -36
- package/dist/resources/Search/SearchInterfaces.js +2 -2
- package/dist/resources/Search/index.js +5 -5
- package/dist/resources/SearchInterfaces/SearchInterfaces.js +48 -48
- package/dist/resources/SearchInterfaces/SearchInterfaces.model.js +2 -2
- package/dist/resources/SearchInterfaces/index.js +5 -5
- package/dist/resources/SearchPages/SearchPages.js +59 -59
- package/dist/resources/SearchPages/SearchPagesInterfaces.js +2 -2
- package/dist/resources/SearchPages/index.js +5 -5
- package/dist/resources/SearchUsageMetrics/LicenseMetrics/LicenseMetrics.js +23 -20
- package/dist/resources/SearchUsageMetrics/LicenseMetrics/LicenseMetrics.js.map +1 -1
- package/dist/resources/SearchUsageMetrics/LicenseMetrics/LicenseMetricsInterface.js +2 -2
- package/dist/resources/SearchUsageMetrics/LicenseMetrics/index.js +5 -5
- package/dist/resources/SearchUsageMetrics/RawMetrics/RawMetrics.js +44 -44
- package/dist/resources/SearchUsageMetrics/RawMetrics/RawMetricsInterface.js +2 -2
- package/dist/resources/SearchUsageMetrics/RawMetrics/index.js +5 -5
- package/dist/resources/SearchUsageMetrics/SearchHubs/SearchHubs.js +38 -38
- package/dist/resources/SearchUsageMetrics/SearchHubs/SearchHubsInterface.js +2 -2
- package/dist/resources/SearchUsageMetrics/SearchHubs/index.js +5 -5
- package/dist/resources/SearchUsageMetrics/SearchUsageMetrics.js +21 -21
- package/dist/resources/SearchUsageMetrics/index.js +7 -7
- package/dist/resources/SecurityCache/SecurityCache.js +79 -79
- package/dist/resources/SecurityCache/SecurityCacheInterfaces.js +2 -2
- package/dist/resources/SecurityCache/index.js +5 -5
- package/dist/resources/Sources/Sources.js +122 -122
- package/dist/resources/Sources/SourcesDatasets/SourcesDatasets.js +29 -29
- package/dist/resources/Sources/SourcesDatasets/SourcesDatasetsInterfaces.js +34 -34
- package/dist/resources/Sources/SourcesDatasets/index.js +5 -5
- package/dist/resources/Sources/SourcesFields/SourcesFields.js +27 -27
- package/dist/resources/Sources/SourcesFields/SourcesFieldsInterfaces.js +2 -2
- package/dist/resources/Sources/SourcesFields/index.js +5 -5
- package/dist/resources/Sources/SourcesInterfaces.js +4 -4
- package/dist/resources/Sources/SourcesMappings/SourcesMappings.js +21 -21
- package/dist/resources/Sources/SourcesMappings/SourcesMappingsInterfaces.js +2 -2
- package/dist/resources/Sources/SourcesMappings/index.js +5 -5
- package/dist/resources/Sources/SourcesMetadata/SourcesMetadata.js +23 -23
- package/dist/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js +2 -2
- package/dist/resources/Sources/SourcesMetadata/index.js +5 -5
- package/dist/resources/Sources/SourcesSubInterfaces/Address.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/Authentification.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/Document.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/Error.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/ExtendedDataFile.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/Extension.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/Information.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/Parameter.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/Permission.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/Url.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/User.js +2 -2
- package/dist/resources/Sources/SourcesSubInterfaces/index.js +14 -14
- package/dist/resources/Sources/index.js +9 -9
- package/dist/resources/TableauService/ContentQuery/ContentQuery.js +22 -22
- package/dist/resources/TableauService/ContentQuery/ContentQueryInterfaces.js +2 -2
- package/dist/resources/TableauService/ContentQuery/index.js +5 -5
- package/dist/resources/TableauService/TableauService.js +17 -17
- package/dist/resources/TableauService/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/Administration/Administration.js +25 -25
- package/dist/resources/UsageAnalytics/Read/Administration/AdministrationInterfaces.js +2 -2
- package/dist/resources/UsageAnalytics/Read/Administration/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/DataShare/DataShare.js +25 -25
- package/dist/resources/UsageAnalytics/Read/DataShare/DataShareInterfaces.js +2 -2
- package/dist/resources/UsageAnalytics/Read/DataShare/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/Dimensions/Dimensions.js +60 -60
- package/dist/resources/UsageAnalytics/Read/Dimensions/DimensionsInterfaces.js +2 -2
- package/dist/resources/UsageAnalytics/Read/Dimensions/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/Exports/Exports.js +59 -59
- package/dist/resources/UsageAnalytics/Read/Exports/ExportsInterfaces.js +2 -2
- package/dist/resources/UsageAnalytics/Read/Exports/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/Filters/Filters.js +111 -111
- package/dist/resources/UsageAnalytics/Read/Filters/FiltersInterfaces.js +2 -2
- package/dist/resources/UsageAnalytics/Read/Filters/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/Reports/Reports.js +99 -99
- package/dist/resources/UsageAnalytics/Read/Reports/ReportsInterfaces.js +8 -8
- package/dist/resources/UsageAnalytics/Read/Reports/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/Snowflake/Snowflake.js +46 -46
- package/dist/resources/UsageAnalytics/Read/Snowflake/SnowflakeInterfaces.js +2 -2
- package/dist/resources/UsageAnalytics/Read/Snowflake/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/Statistics/Statistics.js +52 -52
- package/dist/resources/UsageAnalytics/Read/Statistics/StatisticsInterfaces.js +2 -2
- package/dist/resources/UsageAnalytics/Read/Statistics/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/Users/Users.js +34 -34
- package/dist/resources/UsageAnalytics/Read/Users/UsersInterfaces.js +2 -2
- package/dist/resources/UsageAnalytics/Read/Users/index.js +5 -5
- package/dist/resources/UsageAnalytics/Read/index.js +12 -12
- package/dist/resources/UsageAnalytics/UsageAnalytics.js +31 -31
- package/dist/resources/UsageAnalytics/index.js +5 -5
- package/dist/resources/Users/User.js +25 -25
- package/dist/resources/Users/UserInterfaces.js +2 -2
- package/dist/resources/Users/index.js +5 -5
- package/dist/resources/Vaults/Vaults.js +54 -54
- package/dist/resources/Vaults/VaultsInterfaces.js +2 -2
- package/dist/resources/Vaults/index.js +5 -5
- package/dist/resources/index.js +51 -51
- package/dist/utils/FormData.js +14 -0
- package/dist/utils/FormData.js.map +1 -0
- package/dist/utils/Retriever.js +4 -4
- package/dist/utils/WithRequired.js +2 -2
- package/dist/utils/index.js +5 -5
- package/dist/utils/normalizePaginatedOptions.js +24 -24
- package/package.json +7 -7
|
@@ -1,209 +1,209 @@
|
|
|
1
|
-
import { ProductsFacetRequestSortType, ProductsSortByType, SortingOrder } from '../Enums';
|
|
2
|
-
export interface AdvancedFiltersModel {
|
|
3
|
-
queryFilter: string;
|
|
4
|
-
}
|
|
5
|
-
export interface AdvancedParametersModel {
|
|
6
|
-
/**
|
|
7
|
-
* Used to retrieve debug information. Will have an impact on query performance.
|
|
8
|
-
*/
|
|
9
|
-
debug?: boolean;
|
|
10
|
-
/**
|
|
11
|
-
* Used to retrieve all documents regardless of their security model.
|
|
12
|
-
*/
|
|
13
|
-
viewAllContent?: boolean;
|
|
14
|
-
}
|
|
15
|
-
export interface FacetRequestOptions {
|
|
16
|
-
/**
|
|
17
|
-
* Whether to take into account the scores generated by the index when reordering facets.
|
|
18
|
-
*/
|
|
19
|
-
enableIndexFacetOrdering?: boolean;
|
|
20
|
-
/**
|
|
21
|
-
* Whether facets should be returned in the same order in which they were requested.
|
|
22
|
-
*/
|
|
23
|
-
freezeFacetOrder?: boolean;
|
|
24
|
-
}
|
|
25
|
-
export interface FacetRequestItem {
|
|
26
|
-
/**
|
|
27
|
-
* The values displayed by the facet in the search interface at the moment of the request.
|
|
28
|
-
*/
|
|
29
|
-
currentValues?: any[];
|
|
30
|
-
/**
|
|
31
|
-
* A custom sort order for the facet values.
|
|
32
|
-
*/
|
|
33
|
-
customOrder?: string[];
|
|
34
|
-
/**
|
|
35
|
-
* The unique identifier of the facet in the search interface.
|
|
36
|
-
*/
|
|
37
|
-
facetId?: string;
|
|
38
|
-
/**
|
|
39
|
-
* The name of the field on which to base the facet request.
|
|
40
|
-
*/
|
|
41
|
-
field: string;
|
|
42
|
-
/**
|
|
43
|
-
* Whether the facet is expanded in the search interface at the moment of the request.
|
|
44
|
-
*/
|
|
45
|
-
isFieldExpanded?: boolean;
|
|
46
|
-
/**
|
|
47
|
-
* The maximum number of facet values to fetch.
|
|
48
|
-
*/
|
|
49
|
-
numberOfValues?: number;
|
|
50
|
-
/**
|
|
51
|
-
* Whether to prevent Coveo ML from automatically selecting facet values.
|
|
52
|
-
*/
|
|
53
|
-
preventAutoSelect?: boolean;
|
|
54
|
-
/**
|
|
55
|
-
* The criterion to use for sorting returned facet values.
|
|
56
|
-
*/
|
|
57
|
-
sortCriteria?: ProductsFacetRequestSortType;
|
|
58
|
-
}
|
|
59
|
-
export interface FacetsRequestModel {
|
|
60
|
-
/**
|
|
61
|
-
* The facet options to add to the request.
|
|
62
|
-
*/
|
|
63
|
-
options?: FacetRequestOptions;
|
|
64
|
-
/**
|
|
65
|
-
* The facet operations to perform on the products listings.
|
|
66
|
-
*/
|
|
67
|
-
requests: FacetRequestItem[];
|
|
68
|
-
}
|
|
69
|
-
export interface PaginatedModel {
|
|
70
|
-
/**
|
|
71
|
-
* The number of elements to list per page.
|
|
72
|
-
*/
|
|
73
|
-
numberOfValues?: number;
|
|
74
|
-
/**
|
|
75
|
-
* The 0-based index number of the page of elements to retrieve.
|
|
76
|
-
*/
|
|
77
|
-
page?: number;
|
|
78
|
-
}
|
|
79
|
-
export interface SortByFields {
|
|
80
|
-
/**
|
|
81
|
-
* The name of the field.
|
|
82
|
-
*/
|
|
83
|
-
name: string;
|
|
84
|
-
/**
|
|
85
|
-
* The sorting direction.
|
|
86
|
-
*/
|
|
87
|
-
direction: SortingOrder;
|
|
88
|
-
}
|
|
89
|
-
export interface SortModel {
|
|
90
|
-
/**
|
|
91
|
-
* The name of the field to sort by.
|
|
92
|
-
*/
|
|
93
|
-
by: ProductsSortByType;
|
|
94
|
-
/**
|
|
95
|
-
* The fields to take into consideration when sorting.
|
|
96
|
-
*/
|
|
97
|
-
fields?: SortByFields[];
|
|
98
|
-
}
|
|
99
|
-
export interface ProductsRequestModel {
|
|
100
|
-
/**
|
|
101
|
-
* Additional fields allow you to collect additional information, besides the standard data.
|
|
102
|
-
*/
|
|
103
|
-
additionalFields?: string[];
|
|
104
|
-
/**
|
|
105
|
-
*
|
|
106
|
-
*/
|
|
107
|
-
advancedFiltersModel?: AdvancedFiltersModel;
|
|
108
|
-
/**
|
|
109
|
-
* Advanced parameters to retrieve more information from the search queries.
|
|
110
|
-
*/
|
|
111
|
-
advancedParameters?: AdvancedParametersModel;
|
|
112
|
-
/**
|
|
113
|
-
* An anonymous identifier used to determine from which identity the query comes from.
|
|
114
|
-
*/
|
|
115
|
-
clientId?: string;
|
|
116
|
-
/**
|
|
117
|
-
* Parameters related to the facet request.
|
|
118
|
-
*/
|
|
119
|
-
facets?: FacetsRequestModel;
|
|
120
|
-
/**
|
|
121
|
-
* Pagination parameters for the returned products.
|
|
122
|
-
*/
|
|
123
|
-
pagination?: PaginatedModel;
|
|
124
|
-
/**
|
|
125
|
-
* Determines the order in which to retrieve the results.
|
|
126
|
-
*/
|
|
127
|
-
sort?: SortModel;
|
|
128
|
-
/**
|
|
129
|
-
* The URL used to retrieve the products listings.
|
|
130
|
-
*/
|
|
131
|
-
url: string;
|
|
132
|
-
}
|
|
133
|
-
export interface FacetResultModel {
|
|
134
|
-
facetId: string;
|
|
135
|
-
field: string;
|
|
136
|
-
fromAutoSelect: boolean;
|
|
137
|
-
indexScore: number;
|
|
138
|
-
mlScore: number;
|
|
139
|
-
moreValuesAvailable: boolean;
|
|
140
|
-
values: any[];
|
|
141
|
-
}
|
|
142
|
-
export interface FacetResponseModel {
|
|
143
|
-
/**
|
|
144
|
-
* A list of facet results.
|
|
145
|
-
*/
|
|
146
|
-
results: FacetResultModel[];
|
|
147
|
-
}
|
|
148
|
-
export interface PaginationResultModel {
|
|
149
|
-
/**
|
|
150
|
-
* The number of elements.
|
|
151
|
-
*/
|
|
152
|
-
totalCount: number;
|
|
153
|
-
}
|
|
154
|
-
export interface ProductListingIdentityModel {
|
|
155
|
-
/**
|
|
156
|
-
* Associated catalog id.
|
|
157
|
-
*/
|
|
158
|
-
catalogId: string;
|
|
159
|
-
/**
|
|
160
|
-
* The product listing unique id.
|
|
161
|
-
*/
|
|
162
|
-
id: string;
|
|
163
|
-
}
|
|
164
|
-
export interface ProductModel {
|
|
165
|
-
additionalFields: Map<string, any>;
|
|
166
|
-
childResults: ProductModel[];
|
|
167
|
-
clickUri: string;
|
|
168
|
-
ec_brand: string;
|
|
169
|
-
ec_category: string[];
|
|
170
|
-
ec_cogs: number;
|
|
171
|
-
ec_description: string;
|
|
172
|
-
ec_images: string[];
|
|
173
|
-
ec_in_stock: boolean;
|
|
174
|
-
ec_item_group_id: string;
|
|
175
|
-
ec_name: string;
|
|
176
|
-
ec_price: number;
|
|
177
|
-
ec_promo_price: number;
|
|
178
|
-
ec_rating: number;
|
|
179
|
-
ec_shortdesc: string;
|
|
180
|
-
ec_thumbnails: string[];
|
|
181
|
-
permanentid: string;
|
|
182
|
-
totalNumberOfChildResults: number;
|
|
183
|
-
}
|
|
184
|
-
export interface ProductsResultModel {
|
|
185
|
-
/**
|
|
186
|
-
* The execution report.
|
|
187
|
-
*/
|
|
188
|
-
executionReport: Map<string, any>;
|
|
189
|
-
/**
|
|
190
|
-
* The list of facet results.
|
|
191
|
-
*/
|
|
192
|
-
facets: FacetResponseModel;
|
|
193
|
-
/**
|
|
194
|
-
* The number of total elements returned.
|
|
195
|
-
*/
|
|
196
|
-
pagination: PaginationResultModel;
|
|
197
|
-
/**
|
|
198
|
-
* The product listing identity model.
|
|
199
|
-
*/
|
|
200
|
-
productListing: ProductListingIdentityModel;
|
|
201
|
-
/**
|
|
202
|
-
* A list of products.
|
|
203
|
-
*/
|
|
204
|
-
products: ProductModel[];
|
|
205
|
-
/**
|
|
206
|
-
* The response unique id.
|
|
207
|
-
*/
|
|
208
|
-
responseId: string;
|
|
209
|
-
}
|
|
1
|
+
import { ProductsFacetRequestSortType, ProductsSortByType, SortingOrder } from '../Enums';
|
|
2
|
+
export interface AdvancedFiltersModel {
|
|
3
|
+
queryFilter: string;
|
|
4
|
+
}
|
|
5
|
+
export interface AdvancedParametersModel {
|
|
6
|
+
/**
|
|
7
|
+
* Used to retrieve debug information. Will have an impact on query performance.
|
|
8
|
+
*/
|
|
9
|
+
debug?: boolean;
|
|
10
|
+
/**
|
|
11
|
+
* Used to retrieve all documents regardless of their security model.
|
|
12
|
+
*/
|
|
13
|
+
viewAllContent?: boolean;
|
|
14
|
+
}
|
|
15
|
+
export interface FacetRequestOptions {
|
|
16
|
+
/**
|
|
17
|
+
* Whether to take into account the scores generated by the index when reordering facets.
|
|
18
|
+
*/
|
|
19
|
+
enableIndexFacetOrdering?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Whether facets should be returned in the same order in which they were requested.
|
|
22
|
+
*/
|
|
23
|
+
freezeFacetOrder?: boolean;
|
|
24
|
+
}
|
|
25
|
+
export interface FacetRequestItem {
|
|
26
|
+
/**
|
|
27
|
+
* The values displayed by the facet in the search interface at the moment of the request.
|
|
28
|
+
*/
|
|
29
|
+
currentValues?: any[];
|
|
30
|
+
/**
|
|
31
|
+
* A custom sort order for the facet values.
|
|
32
|
+
*/
|
|
33
|
+
customOrder?: string[];
|
|
34
|
+
/**
|
|
35
|
+
* The unique identifier of the facet in the search interface.
|
|
36
|
+
*/
|
|
37
|
+
facetId?: string;
|
|
38
|
+
/**
|
|
39
|
+
* The name of the field on which to base the facet request.
|
|
40
|
+
*/
|
|
41
|
+
field: string;
|
|
42
|
+
/**
|
|
43
|
+
* Whether the facet is expanded in the search interface at the moment of the request.
|
|
44
|
+
*/
|
|
45
|
+
isFieldExpanded?: boolean;
|
|
46
|
+
/**
|
|
47
|
+
* The maximum number of facet values to fetch.
|
|
48
|
+
*/
|
|
49
|
+
numberOfValues?: number;
|
|
50
|
+
/**
|
|
51
|
+
* Whether to prevent Coveo ML from automatically selecting facet values.
|
|
52
|
+
*/
|
|
53
|
+
preventAutoSelect?: boolean;
|
|
54
|
+
/**
|
|
55
|
+
* The criterion to use for sorting returned facet values.
|
|
56
|
+
*/
|
|
57
|
+
sortCriteria?: ProductsFacetRequestSortType;
|
|
58
|
+
}
|
|
59
|
+
export interface FacetsRequestModel {
|
|
60
|
+
/**
|
|
61
|
+
* The facet options to add to the request.
|
|
62
|
+
*/
|
|
63
|
+
options?: FacetRequestOptions;
|
|
64
|
+
/**
|
|
65
|
+
* The facet operations to perform on the products listings.
|
|
66
|
+
*/
|
|
67
|
+
requests: FacetRequestItem[];
|
|
68
|
+
}
|
|
69
|
+
export interface PaginatedModel {
|
|
70
|
+
/**
|
|
71
|
+
* The number of elements to list per page.
|
|
72
|
+
*/
|
|
73
|
+
numberOfValues?: number;
|
|
74
|
+
/**
|
|
75
|
+
* The 0-based index number of the page of elements to retrieve.
|
|
76
|
+
*/
|
|
77
|
+
page?: number;
|
|
78
|
+
}
|
|
79
|
+
export interface SortByFields {
|
|
80
|
+
/**
|
|
81
|
+
* The name of the field.
|
|
82
|
+
*/
|
|
83
|
+
name: string;
|
|
84
|
+
/**
|
|
85
|
+
* The sorting direction.
|
|
86
|
+
*/
|
|
87
|
+
direction: SortingOrder;
|
|
88
|
+
}
|
|
89
|
+
export interface SortModel {
|
|
90
|
+
/**
|
|
91
|
+
* The name of the field to sort by.
|
|
92
|
+
*/
|
|
93
|
+
by: ProductsSortByType;
|
|
94
|
+
/**
|
|
95
|
+
* The fields to take into consideration when sorting.
|
|
96
|
+
*/
|
|
97
|
+
fields?: SortByFields[];
|
|
98
|
+
}
|
|
99
|
+
export interface ProductsRequestModel {
|
|
100
|
+
/**
|
|
101
|
+
* Additional fields allow you to collect additional information, besides the standard data.
|
|
102
|
+
*/
|
|
103
|
+
additionalFields?: string[];
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
*/
|
|
107
|
+
advancedFiltersModel?: AdvancedFiltersModel;
|
|
108
|
+
/**
|
|
109
|
+
* Advanced parameters to retrieve more information from the search queries.
|
|
110
|
+
*/
|
|
111
|
+
advancedParameters?: AdvancedParametersModel;
|
|
112
|
+
/**
|
|
113
|
+
* An anonymous identifier used to determine from which identity the query comes from.
|
|
114
|
+
*/
|
|
115
|
+
clientId?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Parameters related to the facet request.
|
|
118
|
+
*/
|
|
119
|
+
facets?: FacetsRequestModel;
|
|
120
|
+
/**
|
|
121
|
+
* Pagination parameters for the returned products.
|
|
122
|
+
*/
|
|
123
|
+
pagination?: PaginatedModel;
|
|
124
|
+
/**
|
|
125
|
+
* Determines the order in which to retrieve the results.
|
|
126
|
+
*/
|
|
127
|
+
sort?: SortModel;
|
|
128
|
+
/**
|
|
129
|
+
* The URL used to retrieve the products listings.
|
|
130
|
+
*/
|
|
131
|
+
url: string;
|
|
132
|
+
}
|
|
133
|
+
export interface FacetResultModel {
|
|
134
|
+
facetId: string;
|
|
135
|
+
field: string;
|
|
136
|
+
fromAutoSelect: boolean;
|
|
137
|
+
indexScore: number;
|
|
138
|
+
mlScore: number;
|
|
139
|
+
moreValuesAvailable: boolean;
|
|
140
|
+
values: any[];
|
|
141
|
+
}
|
|
142
|
+
export interface FacetResponseModel {
|
|
143
|
+
/**
|
|
144
|
+
* A list of facet results.
|
|
145
|
+
*/
|
|
146
|
+
results: FacetResultModel[];
|
|
147
|
+
}
|
|
148
|
+
export interface PaginationResultModel {
|
|
149
|
+
/**
|
|
150
|
+
* The number of elements.
|
|
151
|
+
*/
|
|
152
|
+
totalCount: number;
|
|
153
|
+
}
|
|
154
|
+
export interface ProductListingIdentityModel {
|
|
155
|
+
/**
|
|
156
|
+
* Associated catalog id.
|
|
157
|
+
*/
|
|
158
|
+
catalogId: string;
|
|
159
|
+
/**
|
|
160
|
+
* The product listing unique id.
|
|
161
|
+
*/
|
|
162
|
+
id: string;
|
|
163
|
+
}
|
|
164
|
+
export interface ProductModel {
|
|
165
|
+
additionalFields: Map<string, any>;
|
|
166
|
+
childResults: ProductModel[];
|
|
167
|
+
clickUri: string;
|
|
168
|
+
ec_brand: string;
|
|
169
|
+
ec_category: string[];
|
|
170
|
+
ec_cogs: number;
|
|
171
|
+
ec_description: string;
|
|
172
|
+
ec_images: string[];
|
|
173
|
+
ec_in_stock: boolean;
|
|
174
|
+
ec_item_group_id: string;
|
|
175
|
+
ec_name: string;
|
|
176
|
+
ec_price: number;
|
|
177
|
+
ec_promo_price: number;
|
|
178
|
+
ec_rating: number;
|
|
179
|
+
ec_shortdesc: string;
|
|
180
|
+
ec_thumbnails: string[];
|
|
181
|
+
permanentid: string;
|
|
182
|
+
totalNumberOfChildResults: number;
|
|
183
|
+
}
|
|
184
|
+
export interface ProductsResultModel {
|
|
185
|
+
/**
|
|
186
|
+
* The execution report.
|
|
187
|
+
*/
|
|
188
|
+
executionReport: Map<string, any>;
|
|
189
|
+
/**
|
|
190
|
+
* The list of facet results.
|
|
191
|
+
*/
|
|
192
|
+
facets: FacetResponseModel;
|
|
193
|
+
/**
|
|
194
|
+
* The number of total elements returned.
|
|
195
|
+
*/
|
|
196
|
+
pagination: PaginationResultModel;
|
|
197
|
+
/**
|
|
198
|
+
* The product listing identity model.
|
|
199
|
+
*/
|
|
200
|
+
productListing: ProductListingIdentityModel;
|
|
201
|
+
/**
|
|
202
|
+
* A list of products.
|
|
203
|
+
*/
|
|
204
|
+
products: ProductModel[];
|
|
205
|
+
/**
|
|
206
|
+
* The response unique id.
|
|
207
|
+
*/
|
|
208
|
+
responseId: string;
|
|
209
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './Product';
|
|
2
|
-
export * from './ProductInterfaces';
|
|
1
|
+
export * from './Product';
|
|
2
|
+
export * from './ProductInterfaces';
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import Resource from '../Resource';
|
|
2
|
-
import { SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SecurityIdentityOptions } from './PushApiInterfaces';
|
|
3
|
-
export default class PushApi extends Resource {
|
|
4
|
-
static baseUrl: string;
|
|
5
|
-
createOrUpdateSecurityIdentityAlias(securityProviderId: string, alias: SecurityIdentityAliasModel, options?: SecurityIdentityOptions): Promise<void>;
|
|
6
|
-
deleteSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityDelete, options?: SecurityIdentityOptions): Promise<void>;
|
|
7
|
-
createOrUpdateSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityModel, options?: SecurityIdentityOptions): Promise<void>;
|
|
8
|
-
manageSecurityIdentities(securityProviderId: string, batchConfig: SecurityIdentityBatchConfig): Promise<void>;
|
|
9
|
-
deleteOldSecurityIdentities(securityProviderId: string, batchDelete: SecurityIdentityDeleteOptions): Promise<void>;
|
|
10
|
-
}
|
|
1
|
+
import Resource from '../Resource';
|
|
2
|
+
import { SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SecurityIdentityOptions } from './PushApiInterfaces';
|
|
3
|
+
export default class PushApi extends Resource {
|
|
4
|
+
static baseUrl: string;
|
|
5
|
+
createOrUpdateSecurityIdentityAlias(securityProviderId: string, alias: SecurityIdentityAliasModel, options?: SecurityIdentityOptions): Promise<void>;
|
|
6
|
+
deleteSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityDelete, options?: SecurityIdentityOptions): Promise<void>;
|
|
7
|
+
createOrUpdateSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityModel, options?: SecurityIdentityOptions): Promise<void>;
|
|
8
|
+
manageSecurityIdentities(securityProviderId: string, batchConfig: SecurityIdentityBatchConfig): Promise<void>;
|
|
9
|
+
deleteOldSecurityIdentities(securityProviderId: string, batchDelete: SecurityIdentityDeleteOptions): Promise<void>;
|
|
10
|
+
}
|
|
@@ -1,37 +1,37 @@
|
|
|
1
|
-
import { SinglePermissionResult, SinglePermissionIdentityType } from '../Enums';
|
|
2
|
-
export interface SecurityIdentityAliasModel extends SecurityIdentityBase {
|
|
3
|
-
mappings: AliasMappings;
|
|
4
|
-
}
|
|
5
|
-
export interface SecurityIdentityModel extends SecurityIdentityBase {
|
|
6
|
-
members?: Identity[];
|
|
7
|
-
}
|
|
8
|
-
export interface SecurityIdentityDelete {
|
|
9
|
-
identity: Identity;
|
|
10
|
-
}
|
|
11
|
-
export interface SecurityIdentityDeleteOptions extends Required<SecurityIdentityOptions> {
|
|
12
|
-
queueDelay?: number;
|
|
13
|
-
}
|
|
14
|
-
export interface SecurityIdentityOptions {
|
|
15
|
-
orderingId?: number;
|
|
16
|
-
}
|
|
17
|
-
export interface SecurityIdentityBatchConfig {
|
|
18
|
-
fileId: string;
|
|
19
|
-
orderingId?: string;
|
|
20
|
-
}
|
|
21
|
-
interface SecurityIdentityBase {
|
|
22
|
-
Result?: {
|
|
23
|
-
errorDetails: string;
|
|
24
|
-
result: SinglePermissionResult;
|
|
25
|
-
};
|
|
26
|
-
identity?: Identity;
|
|
27
|
-
wellKnowns?: Identity[];
|
|
28
|
-
}
|
|
29
|
-
interface AliasMappings extends Identity {
|
|
30
|
-
provider: string;
|
|
31
|
-
}
|
|
32
|
-
interface Identity {
|
|
33
|
-
additionalInfo: Record<string, string>;
|
|
34
|
-
name: string;
|
|
35
|
-
type: SinglePermissionIdentityType;
|
|
36
|
-
}
|
|
37
|
-
export {};
|
|
1
|
+
import { SinglePermissionResult, SinglePermissionIdentityType } from '../Enums';
|
|
2
|
+
export interface SecurityIdentityAliasModel extends SecurityIdentityBase {
|
|
3
|
+
mappings: AliasMappings;
|
|
4
|
+
}
|
|
5
|
+
export interface SecurityIdentityModel extends SecurityIdentityBase {
|
|
6
|
+
members?: Identity[];
|
|
7
|
+
}
|
|
8
|
+
export interface SecurityIdentityDelete {
|
|
9
|
+
identity: Identity;
|
|
10
|
+
}
|
|
11
|
+
export interface SecurityIdentityDeleteOptions extends Required<SecurityIdentityOptions> {
|
|
12
|
+
queueDelay?: number;
|
|
13
|
+
}
|
|
14
|
+
export interface SecurityIdentityOptions {
|
|
15
|
+
orderingId?: number;
|
|
16
|
+
}
|
|
17
|
+
export interface SecurityIdentityBatchConfig {
|
|
18
|
+
fileId: string;
|
|
19
|
+
orderingId?: string;
|
|
20
|
+
}
|
|
21
|
+
interface SecurityIdentityBase {
|
|
22
|
+
Result?: {
|
|
23
|
+
errorDetails: string;
|
|
24
|
+
result: SinglePermissionResult;
|
|
25
|
+
};
|
|
26
|
+
identity?: Identity;
|
|
27
|
+
wellKnowns?: Identity[];
|
|
28
|
+
}
|
|
29
|
+
interface AliasMappings extends Identity {
|
|
30
|
+
provider: string;
|
|
31
|
+
}
|
|
32
|
+
interface Identity {
|
|
33
|
+
additionalInfo: Record<string, string>;
|
|
34
|
+
name: string;
|
|
35
|
+
type: SinglePermissionIdentityType;
|
|
36
|
+
}
|
|
37
|
+
export {};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './PushApi';
|
|
2
|
-
export * from './PushApiInterfaces';
|
|
1
|
+
export * from './PushApi';
|
|
2
|
+
export * from './PushApiInterfaces';
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import API from '../APICore';
|
|
2
|
-
declare class Resource {
|
|
3
|
-
protected api: API;
|
|
4
|
-
protected serverlessApi: API;
|
|
5
|
-
static baseUrl: string;
|
|
6
|
-
constructor(api: API, serverlessApi: API);
|
|
7
|
-
protected buildPath(route: string, parameters: any): string;
|
|
8
|
-
private convertObjectToQueryString;
|
|
9
|
-
}
|
|
10
|
-
export default Resource;
|
|
1
|
+
import API from '../APICore';
|
|
2
|
+
declare class Resource {
|
|
3
|
+
protected api: API;
|
|
4
|
+
protected serverlessApi: API;
|
|
5
|
+
static baseUrl: string;
|
|
6
|
+
constructor(api: API, serverlessApi: API);
|
|
7
|
+
protected buildPath(route: string, parameters: any): string;
|
|
8
|
+
private convertObjectToQueryString;
|
|
9
|
+
}
|
|
10
|
+
export default Resource;
|
|
@@ -1,52 +1,52 @@
|
|
|
1
|
-
import Resource from '../Resource';
|
|
2
|
-
import { ApplyOptions, CreateFromFileOptions, CreateFromOrganizationOptions, DryRunOptions, ExportSnapshotContentOptions, GenerateUrlOptions, GetSnapshotOptions, PushSnapshotOptions, ResourceSnapshotExportConfigurationModel, ResourceSnapshotsModel, ResourceSnapshotsReportModel, ResourceSnapshotsSynchronizationPlanModel, ResourceSnapshotsSynchronizationReportModel, ResourceSnapshotType, ResourceSnapshotUrlModel, SnapshotAccessModel, SnapshotDiffModel, SnapshotListParams, UpdateChildrenOptions, ValidateAccessOptions } from './ResourceSnapshotsInterfaces';
|
|
3
|
-
export default class ResourceSnapshots extends Resource {
|
|
4
|
-
static baseUrl: string;
|
|
5
|
-
list(params?: SnapshotListParams): Promise<ResourceSnapshotsModel[]>;
|
|
6
|
-
get(snapshotId: string, options?: GetSnapshotOptions): Promise<ResourceSnapshotsModel>;
|
|
7
|
-
/**
|
|
8
|
-
* Lists the resources that the authenticated user can leverage in snapshots in the target organization.
|
|
9
|
-
*/
|
|
10
|
-
listResourceAccess(): Promise<ResourceSnapshotType[]>;
|
|
11
|
-
/**
|
|
12
|
-
* Shows whether the authenticated user has the specified access level (i.e., read or write) to the content of the target snapshot.
|
|
13
|
-
*/
|
|
14
|
-
validateAccess(snapshotId: string, options: ValidateAccessOptions): Promise<SnapshotAccessModel>;
|
|
15
|
-
/**
|
|
16
|
-
* Retrieves a ZIP file holding the content of the target snapshot, in the target format.
|
|
17
|
-
*
|
|
18
|
-
* @param {string} snapshotId The unique identifier of the target snapshot.
|
|
19
|
-
* @param {ExportSnapshotContentOptions} [options]
|
|
20
|
-
* @returns {Promise<Blob>} A newly created Blob object which contains the zipped snapshot
|
|
21
|
-
*/
|
|
22
|
-
export(snapshotId: string, options?: ExportSnapshotContentOptions): Promise<Blob>;
|
|
23
|
-
getContent(snapshotId: string, options: GenerateUrlOptions): Promise<Response>;
|
|
24
|
-
/**
|
|
25
|
-
* Creates a snapshot from a file containing the configuration.
|
|
26
|
-
*
|
|
27
|
-
* @param {File} file The file containing the configuration.
|
|
28
|
-
* @param {CreateFromFileOptions} options
|
|
29
|
-
*/
|
|
30
|
-
createFromFile(file: File, options?: CreateFromFileOptions): Promise<ResourceSnapshotsModel>;
|
|
31
|
-
createFromOrganization(exportConfigurationModel: ResourceSnapshotExportConfigurationModel, options: CreateFromOrganizationOptions): Promise<ResourceSnapshotsModel>;
|
|
32
|
-
generateUrl(snapshotId: string, options: GenerateUrlOptions): Promise<ResourceSnapshotUrlModel>;
|
|
33
|
-
dryRun(snapshotId: string, options: DryRunOptions): Promise<ResourceSnapshotsReportModel>;
|
|
34
|
-
apply(snapshotId: string, options: ApplyOptions): Promise<ResourceSnapshotsReportModel>;
|
|
35
|
-
push(snapshotId: string, options: PushSnapshotOptions): Promise<Record<string, unknown>>;
|
|
36
|
-
delete(snapshotId: string): Promise<Record<string, unknown>>;
|
|
37
|
-
createSynchronizationPlan(snapshotId: string): Promise<ResourceSnapshotsSynchronizationPlanModel>;
|
|
38
|
-
getSynchronizationPlan(snapshotId: string, synchronizationPlanId: string): Promise<ResourceSnapshotsSynchronizationPlanModel>;
|
|
39
|
-
updateSynchronizationPlan(snapshotId: string, synchronizationPlanId: string, synchronizationPlanModel: ResourceSnapshotsSynchronizationPlanModel): Promise<ResourceSnapshotsSynchronizationPlanModel>;
|
|
40
|
-
applySynchronizationPlan(snapshotId: string, synchronizationPlanId: string): Promise<ResourceSnapshotsSynchronizationReportModel>;
|
|
41
|
-
updateSynchronizationPlanForChildren(snapshotId: string, synchronizationPlanId: string, options: UpdateChildrenOptions): Promise<ResourceSnapshotsSynchronizationPlanModel>;
|
|
42
|
-
private getSnapshotFileType;
|
|
43
|
-
/**
|
|
44
|
-
* @description Shows the diff report for the target snapshot and dry-run report
|
|
45
|
-
* @experimental
|
|
46
|
-
*
|
|
47
|
-
* @param {string} snapshotId - The unique identifier of the target snapshot.
|
|
48
|
-
* @param {string} relativeReportId - The unique identifier of the dry-run operation report associated with the target diff report.
|
|
49
|
-
* @param {(number|undefined)} [numberOfLinesMax=undefined] - Maximum number of lines before the diff is downloaded to a file.
|
|
50
|
-
*/
|
|
51
|
-
diff(snapshotId: string, relativeReportId: string, numberOfLinesMax?: number): Promise<SnapshotDiffModel>;
|
|
52
|
-
}
|
|
1
|
+
import Resource from '../Resource';
|
|
2
|
+
import { ApplyOptions, CreateFromFileOptions, CreateFromOrganizationOptions, DryRunOptions, ExportSnapshotContentOptions, GenerateUrlOptions, GetSnapshotOptions, PushSnapshotOptions, ResourceSnapshotExportConfigurationModel, ResourceSnapshotsModel, ResourceSnapshotsReportModel, ResourceSnapshotsSynchronizationPlanModel, ResourceSnapshotsSynchronizationReportModel, ResourceSnapshotType, ResourceSnapshotUrlModel, SnapshotAccessModel, SnapshotDiffModel, SnapshotListParams, UpdateChildrenOptions, ValidateAccessOptions } from './ResourceSnapshotsInterfaces';
|
|
3
|
+
export default class ResourceSnapshots extends Resource {
|
|
4
|
+
static baseUrl: string;
|
|
5
|
+
list(params?: SnapshotListParams): Promise<ResourceSnapshotsModel[]>;
|
|
6
|
+
get(snapshotId: string, options?: GetSnapshotOptions): Promise<ResourceSnapshotsModel>;
|
|
7
|
+
/**
|
|
8
|
+
* Lists the resources that the authenticated user can leverage in snapshots in the target organization.
|
|
9
|
+
*/
|
|
10
|
+
listResourceAccess(): Promise<ResourceSnapshotType[]>;
|
|
11
|
+
/**
|
|
12
|
+
* Shows whether the authenticated user has the specified access level (i.e., read or write) to the content of the target snapshot.
|
|
13
|
+
*/
|
|
14
|
+
validateAccess(snapshotId: string, options: ValidateAccessOptions): Promise<SnapshotAccessModel>;
|
|
15
|
+
/**
|
|
16
|
+
* Retrieves a ZIP file holding the content of the target snapshot, in the target format.
|
|
17
|
+
*
|
|
18
|
+
* @param {string} snapshotId The unique identifier of the target snapshot.
|
|
19
|
+
* @param {ExportSnapshotContentOptions} [options]
|
|
20
|
+
* @returns {Promise<Blob>} A newly created Blob object which contains the zipped snapshot
|
|
21
|
+
*/
|
|
22
|
+
export(snapshotId: string, options?: ExportSnapshotContentOptions): Promise<Blob>;
|
|
23
|
+
getContent(snapshotId: string, options: GenerateUrlOptions): Promise<Response>;
|
|
24
|
+
/**
|
|
25
|
+
* Creates a snapshot from a file containing the configuration.
|
|
26
|
+
*
|
|
27
|
+
* @param {File} file The file containing the configuration.
|
|
28
|
+
* @param {CreateFromFileOptions} options
|
|
29
|
+
*/
|
|
30
|
+
createFromFile(file: File, options?: CreateFromFileOptions): Promise<ResourceSnapshotsModel>;
|
|
31
|
+
createFromOrganization(exportConfigurationModel: ResourceSnapshotExportConfigurationModel, options: CreateFromOrganizationOptions): Promise<ResourceSnapshotsModel>;
|
|
32
|
+
generateUrl(snapshotId: string, options: GenerateUrlOptions): Promise<ResourceSnapshotUrlModel>;
|
|
33
|
+
dryRun(snapshotId: string, options: DryRunOptions): Promise<ResourceSnapshotsReportModel>;
|
|
34
|
+
apply(snapshotId: string, options: ApplyOptions): Promise<ResourceSnapshotsReportModel>;
|
|
35
|
+
push(snapshotId: string, options: PushSnapshotOptions): Promise<Record<string, unknown>>;
|
|
36
|
+
delete(snapshotId: string): Promise<Record<string, unknown>>;
|
|
37
|
+
createSynchronizationPlan(snapshotId: string): Promise<ResourceSnapshotsSynchronizationPlanModel>;
|
|
38
|
+
getSynchronizationPlan(snapshotId: string, synchronizationPlanId: string): Promise<ResourceSnapshotsSynchronizationPlanModel>;
|
|
39
|
+
updateSynchronizationPlan(snapshotId: string, synchronizationPlanId: string, synchronizationPlanModel: ResourceSnapshotsSynchronizationPlanModel): Promise<ResourceSnapshotsSynchronizationPlanModel>;
|
|
40
|
+
applySynchronizationPlan(snapshotId: string, synchronizationPlanId: string): Promise<ResourceSnapshotsSynchronizationReportModel>;
|
|
41
|
+
updateSynchronizationPlanForChildren(snapshotId: string, synchronizationPlanId: string, options: UpdateChildrenOptions): Promise<ResourceSnapshotsSynchronizationPlanModel>;
|
|
42
|
+
private getSnapshotFileType;
|
|
43
|
+
/**
|
|
44
|
+
* @description Shows the diff report for the target snapshot and dry-run report
|
|
45
|
+
* @experimental
|
|
46
|
+
*
|
|
47
|
+
* @param {string} snapshotId - The unique identifier of the target snapshot.
|
|
48
|
+
* @param {string} relativeReportId - The unique identifier of the dry-run operation report associated with the target diff report.
|
|
49
|
+
* @param {(number|undefined)} [numberOfLinesMax=undefined] - Maximum number of lines before the diff is downloaded to a file.
|
|
50
|
+
*/
|
|
51
|
+
diff(snapshotId: string, relativeReportId: string, numberOfLinesMax?: number): Promise<SnapshotDiffModel>;
|
|
52
|
+
}
|