@coveo/platform-client 55.13.2 → 56.0.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/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/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/ModelListing/ModelListingInterfaces.d.ts +1 -14
- 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/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
|
@@ -9,7 +9,6 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* Create a new user within a Snowflake reader account.
|
|
12
|
-
*
|
|
13
12
|
* @param model The user to create.
|
|
14
13
|
*/
|
|
15
14
|
createUser(model) {
|
|
@@ -17,7 +16,6 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
17
16
|
}
|
|
18
17
|
/**
|
|
19
18
|
* Delete a user from a Snowflake reader account.
|
|
20
|
-
*
|
|
21
19
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
22
20
|
*/
|
|
23
21
|
deleteUser(snowflakeUser) {
|
|
@@ -25,7 +23,6 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
25
23
|
}
|
|
26
24
|
/**
|
|
27
25
|
* Get the details for a specific user from a Snowflake reader account.
|
|
28
|
-
*
|
|
29
26
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
30
27
|
*/
|
|
31
28
|
getUser(snowflakeUser) {
|
|
@@ -33,7 +30,6 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
33
30
|
}
|
|
34
31
|
/**
|
|
35
32
|
* Reset a user's password in a Snowflake reader account.
|
|
36
|
-
*
|
|
37
33
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
38
34
|
*/
|
|
39
35
|
resetPassword(snowflakeUser) {
|
|
@@ -41,7 +37,6 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
41
37
|
}
|
|
42
38
|
/**
|
|
43
39
|
* Reactivate and set a user's expiration in a Snowflake reader account.
|
|
44
|
-
*
|
|
45
40
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
46
41
|
* @param params The number of days until the user's expiration date.
|
|
47
42
|
*/
|
|
@@ -56,7 +51,6 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
56
51
|
}
|
|
57
52
|
/**
|
|
58
53
|
* Set the details of the active network policy for a Snowflake reader account.
|
|
59
|
-
*
|
|
60
54
|
* @param model The network policy to create.
|
|
61
55
|
*/
|
|
62
56
|
updateNetworkPolicy(model) {
|
|
@@ -64,7 +58,6 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
64
58
|
}
|
|
65
59
|
/**
|
|
66
60
|
* Get the amount of compute credits used by a Snowflake reader account within a date range.
|
|
67
|
-
*
|
|
68
61
|
* @param params The time range to get the amount of compute credits.
|
|
69
62
|
*/
|
|
70
63
|
getCreditUsage(params) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Snowflake.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/Snowflake/Snowflake.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAa5D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,mBAAmB;IACtD,MAAM,CAAC,OAAO,GAAG,8BAA8B,CAAC;IAEhD;;OAEG;IACH,SAAS;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC;IAClG,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"Snowflake.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/Snowflake/Snowflake.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAa5D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,mBAAmB;IACtD,MAAM,CAAC,OAAO,GAAG,8BAA8B,CAAC;IAEhD;;OAEG;IACH,SAAS;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC;IAClG,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,KAAyB;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,aAAqB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,EAAE,CAAC,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,aAAqB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAqB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,EAAE,CAAC,CAAC,CAAC;IAClH,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,aAAqB;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,gBAAgB,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,aAAqB,EAAE,MAA4B;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,aAAa,CAAC,EAC/E,MAAM,CACT,CAAC;IACN,CAAC;IAED;;OAEG;IACH,gBAAgB;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA8B,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAClH,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,KAAkC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,EAAE,KAAK,CAAC,CAAC;IAClG,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,MAA4B;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,cAAc,EAAE,MAAM,CAAC,CACpE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,yBAAyB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;OAEG;IACH,iCAAiC;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,yBAAyB,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,4BAA4B;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,4BAA4B;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC9F,CAAC"}
|
|
@@ -3,36 +3,42 @@ export default class Statistics extends ReadServiceResource {
|
|
|
3
3
|
static baseUrl = '/rest/ua/v15/stats';
|
|
4
4
|
/**
|
|
5
5
|
* Get the incoherent events for a date range.
|
|
6
|
+
* @param options
|
|
6
7
|
*/
|
|
7
8
|
listIncoherentEvents(options) {
|
|
8
9
|
return this.api.get(this.buildPathWithOrg(`${Statistics.baseUrl}/incoherentEvents`, options));
|
|
9
10
|
}
|
|
10
11
|
/**
|
|
11
12
|
* Get graph data points for the metrics for a date range.
|
|
13
|
+
* @param options
|
|
12
14
|
*/
|
|
13
15
|
listGraphDataPoints(options) {
|
|
14
16
|
return this.api.get(this.buildPathWithOrg(`${Statistics.baseUrl}/graphDataPoints`, options));
|
|
15
17
|
}
|
|
16
18
|
/**
|
|
17
19
|
* Get global data for each metric for a date range.
|
|
20
|
+
* @param options
|
|
18
21
|
*/
|
|
19
22
|
listGlobalData(options) {
|
|
20
23
|
return this.api.get(this.buildPathWithOrg(`${Statistics.baseUrl}/globalData`, options));
|
|
21
24
|
}
|
|
22
25
|
/**
|
|
23
26
|
* Get trends of a metric combined with dimensions for a date range.
|
|
27
|
+
* @param options
|
|
24
28
|
*/
|
|
25
29
|
listTrends(options) {
|
|
26
30
|
return this.api.get(this.buildPathWithOrg(`${Statistics.baseUrl}/trends`, options));
|
|
27
31
|
}
|
|
28
32
|
/**
|
|
29
33
|
* Get the metrics based on the visits matching the specified criteria.
|
|
34
|
+
* @param options
|
|
30
35
|
*/
|
|
31
36
|
listVisitsMetrics(options) {
|
|
32
37
|
return this.api.get(this.buildPathWithOrg(`${Statistics.baseUrl}/visitsMetrics`, options));
|
|
33
38
|
}
|
|
34
39
|
/**
|
|
35
40
|
* Get graph data points for visit based metrics for a date range.
|
|
41
|
+
* @param options
|
|
36
42
|
*/
|
|
37
43
|
listVisitsGraphDataPoints(options) {
|
|
38
44
|
return this.api.get(this.buildPathWithOrg(`${Statistics.baseUrl}/visitsGraphDataPoints`, options));
|
|
@@ -41,26 +47,29 @@ export default class Statistics extends ReadServiceResource {
|
|
|
41
47
|
* Cancel the execution of a query.
|
|
42
48
|
* This is a best effort; there is no guarantee that the query will be cancelled.
|
|
43
49
|
* If the query is cancelled, the sender of the now cancelled query will receive a 409 Conflict.
|
|
44
|
-
*
|
|
45
50
|
* @param queryId The id of the query to cancel.
|
|
51
|
+
* @param options
|
|
46
52
|
*/
|
|
47
53
|
cancelQuery(queryId, options) {
|
|
48
54
|
return this.api.delete(this.buildPathWithOrg(`${Statistics.baseUrl}/query/${queryId}`, options));
|
|
49
55
|
}
|
|
50
56
|
/**
|
|
51
57
|
* Get metrics combined with dimensions for a date range.
|
|
58
|
+
* @param options
|
|
52
59
|
*/
|
|
53
60
|
listCombinedData(options) {
|
|
54
61
|
return this.api.get(this.buildPathWithOrg(`${Statistics.baseUrl}/combinedData`, options));
|
|
55
62
|
}
|
|
56
63
|
/**
|
|
57
64
|
* Get the details of the visits matching the specified criteria.
|
|
65
|
+
* @param options
|
|
58
66
|
*/
|
|
59
67
|
listVisits(options) {
|
|
60
68
|
return this.api.get(this.buildPathWithOrg(`${Statistics.baseUrl}/visits`, options));
|
|
61
69
|
}
|
|
62
70
|
/**
|
|
63
71
|
* Force a visit view update.
|
|
72
|
+
* @param options
|
|
64
73
|
*/
|
|
65
74
|
updateVisitView(options) {
|
|
66
75
|
return this.api.post(this.buildPathWithOrg(`${Statistics.baseUrl}/visits`, options));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Statistics.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/Statistics/Statistics.ts"],"names":[],"mappings":"AACA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAoB5D,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,mBAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,oBAAoB,CAAC;IAEtC
|
|
1
|
+
{"version":3,"file":"Statistics.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/Statistics/Statistics.ts"],"names":[],"mappings":"AACA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAoB5D,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,mBAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,oBAAoB,CAAC;IAEtC;;;OAGG;IACH,oBAAoB,CAAC,OAAgC;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,mBAAmB,EAAE,OAAO,CAAC,CAC3E,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,OAA+B;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,kBAAkB,EAAE,OAAO,CAAC,CAC1E,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,OAA0B;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,OAAsB;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,OAA6B;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7G,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,OAAqC;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,wBAAwB,EAAE,OAAO,CAAC,CAChF,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,OAAe,EAAE,OAA2B;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,UAAU,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,OAA4B;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAoB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,OAAgC;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAwB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,OAAyB;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;IACzF,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA4B,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC;IAC9F,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA4B,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC;IACnF,CAAC"}
|
|
@@ -3,39 +3,38 @@ export default class UAUsers extends ReadServiceResource {
|
|
|
3
3
|
static baseUrl = '/rest/ua/v15/users';
|
|
4
4
|
/**
|
|
5
5
|
* Get the data level filters that apply to a user.
|
|
6
|
-
*
|
|
7
6
|
* @param userId The unique identifier of a user.
|
|
7
|
+
* @param params
|
|
8
8
|
*/
|
|
9
9
|
listUserFilters(userId, params) {
|
|
10
10
|
return this.api.get(this.buildPathWithOrg(`${UAUsers.baseUrl}/${userId}/filters`, params));
|
|
11
11
|
}
|
|
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, filters) {
|
|
18
18
|
return this.api.put(this.buildPathWithOrg(`${UAUsers.baseUrl}/${userId}/filters`), filters);
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* Get the reports that a user can access.
|
|
22
|
-
*
|
|
23
22
|
* @param userId The unique identifier of a user.
|
|
23
|
+
* @param params
|
|
24
24
|
*/
|
|
25
25
|
listUsersReports(userId, params) {
|
|
26
26
|
return this.api.get(this.buildPathWithOrg(`${UAUsers.baseUrl}/${userId}/reports`, params));
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
29
|
* Set which reports a user can access.
|
|
30
|
-
*
|
|
31
30
|
* @param userId The unique identifier of a user.
|
|
31
|
+
* @param reportsIDs
|
|
32
32
|
*/
|
|
33
33
|
updateUsersReports(userId, reportsIDs) {
|
|
34
34
|
return this.api.put(this.buildPathWithOrg(`${UAUsers.baseUrl}/${userId}/reports`), reportsIDs);
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
37
|
* Get a user.
|
|
38
|
-
*
|
|
39
38
|
* @param userId The unique identifier of a user.
|
|
40
39
|
*/
|
|
41
40
|
getUser(userId) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"UAUsers.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/UAUsers/UAUsers.ts"],"names":[],"mappings":"AACA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAU5D,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,mBAAmB;IACpD,MAAM,CAAC,OAAO,GAAG,oBAAoB,CAAC;IAEtC;;;;OAIG;IACH,eAAe,CAAC,MAAc,EAAE,MAAiC;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IACpH,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,MAAc,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAc,EAAE,MAAiC;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IACpH,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAAc,EAAE,UAAoB;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC;IACzG,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"UAUsers.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/UAUsers/UAUsers.ts"],"names":[],"mappings":"AACA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAU5D,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,mBAAmB;IACpD,MAAM,CAAC,OAAO,GAAG,oBAAoB,CAAC;IAEtC;;;;OAIG;IACH,eAAe,CAAC,MAAc,EAAE,MAAiC;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IACpH,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,MAAc,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAc,EAAE,MAAiC;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IACpH,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAAc,EAAE,UAAoB;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,MAAc;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA4B,GAAG,OAAO,CAAC,OAAO,oBAAoB,CAAC,CAAC;IAC3F,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA4B,GAAG,OAAO,CAAC,OAAO,SAAS,CAAC,CAAC;IAChF,CAAC"}
|
|
@@ -5,18 +5,16 @@ export default class Vaults extends Resource {
|
|
|
5
5
|
static baseUrl = `/rest/organizations/${API.orgPlaceholder}/vaultentries`;
|
|
6
6
|
/**
|
|
7
7
|
* Find error vault keys for a given snapshot.
|
|
8
|
-
*
|
|
9
|
-
* @param {string} snapshotId The unique identifier of the target snapshot.
|
|
8
|
+
* @param snapshotId The unique identifier of the target snapshot.
|
|
10
9
|
*/
|
|
11
10
|
findMissing(snapshotId) {
|
|
12
11
|
return this.api.get(this.buildPath(`${Vaults.baseUrl}/missing`, { snapshotId }));
|
|
13
12
|
}
|
|
14
13
|
/**
|
|
15
14
|
* Import vault entries from the starting organization into the current organization.
|
|
16
|
-
*
|
|
17
|
-
* @param
|
|
18
|
-
* @param
|
|
19
|
-
* @param {VaultFetchStrategy} fetchStrategy Choosing the strategy to use when importing vault entries.
|
|
15
|
+
* @param currentSnapshotId The unique identifier of the current snapshot.
|
|
16
|
+
* @param sourceOrganizationId The unique identifier of the source organization.
|
|
17
|
+
* @param fetchStrategy Choosing the strategy to use when importing vault entries.
|
|
20
18
|
*/
|
|
21
19
|
import(currentSnapshotId, sourceOrganizationId, fetchStrategy) {
|
|
22
20
|
return this.api.put(this.buildPath(`${Vaults.baseUrl}/fetch`, {
|
|
@@ -27,16 +25,14 @@ export default class Vaults extends Resource {
|
|
|
27
25
|
}
|
|
28
26
|
/**
|
|
29
27
|
* Create a vault entry.
|
|
30
|
-
*
|
|
31
|
-
* @param {VaultEntryModel} model Vault entry model
|
|
28
|
+
* @param model Vault entry model
|
|
32
29
|
*/
|
|
33
30
|
create(model) {
|
|
34
31
|
return this.api.post(Vaults.baseUrl, model);
|
|
35
32
|
}
|
|
36
33
|
/**
|
|
37
34
|
* Get all vault entries for an organization.
|
|
38
|
-
*
|
|
39
|
-
* @param {VaultEntryListOptions} options pagination options
|
|
35
|
+
* @param options pagination options
|
|
40
36
|
*/
|
|
41
37
|
list(options) {
|
|
42
38
|
const normalizedOptions = normalizePaginatedOptions(options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Vaults.js","sourceRoot":"","sources":["../../../../src/resources/Vaults/Vaults.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,EAAC,yBAAyB,EAAC,MAAM,0CAA0C,CAAC;AAGnF,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,eAAe,CAAC;IAE1E
|
|
1
|
+
{"version":3,"file":"Vaults.js","sourceRoot":"","sources":["../../../../src/resources/Vaults/Vaults.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,EAAC,yBAAyB,EAAC,MAAM,0CAA0C,CAAC;AAGnF,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,eAAe,CAAC;IAE1E;;;OAGG;IACH,WAAW,CAAC,UAAkB;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAoB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,UAAU,EAAE,EAAC,UAAU,EAAC,CAAC,CAAC,CAAC;IACtG,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,iBAAyB,EAAE,oBAA4B,EAAE,aAAiC;QAC7F,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,QAAQ,EAAE;YACtC,mBAAmB,EAAE,iBAAiB;YACtC,oBAAoB;YACpB,aAAa;SAChB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAsB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAkB,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,OAA+B;QAChC,MAAM,iBAAiB,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA6B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACvG,CAAC"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Creates a method to perform a fetch request. Can be retried by calling the method again.
|
|
3
|
-
*
|
|
4
3
|
* @param url The URL to use for the request.
|
|
5
4
|
* @param init The parameters to provide to the request.
|
|
6
5
|
* @param shouldReject Predicate to see if the response should be (Promise) rejected.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createFetcher.js","sourceRoot":"","sources":["../../../src/utils/createFetcher.ts"],"names":[],"mappings":"AAEA
|
|
1
|
+
{"version":3,"file":"createFetcher.js","sourceRoot":"","sources":["../../../src/utils/createFetcher.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GACtB,CAAC,GAAW,EAAE,IAAiB,EAAE,YAAkC,EAA2B,EAAE,CAChG,KAAK,IAAI,EAAE;IACP,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACxC,IAAI,YAAY,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,MAAM,QAAQ,CAAC;IACnB,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"normalizePaginatedOptions.js","sourceRoot":"","sources":["../../../src/utils/normalizePaginatedOptions.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACrC,OAAoD,EACjC,EAAE;IACrB,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC;IACnB,CAAC;SAAM,CAAC;QACJ,MAAM,EAAC,OAAO,EAAE,CAAC,EAAE,GAAG,aAAa,EAAC,GAAG,EAAC,GAAG,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAC,CAAC;QAChF,OAAO,aAAa,CAAC;IACzB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,
|
|
1
|
+
{"version":3,"file":"normalizePaginatedOptions.js","sourceRoot":"","sources":["../../../src/utils/normalizePaginatedOptions.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACrC,OAAoD,EACjC,EAAE;IACrB,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC;IACnB,CAAC;SAAM,CAAC;QACJ,MAAM,EAAC,OAAO,EAAE,CAAC,EAAE,GAAG,aAAa,EAAC,GAAG,EAAC,GAAG,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAC,CAAC;QAChF,OAAO,aAAa,CAAC;IACzB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAAgB,EAAkC,EAAE;IAC/E,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACX,oGAAoG,CACvG,CAAC;IACN,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stringifyNestedObjects.js","sourceRoot":"","sources":["../../../src/utils/stringifyNestedObjects.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,
|
|
1
|
+
{"version":3,"file":"stringifyNestedObjects.js","sourceRoot":"","sources":["../../../src/utils/stringifyNestedObjects.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAmB,GAAM,EAAK,EAAE;IAClE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,GAAG,CAAC,GAAc,CAAC,CAAC;QAClC,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9D,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACf,CAAC,CAAC"}
|
package/dist/types/APICore.d.ts
CHANGED
|
@@ -11,12 +11,12 @@ export default class API {
|
|
|
11
11
|
get organizationId(): string;
|
|
12
12
|
get<T = Record<string, unknown>>(url: string, args?: CoveoPlatformClientRequestInit): Promise<T>;
|
|
13
13
|
post<T = Record<string, unknown>>(url: string, body: undefined, args?: CoveoPlatformClientRequestInit): Promise<T>;
|
|
14
|
-
post<T = Record<string, unknown>>(url: string, body?:
|
|
14
|
+
post<T = Record<string, unknown>>(url: string, body?: object, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
|
|
15
15
|
postForm<T = Record<string, unknown>>(url: string, body: FormData, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
|
|
16
16
|
put<T = Record<string, unknown>>(url: string, body: undefined, args?: CoveoPlatformClientRequestInit): Promise<T>;
|
|
17
|
-
put<T = Record<string, unknown>>(url: string, body?:
|
|
17
|
+
put<T = Record<string, unknown>>(url: string, body?: object, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
|
|
18
18
|
patch<T = Record<string, unknown>>(url: string, body: undefined, args?: CoveoPlatformClientRequestInit): Promise<T>;
|
|
19
|
-
patch<T = Record<string, unknown>>(url: string, body?:
|
|
19
|
+
patch<T = Record<string, unknown>>(url: string, body?: object, args?: Omit<CoveoPlatformClientRequestInit, 'body'>): Promise<T>;
|
|
20
20
|
delete<T = Record<string, unknown>>(url: string, args?: CoveoPlatformClientRequestInit): Promise<T>;
|
|
21
21
|
abortGetRequests(): void;
|
|
22
22
|
checkToken(): Promise<void>;
|
|
@@ -9,7 +9,6 @@ export interface RequestHandler {
|
|
|
9
9
|
canProcess: Predicate<EnrichedRequestInit>;
|
|
10
10
|
/**
|
|
11
11
|
* How to process the requests.
|
|
12
|
-
*
|
|
13
12
|
* @param request The [request object](https://developer.mozilla.org/en-US/docs/Web/API/Request).
|
|
14
13
|
*/
|
|
15
14
|
process(request: EnrichedRequestInit): EnrichedRequestInit;
|
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
import 'core-js/actual/json/parse.js';
|
|
2
2
|
import { Predicate } from '../../utils/types.js';
|
|
3
3
|
import { ResponseBodyFormat, ResponseHandler } from './ResponseHandlerInterfaces.js';
|
|
4
|
-
/**
|
|
4
|
+
/**
|
|
5
|
+
* Check whether the response status is `204 No Content`.
|
|
6
|
+
* @param response
|
|
7
|
+
*/
|
|
5
8
|
export declare const isNoContent: Predicate<Response>;
|
|
6
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Check whether the response is considered to have any "ok" status code (not just 200).
|
|
11
|
+
* @param response
|
|
12
|
+
*/
|
|
7
13
|
export declare const isAnyOkStatus: Predicate<Response>;
|
|
8
14
|
export declare const ResponseHandlers: Readonly<{
|
|
9
15
|
noContent: ResponseHandler;
|
|
@@ -9,9 +9,8 @@ export default class Activity extends Resource {
|
|
|
9
9
|
getResourceTypes(): Promise<string[]>;
|
|
10
10
|
/**
|
|
11
11
|
* Retrieves a list of ActivityOperation for a given organization.
|
|
12
|
-
*
|
|
13
|
-
* @
|
|
14
|
-
* @returns {Promise<ActivityOperation[]>} A list of activity operations.
|
|
12
|
+
* @param includeInternal Whether or not to include internal operations.
|
|
13
|
+
* @returns A list of activity operations.
|
|
15
14
|
*/
|
|
16
15
|
getOperationTypes(includeInternal?: boolean): Promise<ActivityOperation[]>;
|
|
17
16
|
getListOfResourcesAndOperations(): Promise<ActivitiesResourceAndOperations>;
|
|
@@ -5,40 +5,41 @@ export default class Properties extends Resource {
|
|
|
5
5
|
static baseUrl: string;
|
|
6
6
|
/**
|
|
7
7
|
* Build the request path, handling the optional `org` query parameter.
|
|
8
|
-
*
|
|
9
8
|
* @param route The path part of the request.
|
|
10
9
|
* @param queryParams Optional query parameters object.
|
|
11
10
|
* If this object contains an `org` property, it will override the value from the configuration.
|
|
12
11
|
* @returns The request path including formatted query parameters.
|
|
13
12
|
*/
|
|
14
|
-
protected buildPathWithOrg(route: string, queryParams?:
|
|
13
|
+
protected buildPathWithOrg(route: string, queryParams?: object): string;
|
|
15
14
|
/**
|
|
16
15
|
* List all properties
|
|
17
|
-
*
|
|
16
|
+
* @param params
|
|
18
17
|
* @returns Promise<PageModel<PropertyModel>>
|
|
19
18
|
*/
|
|
20
19
|
list(params?: ListPropertiesParams): Promise<PageModel<PropertyModel>>;
|
|
21
20
|
/**
|
|
22
21
|
* Get a property
|
|
23
|
-
*
|
|
22
|
+
* @param trackingId
|
|
24
23
|
* @returns Promise<PropertyModel>
|
|
25
24
|
*/
|
|
26
25
|
get(trackingId: string): Promise<PropertyModel>;
|
|
27
26
|
/**
|
|
28
27
|
* Create a property
|
|
29
|
-
*
|
|
28
|
+
* @param trackingId
|
|
29
|
+
* @param displayName
|
|
30
30
|
* @returns Promise<PropertiesResponseMessage>
|
|
31
31
|
*/
|
|
32
32
|
create(trackingId: string, displayName: string): Promise<PropertiesResponseMessage>;
|
|
33
33
|
/**
|
|
34
34
|
* Edit a property
|
|
35
|
-
*
|
|
35
|
+
* @param trackingId
|
|
36
|
+
* @param displayName
|
|
36
37
|
* @returns Promise<PropertiesResponseMessage>
|
|
37
38
|
*/
|
|
38
39
|
update(trackingId: string, displayName: string): Promise<PropertiesResponseMessage>;
|
|
39
40
|
/**
|
|
40
41
|
* Delete a property
|
|
41
|
-
*
|
|
42
|
+
* @param trackingId
|
|
42
43
|
* @returns Promise<PropertiesResponseMessage>
|
|
43
44
|
*/
|
|
44
45
|
delete(trackingId: string): Promise<PropertiesResponseMessage>;
|
|
@@ -10,8 +10,7 @@ export declare enum CaseClassificationStrategies {
|
|
|
10
10
|
Some = "Some",
|
|
11
11
|
Axon = "Axon"
|
|
12
12
|
}
|
|
13
|
-
export
|
|
14
|
-
}
|
|
13
|
+
export type CaseAssistConfigListOptions = Paginated;
|
|
15
14
|
export interface ITDConfigurationModel {
|
|
16
15
|
pipeline?: string;
|
|
17
16
|
filter?: string;
|
|
@@ -8,6 +8,8 @@ export default class Catalog extends Resource {
|
|
|
8
8
|
delete(catalogId: string): Promise<Record<string, unknown>>;
|
|
9
9
|
get(catalogId: string): Promise<CatalogModel>;
|
|
10
10
|
/**
|
|
11
|
+
* @param catalogId
|
|
12
|
+
* @param options
|
|
11
13
|
* @deprecated getFields(catalogId: string, options?: CatalogFieldsOptions) is kept for backward compatibility, you should now use `getFieldStats(catalogId: string, options?: CatalogFieldStatsOptions)`.
|
|
12
14
|
*/
|
|
13
15
|
getFields(catalogId: string, options?: CatalogFieldsOptions): Promise<CachedCatalogFieldsModel>;
|
|
@@ -8,22 +8,32 @@ export default class ProductListing extends Resource {
|
|
|
8
8
|
static baseCatalogsUrl: string;
|
|
9
9
|
static baseProductListingsUrl: string;
|
|
10
10
|
/**
|
|
11
|
+
* @param catalogId
|
|
12
|
+
* @param options
|
|
11
13
|
* @deprecated
|
|
12
14
|
*/
|
|
13
15
|
list(catalogId: string, options?: ProductListingsListOptions): Promise<PageModel<ProductListingModel>>;
|
|
14
16
|
/**
|
|
17
|
+
* @param catalogId
|
|
18
|
+
* @param model
|
|
15
19
|
* @deprecated
|
|
16
20
|
*/
|
|
17
21
|
create(catalogId: string, model: New<ProductListingModel>): Promise<ProductListingModel>;
|
|
18
22
|
/**
|
|
23
|
+
* @param catalogId
|
|
24
|
+
* @param productListingId
|
|
19
25
|
* @deprecated
|
|
20
26
|
*/
|
|
21
27
|
delete(catalogId: string, productListingId: string): Promise<Record<string, unknown>>;
|
|
22
28
|
/**
|
|
29
|
+
* @param catalogId
|
|
30
|
+
* @param productListingId
|
|
23
31
|
* @deprecated
|
|
24
32
|
*/
|
|
25
33
|
get(catalogId: string, productListingId: string): Promise<ProductListingModel>;
|
|
26
34
|
/**
|
|
35
|
+
* @param catalogId
|
|
36
|
+
* @param model
|
|
27
37
|
* @deprecated
|
|
28
38
|
*/
|
|
29
39
|
update(catalogId: string, model: ProductListingModel): Promise<ProductListingModel>;
|
|
@@ -7,22 +7,38 @@ import { ProductListingConfigurationModel, ProductListingConfigurationOptions }
|
|
|
7
7
|
export default class ProductListingConfiguration extends Resource {
|
|
8
8
|
static baseUrl: string;
|
|
9
9
|
/**
|
|
10
|
+
* @param catalogId
|
|
11
|
+
* @param productListingId
|
|
12
|
+
* @param options
|
|
10
13
|
* @deprecated
|
|
11
14
|
*/
|
|
12
15
|
list(catalogId: string, productListingId: string, options?: ProductListingConfigurationOptions): Promise<PageModel<ProductListingConfigurationModel>>;
|
|
13
16
|
/**
|
|
17
|
+
* @param catalogId
|
|
18
|
+
* @param productListingId
|
|
19
|
+
* @param rankingConfiguration
|
|
14
20
|
* @deprecated
|
|
15
21
|
*/
|
|
16
22
|
create(catalogId: string, productListingId: string, rankingConfiguration: New<ProductListingConfigurationModel>): Promise<Record<string, unknown>>;
|
|
17
23
|
/**
|
|
24
|
+
* @param catalogId
|
|
25
|
+
* @param productListingId
|
|
26
|
+
* @param productListingConfigurationId
|
|
18
27
|
* @deprecated
|
|
19
28
|
*/
|
|
20
29
|
delete(catalogId: string, productListingId: string, productListingConfigurationId: string): Promise<Record<string, unknown>>;
|
|
21
30
|
/**
|
|
31
|
+
* @param catalogId
|
|
32
|
+
* @param productListingId
|
|
33
|
+
* @param productListingConfigurationId
|
|
22
34
|
* @deprecated
|
|
23
35
|
*/
|
|
24
36
|
get(catalogId: string, productListingId: string, productListingConfigurationId: string): Promise<ProductListingConfigurationModel>;
|
|
25
37
|
/**
|
|
38
|
+
* @param catalogId
|
|
39
|
+
* @param productListingId
|
|
40
|
+
* @param productListingConfigurationId
|
|
41
|
+
* @param rankingConfiguration
|
|
26
42
|
* @deprecated
|
|
27
43
|
*/
|
|
28
44
|
update(catalogId: string, productListingId: string, productListingConfigurationId: string, rankingConfiguration: New<ProductListingConfigurationModel>): Promise<Record<string, unknown>>;
|
|
@@ -186,14 +186,10 @@ export interface CrawlingModuleDeployment {
|
|
|
186
186
|
name: string;
|
|
187
187
|
/**
|
|
188
188
|
* The status of the Crawling Module
|
|
189
|
-
*
|
|
190
|
-
* @type {CrawlingModuleStatus}
|
|
191
189
|
*/
|
|
192
190
|
status?: CrawlingModuleStatus;
|
|
193
191
|
/**
|
|
194
192
|
* The component versions of the Crawling Module
|
|
195
|
-
*
|
|
196
|
-
* @type {ComponentVersion}.
|
|
197
193
|
*/
|
|
198
194
|
versions: ComponentVersion;
|
|
199
195
|
}
|
|
@@ -11,16 +11,18 @@ export default class Extension extends Resource {
|
|
|
11
11
|
list(): Promise<ExtensionModel[]>;
|
|
12
12
|
/**
|
|
13
13
|
* Lists all versions of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
|
|
14
|
+
* @param extensionId
|
|
14
15
|
*/
|
|
15
16
|
listVersions(extensionId: string): Promise<ExtensionContentVersionModel[]>;
|
|
16
17
|
/**
|
|
17
18
|
* Shows a specific version of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
|
|
19
|
+
* @param extensionId
|
|
20
|
+
* @param versionId
|
|
18
21
|
*/
|
|
19
22
|
getVersion(extensionId: string, versionId: string): Promise<ExtensionModel>;
|
|
20
23
|
/**
|
|
21
24
|
* Validates the extension's script
|
|
22
|
-
*
|
|
23
|
-
* @param {ExtensionCompileCode} extensionCode The code to compile
|
|
25
|
+
* @param extensionCode The code to compile
|
|
24
26
|
*/
|
|
25
27
|
validateCode(extensionCode: ExtensionCompileCode): Promise<ExtensionCompileResult>;
|
|
26
28
|
}
|
|
@@ -93,13 +93,11 @@ export interface ExtensionCompileError {
|
|
|
93
93
|
export interface ExtensionContentVersionModel {
|
|
94
94
|
/**
|
|
95
95
|
* The date at which the extension version was created (in number of milliseconds since UNIX epoch), i.e., the date of the modification of the extension when this extension version was created.
|
|
96
|
-
*
|
|
97
96
|
* @example 1556308241000
|
|
98
97
|
*/
|
|
99
98
|
lastModified: number;
|
|
100
99
|
/**
|
|
101
100
|
* The unique identifier of the extension target version.
|
|
102
|
-
*
|
|
103
101
|
* @example hdJSDb4hTkdnsCynNtF.d657FgLSDydcj
|
|
104
102
|
*/
|
|
105
103
|
id: string;
|
|
@@ -12,6 +12,7 @@ export default class Field extends Resource {
|
|
|
12
12
|
get(fieldId: string): Promise<FieldModel>;
|
|
13
13
|
update(fieldId: string, options: FieldModel): Promise<Record<string, unknown>>;
|
|
14
14
|
/**
|
|
15
|
+
* @param params
|
|
15
16
|
* @deprecated list(params?: ListFieldsParams) is kept for backward compatibility, you should now use `search(params?: FieldListingOptions)`.
|
|
16
17
|
*/
|
|
17
18
|
list(params?: ListFieldsParams): Promise<PageModel<FieldModel>>;
|
|
@@ -76,13 +76,11 @@ export interface HostedInterfaceVersion<T> {
|
|
|
76
76
|
export interface ListHostedInterfaceVersionsParams extends Paginated {
|
|
77
77
|
/**
|
|
78
78
|
* The zero-based page to retrieve.
|
|
79
|
-
*
|
|
80
79
|
* @default `0`
|
|
81
80
|
*/
|
|
82
81
|
page?: number;
|
|
83
82
|
/**
|
|
84
83
|
* The number of versions to return per page.
|
|
85
|
-
*
|
|
86
84
|
* @default `10`
|
|
87
85
|
*/
|
|
88
86
|
perPage?: number;
|
|
@@ -97,7 +95,6 @@ export interface ListHostedInterfaceVersionsParams extends Paginated {
|
|
|
97
95
|
* - `undefined`: Configurations are returned in no specific order.
|
|
98
96
|
* - `asc`: Sort version by number in ascending order.
|
|
99
97
|
* - `desc`: Sort version by number in descending order.
|
|
100
|
-
*
|
|
101
98
|
* @default `undefined`
|
|
102
99
|
*/
|
|
103
100
|
order?: 'asc' | 'desc';
|
|
@@ -135,13 +132,11 @@ export interface IAccesses {
|
|
|
135
132
|
domains: string[];
|
|
136
133
|
/**
|
|
137
134
|
* When set to true, all users can share and see the search page.
|
|
138
|
-
*
|
|
139
135
|
* @default false
|
|
140
136
|
*/
|
|
141
137
|
sharingLinkEnabled?: boolean;
|
|
142
138
|
/**
|
|
143
139
|
* When set to true, the domain sharing is enabled. Otherwise, only users that have explicitly access to the search page can access it.
|
|
144
|
-
*
|
|
145
140
|
* @default false
|
|
146
141
|
*/
|
|
147
142
|
sharingDomainEnabled?: boolean;
|
|
@@ -3,10 +3,8 @@ export declare enum IPXResultTemplateLayout {
|
|
|
3
3
|
Default = "default",
|
|
4
4
|
Thumbnail = "thumbnail"
|
|
5
5
|
}
|
|
6
|
-
export
|
|
7
|
-
|
|
8
|
-
export interface IPXCondition extends HostedInterfaceCondition {
|
|
9
|
-
}
|
|
6
|
+
export type IPXFacet = HostedInterfaceFacet;
|
|
7
|
+
export type IPXCondition = HostedInterfaceCondition;
|
|
10
8
|
export interface IPXTab extends HostedInterfaceTab {
|
|
11
9
|
/**
|
|
12
10
|
* A constant query expression or filter that the Tab should add to any outgoing query.
|
|
@@ -17,10 +15,8 @@ export interface IPXTab extends HostedInterfaceTab {
|
|
|
17
15
|
*/
|
|
18
16
|
conditions: IPXCondition[];
|
|
19
17
|
}
|
|
20
|
-
export
|
|
21
|
-
|
|
22
|
-
export interface IPXResultTemplateDetail extends HostedInterfaceResultTemplateDetail {
|
|
23
|
-
}
|
|
18
|
+
export type IPXResultTemplateBadge = HostedInterfaceResultTemplateBadge;
|
|
19
|
+
export type IPXResultTemplateDetail = HostedInterfaceResultTemplateDetail;
|
|
24
20
|
export interface IPXResultTemplate extends HostedInterfaceResultTemplate {
|
|
25
21
|
layout: IPXResultTemplateLayout;
|
|
26
22
|
/**
|
|
@@ -26,6 +26,7 @@ export default class InProductExperiences extends Resource {
|
|
|
26
26
|
/**
|
|
27
27
|
* `delete` is a helper method based on observed behavior of the Coveo UI where deletion logic calls out to the
|
|
28
28
|
* Search Pages endpoint to delete an IPX.
|
|
29
|
+
* @param ipxId
|
|
29
30
|
*/
|
|
30
31
|
delete(ipxId: string): Promise<Record<string, unknown>>;
|
|
31
32
|
}
|