@coveo/platform-client 55.13.2 → 56.1.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/cjs/APICore.js +17 -4
- package/dist/cjs/APICore.js.map +1 -1
- package/dist/cjs/handlers/request/RequestHandlers.js +2 -1
- package/dist/cjs/handlers/request/RequestHandlers.js.map +1 -1
- package/dist/cjs/handlers/response/ResponseHandlers.js +14 -8
- package/dist/cjs/handlers/response/ResponseHandlers.js.map +1 -1
- package/dist/cjs/resources/Activities/Activities.js +4 -5
- package/dist/cjs/resources/Activities/Activities.js.map +1 -1
- package/dist/cjs/resources/AnalyticsAdmin/Properties/Properties.js +7 -6
- package/dist/cjs/resources/AnalyticsAdmin/Properties/Properties.js.map +1 -1
- package/dist/cjs/resources/ApiKeys/ApiKeys.js.map +1 -1
- package/dist/cjs/resources/Catalogs/Catalog.js +2 -1
- package/dist/cjs/resources/Catalogs/Catalog.js.map +1 -1
- package/dist/cjs/resources/Catalogs/ProductListing.js +10 -0
- package/dist/cjs/resources/Catalogs/ProductListing.js.map +1 -1
- package/dist/cjs/resources/Catalogs/ProductListingConfiguration.js +16 -0
- package/dist/cjs/resources/Catalogs/ProductListingConfiguration.js.map +1 -1
- package/dist/cjs/resources/Enums.js.map +1 -1
- package/dist/cjs/resources/Extensions/Extensions.js +4 -2
- package/dist/cjs/resources/Extensions/Extensions.js.map +1 -1
- package/dist/cjs/resources/Fields/Fields.js +1 -0
- package/dist/cjs/resources/Fields/Fields.js.map +1 -1
- package/dist/cjs/resources/InProductExperiences/InProductExperiences.js +1 -0
- package/dist/cjs/resources/InProductExperiences/InProductExperiences.js.map +1 -1
- package/dist/cjs/resources/InProductExperiences/InProductExperiencesInterfaces.js +0 -2
- package/dist/cjs/resources/InProductExperiences/InProductExperiencesInterfaces.js.map +1 -1
- package/dist/cjs/resources/Indexes/Documents/Documents.js +5 -8
- package/dist/cjs/resources/Indexes/Documents/Documents.js.map +1 -1
- package/dist/cjs/resources/License/LicenseInterfaces.js.map +1 -1
- package/dist/cjs/resources/Limits/Limits.js +0 -1
- package/dist/cjs/resources/Limits/Limits.js.map +1 -1
- package/dist/cjs/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js +4 -0
- package/dist/cjs/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js.map +1 -1
- package/dist/cjs/resources/MachineLearning/MachineLearning.js +7 -4
- package/dist/cjs/resources/MachineLearning/MachineLearning.js.map +1 -1
- package/dist/cjs/resources/MachineLearning/MachineLearningInterfaces.js +13 -0
- package/dist/cjs/resources/MachineLearning/MachineLearningInterfaces.js.map +1 -1
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfo.js +13 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfo.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfoInterfaces.js +3 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfoInterfaces.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetails.js +3 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetails.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsBuildingStats.js +3 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsBuildingStats.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsCommerceEvents.js +3 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsCommerceEvents.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsLanguages.js +3 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsLanguages.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsStatsPerSource.js +3 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsStatsPerSource.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsSubModels.js +3 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsSubModels.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/index.js +10 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/details/index.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/index.js +7 -0
- package/dist/cjs/resources/MachineLearning/ModelDetailedInfo/index.js.map +1 -0
- package/dist/cjs/resources/MachineLearning/index.js +9 -8
- package/dist/cjs/resources/MachineLearning/index.js.map +1 -1
- package/dist/cjs/resources/Organizations/Members/Members.js +3 -5
- package/dist/cjs/resources/Organizations/Members/Members.js.map +1 -1
- package/dist/cjs/resources/Organizations/Organization.js +2 -0
- package/dist/cjs/resources/Organizations/Organization.js.map +1 -1
- package/dist/cjs/resources/Organizations/OrganizationInterfaces.js.map +1 -1
- package/dist/cjs/resources/Pipelines/Conditions/Condition.js +6 -12
- package/dist/cjs/resources/Pipelines/Conditions/Condition.js.map +1 -1
- package/dist/cjs/resources/Pipelines/ResultRankings/ResultRankings.js +0 -1
- package/dist/cjs/resources/Pipelines/ResultRankings/ResultRankings.js.map +1 -1
- package/dist/cjs/resources/Pipelines/StatementGroups/StatementGroupsInterfaces.js.map +1 -1
- package/dist/cjs/resources/Pipelines/Statements/Statements.js +34 -44
- package/dist/cjs/resources/Pipelines/Statements/Statements.js.map +1 -1
- package/dist/cjs/resources/PrivilegeEvaluator/PrivilegeEvaluator.js +1 -2
- package/dist/cjs/resources/PrivilegeEvaluator/PrivilegeEvaluator.js.map +1 -1
- package/dist/cjs/resources/Products/Product.js +2 -0
- package/dist/cjs/resources/Products/Product.js.map +1 -1
- package/dist/cjs/resources/Projects/Project.js +19 -27
- package/dist/cjs/resources/Projects/Project.js.map +1 -1
- package/dist/cjs/resources/Projects/ProjectInterfaces.js +0 -2
- package/dist/cjs/resources/Projects/ProjectInterfaces.js.map +1 -1
- package/dist/cjs/resources/Resource.js +1 -1
- package/dist/cjs/resources/Resource.js.map +1 -1
- package/dist/cjs/resources/ResourceSnapshots/ResourceSnapshots.js +10 -11
- package/dist/cjs/resources/ResourceSnapshots/ResourceSnapshots.js.map +1 -1
- package/dist/cjs/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js.map +1 -1
- package/dist/cjs/resources/Resources/Resources.js +2 -3
- package/dist/cjs/resources/Resources/Resources.js.map +1 -1
- package/dist/cjs/resources/SchemaService/SchemaService.js +15 -21
- package/dist/cjs/resources/SchemaService/SchemaService.js.map +1 -1
- package/dist/cjs/resources/Search/Search.js +12 -1
- package/dist/cjs/resources/Search/Search.js.map +1 -1
- package/dist/cjs/resources/SearchAnalysis/SearchAnalysis.js +0 -1
- package/dist/cjs/resources/SearchAnalysis/SearchAnalysis.js.map +1 -1
- package/dist/cjs/resources/Sources/Sources.js +1 -0
- package/dist/cjs/resources/Sources/Sources.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Administration/Administration.js +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Administration/Administration.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js +8 -2
- package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/DataShare/DataShare.js +2 -0
- package/dist/cjs/resources/UsageAnalytics/Read/DataShare/DataShare.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Dimensions/Dimensions.js +8 -8
- package/dist/cjs/resources/UsageAnalytics/Read/Dimensions/Dimensions.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Exports/Exports.js +3 -13
- package/dist/cjs/resources/UsageAnalytics/Read/Exports/Exports.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Filters/Filters.js +7 -9
- package/dist/cjs/resources/UsageAnalytics/Read/Filters/Filters.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/ReadServiceResource.js +0 -1
- package/dist/cjs/resources/UsageAnalytics/Read/ReadServiceResource.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Reports/Reports.js +8 -9
- package/dist/cjs/resources/UsageAnalytics/Read/Reports/Reports.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Snowflake/Snowflake.js +0 -7
- package/dist/cjs/resources/UsageAnalytics/Read/Snowflake/Snowflake.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Statistics/Statistics.js +10 -1
- package/dist/cjs/resources/UsageAnalytics/Read/Statistics/Statistics.js.map +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/UAUsers/UAUsers.js +4 -5
- package/dist/cjs/resources/UsageAnalytics/Read/UAUsers/UAUsers.js.map +1 -1
- package/dist/cjs/resources/Vaults/Vaults.js +6 -10
- package/dist/cjs/resources/Vaults/Vaults.js.map +1 -1
- package/dist/cjs/utils/createFetcher.js +0 -1
- package/dist/cjs/utils/createFetcher.js.map +1 -1
- package/dist/cjs/utils/normalizePaginatedOptions.js +3 -0
- package/dist/cjs/utils/normalizePaginatedOptions.js.map +1 -1
- package/dist/cjs/utils/stringifyNestedObjects.js.map +1 -1
- package/dist/esm/APICore.js +17 -4
- package/dist/esm/APICore.js.map +1 -1
- package/dist/esm/handlers/request/RequestHandlers.js +2 -1
- package/dist/esm/handlers/request/RequestHandlers.js.map +1 -1
- package/dist/esm/handlers/response/ResponseHandlers.js +14 -8
- package/dist/esm/handlers/response/ResponseHandlers.js.map +1 -1
- package/dist/esm/resources/Activities/Activities.js +4 -5
- package/dist/esm/resources/Activities/Activities.js.map +1 -1
- package/dist/esm/resources/AnalyticsAdmin/Properties/Properties.js +7 -6
- package/dist/esm/resources/AnalyticsAdmin/Properties/Properties.js.map +1 -1
- package/dist/esm/resources/ApiKeys/ApiKeys.js.map +1 -1
- package/dist/esm/resources/Catalogs/Catalog.js +2 -1
- package/dist/esm/resources/Catalogs/Catalog.js.map +1 -1
- package/dist/esm/resources/Catalogs/ProductListing.js +10 -0
- package/dist/esm/resources/Catalogs/ProductListing.js.map +1 -1
- package/dist/esm/resources/Catalogs/ProductListingConfiguration.js +16 -0
- package/dist/esm/resources/Catalogs/ProductListingConfiguration.js.map +1 -1
- package/dist/esm/resources/Enums.js.map +1 -1
- package/dist/esm/resources/Extensions/Extensions.js +4 -2
- package/dist/esm/resources/Extensions/Extensions.js.map +1 -1
- package/dist/esm/resources/Fields/Fields.js +1 -0
- package/dist/esm/resources/Fields/Fields.js.map +1 -1
- package/dist/esm/resources/InProductExperiences/InProductExperiences.js +1 -0
- package/dist/esm/resources/InProductExperiences/InProductExperiences.js.map +1 -1
- package/dist/esm/resources/InProductExperiences/InProductExperiencesInterfaces.js +0 -2
- package/dist/esm/resources/InProductExperiences/InProductExperiencesInterfaces.js.map +1 -1
- package/dist/esm/resources/Indexes/Documents/Documents.js +5 -8
- package/dist/esm/resources/Indexes/Documents/Documents.js.map +1 -1
- package/dist/esm/resources/License/LicenseInterfaces.js.map +1 -1
- package/dist/esm/resources/Limits/Limits.js +0 -1
- package/dist/esm/resources/Limits/Limits.js.map +1 -1
- package/dist/esm/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js +4 -0
- package/dist/esm/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.js.map +1 -1
- package/dist/esm/resources/MachineLearning/MachineLearning.js +7 -4
- package/dist/esm/resources/MachineLearning/MachineLearning.js.map +1 -1
- package/dist/esm/resources/MachineLearning/MachineLearningInterfaces.js +12 -1
- package/dist/esm/resources/MachineLearning/MachineLearningInterfaces.js.map +1 -1
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfo.js +9 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfo.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfoInterfaces.js +2 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfoInterfaces.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetails.js +2 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetails.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsBuildingStats.js +2 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsBuildingStats.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsCommerceEvents.js +2 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsCommerceEvents.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsLanguages.js +2 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsLanguages.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsStatsPerSource.js +2 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsStatsPerSource.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsSubModels.js +2 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsSubModels.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/index.js +7 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/details/index.js.map +1 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/index.js +4 -0
- package/dist/esm/resources/MachineLearning/ModelDetailedInfo/index.js.map +1 -0
- package/dist/esm/resources/MachineLearning/index.js +9 -8
- package/dist/esm/resources/MachineLearning/index.js.map +1 -1
- package/dist/esm/resources/Organizations/Members/Members.js +3 -5
- package/dist/esm/resources/Organizations/Members/Members.js.map +1 -1
- package/dist/esm/resources/Organizations/Organization.js +2 -0
- package/dist/esm/resources/Organizations/Organization.js.map +1 -1
- package/dist/esm/resources/Organizations/OrganizationInterfaces.js.map +1 -1
- package/dist/esm/resources/Pipelines/Conditions/Condition.js +6 -12
- package/dist/esm/resources/Pipelines/Conditions/Condition.js.map +1 -1
- package/dist/esm/resources/Pipelines/ResultRankings/ResultRankings.js +0 -1
- package/dist/esm/resources/Pipelines/ResultRankings/ResultRankings.js.map +1 -1
- package/dist/esm/resources/Pipelines/StatementGroups/StatementGroupsInterfaces.js.map +1 -1
- package/dist/esm/resources/Pipelines/Statements/Statements.js +34 -44
- package/dist/esm/resources/Pipelines/Statements/Statements.js.map +1 -1
- package/dist/esm/resources/PrivilegeEvaluator/PrivilegeEvaluator.js +1 -2
- package/dist/esm/resources/PrivilegeEvaluator/PrivilegeEvaluator.js.map +1 -1
- package/dist/esm/resources/Products/Product.js +2 -0
- package/dist/esm/resources/Products/Product.js.map +1 -1
- package/dist/esm/resources/Projects/Project.js +19 -27
- package/dist/esm/resources/Projects/Project.js.map +1 -1
- package/dist/esm/resources/Projects/ProjectInterfaces.js +0 -2
- package/dist/esm/resources/Projects/ProjectInterfaces.js.map +1 -1
- package/dist/esm/resources/Resource.js +1 -1
- package/dist/esm/resources/Resource.js.map +1 -1
- package/dist/esm/resources/ResourceSnapshots/ResourceSnapshots.js +10 -11
- package/dist/esm/resources/ResourceSnapshots/ResourceSnapshots.js.map +1 -1
- package/dist/esm/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js.map +1 -1
- package/dist/esm/resources/Resources/Resources.js +2 -3
- package/dist/esm/resources/Resources/Resources.js.map +1 -1
- package/dist/esm/resources/SchemaService/SchemaService.js +15 -21
- package/dist/esm/resources/SchemaService/SchemaService.js.map +1 -1
- package/dist/esm/resources/Search/Search.js +12 -1
- package/dist/esm/resources/Search/Search.js.map +1 -1
- package/dist/esm/resources/SearchAnalysis/SearchAnalysis.js +0 -1
- package/dist/esm/resources/SearchAnalysis/SearchAnalysis.js.map +1 -1
- package/dist/esm/resources/Sources/Sources.js +1 -0
- package/dist/esm/resources/Sources/Sources.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Administration/Administration.js +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Administration/Administration.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js +8 -2
- package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/DataShare/DataShare.js +2 -0
- package/dist/esm/resources/UsageAnalytics/Read/DataShare/DataShare.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Dimensions/Dimensions.js +8 -8
- package/dist/esm/resources/UsageAnalytics/Read/Dimensions/Dimensions.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Exports/Exports.js +3 -13
- package/dist/esm/resources/UsageAnalytics/Read/Exports/Exports.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Filters/Filters.js +7 -9
- package/dist/esm/resources/UsageAnalytics/Read/Filters/Filters.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/ReadServiceResource.js +0 -1
- package/dist/esm/resources/UsageAnalytics/Read/ReadServiceResource.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Reports/Reports.js +8 -9
- package/dist/esm/resources/UsageAnalytics/Read/Reports/Reports.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Snowflake/Snowflake.js +0 -7
- package/dist/esm/resources/UsageAnalytics/Read/Snowflake/Snowflake.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Statistics/Statistics.js +10 -1
- package/dist/esm/resources/UsageAnalytics/Read/Statistics/Statistics.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/UAUsers/UAUsers.js +4 -5
- package/dist/esm/resources/UsageAnalytics/Read/UAUsers/UAUsers.js.map +1 -1
- package/dist/esm/resources/Vaults/Vaults.js +6 -10
- package/dist/esm/resources/Vaults/Vaults.js.map +1 -1
- package/dist/esm/utils/createFetcher.js +0 -1
- package/dist/esm/utils/createFetcher.js.map +1 -1
- package/dist/esm/utils/normalizePaginatedOptions.js +3 -0
- package/dist/esm/utils/normalizePaginatedOptions.js.map +1 -1
- package/dist/esm/utils/stringifyNestedObjects.js.map +1 -1
- package/dist/types/APICore.d.ts +3 -3
- package/dist/types/handlers/request/RequestHandlerInterfaces.d.ts +0 -1
- package/dist/types/handlers/response/ResponseHandlers.d.ts +8 -2
- package/dist/types/resources/Activities/Activities.d.ts +2 -3
- package/dist/types/resources/AnalyticsAdmin/Properties/Properties.d.ts +8 -7
- package/dist/types/resources/CaseAssistConfigs/CaseAssistConfigInterfaces.d.ts +1 -2
- package/dist/types/resources/Catalogs/Catalog.d.ts +2 -0
- package/dist/types/resources/Catalogs/ProductListing.d.ts +10 -0
- package/dist/types/resources/Catalogs/ProductListingConfiguration.d.ts +16 -0
- package/dist/types/resources/CrawlingModule/CrawlingModuleInterfaces.d.ts +0 -4
- package/dist/types/resources/Extensions/Extensions.d.ts +4 -2
- package/dist/types/resources/Extensions/ExtensionsInterfaces.d.ts +0 -2
- package/dist/types/resources/Fields/Fields.d.ts +1 -0
- package/dist/types/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.d.ts +0 -5
- package/dist/types/resources/IPXInterfaces/IPXInterface.model.d.ts +4 -8
- package/dist/types/resources/InProductExperiences/InProductExperiences.d.ts +1 -0
- package/dist/types/resources/InProductExperiences/InProductExperiencesInterfaces.d.ts +0 -1
- package/dist/types/resources/Indexes/Documents/Documents.d.ts +5 -8
- package/dist/types/resources/InsightPanelConfigs/InsightPanelConfigInterfaces.d.ts +0 -5
- package/dist/types/resources/InsightPanelInterfaces/InsightPanelInterface.model.d.ts +7 -14
- package/dist/types/resources/InternalBaseInterface.d.ts +0 -1
- package/dist/types/resources/Limits/Limits.d.ts +0 -1
- package/dist/types/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfiguration.d.ts +4 -0
- package/dist/types/resources/MachineLearning/DocumentInterfaces.d.ts +0 -1
- package/dist/types/resources/MachineLearning/IAPRConfiguration/IAPRConfigurationInterfaces.d.ts +0 -1
- package/dist/types/resources/MachineLearning/MachineLearning.d.ts +6 -4
- package/dist/types/resources/MachineLearning/MachineLearningInterfaces.d.ts +11 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfo.d.ts +6 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/ModelDetailedInfoInterfaces.d.ts +95 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetails.d.ts +21 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsBuildingStats.d.ts +30 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsCommerceEvents.d.ts +6 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsLanguages.d.ts +8 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsStatsPerSource.d.ts +7 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/ModelDetailsSubModels.d.ts +5 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/details/index.d.ts +6 -0
- package/dist/types/resources/MachineLearning/ModelDetailedInfo/index.d.ts +3 -0
- package/dist/types/resources/MachineLearning/ModelListing/ModelListingInterfaces.d.ts +3 -15
- package/dist/types/resources/MachineLearning/PQSConfiguration/PQSConfigurationInterfaces.d.ts +0 -1
- package/dist/types/resources/MachineLearning/RGAConfiguration/RelevanceGenerativeAnsweringConfigurationInterface.d.ts +0 -2
- package/dist/types/resources/MachineLearning/SemanticEncoderConfiguration/SemanticEncoderConfigurationInterfaces.d.ts +0 -2
- package/dist/types/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts +0 -2
- package/dist/types/resources/MachineLearning/index.d.ts +9 -8
- package/dist/types/resources/Organizations/Members/Members.d.ts +3 -5
- package/dist/types/resources/Organizations/Organization.d.ts +3 -1
- package/dist/types/resources/Organizations/OrganizationInterfaces.d.ts +1 -7
- package/dist/types/resources/Pipelines/Conditions/Condition.d.ts +6 -12
- package/dist/types/resources/Pipelines/Conditions/ConditionInterfaces.d.ts +0 -2
- package/dist/types/resources/Pipelines/MLAssociations/MLAssociationsInterfaces.d.ts +1 -2
- package/dist/types/resources/Pipelines/PipelinesInterfaces.d.ts +0 -15
- package/dist/types/resources/Pipelines/ResultRankings/ResultRankings.d.ts +0 -1
- package/dist/types/resources/Pipelines/ResultRankings/ResultRankingsInterfaces.d.ts +0 -1
- package/dist/types/resources/Pipelines/StatementGroups/StatementGroupsInterfaces.d.ts +2 -12
- package/dist/types/resources/Pipelines/Statements/Statements.d.ts +34 -44
- package/dist/types/resources/PrivilegeEvaluator/PrivilegeEvaluator.d.ts +1 -2
- package/dist/types/resources/Products/Product.d.ts +2 -0
- package/dist/types/resources/Projects/Project.d.ts +19 -27
- package/dist/types/resources/Projects/ProjectInterfaces.d.ts +0 -9
- package/dist/types/resources/Resource.d.ts +1 -1
- package/dist/types/resources/ResourceSnapshots/ResourceSnapshots.d.ts +10 -11
- package/dist/types/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts +0 -5
- package/dist/types/resources/Resources/Resources.d.ts +2 -3
- package/dist/types/resources/SchemaService/SchemaService.d.ts +16 -24
- package/dist/types/resources/SchemaService/SchemaServiceInterfaces.d.ts +1 -2
- package/dist/types/resources/Search/Search.d.ts +11 -1
- package/dist/types/resources/Search/SearchInterfaces.d.ts +2 -196
- package/dist/types/resources/SearchAnalysis/SearchAnalysis.d.ts +0 -1
- package/dist/types/resources/SearchPages/SearchPagesInterfaces.d.ts +2 -4
- package/dist/types/resources/SearchUsageMetrics/SearchHubs/SearchHubsInterface.d.ts +0 -3
- package/dist/types/resources/Sources/Sources.d.ts +1 -0
- package/dist/types/resources/UsageAnalytics/Read/Administration/Administration.d.ts +1 -1
- package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealth.d.ts +9 -3
- package/dist/types/resources/UsageAnalytics/Read/DataShare/DataShare.d.ts +2 -0
- package/dist/types/resources/UsageAnalytics/Read/Dimensions/Dimensions.d.ts +8 -8
- package/dist/types/resources/UsageAnalytics/Read/Dimensions/DimensionsInterfaces.d.ts +0 -1
- package/dist/types/resources/UsageAnalytics/Read/Exports/Exports.d.ts +3 -13
- package/dist/types/resources/UsageAnalytics/Read/Filters/Filters.d.ts +7 -9
- package/dist/types/resources/UsageAnalytics/Read/ReadServiceResource.d.ts +1 -2
- package/dist/types/resources/UsageAnalytics/Read/Reports/Reports.d.ts +8 -9
- package/dist/types/resources/UsageAnalytics/Read/Reports/ReportsInterfaces.d.ts +1 -2
- package/dist/types/resources/UsageAnalytics/Read/Snowflake/Snowflake.d.ts +0 -7
- package/dist/types/resources/UsageAnalytics/Read/Snowflake/SnowflakeInterfaces.d.ts +1 -2
- package/dist/types/resources/UsageAnalytics/Read/Statistics/Statistics.d.ts +10 -1
- package/dist/types/resources/UsageAnalytics/Read/Statistics/StatisticsInterfaces.d.ts +2 -4
- package/dist/types/resources/UsageAnalytics/Read/UAUsers/UAUsers.d.ts +4 -5
- package/dist/types/resources/Users/UserInterfaces.d.ts +1 -1
- package/dist/types/resources/Vaults/Vaults.d.ts +6 -10
- package/dist/types/utils/createFetcher.d.ts +0 -1
- package/dist/types/utils/stringifyNestedObjects.d.ts +1 -1
- package/package.json +10 -12
|
@@ -4,7 +4,6 @@ export default class SearchAnalysis extends Resource {
|
|
|
4
4
|
static baseUrl: string;
|
|
5
5
|
/**
|
|
6
6
|
* Replay a query that was already done and get inspection details.
|
|
7
|
-
*
|
|
8
7
|
* @param id The SearchUID of the request to replay.
|
|
9
8
|
* @param from The inclusive date at which to start looking for the request. Example: 2019-08-24T14:15:22Z
|
|
10
9
|
* @param to The inclusive date at which to stop looking for the SearchUID. When omitted searches up until the most recent requests. Example:2019-08-24T14:15:22Z
|
|
@@ -9,10 +9,8 @@ export interface SearchPageModel extends GranularResource {
|
|
|
9
9
|
css?: CSSResourceModel[];
|
|
10
10
|
lastModified?: string;
|
|
11
11
|
}
|
|
12
|
-
export
|
|
13
|
-
|
|
14
|
-
export interface UpdateSearchPageModel extends Pick<SearchPageModel, 'name' | 'title' | 'html'> {
|
|
15
|
-
}
|
|
12
|
+
export type CreateSearchPageModel = Pick<SearchPageModel, 'name' | 'title'>;
|
|
13
|
+
export type UpdateSearchPageModel = Pick<SearchPageModel, 'name' | 'title' | 'html'>;
|
|
16
14
|
export type JavaScriptResourceModel = SearchPageResourceModel;
|
|
17
15
|
export type CSSResourceModel = SearchPageResourceModel;
|
|
18
16
|
export type SearchPageResourceModel = SearchPageResourceModelWithUrl | SearchPageResourceModelWithInlineContent;
|
|
@@ -30,19 +30,16 @@ export interface ListSearchHubsParams extends Paginated {
|
|
|
30
30
|
filter?: string;
|
|
31
31
|
/**
|
|
32
32
|
* The maximum number of search hubs to list per page
|
|
33
|
-
*
|
|
34
33
|
* @default `100`
|
|
35
34
|
*/
|
|
36
35
|
perPage?: number;
|
|
37
36
|
/**
|
|
38
37
|
* The 0-based index number of page to list
|
|
39
|
-
*
|
|
40
38
|
* @default `0`
|
|
41
39
|
*/
|
|
42
40
|
page?: number;
|
|
43
41
|
/**
|
|
44
42
|
* The minimum queries a search hub must have to be listed
|
|
45
|
-
*
|
|
46
43
|
* @default '1'
|
|
47
44
|
*/
|
|
48
45
|
minimumQueries?: string;
|
|
@@ -8,12 +8,12 @@ export default class Administration extends ReadServiceResource {
|
|
|
8
8
|
getAccount(): Promise<AccountResponseV15>;
|
|
9
9
|
/**
|
|
10
10
|
* Edit an account.
|
|
11
|
-
*
|
|
12
11
|
* @param model The account information.
|
|
13
12
|
*/
|
|
14
13
|
updateAccount(model: AccountInfoModelV15): Promise<AccountResponseV15>;
|
|
15
14
|
/**
|
|
16
15
|
* Get example values that would be rejected by strict validation for the specified dimension.
|
|
16
|
+
* @param params
|
|
17
17
|
*/
|
|
18
18
|
getStrictValidationTest(params: StrictValidationTestParams): Promise<StrictValidationTestResponseV15>;
|
|
19
19
|
}
|
|
@@ -4,49 +4,55 @@ export default class DataHealth extends ReadServiceResource {
|
|
|
4
4
|
static baseUrl: string;
|
|
5
5
|
/**
|
|
6
6
|
* Get health information about events.
|
|
7
|
+
* @param params
|
|
7
8
|
*/
|
|
8
9
|
listEvents(params: DataHealthListEventsParameters): Promise<DataHealthListEventsResponse>;
|
|
9
10
|
/**
|
|
10
11
|
* Get original event payload.
|
|
12
|
+
* @param params
|
|
11
13
|
*/
|
|
12
14
|
getEventPayload(params: DataHealthGetEventPayloadParams): Promise<DataHealthEventPayloadResponse>;
|
|
13
15
|
/**
|
|
14
16
|
* List applicable facet values in the specified time range.
|
|
17
|
+
* @param params
|
|
15
18
|
*/
|
|
16
19
|
listFacetValues(params: DataHealthListFacetValueParams): Promise<DataHealthListFacetsResponse>;
|
|
17
20
|
/**
|
|
18
21
|
* Get general data health information.
|
|
22
|
+
* @param params
|
|
19
23
|
*/
|
|
20
24
|
getOverview(params: DataHealthGetOverviewParams): Promise<DataHealthGetOverviewResponse>;
|
|
21
25
|
/**
|
|
22
26
|
* Get health information about groups of validation rules.
|
|
27
|
+
* @param params
|
|
23
28
|
*/
|
|
24
29
|
getGroupListing(params: DataHealthGetGroupListingParams): Promise<DataHealthGetGroupListingResponse>;
|
|
25
30
|
/**
|
|
26
31
|
* Get health information about validation rules of a specific group.
|
|
32
|
+
* @param params
|
|
27
33
|
*/
|
|
28
34
|
getGroupDetail(params: DataHealthGetGroupDetailParams): Promise<DataHealthGetGroupDetailResponse>;
|
|
29
35
|
/**
|
|
30
36
|
* Get a list of unique tracking ids.
|
|
37
|
+
* @param params
|
|
31
38
|
*/
|
|
32
39
|
getTrackingIds(params: DataHealthGetTrackingIdsParams): Promise<DataHealthGetTrackingIdsResponse>;
|
|
33
40
|
/**
|
|
34
41
|
* Get problems about events.
|
|
42
|
+
* @param params
|
|
35
43
|
*/
|
|
36
44
|
getEventsProblems(params: DataHealthGetEventProblemsParams): Promise<EventProblemsResponse>;
|
|
37
45
|
/**
|
|
38
46
|
* Get failed instances for a data health criterion
|
|
39
|
-
*
|
|
40
47
|
* @param params Parameters to fetch data health failed instances.
|
|
41
48
|
*/
|
|
42
49
|
getFailedInstances(params: DataHealthGetFailedInstancesParams): Promise<DataHealthGetFailedInstancesResponse>;
|
|
43
50
|
/**
|
|
44
51
|
* Build the request path, handling the optional `org` query parameter.
|
|
45
|
-
*
|
|
46
52
|
* @param route The path part of the request.
|
|
47
53
|
* @param queryParams Optional query parameters object.
|
|
48
54
|
* If this object contains an `org` property, it will override the value from the configuration.
|
|
49
55
|
* @returns The request path including formatted query parameters.
|
|
50
56
|
*/
|
|
51
|
-
protected buildPathWithOrg(route: string, queryParams?:
|
|
57
|
+
protected buildPathWithOrg(route: string, queryParams?: object): string;
|
|
52
58
|
}
|
|
@@ -8,10 +8,12 @@ export default class DataShare extends ReadServiceResource {
|
|
|
8
8
|
listSnowflakeAccount(): Promise<SnowflakeAccountDataSharingAccountModel[]>;
|
|
9
9
|
/**
|
|
10
10
|
* Add a Snowflake account to Secure Data Sharing.
|
|
11
|
+
* @param params
|
|
11
12
|
*/
|
|
12
13
|
addSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
|
|
13
14
|
/**
|
|
14
15
|
* Removes a Snowflake account from Secure Data Sharing.
|
|
16
|
+
* @param params
|
|
15
17
|
*/
|
|
16
18
|
deleteSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
|
|
17
19
|
/**
|
|
@@ -6,57 +6,57 @@ export default class Dimensions extends ReadServiceResource implements ReadServi
|
|
|
6
6
|
static baseUrl: string;
|
|
7
7
|
/**
|
|
8
8
|
* Get all the dimensions.
|
|
9
|
+
* @param params
|
|
9
10
|
*/
|
|
10
11
|
list(params?: ListDimensionsParams): Promise<DimensionModel[]>;
|
|
11
12
|
/**
|
|
12
13
|
* Get all the exportable dimensions.
|
|
14
|
+
* @param params
|
|
13
15
|
*/
|
|
14
16
|
listExportableDimensions(params?: ListDimensionsParams): Promise<DimensionModel[]>;
|
|
15
17
|
/**
|
|
16
18
|
* Get a dimension.
|
|
17
|
-
*
|
|
18
19
|
* @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
|
|
19
20
|
*/
|
|
20
21
|
get(apiName: string): Promise<DimensionModel>;
|
|
21
22
|
/**
|
|
22
23
|
* Get the values for a dimension.
|
|
23
|
-
*
|
|
24
24
|
* @param dimension The dimension to fetch.
|
|
25
|
+
* @param params
|
|
25
26
|
*/
|
|
26
27
|
getValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
|
|
27
28
|
/**
|
|
28
29
|
* Get all the custom dimensions.
|
|
29
|
-
*
|
|
30
30
|
* @param includeOnlyParents This will filter out dimensions which are covered by others.
|
|
31
31
|
* Only parent/master dimensions will be output.
|
|
32
32
|
*/
|
|
33
33
|
listCustomDimensions(includeOnlyParents?: boolean): Promise<DimensionModel[]>;
|
|
34
34
|
/**
|
|
35
35
|
* Create a custom dimension.
|
|
36
|
+
* @param model
|
|
37
|
+
* @param params
|
|
36
38
|
*/
|
|
37
39
|
createCustomDimension(model: CustomDimensionModel, params: CreateCustomDimensionParams): Promise<DimensionModel>;
|
|
38
40
|
/**
|
|
39
41
|
* Get a custom dimension.
|
|
40
|
-
*
|
|
41
42
|
* @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
|
|
42
43
|
*/
|
|
43
44
|
getCustomDimension(apiName: string): Promise<DimensionModel>;
|
|
44
45
|
/**
|
|
45
46
|
* Get the values for a custom dimension.
|
|
46
|
-
*
|
|
47
47
|
* @param dimension The dimension to fetch.
|
|
48
|
+
* @param params
|
|
48
49
|
*/
|
|
49
50
|
getCustomDimensionValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
|
|
50
51
|
/**
|
|
51
52
|
* Create or edit a custom dimension.
|
|
52
|
-
*
|
|
53
53
|
* @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
|
|
54
|
+
* @param model
|
|
54
55
|
* @param updatePastEvents Whether to update the custom dimension in past events (deprecated).
|
|
55
56
|
*/
|
|
56
57
|
updateCustomDimension(apiName: string, model: CustomDimensionModel, updatePastEvents?: boolean): Promise<DimensionModel>;
|
|
57
58
|
/**
|
|
58
59
|
* Delete a custom dimension.
|
|
59
|
-
*
|
|
60
60
|
* @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
|
|
61
61
|
*/
|
|
62
62
|
deleteCustomDimension(apiName: string): Promise<void>;
|
|
@@ -70,8 +70,8 @@ export default class Dimensions extends ReadServiceResource implements ReadServi
|
|
|
70
70
|
checkCustomDimensionHealth(): Promise<Record<string, string>>;
|
|
71
71
|
/**
|
|
72
72
|
* Get a list of dimensions that have data but are not created yet.
|
|
73
|
-
*
|
|
74
73
|
* @param event The type of event for which to look for suggestions.
|
|
74
|
+
* @param params
|
|
75
75
|
*/
|
|
76
76
|
listUncreatedDimensions(event: DimensionEventTypes, params?: ListUncreatedDimensionsParams): Promise<CustomDimensionSuggestionsModel>;
|
|
77
77
|
checkHealth(): Promise<ReadServiceHealthResponse>;
|
|
@@ -9,56 +9,49 @@ export default class Exports extends ReadServiceResource implements ReadServiceH
|
|
|
9
9
|
list(): Promise<ExportModel[]>;
|
|
10
10
|
/**
|
|
11
11
|
* Generate an export.
|
|
12
|
-
*
|
|
13
12
|
* @param params The parameters to generate the export with.
|
|
14
13
|
*/
|
|
15
14
|
generate(params: GenerateExportParams): Promise<ExportModel>;
|
|
16
15
|
/**
|
|
17
16
|
* Generate an export with the parameters in the request body.
|
|
18
|
-
*
|
|
19
17
|
* @param params The parameters to generate the export with, passed in the request body.
|
|
18
|
+
* @param args
|
|
20
19
|
*/
|
|
21
20
|
generateExportWithBody(params: GenerateExportWithBodyParams, args?: RequestInit): Promise<ExportModel>;
|
|
22
21
|
/**
|
|
23
22
|
* Get information on an export.
|
|
24
|
-
*
|
|
25
23
|
* @param exportId The export's unique identifier.
|
|
26
24
|
* @param redirect Whether to return a HTTP redirect to the actual file.
|
|
27
25
|
*/
|
|
28
26
|
get(exportId: string, redirect?: boolean): Promise<ExportModel>;
|
|
29
27
|
/**
|
|
30
28
|
* Get the download link of an export.
|
|
31
|
-
*
|
|
32
29
|
* @param exportId The export's unique identifier.
|
|
33
30
|
*/
|
|
34
31
|
getExportDownloadLink(exportId: string): Promise<ExportDownloadLink>;
|
|
35
32
|
/**
|
|
36
33
|
* Delete an export.
|
|
37
|
-
*
|
|
38
34
|
* @param exportId The export's unique identifier.
|
|
39
35
|
*/
|
|
40
36
|
delete(exportId: string): Promise<void>;
|
|
41
37
|
/**
|
|
42
38
|
* Estimate the number of rows in an export.
|
|
43
|
-
*
|
|
44
39
|
* @param params The date range and other parameters for the export.
|
|
45
40
|
*/
|
|
46
41
|
estimateRowsCount(params: EstimateExportParams): Promise<ExportEstimateModel>;
|
|
47
42
|
/**
|
|
48
43
|
* Generate a visit export.
|
|
49
|
-
*
|
|
50
44
|
* @param params The parameters to generate the visit export with.
|
|
51
45
|
*/
|
|
52
46
|
generateVisitExport(params: GenerateVisitExportParams): Promise<ExportModel>;
|
|
53
47
|
/**
|
|
54
48
|
* Generate a visit export with the parameters in the request body.
|
|
55
|
-
*
|
|
56
49
|
* @param params The parameters to generate the visit export with, passed in the request body.
|
|
50
|
+
* @param args
|
|
57
51
|
*/
|
|
58
52
|
generateVisitExportWithBody(params: GenerateVisitExportWithBodyParams, args?: RequestInit): Promise<ExportModel>;
|
|
59
53
|
/**
|
|
60
54
|
* Estimate the number of rows in a visit export.
|
|
61
|
-
*
|
|
62
55
|
* @param params The parameters of the visit export to estimate.
|
|
63
56
|
*/
|
|
64
57
|
estimateVisitExportRowsCount(params: EstimateVisitExportParams): Promise<ExportEstimateModel>;
|
|
@@ -68,25 +61,22 @@ export default class Exports extends ReadServiceResource implements ReadServiceH
|
|
|
68
61
|
listSchedules(): Promise<ExportScheduleModel[]>;
|
|
69
62
|
/**
|
|
70
63
|
* Create an export schedule.
|
|
71
|
-
*
|
|
72
64
|
* @param model The export schedule to create.
|
|
73
65
|
*/
|
|
74
66
|
createSchedule(model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
|
|
75
67
|
/**
|
|
76
68
|
* Get information on an export schedule.
|
|
77
|
-
*
|
|
78
69
|
* @param exportScheduleId The export schedule's unique identifier.
|
|
79
70
|
*/
|
|
80
71
|
getSchedule(exportScheduleId: string): Promise<ExportScheduleModel>;
|
|
81
72
|
/**
|
|
82
73
|
* Update an existing export schedule.
|
|
83
|
-
*
|
|
84
74
|
* @param exportScheduleId The export schedule's unique identifier.
|
|
75
|
+
* @param model
|
|
85
76
|
*/
|
|
86
77
|
updateSchedule(exportScheduleId: string, model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
|
|
87
78
|
/**
|
|
88
79
|
* Delete an export schedule.
|
|
89
|
-
*
|
|
90
80
|
* @param exportScheduleId The export schedule's unique identifier.
|
|
91
81
|
*/
|
|
92
82
|
deleteSchedule(exportScheduleId: string): Promise<void>;
|
|
@@ -11,23 +11,22 @@ export default class Filters extends ReadServiceResource implements ReadServiceH
|
|
|
11
11
|
listReportFilters(): Promise<ListFiltersResponse>;
|
|
12
12
|
/**
|
|
13
13
|
* Get a reporting filter.
|
|
14
|
-
*
|
|
15
14
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
16
15
|
*/
|
|
17
16
|
getReportFilter(filterId: string): Promise<FilterResponse>;
|
|
18
17
|
/**
|
|
19
18
|
* Create a reporting filter.
|
|
19
|
+
* @param filter
|
|
20
20
|
*/
|
|
21
21
|
createReportFilter(filter: CreateReportingFilterModel): Promise<CreateReportingFilterResponse>;
|
|
22
22
|
/**
|
|
23
23
|
* Update a reporting filter
|
|
24
|
-
*
|
|
25
24
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
25
|
+
* @param filter
|
|
26
26
|
*/
|
|
27
27
|
updateReportFilter(filterId: string, filter: UpdateReportingFilterModel): Promise<CreateReportingFilterResponse>;
|
|
28
28
|
/**
|
|
29
29
|
* Delete a reporting filter
|
|
30
|
-
*
|
|
31
30
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
32
31
|
*/
|
|
33
32
|
deleteReportFilter(filterId: string): Promise<Record<string, unknown>>;
|
|
@@ -37,46 +36,45 @@ export default class Filters extends ReadServiceResource implements ReadServiceH
|
|
|
37
36
|
listPermissionFilters(): Promise<ListFiltersResponse>;
|
|
38
37
|
/**
|
|
39
38
|
* Get a permission filter.
|
|
39
|
+
* @param filterId
|
|
40
40
|
*/
|
|
41
41
|
getPermissionFilter(filterId: string): Promise<FilterResponse>;
|
|
42
42
|
/**
|
|
43
43
|
* Create a permission filter.
|
|
44
|
+
* @param filter
|
|
44
45
|
*/
|
|
45
46
|
createPermissionFilter(filter: CreatePermissionsFilterModel): Promise<CreatePermissionsFilterResponse>;
|
|
46
47
|
/**
|
|
47
48
|
* Update a permission filter.
|
|
48
|
-
*
|
|
49
49
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
50
|
+
* @param filter
|
|
50
51
|
*/
|
|
51
52
|
updatePermissionFilter(filterId: string, filter: UpdatePermissionsFilterModel): Promise<CreatePermissionsFilterResponse>;
|
|
52
53
|
/**
|
|
53
54
|
* Delete a permission filter.
|
|
54
|
-
*
|
|
55
55
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
56
56
|
*/
|
|
57
57
|
deletePermissionFilter(filterId: string): Promise<Record<string, unknown>>;
|
|
58
58
|
/**
|
|
59
59
|
* Get the users of a permission filters.
|
|
60
|
-
*
|
|
61
60
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
62
61
|
*/
|
|
63
62
|
getPermissionFilterUsers(filterId: string): Promise<PermissionsFilterUser[]>;
|
|
64
63
|
/**
|
|
65
64
|
* Set the users of a permission filter.
|
|
66
|
-
*
|
|
67
65
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
66
|
+
* @param users
|
|
68
67
|
*/
|
|
69
68
|
updatePermissionFilterUsers(filterId: string, users: string[]): Promise<Record<string, unknown>>;
|
|
70
69
|
/**
|
|
71
70
|
* Get the targets of a permission filters.
|
|
72
|
-
*
|
|
73
71
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
74
72
|
*/
|
|
75
73
|
getPermissionFilterTargets(filterId: string): Promise<FilterTargetsResponse[]>;
|
|
76
74
|
/**
|
|
77
75
|
* Set the targets of a permission filter.
|
|
78
|
-
*
|
|
79
76
|
* @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
|
|
77
|
+
* @param targets
|
|
80
78
|
*/
|
|
81
79
|
updatePermissionFilterTargets(filterId: string, targets: FilterTargetsModel): Promise<Record<string, unknown>>;
|
|
82
80
|
checkHealth(): Promise<ReadServiceHealthResponse>;
|
|
@@ -6,11 +6,10 @@ import Resource from '../../Resource.js';
|
|
|
6
6
|
export default class ReadServiceResource extends Resource {
|
|
7
7
|
/**
|
|
8
8
|
* Build the request path, handling the optional `org` query parameter.
|
|
9
|
-
*
|
|
10
9
|
* @param route The path part of the request.
|
|
11
10
|
* @param queryParams Optional query parameters object.
|
|
12
11
|
* If this object contains an `org` property, it will override the value from the configuration.
|
|
13
12
|
* @returns The request path including formatted query parameters.
|
|
14
13
|
*/
|
|
15
|
-
protected buildPathWithOrg(route: string, queryParams?:
|
|
14
|
+
protected buildPathWithOrg(route: string, queryParams?: object): string;
|
|
16
15
|
}
|
|
@@ -6,64 +6,63 @@ export default class Reports extends ReadServiceResource implements ReadServiceH
|
|
|
6
6
|
static baseUrl: string;
|
|
7
7
|
/**
|
|
8
8
|
* Get the persisted reports of one or all types.
|
|
9
|
+
* @param options
|
|
9
10
|
*/
|
|
10
11
|
list(options?: ListReportsOptions): Promise<ListReportsResponse>;
|
|
11
12
|
/**
|
|
12
13
|
* Get a report.
|
|
13
|
-
*
|
|
14
14
|
* @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
|
|
15
|
+
* @param options
|
|
15
16
|
*/
|
|
16
17
|
get(reportId: string, options?: GetReportOptions): Promise<ReportModel>;
|
|
17
18
|
/**
|
|
18
19
|
* Create a report.
|
|
20
|
+
* @param report
|
|
19
21
|
*/
|
|
20
22
|
create(report: CreateReportModel): Promise<CreateReportResponse>;
|
|
21
23
|
/**
|
|
22
24
|
* Update a report.
|
|
23
|
-
*
|
|
24
25
|
* @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
|
|
26
|
+
* @param report
|
|
25
27
|
*/
|
|
26
28
|
update(reportId: string, report: UpdateReportModel): Promise<CreateReportModel>;
|
|
27
29
|
/**
|
|
28
30
|
* Delete a report.
|
|
29
|
-
*
|
|
30
31
|
* @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
|
|
31
32
|
*/
|
|
32
33
|
delete(reportId: string): Promise<Record<string, unknown>>;
|
|
33
34
|
/**
|
|
34
35
|
* Get the users and groups who can view a report.
|
|
35
|
-
*
|
|
36
36
|
* @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
|
|
37
37
|
*/
|
|
38
38
|
getAccess(reportId: string): Promise<ReportAccessResponse>;
|
|
39
39
|
/**
|
|
40
40
|
* Set the users and groups who are allowed to view a report.
|
|
41
|
-
*
|
|
42
41
|
* @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
|
|
42
|
+
* @param reportAccess
|
|
43
43
|
*/
|
|
44
44
|
setAccess(reportId: string, reportAccess: ReportAccessRequest): Promise<Record<string, unknown>>;
|
|
45
45
|
/**
|
|
46
46
|
* Get the users who can view a report.
|
|
47
|
-
*
|
|
48
47
|
* @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
|
|
49
48
|
*/
|
|
50
49
|
getUsers(reportId: string): Promise<ReportUsersResponse>;
|
|
51
50
|
/**
|
|
52
51
|
* Set the users who are allowed to view a report.
|
|
53
|
-
*
|
|
54
52
|
* @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
|
|
53
|
+
* @param userIds
|
|
55
54
|
*/
|
|
56
55
|
setUsers(reportId: string, userIds: string[]): Promise<Record<string, unknown>>;
|
|
57
56
|
/**
|
|
58
57
|
* Get a report template.
|
|
59
|
-
*
|
|
60
58
|
* @param templateId The unique identifier of a template.
|
|
59
|
+
* @param options
|
|
61
60
|
*/
|
|
62
61
|
getReportTemplate(templateId: string, options?: GetReportTemplateOptions): Promise<TemplateResponse[]>;
|
|
63
62
|
/**
|
|
64
63
|
* Get metadata about available report templates.
|
|
65
|
-
*
|
|
66
64
|
* @param type The type of the report. Must be either 'explorer' or 'dashboard'.
|
|
65
|
+
* @param options
|
|
67
66
|
*/
|
|
68
67
|
listReportTemplates(type: ReportType, options?: GetReportTemplateOptions): Promise<TemplateMetadataResponse[]>;
|
|
69
68
|
checkHealth(): Promise<ReadServiceHealthResponse>;
|
|
@@ -18,8 +18,7 @@ export interface ReportModel {
|
|
|
18
18
|
}
|
|
19
19
|
export type CreateReportModel = Omit<ReportModel, 'id' | 'account'>;
|
|
20
20
|
export type CreateReportResponse = Pick<ReportModel, 'id'>;
|
|
21
|
-
export
|
|
22
|
-
}
|
|
21
|
+
export type GetReportOptions = TimeZoneParamParts;
|
|
23
22
|
export type UpdateReportModel = CreateReportModel;
|
|
24
23
|
export type UpdateReportResponse = CreateReportResponse;
|
|
25
24
|
export interface ListReportsOptions {
|
|
@@ -8,31 +8,26 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
8
8
|
listUsers(): Promise<SnowflakeUsersModel>;
|
|
9
9
|
/**
|
|
10
10
|
* Create a new user within a Snowflake reader account.
|
|
11
|
-
*
|
|
12
11
|
* @param model The user to create.
|
|
13
12
|
*/
|
|
14
13
|
createUser(model: SnowflakeUserModel): Promise<SnowflakeUserModel>;
|
|
15
14
|
/**
|
|
16
15
|
* Delete a user from a Snowflake reader account.
|
|
17
|
-
*
|
|
18
16
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
19
17
|
*/
|
|
20
18
|
deleteUser(snowflakeUser: string): Promise<void>;
|
|
21
19
|
/**
|
|
22
20
|
* Get the details for a specific user from a Snowflake reader account.
|
|
23
|
-
*
|
|
24
21
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
25
22
|
*/
|
|
26
23
|
getUser(snowflakeUser: string): Promise<SnowflakeUserModel>;
|
|
27
24
|
/**
|
|
28
25
|
* Reset a user's password in a Snowflake reader account.
|
|
29
|
-
*
|
|
30
26
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
31
27
|
*/
|
|
32
28
|
resetPassword(snowflakeUser: string): Promise<void>;
|
|
33
29
|
/**
|
|
34
30
|
* Reactivate and set a user's expiration in a Snowflake reader account.
|
|
35
|
-
*
|
|
36
31
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
37
32
|
* @param params The number of days until the user's expiration date.
|
|
38
33
|
*/
|
|
@@ -43,13 +38,11 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
43
38
|
getNetworkPolicy(): Promise<SnowflakeNetworkPolicyModel>;
|
|
44
39
|
/**
|
|
45
40
|
* Set the details of the active network policy for a Snowflake reader account.
|
|
46
|
-
*
|
|
47
41
|
* @param model The network policy to create.
|
|
48
42
|
*/
|
|
49
43
|
updateNetworkPolicy(model: SnowflakeNetworkPolicyModel): Promise<void>;
|
|
50
44
|
/**
|
|
51
45
|
* Get the amount of compute credits used by a Snowflake reader account within a date range.
|
|
52
|
-
*
|
|
53
46
|
* @param params The time range to get the amount of compute credits.
|
|
54
47
|
*/
|
|
55
48
|
getCreditUsage(params: GetCreditUsageParams): Promise<SnowflakeCreditUsageModel>;
|
|
@@ -44,8 +44,7 @@ export interface SnowflakeNetworkPolicyModel {
|
|
|
44
44
|
allowedIpAddresses: string[];
|
|
45
45
|
blockedIpAddresses: string[];
|
|
46
46
|
}
|
|
47
|
-
export
|
|
48
|
-
}
|
|
47
|
+
export type GetCreditUsageParams = TimeRangeParamParts;
|
|
49
48
|
export interface SnowflakeCreditUsageModel {
|
|
50
49
|
creditsUsed: number;
|
|
51
50
|
}
|
|
@@ -5,46 +5,55 @@ export default class Statistics extends ReadServiceResource implements ReadServi
|
|
|
5
5
|
static baseUrl: string;
|
|
6
6
|
/**
|
|
7
7
|
* Get the incoherent events for a date range.
|
|
8
|
+
* @param options
|
|
8
9
|
*/
|
|
9
10
|
listIncoherentEvents(options: IncoherentEventsOptions): Promise<IncoherentEventsModel>;
|
|
10
11
|
/**
|
|
11
12
|
* Get graph data points for the metrics for a date range.
|
|
13
|
+
* @param options
|
|
12
14
|
*/
|
|
13
15
|
listGraphDataPoints(options: GraphDataPointsOptions): Promise<GraphDataPointsModel>;
|
|
14
16
|
/**
|
|
15
17
|
* Get global data for each metric for a date range.
|
|
18
|
+
* @param options
|
|
16
19
|
*/
|
|
17
20
|
listGlobalData(options: GlobalDataOptions): Promise<MetricsModel>;
|
|
18
21
|
/**
|
|
19
22
|
* Get trends of a metric combined with dimensions for a date range.
|
|
23
|
+
* @param options
|
|
20
24
|
*/
|
|
21
25
|
listTrends(options: TrendsOptions): Promise<TrendsModel>;
|
|
22
26
|
/**
|
|
23
27
|
* Get the metrics based on the visits matching the specified criteria.
|
|
28
|
+
* @param options
|
|
24
29
|
*/
|
|
25
30
|
listVisitsMetrics(options: VisitsMetricsOptions): Promise<MetricsModel>;
|
|
26
31
|
/**
|
|
27
32
|
* Get graph data points for visit based metrics for a date range.
|
|
33
|
+
* @param options
|
|
28
34
|
*/
|
|
29
35
|
listVisitsGraphDataPoints(options: VisitsGraphDataPointsOptions): Promise<GraphDataPointsModel>;
|
|
30
36
|
/**
|
|
31
37
|
* Cancel the execution of a query.
|
|
32
38
|
* This is a best effort; there is no guarantee that the query will be cancelled.
|
|
33
39
|
* If the query is cancelled, the sender of the now cancelled query will receive a 409 Conflict.
|
|
34
|
-
*
|
|
35
40
|
* @param queryId The id of the query to cancel.
|
|
41
|
+
* @param options
|
|
36
42
|
*/
|
|
37
43
|
cancelQuery(queryId: string, options: CancelQueryOptions): Promise<Record<string, unknown>>;
|
|
38
44
|
/**
|
|
39
45
|
* Get metrics combined with dimensions for a date range.
|
|
46
|
+
* @param options
|
|
40
47
|
*/
|
|
41
48
|
listCombinedData(options: CombinedDataOptions): Promise<CombinedDataModel>;
|
|
42
49
|
/**
|
|
43
50
|
* Get the details of the visits matching the specified criteria.
|
|
51
|
+
* @param options
|
|
44
52
|
*/
|
|
45
53
|
listVisits(options: VisitsStatisticsOptions): Promise<VisitsStatisticsModel>;
|
|
46
54
|
/**
|
|
47
55
|
* Force a visit view update.
|
|
56
|
+
* @param options
|
|
48
57
|
*/
|
|
49
58
|
updateVisitView(options: VisitViewOptions): Promise<Record<string, unknown>>;
|
|
50
59
|
checkHealth(): Promise<ReadServiceHealthResponse>;
|
|
@@ -109,8 +109,7 @@ export interface VisitMetricStats {
|
|
|
109
109
|
}
|
|
110
110
|
export interface VisitsGraphDataPointsOptions extends OrganizationParamParts, TimeRangeParamParts, TimeZoneParamParts, EventMetricsParamParts, EventMetricsIntervalParamParts, EventDimensionsFilterParamParts, EventDimensionsExcludeFilterParamParts, EventDimensionsHideEventsFilterParamParts {
|
|
111
111
|
}
|
|
112
|
-
export
|
|
113
|
-
}
|
|
112
|
+
export type CancelQueryOptions = OrganizationParamParts;
|
|
114
113
|
export interface DataPointModel {
|
|
115
114
|
dateTime: number;
|
|
116
115
|
datas: Record<string, number>;
|
|
@@ -154,5 +153,4 @@ export interface VisitsStatisticsModel {
|
|
|
154
153
|
visits: VisitStatisticsModel[];
|
|
155
154
|
totalNumberOfVisits: number;
|
|
156
155
|
}
|
|
157
|
-
export
|
|
158
|
-
}
|
|
156
|
+
export type VisitViewOptions = OrganizationParamParts;
|
|
@@ -5,31 +5,30 @@ export default class UAUsers extends ReadServiceResource implements ReadServiceH
|
|
|
5
5
|
static baseUrl: string;
|
|
6
6
|
/**
|
|
7
7
|
* Get the data level filters that apply to a user.
|
|
8
|
-
*
|
|
9
8
|
* @param userId The unique identifier of a user.
|
|
9
|
+
* @param params
|
|
10
10
|
*/
|
|
11
11
|
listUserFilters(userId: string, params?: ListUAUsersFiltersParams): Promise<UAUsersFiltersModel>;
|
|
12
12
|
/**
|
|
13
13
|
* Set the filters that will be applied to a user query.
|
|
14
|
-
*
|
|
15
14
|
* @param userId The unique identifier of a user.
|
|
15
|
+
* @param filters
|
|
16
16
|
*/
|
|
17
17
|
updateUserFilters(userId: string, filters: UAUserFilterParams[]): Promise<void>;
|
|
18
18
|
/**
|
|
19
19
|
* Get the reports that a user can access.
|
|
20
|
-
*
|
|
21
20
|
* @param userId The unique identifier of a user.
|
|
21
|
+
* @param params
|
|
22
22
|
*/
|
|
23
23
|
listUsersReports(userId: string, params?: ListUAUsersReportsParams): Promise<UAUsersReportsModel>;
|
|
24
24
|
/**
|
|
25
25
|
* Set which reports a user can access.
|
|
26
|
-
*
|
|
27
26
|
* @param userId The unique identifier of a user.
|
|
27
|
+
* @param reportsIDs
|
|
28
28
|
*/
|
|
29
29
|
updateUsersReports(userId: string, reportsIDs: string[]): Promise<void>;
|
|
30
30
|
/**
|
|
31
31
|
* Get a user.
|
|
32
|
-
*
|
|
33
32
|
* @param userId The unique identifier of a user.
|
|
34
33
|
*/
|
|
35
34
|
getUser(userId: string): Promise<UAUserModel>;
|