@coveo/platform-client 37.7.0 → 37.8.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/definitions/ConfigurationInterfaces.d.ts +1 -1
- package/dist/definitions/resources/BaseInterfaces.d.ts +2 -2
- package/dist/definitions/resources/CaseAssistConfigs/CaseAssistConfigInterfaces.d.ts +4 -4
- package/dist/definitions/resources/Catalogs/CatalogInterfaces.d.ts +8 -8
- package/dist/definitions/resources/Catalogs/ProductListingConfigurationInterfaces.d.ts +1 -1
- package/dist/definitions/resources/Catalogs/ProductListingInterfaces.d.ts +2 -2
- package/dist/definitions/resources/Extensions/ExtensionsInterfaces.d.ts +1 -1
- package/dist/definitions/resources/Groups/Invites/GroupInviteInterfaces.d.ts +1 -1
- package/dist/definitions/resources/InProductExperiences/InProductExperiencesInterfaces.d.ts +4 -4
- package/dist/definitions/resources/InsightPanelInterfaces/InsightPanelInterface.model.d.ts +1 -1
- package/dist/definitions/resources/MachineLearning/CaseClassificationConfiguration/CaseClassificationConfigurationInterfaces.d.ts +2 -2
- package/dist/definitions/resources/MachineLearning/ModelInformation/ModelInformationInterfaces.d.ts +1 -1
- package/dist/definitions/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts +1 -1
- package/dist/definitions/resources/Organizations/Organization.d.ts +1 -1
- package/dist/definitions/resources/Organizations/OrganizationInterfaces.d.ts +1 -1
- package/dist/definitions/resources/Pipelines/PipelinesInterfaces.d.ts +2 -2
- package/dist/definitions/resources/Pipelines/StatementGroups/StatementGroupsInterfaces.d.ts +3 -3
- package/dist/definitions/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts +1 -1
- package/dist/definitions/resources/Search/SearchInterfaces.d.ts +11 -11
- package/dist/definitions/resources/SearchPages/SearchPagesInterfaces.d.ts +5 -5
- package/dist/definitions/resources/SearchUsageMetrics/LicenseMetrics/LicenseMetricsInterface.d.ts +4 -0
- package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/RawMetricsInterface.d.ts +1 -1
- package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/SearchHubsInterface.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Exports/ExportsInterfaces.d.ts +2 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Filters/FiltersInterfaces.d.ts +8 -8
- package/dist/definitions/resources/UsageAnalytics/Read/Reports/ReportsInterfaces.d.ts +5 -5
- package/dist/definitions/resources/Vaults/VaultsInterfaces.d.ts +1 -1
- package/dist/definitions/utils/Retriever.d.ts +1 -1
- package/dist/definitions/utils/WithRequired.d.ts +1 -1
- package/package.json +7 -7
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Environment, Region } from './Endpoints';
|
|
2
2
|
import { ResponseHandler } from './handlers/ResponseHandlerInterfaces';
|
|
3
3
|
import { Retrievable } from './utils/Retriever';
|
|
4
|
-
export
|
|
4
|
+
export type Feature = (currentOptions: PlatformClientOptions) => PlatformClientOptions;
|
|
5
5
|
export interface PlatformClientOptions {
|
|
6
6
|
accessToken: Retrievable<string>;
|
|
7
7
|
organizationId?: Retrievable<string>;
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type PageModel<T = any, TItemsKey extends string = 'items'> = {
|
|
2
2
|
[key in TItemsKey]: T[];
|
|
3
3
|
} & {
|
|
4
4
|
totalEntries: number;
|
|
5
5
|
totalPages: number;
|
|
6
6
|
};
|
|
7
|
-
export
|
|
7
|
+
export type New<T, K extends string | number | symbol = null> = Omit<T, 'id' | K>;
|
|
8
8
|
export interface IdAndDisplayNameModel {
|
|
9
9
|
id: string;
|
|
10
10
|
displayName?: string;
|
|
@@ -38,9 +38,9 @@ export interface CaseClassificationAxonConfigurationModel {
|
|
|
38
38
|
modelId: string;
|
|
39
39
|
strategy: CaseClassificationStrategies;
|
|
40
40
|
}
|
|
41
|
-
export
|
|
42
|
-
export
|
|
43
|
-
export
|
|
41
|
+
export type TypingAidsConfigurations = StaticValuesConfigurationModel | ValuesFromIndexConfigurationModel;
|
|
42
|
+
export type DocumentSuggestionsConfigurations = ITDConfigurationModel;
|
|
43
|
+
export type CaseClassificationConfiguration = CaseClassificationSomeConfigurationModel | CaseClassificationAxonConfigurationModel;
|
|
44
44
|
export interface CaseAssistConfigModel {
|
|
45
45
|
id: string;
|
|
46
46
|
name: string;
|
|
@@ -51,7 +51,7 @@ export interface CaseAssistConfigModel {
|
|
|
51
51
|
export interface ContextField {
|
|
52
52
|
value: string;
|
|
53
53
|
}
|
|
54
|
-
export
|
|
54
|
+
export type ContextFields = Record<string, ContextField>;
|
|
55
55
|
export interface SuggestionRequestBody {
|
|
56
56
|
visitorId: string;
|
|
57
57
|
locale: string;
|
|
@@ -12,7 +12,7 @@ export interface CatalogsListOptions {
|
|
|
12
12
|
*/
|
|
13
13
|
pageSize?: number;
|
|
14
14
|
}
|
|
15
|
-
export
|
|
15
|
+
export type CatalogConfigurationsListOptions = Omit<CatalogsListOptions, 'filter'>;
|
|
16
16
|
export interface CatalogFieldsOptions {
|
|
17
17
|
/**
|
|
18
18
|
* If true, the database cache will be bypassed. This will resolve your fields once, and save them into the database.
|
|
@@ -125,7 +125,7 @@ export interface BaseCatalogModel {
|
|
|
125
125
|
*/
|
|
126
126
|
scope?: ScopeModel;
|
|
127
127
|
}
|
|
128
|
-
export
|
|
128
|
+
export type HierarchyWithFields<T extends {
|
|
129
129
|
fields?: string[];
|
|
130
130
|
}> = Omit<T, 'fields'> & {
|
|
131
131
|
/**
|
|
@@ -163,7 +163,7 @@ interface CatalogFieldsModel {
|
|
|
163
163
|
*/
|
|
164
164
|
availabilityFields: string[];
|
|
165
165
|
}
|
|
166
|
-
export
|
|
166
|
+
export type CachedCatalogFieldsModel = Cached<CatalogFieldsModel>;
|
|
167
167
|
export interface CatalogModel extends BaseCatalogModel {
|
|
168
168
|
/**
|
|
169
169
|
* @deprecated use `configuration.product` instead.
|
|
@@ -186,7 +186,7 @@ export interface CatalogModel extends BaseCatalogModel {
|
|
|
186
186
|
*/
|
|
187
187
|
configuration?: CatalogConfigurationModel;
|
|
188
188
|
}
|
|
189
|
-
export
|
|
189
|
+
export type CreateCatalogModel = BaseCatalogModel & ({
|
|
190
190
|
product?: CreateProductHierarchyModel;
|
|
191
191
|
variant?: CreateVariantHierarchyModel;
|
|
192
192
|
availability?: CreateAvailabilityHierarchyModel;
|
|
@@ -249,7 +249,7 @@ export interface ProductHierarchyModel {
|
|
|
249
249
|
*/
|
|
250
250
|
objectType: string;
|
|
251
251
|
}
|
|
252
|
-
export
|
|
252
|
+
export type CreateProductHierarchyModel = ProductHierarchyModel;
|
|
253
253
|
export interface VariantHierarchyModel {
|
|
254
254
|
/**
|
|
255
255
|
* @deprecated `fields` will be ignored by the service on creation or update, but is kept for backward compatibility.
|
|
@@ -264,7 +264,7 @@ export interface VariantHierarchyModel {
|
|
|
264
264
|
*/
|
|
265
265
|
objectType: string;
|
|
266
266
|
}
|
|
267
|
-
export
|
|
267
|
+
export type CreateVariantHierarchyModel = VariantHierarchyModel;
|
|
268
268
|
export interface AvailabilityHierarchyModel {
|
|
269
269
|
/**
|
|
270
270
|
* Field used to contain the list of SKUs for an availability
|
|
@@ -283,13 +283,13 @@ export interface AvailabilityHierarchyModel {
|
|
|
283
283
|
*/
|
|
284
284
|
objectType: string;
|
|
285
285
|
}
|
|
286
|
-
export
|
|
286
|
+
export type CreateAvailabilityHierarchyModel = AvailabilityHierarchyModel & {
|
|
287
287
|
/**
|
|
288
288
|
* Field used as the unique availability identifier
|
|
289
289
|
*/
|
|
290
290
|
idField: string;
|
|
291
291
|
};
|
|
292
|
-
export
|
|
292
|
+
export type ScopeModel = {
|
|
293
293
|
query: string;
|
|
294
294
|
} | {
|
|
295
295
|
query?: string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Paginated } from '../BaseInterfaces';
|
|
2
2
|
import { DeprecatedPaginated } from '../InternalBaseInterface';
|
|
3
3
|
import { QueryFilterModel } from './ProductListingInterfaces';
|
|
4
|
-
export
|
|
4
|
+
export type ProductListingConfigurationOptions = Paginated | DeprecatedPaginated;
|
|
5
5
|
export interface ProductListingConfigurationModel {
|
|
6
6
|
/**
|
|
7
7
|
* The id of the ProductListingConfiguration.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Paginated } from '../BaseInterfaces';
|
|
2
2
|
import { FieldOperatorType, FieldValueType } from '../Enums';
|
|
3
3
|
import { DeprecatedPaginated } from '../InternalBaseInterface';
|
|
4
|
-
export
|
|
4
|
+
export type ProductListingsListOptions = Paginated | DeprecatedPaginated;
|
|
5
5
|
interface FieldValueModelGeneric<T extends FieldValueType> {
|
|
6
6
|
/**
|
|
7
7
|
* The type of the field.
|
|
@@ -19,7 +19,7 @@ interface ValueTypeForFieldValueType {
|
|
|
19
19
|
[FieldValueType.ARRAY]: string[];
|
|
20
20
|
[FieldValueType.HIERARCHIC_MULTI_VALUE]: string[];
|
|
21
21
|
}
|
|
22
|
-
|
|
22
|
+
type FieldValueModel = FieldValueModelGeneric<FieldValueType.RANGE> | FieldValueModelGeneric<FieldValueType.STRING> | FieldValueModelGeneric<FieldValueType.DECIMAL> | FieldValueModelGeneric<FieldValueType.ARRAY> | FieldValueModelGeneric<FieldValueType.HIERARCHIC_MULTI_VALUE>;
|
|
23
23
|
export interface QueryFilterModel {
|
|
24
24
|
/**
|
|
25
25
|
* The field name.
|
|
@@ -29,7 +29,7 @@ export interface InviteByProvider {
|
|
|
29
29
|
expirationDate?: number;
|
|
30
30
|
invitedDate?: number;
|
|
31
31
|
}
|
|
32
|
-
export
|
|
32
|
+
export type InviteModel = InviteByEmail | InviteByUsername | InviteByProvider;
|
|
33
33
|
export interface AddInviteOptions {
|
|
34
34
|
sendEmail: boolean;
|
|
35
35
|
}
|
|
@@ -221,8 +221,8 @@ export declare enum ButtonPositionVerticalResponseModel {
|
|
|
221
221
|
/**
|
|
222
222
|
* The configuration to use for the new InAppWidget.
|
|
223
223
|
*/
|
|
224
|
-
export
|
|
225
|
-
export
|
|
224
|
+
export type CreateInProductExperienceModel = CreateUpdateInProductExperienceModel;
|
|
225
|
+
export type CreateInProductExperienceResponse = Pick<InProductExperienceModel, 'id' | 'name' | 'lastModified' | 'title' | 'button' | 'token'> & {
|
|
226
226
|
/**
|
|
227
227
|
* The <script> HTML tag to include in the head content.
|
|
228
228
|
*
|
|
@@ -234,8 +234,8 @@ export declare type CreateInProductExperienceResponse = Pick<InProductExperience
|
|
|
234
234
|
/**
|
|
235
235
|
* The new configuration to use for the updated InAppWidget.
|
|
236
236
|
*/
|
|
237
|
-
export
|
|
238
|
-
export
|
|
237
|
+
export type UpdateInProductExperienceModel = CreateUpdateInProductExperienceModel;
|
|
238
|
+
export type InProductExperienceLoader = string;
|
|
239
239
|
export interface IPXButtonModel {
|
|
240
240
|
/**
|
|
241
241
|
* The button's CSS.
|
|
@@ -126,7 +126,7 @@ export interface InsightPanelResultTemplate {
|
|
|
126
126
|
*/
|
|
127
127
|
tags: InsightPanelResultTags;
|
|
128
128
|
}
|
|
129
|
-
export
|
|
129
|
+
export type DisplayValueType = 'checkbox' | 'link';
|
|
130
130
|
export interface InsightPanelFacet {
|
|
131
131
|
/**
|
|
132
132
|
* The [field](https://docs.coveo.com/en/200) on which the facet is based.
|
|
@@ -3,7 +3,7 @@ export declare enum Operator {
|
|
|
3
3
|
Equals = "EQUALS",
|
|
4
4
|
NotEquals = "NOT_EQUALS"
|
|
5
5
|
}
|
|
6
|
-
export
|
|
6
|
+
export type CaseClassificationDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
|
|
7
7
|
export interface DateField {
|
|
8
8
|
/**
|
|
9
9
|
* The field to use as date.
|
|
@@ -30,7 +30,7 @@ export interface IntervalExtractionPeriod {
|
|
|
30
30
|
*/
|
|
31
31
|
exportPeriod: string;
|
|
32
32
|
}
|
|
33
|
-
export
|
|
33
|
+
export type ExtractionPeriod = DateField & (FixedExtractionPeriod | IntervalExtractionPeriod);
|
|
34
34
|
export interface CaseClassificationConfigurationModel {
|
|
35
35
|
/**
|
|
36
36
|
* The unique ID of the model.
|
package/dist/definitions/resources/MachineLearning/ModelInformation/ModelInformationInterfaces.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ export interface MLModelInfo<T extends MLModelTypeInfo = never> {
|
|
|
2
2
|
id: string;
|
|
3
3
|
info?: T;
|
|
4
4
|
}
|
|
5
|
-
export
|
|
5
|
+
export type MLModelTypeInfo = ModelInformationART | ModelInformationCC | ModelInformationDNE | ModelInformationER | ModelInformationPR | ModelInformationQS | ModelInformationSS;
|
|
6
6
|
export interface MetaInfo {
|
|
7
7
|
modelName: string;
|
|
8
8
|
version: string;
|
|
@@ -36,7 +36,7 @@ export interface SmartSnippetsConfigurationModel {
|
|
|
36
36
|
*/
|
|
37
37
|
documentTypes?: DocumentType[];
|
|
38
38
|
}
|
|
39
|
-
export
|
|
39
|
+
export type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
|
|
40
40
|
export interface SmartSnippetsDocumentGroupPreviewParams {
|
|
41
41
|
/**
|
|
42
42
|
* The sources to consider.
|
|
@@ -4,7 +4,7 @@ import Resource from '../Resource';
|
|
|
4
4
|
import Members from './Members/Members';
|
|
5
5
|
import { CreateOrganizationOptions, DefinitionModel, GetOrganizationOptions, ListOrganizationOptions, OrganizationModel, OrganizationsStatusModel } from './OrganizationInterfaces';
|
|
6
6
|
import { AuthProvider } from '../Enums';
|
|
7
|
-
export
|
|
7
|
+
export type NoPagination = undefined | null;
|
|
8
8
|
export default class Organization extends Resource {
|
|
9
9
|
protected api: API;
|
|
10
10
|
protected serverlessApi: API;
|
|
@@ -114,7 +114,7 @@ export interface OrganizationModel {
|
|
|
114
114
|
license?: LicenseModel;
|
|
115
115
|
organizationStatusModel?: OrganizationsStatusModel;
|
|
116
116
|
}
|
|
117
|
-
export
|
|
117
|
+
export type AdditionalOrganizationField = 'status' | 'license' | string;
|
|
118
118
|
export interface GetOrganizationOptions {
|
|
119
119
|
additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
|
|
120
120
|
}
|
|
@@ -206,8 +206,8 @@ export interface ListPipelinesOptions extends Paginated {
|
|
|
206
206
|
*/
|
|
207
207
|
enablePagination?: boolean;
|
|
208
208
|
}
|
|
209
|
-
export
|
|
210
|
-
export
|
|
209
|
+
export type PaginatedListPipelinesModel = Omit<PageModel<PipelineModel>, 'totalPages'>;
|
|
210
|
+
export type ListPipelinesReturnVariant<ListPipelineVariant> = ListPipelineVariant extends {
|
|
211
211
|
enablePagination: true;
|
|
212
212
|
} ? PaginatedListPipelinesModel : PipelineModel[];
|
|
213
213
|
export {};
|
|
@@ -8,7 +8,7 @@ export interface StatementGroupList {
|
|
|
8
8
|
totalCount: number;
|
|
9
9
|
groupComposition: PipelineGroupsComposition;
|
|
10
10
|
}
|
|
11
|
-
export
|
|
11
|
+
export type StatementGroupModel = PermanentStatementGroup | CampaignStatementGroup;
|
|
12
12
|
interface StatementGroupModelBase {
|
|
13
13
|
/**
|
|
14
14
|
* The unique identifier of the statement group.
|
|
@@ -148,7 +148,7 @@ export interface ListStatementGroupsOptions extends Paginated {
|
|
|
148
148
|
*/
|
|
149
149
|
types?: StatementGroupType[];
|
|
150
150
|
}
|
|
151
|
-
export
|
|
151
|
+
export type CreateStatementGroupModel = CreatePermanentStatementGroupModel | CreateCampaignStatementGroupModel;
|
|
152
152
|
interface CreateStatementGroupModelBase {
|
|
153
153
|
/**
|
|
154
154
|
* The name of the statement group.
|
|
@@ -187,7 +187,7 @@ export interface CreateCampaignStatementGroupModel extends CreateStatementGroupM
|
|
|
187
187
|
*/
|
|
188
188
|
campaignEnd: string;
|
|
189
189
|
}
|
|
190
|
-
export
|
|
190
|
+
export type UpdateStatementGroupModel = UpdatePermanentStatementGroupModel | UpdateCampaignStatementGroupsModel;
|
|
191
191
|
export interface UpdatePermanentStatementGroupModel extends CreatePermanentStatementGroupModel {
|
|
192
192
|
}
|
|
193
193
|
export interface UpdateCampaignStatementGroupsModel extends CreateCampaignStatementGroupModel {
|
|
@@ -144,7 +144,7 @@ export interface ResourceSnapshotsReportOperationResult {
|
|
|
144
144
|
*/
|
|
145
145
|
message: string;
|
|
146
146
|
}
|
|
147
|
-
export
|
|
147
|
+
export type ResourceSnapshotsReportOperationResults = Record<string, ResourceSnapshotsReportOperationResult[]>;
|
|
148
148
|
export declare enum SnapshotsReportStages {
|
|
149
149
|
COMPUTING_OPERATIONS = "COMPUTING_OPERATIONS",
|
|
150
150
|
CREATING_SNAPSHOT = "CREATING_SNAPSHOT",
|
|
@@ -34,7 +34,7 @@ export interface RestCommerceParameters {
|
|
|
34
34
|
export interface TokenModel {
|
|
35
35
|
token: string;
|
|
36
36
|
}
|
|
37
|
-
export
|
|
37
|
+
export type RestQueryParams = PostSearchBodyQueryParams & PostSearchQueryStringParams;
|
|
38
38
|
export interface PostSearchQueryStringParams {
|
|
39
39
|
viewAllContent?: boolean | number;
|
|
40
40
|
}
|
|
@@ -1129,16 +1129,16 @@ export interface PostSearchQuerySuggestBodyParams extends PostSearchBodyCommonPa
|
|
|
1129
1129
|
*/
|
|
1130
1130
|
enableWordCompletion?: boolean;
|
|
1131
1131
|
}
|
|
1132
|
-
export
|
|
1133
|
-
export
|
|
1134
|
-
export
|
|
1135
|
-
export
|
|
1136
|
-
export
|
|
1137
|
-
export
|
|
1138
|
-
export
|
|
1139
|
-
export
|
|
1140
|
-
export
|
|
1141
|
-
export
|
|
1132
|
+
export type RestFacetRequest = RestSpecificFacetRequest | RestDateRangeFacetRequest | RestNumericalRangeFacetRequest | RestHierarchicalFacetRequest;
|
|
1133
|
+
export type RestThreshold = string | number;
|
|
1134
|
+
export type RestComputedFieldOperation = 'average' | 'maximum' | 'minimum' | 'sum';
|
|
1135
|
+
export type RestHierarchicalFacetSortCriteria = 'score' | 'alphanumeric' | 'occurrences';
|
|
1136
|
+
export type RestRangeFacetSortCriteria = 'score' | 'alphanumeric' | 'ascending' | 'descending';
|
|
1137
|
+
export type RestSpecificFacetSortCriteria = 'score' | 'alphanumeric';
|
|
1138
|
+
export type RestFormat = 'json' | 'opensearch-atom' | 'opensearch-rss' | 'xlsx';
|
|
1139
|
+
export type RestGroupBySortCriteria = 'alphaascending' | 'alphadescending' | 'chisquare' | 'computedfieldascending' | 'computedfielddescending' | 'nosort' | 'occurrences' | 'score';
|
|
1140
|
+
export type RestMLParametersPadding = 'popular' | 'trending';
|
|
1141
|
+
export type RestRangeAlgorithm = 'equiprobable' | 'even';
|
|
1142
1142
|
/**
|
|
1143
1143
|
* A single query or page view action (see the `actionsHistory` top-level search request parameter).
|
|
1144
1144
|
*/
|
|
@@ -13,9 +13,9 @@ export interface CreateSearchPageModel extends Pick<SearchPageModel, 'name' | 't
|
|
|
13
13
|
}
|
|
14
14
|
export interface UpdateSearchPageModel extends Pick<SearchPageModel, 'name' | 'title' | 'html'> {
|
|
15
15
|
}
|
|
16
|
-
export
|
|
17
|
-
export
|
|
18
|
-
export
|
|
16
|
+
export type JavaScriptResourceModel = SearchPageResourceModel;
|
|
17
|
+
export type CSSResourceModel = SearchPageResourceModel;
|
|
18
|
+
export type SearchPageResourceModel = SearchPageResourceModelWithUrl | SearchPageResourceModelWithInlineContent;
|
|
19
19
|
export interface SearchPageResourceModelBasics {
|
|
20
20
|
name: string;
|
|
21
21
|
}
|
|
@@ -38,5 +38,5 @@ export interface MajorMinorVersion {
|
|
|
38
38
|
major: string;
|
|
39
39
|
minor: string;
|
|
40
40
|
}
|
|
41
|
-
export
|
|
42
|
-
export
|
|
41
|
+
export type SearchPageHeadersModel = Pick<SearchPageModel, 'css' | 'javascript'>;
|
|
42
|
+
export type ReorderSearchPageHeadersModel = Record<'css' | 'javascript', string[]>;
|
|
@@ -59,6 +59,6 @@ interface SearchHubBucketParams {
|
|
|
59
59
|
*/
|
|
60
60
|
bucket: string;
|
|
61
61
|
}
|
|
62
|
-
export
|
|
63
|
-
export
|
|
62
|
+
export type UpdateSearchHubParams = SearchHubNameParams & SearchHubModel;
|
|
63
|
+
export type UpdateSearchHubBucketParams = SearchHubNameParams & SearchHubBucketParams;
|
|
64
64
|
export {};
|
|
@@ -70,8 +70,8 @@ interface GenerateExportCommonParams {
|
|
|
70
70
|
format?: CSVFileFormat;
|
|
71
71
|
useDisplayNames?: boolean;
|
|
72
72
|
}
|
|
73
|
-
export
|
|
74
|
-
export
|
|
73
|
+
export type GenerateExportParams = EstimateExportParams & GenerateExportCommonParams;
|
|
74
|
+
export type GenerateVisitExportParams = EstimateVisitExportParams & GenerateExportCommonParams & {
|
|
75
75
|
ordered?: boolean;
|
|
76
76
|
};
|
|
77
77
|
interface ScheduleCommonProperties {
|
|
@@ -17,14 +17,14 @@ export interface FilterResponse {
|
|
|
17
17
|
/** The actual filter. */
|
|
18
18
|
value: string;
|
|
19
19
|
}
|
|
20
|
-
export
|
|
21
|
-
export
|
|
22
|
-
export
|
|
23
|
-
export
|
|
24
|
-
export
|
|
25
|
-
export
|
|
26
|
-
export
|
|
27
|
-
export
|
|
20
|
+
export type CreateReportingFilterModel = FilterModel;
|
|
21
|
+
export type CreateReportingFilterResponse = Pick<FilterResponse, 'id'>;
|
|
22
|
+
export type UpdateReportingFilterModel = CreateReportingFilterModel;
|
|
23
|
+
export type UpdateReportingFilterResponse = CreateReportingFilterResponse;
|
|
24
|
+
export type CreatePermissionsFilterModel = FilterModel;
|
|
25
|
+
export type CreatePermissionsFilterResponse = Pick<FilterResponse, 'id'>;
|
|
26
|
+
export type UpdatePermissionsFilterModel = CreatePermissionsFilterModel;
|
|
27
|
+
export type UpdatePermissionsFilterResponse = CreatePermissionsFilterResponse;
|
|
28
28
|
export interface ListFiltersResponse {
|
|
29
29
|
/** A list of filters */
|
|
30
30
|
filters: FilterResponse[];
|
|
@@ -15,14 +15,14 @@ export interface ReportModel {
|
|
|
15
15
|
/** The ids of the persisted filters associated with the report. */
|
|
16
16
|
filters: string[];
|
|
17
17
|
}
|
|
18
|
-
export
|
|
19
|
-
export
|
|
18
|
+
export type CreateReportModel = Omit<ReportModel, 'id' | 'account'>;
|
|
19
|
+
export type CreateReportResponse = Pick<ReportModel, 'id'>;
|
|
20
20
|
export interface GetReportOptions {
|
|
21
21
|
/** Timezone used for calculations. */
|
|
22
22
|
tz?: string;
|
|
23
23
|
}
|
|
24
|
-
export
|
|
25
|
-
export
|
|
24
|
+
export type UpdateReportModel = CreateReportModel;
|
|
25
|
+
export type UpdateReportResponse = CreateReportResponse;
|
|
26
26
|
export interface ListReportsOptions {
|
|
27
27
|
/** The type of the report. Must be either 'explorer' or 'dashboard'. */
|
|
28
28
|
type?: ReportType;
|
|
@@ -77,7 +77,7 @@ export interface GroupResponse extends AccountMetaModel {
|
|
|
77
77
|
/** The group account */
|
|
78
78
|
account: string;
|
|
79
79
|
}
|
|
80
|
-
export
|
|
80
|
+
export type StatusResponse = Record<string, unknown>;
|
|
81
81
|
export interface GetReportTemplateOptions {
|
|
82
82
|
/** Whether to include metadata about the report template */
|
|
83
83
|
includeMetadata?: boolean;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@coveo/platform-client",
|
|
3
|
-
"version": "37.
|
|
3
|
+
"version": "37.8.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "dist/Entry.js",
|
|
6
6
|
"types": "dist/definitions/Entry.d.ts",
|
|
@@ -24,14 +24,14 @@
|
|
|
24
24
|
"prepare": "husky install"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
|
-
"@commitlint/cli": "17.
|
|
28
|
-
"@commitlint/config-conventional": "17.
|
|
27
|
+
"@commitlint/cli": "17.3.0",
|
|
28
|
+
"@commitlint/config-conventional": "17.3.0",
|
|
29
29
|
"@types/jest": "29.2.3",
|
|
30
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
31
|
-
"@typescript-eslint/parser": "5.
|
|
30
|
+
"@typescript-eslint/eslint-plugin": "5.44.0",
|
|
31
|
+
"@typescript-eslint/parser": "5.44.0",
|
|
32
32
|
"abortcontroller-polyfill": "1.7.5",
|
|
33
33
|
"cz-conventional-changelog": "3.3.0",
|
|
34
|
-
"eslint": "8.
|
|
34
|
+
"eslint": "8.28.0",
|
|
35
35
|
"eslint-config-prettier": "8.5.0",
|
|
36
36
|
"eslint-config-typescript": "3.0.0",
|
|
37
37
|
"eslint-plugin-jest": "27.1.5",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"ts-jest": "29.0.3",
|
|
47
47
|
"tsjs": "4.2.1",
|
|
48
48
|
"tslib": "2.4.1",
|
|
49
|
-
"typescript": "4.
|
|
49
|
+
"typescript": "4.9.3"
|
|
50
50
|
},
|
|
51
51
|
"prettier": "tsjs/prettier-config",
|
|
52
52
|
"lint-staged": {
|